diff mbox series

[v5,2/4] proc_pid_fdinfo.5: Make pid clearer in the name and 1st paragraph

Message ID 20241206073828.1119464-2-irogers@google.com (mailing list archive)
State New, archived
Headers show
Series [v5,1/4] proc_pid_fdinfo.5: Reduce indent for most of the page | expand

Commit Message

Ian Rogers Dec. 6, 2024, 7:38 a.m. UTC
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>
---
v5. Switch .IR pid to .I pid
---
 man/man5/proc_pid_fdinfo.5 | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Comments

Alejandro Colomar Dec. 6, 2024, 3:19 p.m. UTC | #1
Hi Ian,

On Thu, Dec 05, 2024 at 11:38:26PM -0800, Ian Rogers wrote:
> 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>

I'm going to reject this patch at the moment.  But I'd like to revisit
this patch in the future, so please resend (rebased) in half a year or
so (ideally after the release of groff-1.24.0).

Cheers,
Alex

> ---
> v5. Switch .IR pid to .I pid
> ---
>  man/man5/proc_pid_fdinfo.5 | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5
> index 1c6c38423..2797ae216 100644
> --- a/man/man5/proc_pid_fdinfo.5
> +++ b/man/man5/proc_pid_fdinfo.5
> @@ -6,10 +6,11 @@
>  .\"
>  .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
> -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
> +.I 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.
> -- 
> 2.47.0.338.g60cca15819-goog
>
diff mbox series

Patch

diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5
index 1c6c38423..2797ae216 100644
--- a/man/man5/proc_pid_fdinfo.5
+++ b/man/man5/proc_pid_fdinfo.5
@@ -6,10 +6,11 @@ 
 .\"
 .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
-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
+.I 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.