public inbox for util-linux@vger.kernel.org
 help / color / mirror / Atom feed
From: Nuno Silva <nunojsilva@ist.utl.pt>
To: util-linux@vger.kernel.org
Cc: bensberg@telfort.nl
Subject: Re: [PATCH] findfs: (man) improve the markup, the layout, and the wording
Date: Sat, 28 Feb 2026 13:03:20 +0000	[thread overview]
Message-ID: <10nup2p$o2$1@ciao.gmane.io> (raw)
In-Reply-To: 20260228115245.9553-1-bensberg@telfort.nl

On 2026-02-28, Benno Schulenberg wrote:

> Mark NAME as a placeholder instead of a literal, and rename it to
> TAGNAME to make it clearer what "tag" in the description refers to.
>
> Indent the list of possible tags, to make it clearer where the
> description continues.
>
> Drop the angle brackets around placeholders -- those are used
> in --help output, but in man pages it is just italics.

My apologies if I'm missing some convention from util-linux itself, but:
from a quick check, it looks to me that italics is used for such
placeholders in IEEE 1003.1. Any chance this is or was a de facto
standard to denote placeholders? Or something done this way for
consistency (not that I've done a survey of how common this is)?

(Also see "Utility Operand" and "Utility Option with Option-Argument" in
the table at [1], at the end.)

[1] https://pubs.opengroup.org/onlinepubs/9799919799/frontmatter/typographics.html

> Also add a missing section header.
>
> Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
[...]

(diff snipped as what's above is IMHO sufficient context for my reply)
-- 
Nuno Silva


  reply	other threads:[~2026-02-28 13:08 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-28 11:52 [PATCH] findfs: (man) improve the markup, the layout, and the wording Benno Schulenberg
2026-02-28 13:03 ` Nuno Silva [this message]
2026-03-01 11:25   ` Benno Schulenberg
2026-03-01 11:56     ` Nuno Silva
2026-03-01 16:45 ` [PATCH] terminal-colors.d: (man) do not show 'type' as an optional part Benno Schulenberg
2026-03-09 10:51   ` [PATCH] findfs: (man) improve the markup, the layout, and the wording Karel Zak
2026-03-09 16:08     ` improvements to terminal-colors.d.5.adoc were undone Benno Schulenberg
2026-03-10 18:49       ` Karel Zak
2026-03-12 15:34         ` Benno Schulenberg
2026-03-11 11:40       ` Karel Zak

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='10nup2p$o2$1@ciao.gmane.io' \
    --to=nunojsilva@ist.utl.pt \
    --cc=bensberg@telfort.nl \
    --cc=util-linux@vger.kernel.org \
    /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