Re: [PATCH v11 13/13] Documentation/x86: Update resctrl.rst for new features

From: Moger, Babu
Date: Thu Jan 12 2023 - 14:19:23 EST



On 1/12/23 11:30, Reinette Chatre wrote:
> Hi Babu,
>
> On 1/11/2023 4:47 PM, Moger, Babu wrote:
>
>> diff --git a/Documentation/x86/resctrl.rst b/Documentation/x86/resctrl.rst
>> index 2860856f4463..7df5889237f4 100644
>> --- a/Documentation/x86/resctrl.rst
>> +++ b/Documentation/x86/resctrl.rst
>> @@ -24,10 +24,15 @@ CDP (Code and Data Prioritization) "cdp_l3", "cdp_l2"
>> CQM (Cache QoS Monitoring) "cqm_llc", "cqm_occup_llc"
>> MBM (Memory Bandwidth Monitoring) "cqm_mbm_total", "cqm_mbm_local"
>> MBA (Memory Bandwidth Allocation) "mba"
>> -SMBA (Slow Memory Bandwidth Allocation) "smba"
>> -BMEC (Bandwidth Monitoring Event Configuration) "bmec"
>> +SMBA (Slow Memory Bandwidth Allocation) ""
>> +BMEC (Bandwidth Monitoring Event Configuration) ""
>> =============================================== ================================
>>
>> +Historically, new features were made visible by default in /proc/cpuinfo. This
>> +resulted in the feature flags becoming hard to parse by the humans. Adding a new
>> +flag to /proc/cpuinfo should be avoided if user space can obtain information
>> +about the feature from resctrl's info directory.
>> +
> Could you please replace "parse by the humans" with "parse by humans"?
Sure.
>
> The rest looks good to me.
>
> Could you please do a sanity check by building the documentation to ensure
> that the usage of the empty quotes looks as expected and is not parsed out by a
> tool when, for example, creating the html docs?

Yes. Will do.

Thanks

Babu

>
>> To use the feature mount the file system::
>>
>> # mount -t resctrl resctrl [-o cdp[,cdpl2][,mba_MBps]] /sys/fs/resctrl
> Thank you very much
>
> Reinette

--
Thanks
Babu Moger