Hi, Boris,

On Tue, Oct 06, 2020 at 06:00:56PM +0200, Borislav Petkov wrote:
> 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.

Sure. I will put the correction table in resctrl.rst.

> 
> > Ok. I will describe the problem in the commit message.
> 
> Just paste the erratum text. That's it - it is small enough.

Sure. I will do that.

Thank you very much for your review!

-Fenghua

Reply via email to