[PATCH v9 10/27] x86/resctrl: Add 'resctrl' to the title of the resctrl documentation

James Morse posted 27 patches 7 months, 3 weeks ago
There is a newer version of this series
[PATCH v9 10/27] x86/resctrl: Add 'resctrl' to the title of the resctrl documentation
Posted by James Morse 7 months, 3 weeks ago
The resctrl documentation is titled "User Interface for Resource Control
feature".

Once the documentation follows the code in a move to the filesystem, this
appears in the list of filesystems, but doesn't contain the name of the
filesystem, making it hard to find.

Add 'resctrl' to the title.

Suggeted-by: Reinette Chatre <reinette.chartre@intel.com>
Signed-off-by: James Morse <james.morse@arm.com>
---
Changes since v8:
 * This patch is new.
---
 Documentation/arch/x86/resctrl.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/arch/x86/resctrl.rst b/Documentation/arch/x86/resctrl.rst
index 6768fc1fad16..c7949dd44f2f 100644
--- a/Documentation/arch/x86/resctrl.rst
+++ b/Documentation/arch/x86/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>
-- 
2.39.5
Re: [PATCH v9 10/27] x86/resctrl: Add 'resctrl' to the title of the resctrl documentation
Posted by Fenghua Yu 7 months, 3 weeks ago
On 4/25/25 10:37, James Morse wrote:
> The resctrl documentation is titled "User Interface for Resource Control
> feature".
>
> Once the documentation follows the code in a move to the filesystem, this
> appears in the list of filesystems, but doesn't contain the name of the
> filesystem, making it hard to find.
>
> Add 'resctrl' to the title.
>
> Suggeted-by: Reinette Chatre <reinette.chartre@intel.com>
s/Suggeted-by/Suggested-by/
> Signed-off-by: James Morse <james.morse@arm.com>

Reviewed-by: Fenghua Yu <fenghuay@nvidia.com>

> ---
> Changes since v8:
>   * This patch is new.
> ---
>   Documentation/arch/x86/resctrl.rst | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/arch/x86/resctrl.rst b/Documentation/arch/x86/resctrl.rst
> index 6768fc1fad16..c7949dd44f2f 100644
> --- a/Documentation/arch/x86/resctrl.rst
> +++ b/Documentation/arch/x86/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>

Thanks.

-Fenghua
Re: [PATCH v9 10/27] x86/resctrl: Add 'resctrl' to the title of the resctrl documentation
Posted by Reinette Chatre 7 months, 3 weeks ago
Hi James,

On 4/25/25 10:37 AM, James Morse wrote:
> The resctrl documentation is titled "User Interface for Resource Control
> feature".
> 
> Once the documentation follows the code in a move to the filesystem, this
> appears in the list of filesystems, but doesn't contain the name of the
> filesystem, making it hard to find.
> 
> Add 'resctrl' to the title.
> 

Thank you.

> Suggeted-by: Reinette Chatre <reinette.chartre@intel.com>

Suggested-by: Reinette Chatre <reinette.chatre@intel.com

> Signed-off-by: James Morse <james.morse@arm.com>
> ---

With typos fixed.

| Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>

Reinette