| Message ID | 20241101191156.1272730-2-irogers@google.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v3,1/4] proc_pid_fdinfo.5: Reduce indent for most of the page | expand |
Hi Ian, At 2024-11-01T12:11:54-0700, Ian Rogers wrote: > diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 > index 87e6dbe56..935b54b4c 100644 > --- a/man/man5/proc_pid_fdinfo.5 > +++ b/man/man5/proc_pid_fdinfo.5 [...] > -this is a subdirectory containing one entry for each file which the > -process has open, named by its file descriptor. > +this subdirectory contains one entry for each file that process > +.IR pid > +has open, named by its file descriptor. `IR` is better used with two or more arguments. As of groff 1.23 (July 2023), the man(7) package will warn you about problem like this if you ask it to. $ nroff -man -rCHECKSTYLE=1 /tmp/proc_pid_fdinfo_mini.5 an.tmac:/tmp/proc_pid_fdinfo_mini.5:7: style: .IR expects at least 2 arguments, got 1 proc_pid_fdinfo_mini(5) File Formats Manual proc_pid_fdinfo_mini(5) Name /proc/pid/fdinfo - information about file descriptors Description Text text text text. One pid to rule them all and in the darkness bind them. example 2024‐11‐02 proc_pid_fdinfo_mini(5) I think Alex has a make(1) target that assists with running groff this way. groff_man(7): Font style macros ... It is often necessary to set text in different styles without intervening space. The macros .BI, .BR, .IB, .IR, .RB, and .RI, where “B”, “I”, and “R” indicate bold, italic, and roman, respectively, set their odd‐ and even‐numbered arguments in alternating styles, with no space separating them. One reason to pay close attention to this point is that .IR foo bar formats as "foobar" (with "foo" in italics), whereas .I foo bar formats as "foo bar", with both words in italics. The different handling of the space is a common manifestation of error. Regards, Branden
diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index 87e6dbe56..935b54b4c 100644 --- a/man/man5/proc_pid_fdinfo.5 +++ b/man/man5/proc_pid_fdinfo.5 @@ -6,11 +6,12 @@ .\" .TH proc_pid_fdinfo 5 (date) "Linux man-pages (unreleased)" .SH NAME -/proc/pid/fdinfo/ \- information about file descriptors +.IR /proc/ pid /fdinfo " \- information about file descriptors" .SH DESCRIPTION Since Linux 2.6.22, -this is a subdirectory containing one entry for each file which the -process has open, named by its file descriptor. +this subdirectory contains one entry for each file that process +.IR pid +has open, named by its file descriptor. The files in this directory are readable only by the owner of the process. The contents of each file can be read to obtain information about the corresponding file descriptor.
Previously the pid was highlighted through being a tagged paragraph but not mentioned in the description. Add italics to the path emphasizing pid and then change the first sentence to include pid in the definition. Suggested-by: G. Branden Robinson <g.branden.robinson@gmail.com> Signed-off-by: Ian Rogers <irogers@google.com> --- man/man5/proc_pid_fdinfo.5 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)