linux-kernel - Re: [man-pages PATCH v3] statx.2, open.2: document STATX

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]

Date:   Tue, 11 Oct 2022 16:02:33 -0700
From:   Eric Biggers <ebiggers@...nel.org>
To:     Alejandro Colomar <alx.manpages@...il.com>
Cc:     linux-man@...r.kernel.org, linux-fsdevel@...r.kernel.org,
        linux-api@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-ext4@...r.kernel.org, linux-f2fs-devel@...ts.sourceforge.net,
        linux-xfs@...r.kernel.org, linux-fscrypt@...r.kernel.org,
        linux-block@...r.kernel.org, "Darrick J. Wong" <djwong@...nel.org>
Subject: Re: [man-pages PATCH v3] statx.2, open.2: document STATX_DIOALIGN

Hi Alejandro,

On Sat, Oct 08, 2022 at 03:56:22AM +0200, Alejandro Colomar wrote:
> > +If none of the above is available, then direct I/O support and alignment
> 
> Please use semantic newlines.
> 
> See man-pages(7):
>    Use semantic newlines
>        In the source of a manual page, new sentences  should  be
>        started on new lines, long sentences should be split into
>        lines  at  clause breaks (commas, semicolons, colons, and
>        so on), and long clauses should be split at phrase bound‐
>        aries.  This convention,  sometimes  known  as  "semantic
>        newlines",  makes it easier to see the effect of patches,
>        which often operate at the level of individual sentences,
>        clauses, or phrases.

I tried to do this in v4.  It seems very arbitrary, though, so if you want
further changes to the newlines I recommend just making them when committing the
patch.

Note that a better way to review changes to text is to do a word diff instead of
a line diff.

- Eric