Documentation: proc: fix section numbering in table of contents

[PATCH v2 v2] Documentation: proc: fix section numbering in table of contents

Posted by Baolin Liu 1 month, 3 weeks ago

From: Baolin Liu <liubaolin@kylinos.cn>

Commit e24ccaaf7ec4 ("block: remove last remaining traces of IDE
documentation") removed the IDE section but left its table of
contents entry behind.
Fix the stale entry and renumber the following sections.

Fixes: e24ccaaf7ec4 ("block: remove last remaining traces of IDE documentation")
Signed-off-by: Baolin Liu <liubaolin@kylinos.cn>
---
 Documentation/filesystems/proc.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 7ce02573a3d9..70db35987ee1 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -23,13 +23,13 @@ fixes/update part 1.1  Stefani Seibold <stefani@seibold.net>    June 9 2009
   1	Collecting System Information
   1.1	Process-Specific Subdirectories
   1.2	Kernel data
-  1.3	IDE devices in /proc/ide
-  1.4	Networking info in /proc/net
-  1.5	SCSI info
-  1.6	Parallel port info in /proc/parport
-  1.7	TTY info in /proc/tty
-  1.8	Miscellaneous kernel statistics in /proc/stat
-  1.9	Ext4 file system parameters
+  1.3	Networking info in /proc/net
+  1.4	SCSI info
+  1.5	Parallel port info in /proc/parport
+  1.6	TTY info in /proc/tty
+  1.7	Miscellaneous kernel statistics in /proc/stat
+  1.8	Ext4 file system parameters
+  1.9	/proc/consoles - Shows registered system consoles
 
   2	Modifying System Parameters
 
-- 
2.51.0

Re: [PATCH v2 v2] Documentation: proc: fix section numbering in table of contents

Posted by Randy Dunlap 1 month, 3 weeks ago


On 4/24/26 2:06 AM, Baolin Liu wrote:
> From: Baolin Liu <liubaolin@kylinos.cn>
> 
> Commit e24ccaaf7ec4 ("block: remove last remaining traces of IDE
> documentation") removed the IDE section but left its table of
> contents entry behind.
> Fix the stale entry and renumber the following sections.
> 
> Fixes: e24ccaaf7ec4 ("block: remove last remaining traces of IDE documentation")
> Signed-off-by: Baolin Liu <liubaolin@kylinos.cn>

LGTM.
Acked-by: Randy Dunlap <rdunlap@infradead.org>

I note that the html-generated TOC is already correct;
e.g., https://docs.kernel.org/filesystems/proc.html#networking-info-in-proc-net
is already section 1.3.

AFAICT, this TOC is for users/readers who use an editor or pager
to read this file, but the patch is useful in that setting.

> ---
>  Documentation/filesystems/proc.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 7ce02573a3d9..70db35987ee1 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -23,13 +23,13 @@ fixes/update part 1.1  Stefani Seibold <stefani@seibold.net>    June 9 2009
>    1	Collecting System Information
>    1.1	Process-Specific Subdirectories
>    1.2	Kernel data
> -  1.3	IDE devices in /proc/ide
> -  1.4	Networking info in /proc/net
> -  1.5	SCSI info
> -  1.6	Parallel port info in /proc/parport
> -  1.7	TTY info in /proc/tty
> -  1.8	Miscellaneous kernel statistics in /proc/stat
> -  1.9	Ext4 file system parameters
> +  1.3	Networking info in /proc/net
> +  1.4	SCSI info
> +  1.5	Parallel port info in /proc/parport
> +  1.6	TTY info in /proc/tty
> +  1.7	Miscellaneous kernel statistics in /proc/stat
> +  1.8	Ext4 file system parameters
> +  1.9	/proc/consoles - Shows registered system consoles
>  
>    2	Modifying System Parameters
>  

-- 
~Randy

Re: [PATCH v2 v2] Documentation: proc: fix section numbering in table of contents

Posted by Jonathan Corbet 1 month, 2 weeks ago

Randy Dunlap <rdunlap@infradead.org> writes:

> On 4/24/26 2:06 AM, Baolin Liu wrote:
>> From: Baolin Liu <liubaolin@kylinos.cn>
>> 
>> Commit e24ccaaf7ec4 ("block: remove last remaining traces of IDE
>> documentation") removed the IDE section but left its table of
>> contents entry behind.
>> Fix the stale entry and renumber the following sections.
>> 
>> Fixes: e24ccaaf7ec4 ("block: remove last remaining traces of IDE documentation")
>> Signed-off-by: Baolin Liu <liubaolin@kylinos.cn>
>
> LGTM.
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
>
> I note that the html-generated TOC is already correct;
> e.g., https://docs.kernel.org/filesystems/proc.html#networking-info-in-proc-net
> is already section 1.3.

There are advantages to having a computer do a job like that :)

I do really question the value of these manually maintained TOCs; they
are always going to be out of date.  But ...

> AFAICT, this TOC is for users/readers who use an editor or pager
> to read this file, but the patch is useful in that setting.

Others seem to disagree, so we keep them.

I've applied the patch, thanks.

jon

Re: [PATCH v2 v2] Documentation: proc: fix section numbering in table of contents

Posted by Randy Dunlap 1 month, 2 weeks ago


On 4/27/26 2:55 AM, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> On 4/24/26 2:06 AM, Baolin Liu wrote:
>>> From: Baolin Liu <liubaolin@kylinos.cn>
>>>
>>> Commit e24ccaaf7ec4 ("block: remove last remaining traces of IDE
>>> documentation") removed the IDE section but left its table of
>>> contents entry behind.
>>> Fix the stale entry and renumber the following sections.
>>>
>>> Fixes: e24ccaaf7ec4 ("block: remove last remaining traces of IDE documentation")
>>> Signed-off-by: Baolin Liu <liubaolin@kylinos.cn>
>>
>> LGTM.
>> Acked-by: Randy Dunlap <rdunlap@infradead.org>
>>
>> I note that the html-generated TOC is already correct;
>> e.g., https://docs.kernel.org/filesystems/proc.html#networking-info-in-proc-net
>> is already section 1.3.
> 
> There are advantages to having a computer do a job like that :)
> 
> I do really question the value of these manually maintained TOCs; they
> are always going to be out of date.  But ...
> 
>> AFAICT, this TOC is for users/readers who use an editor or pager
>> to read this file, but the patch is useful in that setting.
> 
> Others seem to disagree, so we keep them.
> 
> I've applied the patch, thanks.

Yes, others do disagree, but my comment was not meant to be an endorsement
for keeping it there. I'm fine without it.

-- 
~Randy