Re: [PATCH v12 04/10] x86/resctrl: Add comments on RFTYPE flags hierarchy

From: Moger, Babu
Date: Wed Oct 11 2023 - 12:57:14 EST


Hi Reinette,

On 10/10/23 19:56, Reinette Chatre wrote:
> Hi Babu,
>
> On 10/10/2023 4:33 PM, Babu Moger wrote:
>> resctrl uses RFTYPE flags for creating resctrl directory structure.
>>
>> Definitions and directory structures are not documented. Add
>> comments to improve the readability and help future additions.
>>
>> Signed-off-by: Babu Moger <babu.moger@xxxxxxx>
>> Tested-by: Peter Newman <peternewman@xxxxxxxxxx>
>> Reviewed-by: Peter Newman <peternewman@xxxxxxxxxx>
>> Tested-by: Tan Shaopeng <tan.shaopeng@xxxxxxxxxxxxxx>
>> Reviewed-by: Tan Shaopeng <tan.shaopeng@xxxxxxxxxxxxxx>
>> Reviewed-by: Fenghua Yu <fenghua.yu@xxxxxxxxx>
>> Reviewed-by: Reinette Chatre <reinette.chatre@xxxxxxxxx>
>> Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@xxxxxxxxxxxxxxx>
>> ---
>> v12: Moved the comments from arch/x86/kernel/cpu/resctrl/internal.h
>> to Documentation/arch/x86/resctrl.rst. (Boris)
>> ---
>
> It seems like you just copied the text to the documentation without
> taking into account the destination's use of reST syntax.
>
> I tried a "make htmldocs" to see how this looks but encountered:
> docutils.utils.SystemMessage: [snip]/linux/Documentation/arch/x86/resctrl.rst:398: (SEVERE/4) Unexpected section title.

My bad. Just tested the format by opening using the browser. Forgot about
make htmldocs. Will fix it now.
>
> Please remove my Reviewed-by.

Sure. Will remove Reviewed-by on this patch. Please let me know about
other patches when you get a chance.
--
Thanks
Babu Moger