[v5,3/4] proc_pid_fdinfo.5: Add subsection headers for different fd types

Commit Message

Ian Rogers Dec. 6, 2024, 7:38 a.m. UTC

Make the sections about eventfd, epoll, signalfd, inotify, fanotify,
timerfd better separated with a clearer subsection header.
---
 man/man5/proc_pid_fdinfo.5 | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Alejandro Colomar Dec. 6, 2024, 3:20 p.m. UTC | #1

Hi Ian,

On Thu, Dec 05, 2024 at 11:38:27PM -0800, Ian Rogers wrote:
> Make the sections about eventfd, epoll, signalfd, inotify, fanotify,
> timerfd better separated with a clearer subsection header.
> ---
>  man/man5/proc_pid_fdinfo.5 | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5
> index 2797ae216..c4914f1f3 100644
> --- a/man/man5/proc_pid_fdinfo.5
> +++ b/man/man5/proc_pid_fdinfo.5
> @@ -57,6 +57,7 @@ is the ID of the mount containing this file.
>  See the description of
>  .IR /proc/ pid /mountinfo .
>  .RE
> +.SS eventfd
>  .P

.P after .SS is redundant, and triggers a warning.  Please remove them.

Cheers,
Alex

>  For eventfd file descriptors (see
>  .BR eventfd (2)),
> @@ -75,6 +76,7 @@ eventfd\-count:               40
>  .P
>  .I eventfd\-count
>  is the current value of the eventfd counter, in hexadecimal.
> +.SS epoll
>  .P
>  For epoll file descriptors (see
>  .BR epoll (7)),
> @@ -108,6 +110,7 @@ descriptor.
>  The
>  .I data
>  field is the data value associated with this file descriptor.
> +.SS signalfd
>  .P
>  For signalfd file descriptors (see
>  .BR signalfd (2)),
> @@ -133,6 +136,7 @@ and
>  .BR SIGQUIT ;
>  see
>  .BR signal (7).)
> +.SS inotify
>  .P
>  For inotify file descriptors (see
>  .BR inotify (7)),
> @@ -173,6 +177,7 @@ file is exposed as a file handle, via three hexadecimal fields:
>  .IR fhandle\-type ,
>  and
>  .IR f_handle .
> +.SS fanotify
>  .P
>  For fanotify file descriptors (see
>  .BR fanotify (7)),
> @@ -229,6 +234,7 @@ The mask of events that are ignored for this mark
>  .P
>  For details on these fields, see
>  .BR fanotify_mark (2).
> +.SS timerfd
>  .P
>  For timerfd file descriptors (see
>  .BR timerfd (2)),
> -- 
> 2.47.0.338.g60cca15819-goog
>

Patch

diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5
index 2797ae216..c4914f1f3 100644
--- a/man/man5/proc_pid_fdinfo.5
+++ b/man/man5/proc_pid_fdinfo.5
@@ -57,6 +57,7 @@  is the ID of the mount containing this file.
 See the description of
 .IR /proc/ pid /mountinfo .
 .RE
+.SS eventfd
 .P
 For eventfd file descriptors (see
 .BR eventfd (2)),
@@ -75,6 +76,7 @@  eventfd\-count:               40
 .P
 .I eventfd\-count
 is the current value of the eventfd counter, in hexadecimal.
+.SS epoll
 .P
 For epoll file descriptors (see
 .BR epoll (7)),
@@ -108,6 +110,7 @@  descriptor.
 The
 .I data
 field is the data value associated with this file descriptor.
+.SS signalfd
 .P
 For signalfd file descriptors (see
 .BR signalfd (2)),
@@ -133,6 +136,7 @@  and
 .BR SIGQUIT ;
 see
 .BR signal (7).)
+.SS inotify
 .P
 For inotify file descriptors (see
 .BR inotify (7)),
@@ -173,6 +177,7 @@  file is exposed as a file handle, via three hexadecimal fields:
 .IR fhandle\-type ,
 and
 .IR f_handle .
+.SS fanotify
 .P
 For fanotify file descriptors (see
 .BR fanotify (7)),
@@ -229,6 +234,7 @@  The mask of events that are ignored for this mark
 .P
 For details on these fields, see
 .BR fanotify_mark (2).
+.SS timerfd
 .P
 For timerfd file descriptors (see
 .BR timerfd (2)),