The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Borislav Petkov <bp@alien8.de>
To: Fenghua Yu <fenghua.yu@intel.com>
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>,
	Stephane Eranian <eranian@google.com>,
	Tony Luck <tony.luck@intel.com>,
	Reinette Chatre <reinette.chatre@intel.com>,
	Ravi V Shankar <ravi.v.shankar@intel.com>, x86 <x86@kernel.org>,
	linux-kernel <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] x86/resctrl: Correct MBM total and local values
Date: Tue, 6 Oct 2020 18:00:56 +0200	[thread overview]
Message-ID: <20201006160056.GG27700@zn.tnic> (raw)
In-Reply-To: <20201006004348.GA1415745@otcwcpicx6.sc.intel.com>

On Tue, Oct 06, 2020 at 12:43:48AM +0000, Fenghua Yu wrote:
> I keep this original table here for two reasons:
> 1. It's an original table that can be tracked by any one in the future.
>    If I don't list the original table here, others may wonder where I
>    get the converted table from.

If you wanna document it then put that table in
Documentation/x86/resctrl_ui.rst.

Before you put it there, you can rename that file to

Documentation/x86/resctrl.rst

because after that change, it won't contain UI documentation only
anymore.

Commit messages tend to become hard to dig out in the future, when a lot
of patches accumulate ontop. Even more so if someone renames files so if
you really need to document something, you can either put it a comment
over the code where it is used, or if it is something bigger as this
table, you can put it in Documentation/ and refer to it in the code.

> Ok. I will describe the problem in the commit message.

Just paste the erratum text. That's it - it is small enough.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

  reply	other threads:[~2020-10-06 16:01 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-28 22:12 [PATCH] x86/resctrl: Correct MBM total and local values Fenghua Yu
2020-10-05  9:35 ` Borislav Petkov
2020-10-06  0:43   ` Fenghua Yu
2020-10-06 16:00     ` Borislav Petkov [this message]
2020-10-06 23:37       ` Fenghua Yu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201006160056.GG27700@zn.tnic \
    --to=bp@alien8.de \
    --cc=eranian@google.com \
    --cc=fenghua.yu@intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=ravi.v.shankar@intel.com \
    --cc=reinette.chatre@intel.com \
    --cc=tglx@linutronix.de \
    --cc=tony.luck@intel.com \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox