Re: [PATCH v8 21/21] x86,fs/resctrl: Move resctrl.rst to live under Documentation/filesystems

Reinette Chatre
2025-04-24T17:22:48Z

Hi James,

On 4/24/25 10:12 AM, James Morse wrote:
> Hi Reinette,
>
> On 16/04/2025 03:31, Reinette Chatre wrote:
>> On 4/11/25 9:42 AM, James Morse wrote:
>>> The filesystem code has moved from arch/x86 to fs. Move the documentation
>>> too.
>
>>> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
>>> index a9cf8e950b15..32618512a965 100644
>>> --- a/Documentation/filesystems/index.rst
>>> +++ b/Documentation/filesystems/index.rst
>>> @@ -113,6 +113,7 @@ Documentation for filesystem implementations.
>>> qnx6
>>> ramfs-rootfs-initramfs
>>> relay
>>> + resctrl
>>> romfs
>>> smb/index
>>> spufs/index
>>
>> I built the htmldocs with this change and the filesystem's index.html is quite big
>> making the resctrl parts not be obvious. The title of the documentation is used as
>> a heading so the resctrl documentation's heading is "User Interface for Resource
>> Control feature" that I think makes a text search hard to use since it may not be
>> obvious to users what to search for.
>>
>> What do you think of a snippet like below that will include "resctrl" as a term
>> in the title that should make the documentation easier to find?
>
> Good point - that is the string people are going to use, and the file names might not be
> something they are looking at.
>
>
>> ---8<---
>> diff --git a/Documentation/filesystems/resctrl.rst b/Documentation/filesystems/resctrl.rst
>> index 6768fc1fad16..c7949dd44f2f 100644
>> --- a/Documentation/filesystems/resctrl.rst
>> +++ b/Documentation/filesystems/resctrl.rst
>> @@ -1,9 +1,9 @@
>> .. SPDX-License-Identifier: GPL-2.0
>> .. include:: <isonum.txt>
>>
>> -===========================================
>> -User Interface for Resource Control feature
>> -===========================================
>> +=====================================================
>> +User Interface for Resource Control feature (resctrl)
>> +=====================================================
>>
>> :Copyright: |copy| 2016 Intel Corporation
>> :Authors: - Fenghua Yu <fenghua.yu@intel.com>
>> ---8<---
>
> I'll add this as a patch before 17 as its a little more nuanced that fallout from moving code.

Thank you for considering this.

>
>
>>> diff --git a/Documentation/arch/x86/resctrl.rst b/Documentation/filesystems/resctrl.rst
>>> similarity index 100%
>>> rename from Documentation/arch/x86/resctrl.rst
>>> rename to Documentation/filesystems/resctrl.rst
>>> diff --git a/MAINTAINERS b/MAINTAINERS
>>> index c30c6fbd1f7a..f7a829898344 100644
>>> --- a/MAINTAINERS
>>> +++ b/MAINTAINERS
>>> @@ -20281,7 +20281,7 @@ M: Tony Luck <tony.luck@intel.com>
>>> M: Reinette Chatre <reinette.chatre@intel.com>
>>> L: linux-kernel@vger.kernel.org
>>> S: Supported
>>> -F: Documentation/arch/x86/resctrl*
>>> +F: Documentation/filesystems/resctrl.rst
>>> F: arch/x86/include/asm/resctrl.h
>>> F: arch/x86/kernel/cpu/resctrl/
>>> F: fs/resctrl/
>
>> On the topic of MAINTAINERS file ... if this is ok with you I would like to suggest
>> that you add your name as reviewer to this area with the goal of you being CCed on
>> any patches that touch any of these files so that you could highlight if anything
>> impacts Arm.
>
> Yes, that makes sense. I'd like to add Dave Martin too so that one of us is more likely to
> be available. I've asked him verbally ...

I'll support this. I find Dave's feedback to be insightful and would appreciate and
welcome more of it.

Reinette