Re: [PATCH 1/2] Various pages: Normalize SYNOPSIS notes about non-existing glibc wrappers

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

 



Hi Alex,

On Tue, 29 Dec 2020 at 21:51, Alejandro Colomar (man-pages)
<alx.manpages@xxxxxxxxx> wrote:
>
> Hello Michael,
>
> A question below.
>
> Cheers,
>
> Alex
>
> On 12/29/20 9:27 PM, Michael Kerrisk (man-pages) wrote:
> > Hi Alex, Ganimedes.
> >
> > In the subject line : s/non-existing/nonexistent/
>
> Ok, I'll resend in a few minutes.
>
> >
> > On Tue, 29 Dec 2020 at 15:43, Alejandro Colomar <alx.manpages@xxxxxxxxx> wrote:
> >>
> >> From: Ganimedes Colomar <gacoan.linux@xxxxxxxxx>
> >>
> >> To easily distinguish documentation about glibc wrappers from
> >> documentation about kernel syscalls, let's have a normalized
> >> 'Note' in the SYNOPSIS, and a further explanation in the page body
> >> (NOTES in most of them), as already happened in many (but not all)
> >> of the manual pages for syscalls without a wrapper.  Furthermore,
> >> let's normalize the messages, following membarrier.2 (because it's
> >> already quite extended), so that it's easy to use grep to find
> >> those pages.
> >>
> >> To find these pages, we used:
> >> $ grep -rn wrapper man? | sort -V
> >> and
> >> $ grep -rni support.*glibc | sort -V
> >>
> >> delete_module.2, init_module.2:  glibc 2.23 is no longer
> >>   maintained, so we changed the notes about wrappers, to say that
> >>   there are no glibc wrappers for these system calls; see NOTES.
> >
> > That seems fine.
> >
> >> We didn't fix some of the obsolete syscalls (create_module(2)),
> >> but if you prefer, we can fix those too.
> >
> > I think it's okay to leave it.
> >
> > The remainder of the patch looks good. The only reason that I'm not
> > applying ir yet (and fixing the subject line myself) is that I wonder
> > if the command I mentioned in response to the 0/2 mail might help you
> > find other pages to include in the patch. Let me know.
> >
> > Thanks,
> >
> > Michael
> >
> >
> >
> >>
> >>
> >> Signed-off-by: Ganimedes Colomar <gacoan.linux@xxxxxxxxx>
> >> Cowritten-by: Alejandro Colomar <alx.manpages@xxxxxxxxx>
> >> Signed-off-by: Alejandro Colomar <alx.manpages@xxxxxxxxx>
> >> ---
> >>
> >> Hi Michael,
> >>
> >> Some comment:
> >>
> >>   syslog.2: Isn't the comment in SYNOPSIS wrong?
> >>         There _is_ a wrapper, which is documented just below that line.
> >>         It just has a different name.
>
> What about that?
>
> $ man 2 syslog | sed -n /^SYNOPSIS/,/^DESCRIPTION/p |sed \$d
> SYNOPSIS
>        int syslog(int type, char *bufp, int len);
>                        /* No wrapper provided in glibc */
> <<<<< I think we should remove the above comment,
> <<<<< or put it consistently everywhere else.
> <<<<< What would you do?

Yep, remove the comment.

Thanks,

Michael


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/




[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux