From: "Theodore Y. Ts'o" <tytso@mit.edu>
To: Jeremy Visser <jeremyvisser@google.com>
Cc: linux-ext4@vger.kernel.org
Subject: Re: [PATCH] chattr.1: improve attribute formatting with labels and indented paragraphs
Date: Mon, 24 Feb 2020 15:32:22 -0500 [thread overview]
Message-ID: <20200224203222.GA5112@mit.edu> (raw)
In-Reply-To: <20200203023741.218441-1-jeremyvisser@google.com>
On Mon, Feb 03, 2020 at 01:37:41PM +1100, Jeremy Visser wrote:
> By convention, lists of options in man pages use a label followed by an
> indented description, such as this example from the Options section:
>
> -R Recursively change attributes of directories and
> their contents.
>
> But the Attributes section places the available attributes mid-sentence,
> which makes it visually more difficult to parse:
>
> A file with the 'a' attribute set can only be opened
> in append mode for writing. [...]
>
> When a file with the 'A' attribute set is accessed, its
> atime record is not modified. [...]
>
> This patch places a label beside each attribute description, which (in
> my opinion) improves readability, especially when visually skimming the
> list. For example:
>
> a A file with the 'a' attribute set can only be
> opened in append mode for writing.
>
> A When a file with the 'A' attribute set is accessed,
> its atime record is not modified.
>
> Signed-off-by: Jeremy Visser <jeremyvisser@google.com>
Applied, thanks.
- Ted
prev parent reply other threads:[~2020-02-24 20:32 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-03 2:37 [PATCH] chattr.1: improve attribute formatting with labels and indented paragraphs Jeremy Visser
2020-02-03 20:41 ` Andreas Dilger
2020-02-24 20:32 ` Theodore Y. Ts'o [this message]
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=20200224203222.GA5112@mit.edu \
--to=tytso@mit.edu \
--cc=jeremyvisser@google.com \
--cc=linux-ext4@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.