Linux Documentation
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Ian Rogers <irogers@google.com>, David Airlie <airlied@gmail.com>,
	Simona Vetter <simona@ffwll.ch>,
	Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
	Maxime Ripard <mripard@kernel.org>,
	Thomas Zimmermann <tzimmermann@suse.de>,
	Jonathan Corbet <corbet@lwn.net>,
	dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-man@vger.kernel.org
Subject: Re: [PATCH v4 3/4] proc_pid_fdinfo.5: Add subsection headers for different fd types
Date: Sat, 2 Nov 2024 10:58:27 +0100	[thread overview]
Message-ID: <20241102095827.mkuj56gwq3yg3ng4@devuan> (raw)
In-Reply-To: <20241102092007.ixxtdc6u4iutxmam@illithid>

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

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).


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

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

  reply	other threads:[~2024-11-02  9:58 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-01 21:18 [PATCH v4 1/4] proc_pid_fdinfo.5: Reduce indent for most of the page Ian Rogers
2024-11-01 21:18 ` [PATCH v4 2/4] proc_pid_fdinfo.5: Make pid clearer in the name and 1st paragraph Ian Rogers
2024-11-01 21:18 ` [PATCH v4 3/4] proc_pid_fdinfo.5: Add subsection headers for different fd types Ian Rogers
2024-11-02  9:20   ` G. Branden Robinson
2024-11-02  9:58     ` Alejandro Colomar [this message]
2024-11-01 21:18 ` [PATCH v4 4/4] proc_pid_fdinfo.5: Add DRM subsection Ian Rogers
2024-11-02  9:48 ` [PATCH v4 1/4] proc_pid_fdinfo.5: Reduce indent for most of the page Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241102095827.mkuj56gwq3yg3ng4@devuan \
    --to=alx@kernel.org \
    --cc=airlied@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=g.branden.robinson@gmail.com \
    --cc=irogers@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=mripard@kernel.org \
    --cc=simona@ffwll.ch \
    --cc=tzimmermann@suse.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox