Skip to contentSkip to conversation

Issue in man page proc_pid_fd.5

DISCUSSION Helge Kreutzmann 3 participants 4 messages Nov 17, 2024 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Helge Kreutzmann

author
#0 lore raw

Without further ado, the following was found:

Issue: Inode -> I<inode>?

"type:[inode]\n"

maintainer
#1 lore raw

[CC += Branden]

Hi Helge,

Quoted 5 lines · Helge Kreutzmann

Without further ado, the following was found:

Issue: Inode -> I<inode>?

"type:[inode]\n"

I've applied the following patch:

	commit f3ac823f7501910031855c1f6e640f0dc5e295bb (HEAD -> contrib)
	Author: Alejandro Colomar <[email protected]>
	Date:   Sun Nov 17 12:23:48 2024 +0100

	    proc_pid_fd.5: ffix
	    
	    Reported-by: Helge Kreutzmann <[email protected]>
	    Cc: "G. Branden Robinson" <[email protected]>
	    Signed-off-by: Alejandro Colomar <[email protected]>

	diff --git a/man/man5/proc_pid_fd.5 b/man/man5/proc_pid_fd.5
	index 2e3341ad8..903063e82 100644
	--- a/man/man5/proc_pid_fd.5
	+++ b/man/man5/proc_pid_fd.5
	@@ -24,7 +24,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-type:[inode]
	+.IB type :[ inode ]
	 .EE
	 .in
	 .IP
	@@ -50,7 +50,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-.RI anon_inode: file-type
	+.BI anon_inode: file-type
	 .EE
	 .in
	 .IP

If anyone has comments, please let me know.

Have a lovely day!
Alex

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

Hi Alex,

Quoted 1 line · Alejandro Colomar

[CC += Branden]

What do you need from me here? I'll take a guess and review your patch.

Quoted 21 lines · Helge Kreutzmann
Quoted 5 lines

Without further ado, the following was found:

Issue: Inode -> I<inode>?

"type:[inode]\n"

I've applied the following patch:

	commit f3ac823f7501910031855c1f6e640f0dc5e295bb (HEAD -> contrib)
	Author: Alejandro Colomar <[email protected]>
	Date:   Sun Nov 17 12:23:48 2024 +0100

	    proc_pid_fd.5: ffix
	    
	    Reported-by: Helge Kreutzmann <[email protected]>
	    Cc: "G. Branden Robinson" <[email protected]>
	    Signed-off-by: Alejandro Colomar <[email protected]>

	diff --git a/man/man5/proc_pid_fd.5 b/man/man5/proc_pid_fd.5
	index 2e3341ad8..903063e82 100644
Quoted 8 lines
	--- a/man/man5/proc_pid_fd.5
	+++ b/man/man5/proc_pid_fd.5
	@@ -24,7 +24,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-type:[inode]
	+.IB type :[ inode ]

This markup looks okay to me, if "type" and "inode" are parameterized and ":[" and "]" are literal.

Personally, I would use IR instead of IB since the example is of _output_, not user input.

groff_man_style(7):
Use bold for literal portions of syntax synopses, for command‐line options in running text, and for literals that are major topics of the subject under discussion; for example, this page uses bold for macro, string, and register names. In an .EX/.EE example of interactive I/O (such as a shell session), set only user input in bold.

But (a) the exhibit here is more an example of file content than I/O per se, and (b) I don't recall if you have an overriding style rule for the man-pages project.

As ever, clarity is the first principle. If the example is clear either way, the choice of typeface for the literal parts of it is a matter of polish, and not likely a barrier to the reader's comprehension.

Quoted 13 lines
	 .EE
	 .in
	 .IP
	@@ -50,7 +50,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-.RI anon_inode: file-type
	+.BI anon_inode: file-type
	 .EE
	 .in
	 .IP
Quoted 1 line

If anyone has comments, please let me know.

Regards,
Branden

maintainer
#3 lore raw

Hi Branden,

Quoted 6 lines · G. Branden Robinson

Hi Alex,

Quoted 1 line · Alejandro Colomar

[CC += Branden]

What do you need from me here? I'll take a guess and review your patch.

The guess was good. :)

Quoted 30 lines
Quoted 21 lines · Helge Kreutzmann
Quoted 5 lines

Without further ado, the following was found:

Issue: Inode -> I<inode>?

"type:[inode]\n"

I've applied the following patch:

	commit f3ac823f7501910031855c1f6e640f0dc5e295bb (HEAD -> contrib)
	Author: Alejandro Colomar <[email protected]>
	Date:   Sun Nov 17 12:23:48 2024 +0100

	    proc_pid_fd.5: ffix
	    
	    Reported-by: Helge Kreutzmann <[email protected]>
	    Cc: "G. Branden Robinson" <[email protected]>
	    Signed-off-by: Alejandro Colomar <[email protected]>

	diff --git a/man/man5/proc_pid_fd.5 b/man/man5/proc_pid_fd.5
	index 2e3341ad8..903063e82 100644
Quoted 8 lines
	--- a/man/man5/proc_pid_fd.5
	+++ b/man/man5/proc_pid_fd.5
	@@ -24,7 +24,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-type:[inode]
	+.IB type :[ inode ]
Quoted 5 lines

This markup looks okay to me, if "type" and "inode" are parameterized and ":[" and "]" are literal.

Personally, I would use IR instead of IB since the example is of _output_, not user input.

Hmmm, interesting. I'll amend the patch, since it's not yet pushed to the master branch.

Quoted 9 lines

groff_man_style(7):
Use bold for literal portions of syntax synopses, for command‐line options in running text, and for literals that are major topics of the subject under discussion; for example, this page uses bold for macro, string, and register names. In an .EX/.EE example of interactive I/O (such as a shell session), set only user input in bold.

Quoted 3 lines

But (a) the exhibit here is more an example of file content than I/O per se, and (b) I don't recall if you have an overriding style rule for the man-pages project.

(b) I don't.

Quoted 4 lines

As ever, clarity is the first principle. If the example is clear either way, the choice of typeface for the literal parts of it is a matter of polish, and not likely a barrier to the reader's comprehension.

Since either way it's clear, I'll take the Roman.

Cheers,
Alex

Quoted 18 lines
Quoted 14 lines
	 .EE
	 .in
	 .IP
	@@ -50,7 +50,7 @@ .SH DESCRIPTION
	 .IP
	 .in +4n
	 .EX
	-.RI anon_inode: file-type
	+.BI anon_inode: file-type
	 .EE
	 .in
	 .IP
Quoted 1 line

If anyone has comments, please let me know.

Regards,
Branden

Signature · 1 line
<https://www.alejandro-colomar.es/>