]> git.ipfire.org Git - thirdparty/e2fsprogs.git/commit
chattr.1: improve attribute formatting with labels and indented paragraphs
authorJeremy Visser <jeremyvisser@google.com>
Mon, 3 Feb 2020 02:37:41 +0000 (13:37 +1100)
committerTheodore Ts'o <tytso@mit.edu>
Mon, 24 Feb 2020 20:31:16 +0000 (15:31 -0500)
commita5676f8da792062f4c0e8ee49e0a5f0877268411
tree1be7cada2a7bffcc3a414b8896a947a0d964f165
parent750bae1542b2acc374fcefbdaa7ff203e0ca0f9e
chattr.1: improve attribute formatting with labels and indented paragraphs

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>
Reviewed-by: Andreas Dilger <adilger@dilger.ca>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
misc/chattr.1.in