Re: [PATCH man-pages v3 2/4] madvise.2: document reliable probe for advice support

[Alejandro Colomar <alx.manpages@xxxxxxxxx>]

Hi Zach,

On 10/31/22 17:33, Zach O'Keefe wrote:
> > Patch applied.
>
> Thank you!
>
> Best,
> Zach
>
> > Thanks,
> >
> > Alex

I just caught a small formatting issue by running some linters through that file:

$ make -ij lint >/dev/null 2>&1
$ touch man2/madvise.2
$ make -k lint-man
LINT (groff)	tmp/lint/man2/madvise.2.lint-man.groff.touch
an.tmac:man2/madvise.2:795: style: .IR expects at least 2 arguments, got 1
found style problems; aborting
make: *** [lib/lint-man.mk:77: tmp/lint/man2/madvise.2.lint-man.groff.touch] Error 1
LINT (mandoc)	tmp/lint/man2/madvise.2.lint-man.mandoc.touch
mandoc: man2/madvise.2:15:5: STYLE: lower case character in document title: TH 
madvise
mandoc: man2/madvise.2:15:15: WARNING: cannot parse date, using it verbatim: TH 
(date)
make: *** [lib/lint-man.mk:87: tmp/lint/man2/madvise.2.lint-man.mandoc.touch] 
Error 2
make: Target 'lint-man' not remade because of errors.


The issues reported by mandoc(1) are expected; but the issue reported by 
groff(1) is legit.  The offending line is:

$ sed -n 795p man2/madvise.2
.IR madvise(0,\ 0,\ advice)

Since all of the line is formatted in italics (no roman part), it should be .I 
and not .IR.
After fixing that line, the linter now says:

$ make lint-man -k
LINT (groff)	tmp/lint/man2/madvise.2.lint-man.groff.touch
LINT (mandoc)	tmp/lint/man2/madvise.2.lint-man.mandoc.touch
mandoc: man2/madvise.2:15:5: STYLE: lower case character in document title: TH 
madvise
mandoc: man2/madvise.2:15:15: WARNING: cannot parse date, using it verbatim: TH 
(date)
make: *** [lib/lint-man.mk:87: tmp/lint/man2/madvise.2.lint-man.mandoc.touch] 
Error 2
make: Target 'lint-man' not remade because of errors.


Ignoring the spurious mandoc(1) warnings, it's all good.

Documentation about how to use this feature is here (written today, so no way 
you could have run it; I should have, though :D):
<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING#n133>

Cheers,

Alex

> > > ---
> > >    man2/madvise.2 | 5 +++++
> > >    1 file changed, 5 insertions(+)
> > >
> > > diff --git a/man2/madvise.2 b/man2/madvise.2
> > > index 64f788ace..df3413cc8 100644
> > > --- a/man2/madvise.2
> > > +++ b/man2/madvise.2
> > > @@ -790,6 +790,11 @@ that are not mapped, the Linux version of
> > >    ignores them and applies the call to the rest (but returns
> > >    .B ENOMEM
> > >    from the system call, as it should).
> > > +.PP
> > > +.IR madvise(0,\ 0,\ advice)
> > > +will return zero iff
> > > +.I advice
> > > +is supported by the kernel and can be relied on to probe for support.
> > >    .\" .SH HISTORY
> > >    .\" The
> > >    .\" .BR madvise ()
> >
> > --
> > <http://www.alejandro-colomar.es/>

--
<http://www.alejandro-colomar.es/>

Attachment: OpenPGP_signature
Description: OpenPGP digital signature