linux-ext4 - Re: [PATCH] chattr.1: improve attribute formatting with labels and indented paragraphs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20200224203222.GA5112@mit.edu>
Date:   Mon, 24 Feb 2020 15:32:22 -0500
From:   "Theodore Y. Ts'o" <tytso@....edu>
To:     Jeremy Visser <jeremyvisser@...gle.com>
Cc:     linux-ext4@...r.kernel.org
Subject: Re: [PATCH] chattr.1: improve attribute formatting with labels and
 indented paragraphs

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@...gle.com>

Applied, thanks.

					- Ted