| Message ID | 20241101211830.1298073-3-irogers@google.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v4,1/4] proc_pid_fdinfo.5: Reduce indent for most of the page | expand |
Hi Ian, At 2024-11-01T14:18:29-0700, Ian Rogers wrote: > Make the sections about eventfd, epoll, signalfd, inotify, fanotify, > timerfd better separated with a clearer subsection header. > > Signed-off-by: Ian Rogers <irogers@google.com> [...] > +.SS eventfd > .P [...] > +.SS epoll > .P [...] > +.SS signalfd > .P [...] > +.SS inotify > .P [etc.] I suggest deleting the paragraphing macros when you add (sub)sectioning macros immediately before them. In these cases the `P` calls end up doing nothing. groff_man(7): .SS [subheading‐text] Set subheading‐text as a subsection heading indented between a section heading and an ordinary paragraph (.P). If no argument is given, a one‐line input trap is planted; text on the next line becomes subheading‐text. The left margin is reset to the value of the SN register to set the heading text in bold (or the font specified by the string HF). If the heading font \*[HF] is bold, use of an italic style in subheading‐text is mapped to the bold‐italic style if available in the font family. The inset level is reset to 1, setting the left margin to the value of the IN register. Text after subheading‐text is set as an ordinary paragraph (.P). Regards, Branden
Hi Branden, Ian, On Sat, Nov 02, 2024 at 04:20:07AM -0500, G. Branden Robinson wrote: > Hi Ian, > > At 2024-11-01T14:18:29-0700, Ian Rogers wrote: > > Make the sections about eventfd, epoll, signalfd, inotify, fanotify, > > timerfd better separated with a clearer subsection header. > > > > Signed-off-by: Ian Rogers <irogers@google.com> > [...] > > +.SS eventfd > > .P > [...] > > +.SS epoll > > .P > [...] > > +.SS signalfd > > .P > [...] > > +.SS inotify > > .P > [etc.] > > I suggest deleting the paragraphing macros when you add (sub)sectioning > macros immediately before them. In these cases the `P` calls end up > doing nothing. Indeed. We have warnings (see `make help`) that trigger for this. Have a lovely day! Alex > > groff_man(7): > .SS [subheading‐text] > Set subheading‐text as a subsection heading indented > between a section heading and an ordinary paragraph (.P). > If no argument is given, a one‐line input trap is planted; > text on the next line becomes subheading‐text. The left > margin is reset to the value of the SN register to set the > heading text in bold (or the font specified by the string > HF). If the heading font \*[HF] is bold, use of an italic > style in subheading‐text is mapped to the bold‐italic > style if available in the font family. The inset level is > reset to 1, setting the left margin to the value of the IN > register. Text after subheading‐text is set as an > ordinary paragraph (.P).
diff --git a/man/man5/proc_pid_fdinfo.5 b/man/man5/proc_pid_fdinfo.5 index be1675b69..b7efde8f4 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)),
Make the sections about eventfd, epoll, signalfd, inotify, fanotify, timerfd better separated with a clearer subsection header. Signed-off-by: Ian Rogers <irogers@google.com> --- man/man5/proc_pid_fdinfo.5 | 6 ++++++ 1 file changed, 6 insertions(+)