Hi Yuanchu, > Subject: Re: [PATCH v4] posix_fadvise.2: NOREUSE now supported. Please spell the full name of the macro. On Tue, Nov 12, 2024 at 07:16:54PM GMT, Yuanchu Xie wrote: > POSIX_FADV_NOREUSE is now supported in Linux[1]. > Updates text regarding former no op behavior. Indicates the readahead Please use 2 spaces after period. <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING.d/patches/description#n44> > policy and treatment of file pages read with this flag. > > [1]: https://lore.kernel.org/linux-mm/20221230215252.2628425-2-yuzhao@xxxxxxxxxx/ Please prepend this with a Link: tag, and wrap the URI in <>. <https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING.d/patches/description#n42> > > Signed-off-by: T.J. Alumbaugh <talumbau@xxxxxxxxxx> > Signed-off-by: Yuanchu Xie <yuanchu@xxxxxxxxxx> > --- > Changelog > v3 -> v4 > - Use semantic newlines > - Format with macros like .B instead of inline \f > > v3: https://lore.kernel.org/linux-man/20230320222057.1976956-1-talumbau@xxxxxxxxxx/ > > man/man2/posix_fadvise.2 | 24 ++++++++++++++++++------ > 1 file changed, 18 insertions(+), 6 deletions(-) > > diff --git a/man/man2/posix_fadvise.2 b/man/man2/posix_fadvise.2 > index ed40b0c0d..11452699e 100644 > --- a/man/man2/posix_fadvise.2 > +++ b/man/man2/posix_fadvise.2 > @@ -62,9 +62,15 @@ The specified data will be accessed in random order. > .B POSIX_FADV_NOREUSE > The specified data will be accessed only once. > .IP > -Before Linux 2.6.18, \fBPOSIX_FADV_NOREUSE\fP had the > -same semantics as \fBPOSIX_FADV_WILLNEED\fP. > +Before Linux 2.6.18, > +.B POSIX_FADV_NOREUSE > +had the same semantics as > +.B POSIX_FADV_WILLNEED. Please don't reformat text that you don't change at all. Patches should be minimal. Also, you've made the '.' bold. To keep it in Roman, you should use: .BR POSIX_FADV_WILLNEED . > -This was probably a bug; since Linux 2.6.18, this flag is a no-op. > +This was probably a bug; from Linux 2.6.18 until Linux 6.2 this flag was a no-op. This goes beyond the 80-column right margin. Please break the line in an appropriate point (';'). > +From Linux 6.3 and beyond, > +.B POSIX_FADV_NOREUSE > +signals that the LRU algorithm can ignore access to mapped page cache marked by this flag. Same here. See man-pages(7). I'd break here right after "algorithm". $ MANWIDTH=72 man man-pages | sed -n '/Use semantic newlines/,/^$/p' 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 boundaries. 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. Have a lovely day! Alex > +This is useful, for example, while streaming large files. > .TP > .B POSIX_FADV_WILLNEED > The specified data will be accessed in the near future. > @@ -127,9 +133,15 @@ Linux returned > .B EINVAL > in this case.) > .SH VERSIONS > -Under Linux, \fBPOSIX_FADV_NORMAL\fP sets the readahead window to the > -default size for the backing device; \fBPOSIX_FADV_SEQUENTIAL\fP doubles > -this size, and \fBPOSIX_FADV_RANDOM\fP disables file readahead entirely. > +Under Linux, > +.B POSIX_FADV_NORMAL > +sets the readahead window to the default size for the backing device; > +.B POSIX_FADV_SEQUENTIAL > +doubles this size, and > +.B POSIX_FADV_RANDOM > +disables file readahead entirely. > +.B POSIX_FADV_NOREUSE > +does not modify the readahead window size. > These changes affect the entire file, not just the specified region > (but other open file handles to the same file are unaffected). > .SS C library/kernel differences > -- > 2.46.0 > -- <https://www.alejandro-colomar.es/>
Attachment:
signature.asc
Description: PGP signature
