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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxx>

Applied, thanks.

					- Ted



[Index of Archives]     [Reiser Filesystem Development]     [Ceph FS]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite National Park]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Device Mapper]     [Linux Media]

  Powered by Linux