Skip to contentSkip to conversation

proc.5: Still refers to "described in more detail below" for splitted out manpages

DISCUSSION Salvatore Bonaccorso 2 participants 6 messages Apr 12, 2024 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Salvatore Bonaccorso

author
#0 lore raw

Hi Alejandro

Back in August 2023, various parts were split out of proc(5) into separate manpage. What seems to have remained from the split is the mentioning:

[...]
178 .P
179 All of the above are described in more detail below. [...]

I'm not sure what you would like to prefer, so I have no explict patch here. But maybe this can be reworded to "All of the above are desribed in sepate manpages prefixes with proc_"?

Regards,
Salvatore

maintainer
#1 lore raw

Hi Salvatore,

Quoted 6 lines · Salvatore Bonaccorso

Hi Alejandro

Back in August 2023, various parts were split out of proc(5) into separate manpage. What seems to have remained from the split is the mentioning:

Quoted 8 lines

[...]
178 .P
179 All of the above are described in more detail below. [...]

I'm not sure what you would like to prefer, so I have no explict patch here. But maybe this can be reworded to "All of the above are desribed in sepate manpages prefixes with proc_"?

Thanks for catching this. Yeah, something like that makes sense.

You could add to the commit message:

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")

Have a lovely day!
Alex

Quoted 4 lines

Regards,
Salvatore

Signature · 1 line
<https://www.alejandro-colomar.es/>
author
#2 lore raw

Hi Alex,

Quoted 18 lines · Alejandro Colomar

Hi Salvatore,

Quoted 6 lines · Salvatore Bonaccorso

Hi Alejandro

Back in August 2023, various parts were split out of proc(5) into separate manpage. What seems to have remained from the split is the mentioning:

Quoted 8 lines

[...]
178 .P
179 All of the above are described in more detail below. [...]

I'm not sure what you would like to prefer, so I have no explict patch here. But maybe this can be reworded to "All of the above are desribed in sepate manpages prefixes with proc_"?

Quoted 5 lines

Thanks for catching this. Yeah, something like that makes sense.

You could add to the commit message:

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")

Thanks for the quick feedback. So please find attached the proposed change. Let me know if you want something changed.

Regards,
Salvatore

From 07bf84cbb2e78595b4514fe820ae5574bba8d0ec Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>
---
 man5/proc.5 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
man5/proc.5 +4 -1
index bdc47456bdce..4c20920e1e3c 100644
@@ -176,7 +176,10 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+prefixed with
+.BR proc_.
+.TP
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0
maintainer
#3 lore raw

Hi Salvatore,

Quoted 2 lines · Salvatore Bonaccorso

Thanks for the quick feedback. So please find attached the proposed change. Let me know if you want something changed.

You're welcome!

Quoted 22 lines

From 07bf84cbb2e78595b4514fe820ae5574bba8d0ec Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>
---
 man5/proc.5 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
man5/proc.5 +0 -0
index bdc47456bdce..4c20920e1e3c 100644

man5/proc.5 Various other files and subdirectories under · line 180

Quoted 6 lines
man5/proc.5 +2 -1
@@ -176,7 +176,10 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+prefixed with

Maybe I'd reword to say "whose name starts with".

man5/proc.5 Various other files and subdirectories under · line 181

Quoted 1 line
man5/proc.5 +1 -0
+.BR proc_.

This would need a space before the '.'.

man5/proc.5 Various other files and subdirectories under · line 182

Quoted 1 line
man5/proc.5 +1 -0
+.TP

Why TP?

Have a lovely night!
Alex

Quoted 6 lines
man5/proc.5 +0 -0
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0
Signature · 1 line
<https://www.alejandro-colomar.es/>
author
#4 lore raw

Hi,

Quoted 25 lines · Alejandro Colomar

Hi Salvatore,

Quoted 2 lines · Salvatore Bonaccorso

Thanks for the quick feedback. So please find attached the proposed change. Let me know if you want something changed.

You're welcome!

Quoted 17 lines

From 07bf84cbb2e78595b4514fe820ae5574bba8d0ec Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>
---
 man5/proc.5 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Quoted 13 lines

man5/proc.5 Various other files and subdirectories under · line 180

Quoted 11 lines
man5/proc.5 +2 -1
index bdc47456bdce..4c20920e1e3c 100644
@@ -176,7 +176,10 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+prefixed with

Maybe I'd reword to say "whose name starts with".

So "whose names start with" as there are multiple manpages?

Quoted 3 lines

man5/proc.5 Various other files and subdirectories under · line 181

Quoted 1 line
man5/proc.5 +1 -0
+.BR proc_.

This would need a space before the '.'.

Ah right added.

Quoted 3 lines

man5/proc.5 Various other files and subdirectories under · line 182

Quoted 1 line
man5/proc.5 +1 -0
+.TP

Why TP?

Because I stupidly copy-pasted lines and did not properly adjust and rechecked.

Quoted 8 lines

Have a lovely night!
Alex

Quoted 5 lines
man5/proc.5 +0 -0
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0

Quite imbarassing doing so many errors in one go. Attached is the revisited version.

Changes in v2:
- Reword as suggested "whose names start with"
- Add missing space in hilighted proc_
- Drop superflous .TP (from a copy paste error)

Regards,
Salvatore

From 7753658486c2ee2b1d50df2811dcef6af335378b Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>
---
 man5/proc.5 | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
man5/proc.5 +3 -1
index bdc47456bdce..8022ca49ee68 100644
@@ -176,7 +176,9 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+whose names start with
+.BR proc_ .
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0
maintainer
#5 lore raw

Hi Salvatore,

Quoted 42 lines · Salvatore Bonaccorso

Hi,

Quoted 25 lines · Alejandro Colomar

Hi Salvatore,

Quoted 2 lines · Salvatore Bonaccorso

Thanks for the quick feedback. So please find attached the proposed change. Let me know if you want something changed.

You're welcome!

Quoted 17 lines

From 07bf84cbb2e78595b4514fe820ae5574bba8d0ec Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>
---
 man5/proc.5 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Quoted 13 lines

man5/proc.5 Various other files and subdirectories under · line 180

Quoted 11 lines
man5/proc.5 +2 -1
index bdc47456bdce..4c20920e1e3c 100644
@@ -176,7 +176,10 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+prefixed with

Maybe I'd reword to say "whose name starts with".

Quoted 1 line

So "whose names start with" as there are multiple manpages?

Sure.

Quoted 4 lines
Quoted 3 lines

man5/proc.5 Various other files and subdirectories under · line 181

Quoted 1 line
man5/proc.5 +1 -0
+.BR proc_.

This would need a space before the '.'.

Quoted 8 lines

Ah right added.

Quoted 3 lines

man5/proc.5 Various other files and subdirectories under · line 182

Quoted 1 line
man5/proc.5 +1 -0
+.TP

Why TP?

Because I stupidly copy-pasted lines and did not properly adjust and rechecked.

:)

Quoted 11 lines
Quoted 9 lines

Have a lovely night!
Alex

Quoted 5 lines
man5/proc.5 +0 -0
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0

Quite imbarassing doing so many errors in one go.

Not so many. And a patch applied in v2 is rather rare here. ;)

Quoted 16 lines

Attached is the
revisited version.

Changes in v2:
- Reword as suggested "whose names start with"
- Add missing space in hilighted proc_
- Drop superflous .TP (from a copy paste error)

Regards,
Salvatore

From 7753658486c2ee2b1d50df2811dcef6af335378b Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <[email protected]>
Date: Fri, 12 Apr 2024 20:29:06 +0200
Subject: [PATCH] proc.5: Refer to split out manpages for detailed description

Quoted 8 lines

Back in August 2023 various parts of proc(5) were split out int separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files.

Fixes 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page")
Signed-off-by Salvatore Bonaccorso <[email protected]>

LGTM. Patch applied! Thanks.
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=79a0af0c9091cb2e1bd09cd4492480b12be89089>

Have a lovely night!
Alex

Quoted 22 lines
---
 man5/proc.5 | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
man5/proc.5 +3 -1
index bdc47456bdce..8022ca49ee68 100644
@@ -176,7 +176,9 @@ Various other files and subdirectories under
 .I /proc
 expose system-wide information.
 .P
-All of the above are described in more detail below.
+All of the above are described in more detail in separate manpages
+whose names start with
+.BR proc_ .
 .\"
 .\" .SH FILES
 .\" FIXME Describe /proc/[pid]/sessionid
Signature · 1 line
2.43.0
Signature · 1 line
<https://www.alejandro-colomar.es/>