Re: [PATCH v5 1/4] proc_pid_fdinfo.5: Reduce indent for most of the page

Alejandro Colomar
2024-12-06T15:16:33Z

[-- Attachment #1: Type: text/plain, Size: 6532 bytes --]

Hi Ian,

On Thu, Dec 05, 2024 at 11:38:25PM -0800, Ian Rogers wrote:
> When /proc/pid/fdinfo was part of proc.5 man page the indentation made
> sense. As a standalone man page the indentation doesn't need to be so
> far over to the right. Remove the initial tagged pragraph, move the
> "since Linux 2.6.22" to a new history subsection.
>
> Suggested-by: G. Branden Robinson <g.branden.robinson@gmail.com>

Thanks! I've applied it, and amended with some minor tweaks.
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=d70b07b4f820ad801f57952cae984c07d73dee1c>

Have a lovely day!
Alex

> ---
> v5. Remove the word Since.
> v4. Since from Alejandro Colomar <alx@kernel.org> review comment.
> ---
> man/man5/proc_pid_fdinfo.5 | 51 +++++++++++++++++++-------------------
> 1 file changed, 25 insertions(+), 26 deletions(-)
>
> diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5
> index 1e23bbe02..1c6c38423 100644
> --- a/man/man5/proc_pid_fdinfo.5
> +++ b/man/man5/proc_pid_fdinfo.5
> @@ -8,8 +8,6 @@
> .SH NAME
> /proc/pid/fdinfo/ \- information about file descriptors
> .SH DESCRIPTION
> -.TP
> -.IR /proc/ pid /fdinfo/ " (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.
> The files in this directory are readable only by the owner of the process.
> @@ -17,9 +15,9 @@ The contents of each file can be read to obtain information
> about the corresponding file descriptor.
> The content depends on the type of file referred to by the
> corresponding file descriptor.
> -.IP
> +.P
> For regular files and directories, we see something like:
> -.IP
> +.P
> .in +4n
> .EX
> .RB "$" " cat /proc/12015/fdinfo/4"
> @@ -28,7 +26,7 @@ flags: 01002002
> mnt_id: 21
> .EE
> .in
> -.IP
> +.P
> The fields are as follows:
> .RS
> .TP
> @@ -51,7 +49,6 @@ this field incorrectly displayed the setting of
> at the time the file was opened,
> rather than the current setting of the close-on-exec flag.
> .TP
> -.I
> .I mnt_id
> This field, present since Linux 3.15,
> .\" commit 49d063cb353265c3af701bab215ac438ca7df36d
> @@ -59,13 +56,13 @@ is the ID of the mount containing this file.
> See the description of
> .IR /proc/ pid /mountinfo .
> .RE
> -.IP
> +.P
> For eventfd file descriptors (see
> .BR eventfd (2)),
> we see (since Linux 3.8)
> .\" commit cbac5542d48127b546a23d816380a7926eee1c25
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -74,16 +71,16 @@ mnt_id: 10
> eventfd\-count: 40
> .EE
> .in
> -.IP
> +.P
> .I eventfd\-count
> is the current value of the eventfd counter, in hexadecimal.
> -.IP
> +.P
> For epoll file descriptors (see
> .BR epoll (7)),
> we see (since Linux 3.8)
> .\" commit 138d22b58696c506799f8de759804083ff9effae
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -93,7 +90,7 @@ tfd: 9 events: 19 data: 74253d2500000009
> tfd: 7 events: 19 data: 74253d2500000007
> .EE
> .in
> -.IP
> +.P
> Each of the lines beginning
> .I tfd
> describes one of the file descriptors being monitored via
> @@ -110,13 +107,13 @@ descriptor.
> The
> .I data
> field is the data value associated with this file descriptor.
> -.IP
> +.P
> For signalfd file descriptors (see
> .BR signalfd (2)),
> we see (since Linux 3.8)
> .\" commit 138d22b58696c506799f8de759804083ff9effae
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -125,7 +122,7 @@ mnt_id: 10
> sigmask: 0000000000000006
> .EE
> .in
> -.IP
> +.P
> .I sigmask
> is the hexadecimal mask of signals that are accepted via this
> signalfd file descriptor.
> @@ -135,12 +132,12 @@ and
> .BR SIGQUIT ;
> see
> .BR signal (7).)
> -.IP
> +.P
> For inotify file descriptors (see
> .BR inotify (7)),
> we see (since Linux 3.8)
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -150,7 +147,7 @@ inotify wd:2 ino:7ef82a sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8
> inotify wd:1 ino:192627 sdev:800001 mask:800afff ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:27261900802dfd73
> .EE
> .in
> -.IP
> +.P
> Each of the lines beginning with "inotify" displays information about
> one file or directory that is being monitored.
> The fields in this line are as follows:
> @@ -168,19 +165,19 @@ The ID of the device where the target file resides (in hexadecimal).
> .I mask
> The mask of events being monitored for the target file (in hexadecimal).
> .RE
> -.IP
> +.P
> If the kernel was built with exportfs support, the path to the target
> file is exposed as a file handle, via three hexadecimal fields:
> .IR fhandle\-bytes ,
> .IR fhandle\-type ,
> and
> .IR f_handle .
> -.IP
> +.P
> For fanotify file descriptors (see
> .BR fanotify (7)),
> we see (since Linux 3.8)
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -190,7 +187,7 @@ fanotify flags:0 event\-flags:88002
> fanotify ino:19264f sdev:800001 mflags:0 mask:1 ignored_mask:0 fhandle\-bytes:8 fhandle\-type:1 f_handle:4f261900a82dfd73
> .EE
> .in
> -.IP
> +.P
> The fourth line displays information defined when the fanotify group
> was created via
> .BR fanotify_init (2):
> @@ -210,7 +207,7 @@ argument given to
> .BR fanotify_init (2)
> (expressed in hexadecimal).
> .RE
> -.IP
> +.P
> Each additional line shown in the file contains information
> about one of the marks in the fanotify group.
> Most of these fields are as for inotify, except:
> @@ -228,16 +225,16 @@ The events mask for this mark
> The mask of events that are ignored for this mark
> (expressed in hexadecimal).
> .RE
> -.IP
> +.P
> For details on these fields, see
> .BR fanotify_mark (2).
> -.IP
> +.P
> For timerfd file descriptors (see
> .BR timerfd (2)),
> we see (since Linux 3.17)
> .\" commit af9c4957cf212ad9cf0bee34c95cb11de5426e85
> the following fields:
> -.IP
> +.P
> .in +4n
> .EX
> pos: 0
> @@ -296,5 +293,7 @@ fields contain the values that
> .BR timerfd_gettime (2)
> on this file descriptor would return.)
> .RE
> +.SH HISTORY
> +Linux 2.6.22.
> .SH SEE ALSO
> .BR proc (5)
> --
> 2.47.0.338.g60cca15819-goog
>
>

--
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]