Re: [PATCH v4 3/7] x86/resctrl: Rename rftype flags for consistency

From: Reinette Chatre
Date: Fri May 05 2023 - 17:26:50 EST


Hi Babu,

On 5/5/2023 1:16 PM, Moger, Babu wrote:
> Hi Reinette,
>
> On 5/4/2023 2:00 PM, Reinette Chatre wrote:
>> Hi Babu,
>>
>> On 4/17/2023 4:34 PM, Babu Moger wrote:
>>> The rftype flags have two different prefixes even though they are used
>> Could this changelog please start with some context about what the
>> rftype flags are? Please note that the changelogs are required
>> to comply to the x86 requirements as documented in:
>> Documentation/process/maintainer-tip.rst (there is a whole
>> section on changelogs).
> Thanks
>>
>> After a context the problem could be made specific with something
>> like "rftype flags use the RF_ as well as RFTYPE_ prefixes."

> I can say start with "rftype flags are used for creating the files
> under resctrl filesystem. These flags use the RF_ as well as RFTYPE_
> prefixes.
>
> Change the prefix to RFTYPE_ for all the flags to be consistent.">

I would be careful with the term "rftype flags" since it is
not clear what is meant by this. Note that there are RF_*, RFTYPE_*,
as well as RFTYPE_FLAGS* flags and the reader may easily think that
you refer to the latter.

"resctrl associates flags with its files so that files can be chosen
based on the resource, whether it is info or base, and if it is control
or monitor type file. These flags use the RF_ as well as RFTYPE_ prefixes.

Change ..."

(A shortcut I used was to look up the commit that introduced the change
and borrow some text from it.)

Reinette