From: Peter Schiffer <pschiffe-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
To: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
Cc: linux-man <linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Subject: Re: clone(2) should be clone(3)
Date: Tue, 09 Apr 2013 20:08:18 +0200 [thread overview]
Message-ID: <51645912.5080602@redhat.com> (raw)
In-Reply-To: <CAKgNAkiRHNZsnWj0J3hizbMRtnq6yAbJpFSr0x_-77bu_9eFXA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
Hello Michael,
On 04/07/2013 12:15 PM, Michael Kerrisk (man-pages) wrote:
> Hi Peter,
>
> On Fri, Apr 5, 2013 at 6:01 PM, Peter Schiffer <pschiffe-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org> wrote:
>> Hi Michael,
>>
>> it looks like the clone(2) man page is describing glibc implementation
>> and not the system call. So I guess it should be moved to the section 3
>> and a new man page for clone(2) syscall should be created in section 2.
>>
>> The clone(2) syscall is defined like this:
>>
>> SYSCALL_DEFINE5(clone, unsigned long, clone_flags, unsigned long, newsp,
>> int __user *, parent_tidptr,
>> int __user *, child_tidptr,
>> int, tls_val)
>>
>> (I'm sorry, but I don't have a patch this time.)
>
> The general tendency is to document all system calls in section 2, and
> if there are some differences caused by wrapper functions, then they
> are noted on the page.
>
> I admint that clone(2) is an unusual case. The signature given at the
> top of the page is for the wrapper (and later the difference to the
> syscall raw interface are described). However, the details are
> primarily about the underlying kernel interface, so I'm inclined to
> leave the page where it is.
>
Ah, I see now. So, basically there are 2 problems:
* it's not clear that in the synopsis is library call
* system call is buried down in the page
Would it be viable to somehow have both signatures in the synopsis?
(I've checked some random man pages in section 2, but didn't find
anything similar..)
My aim here is, that when I'm opening man page in section 2, the first
thing I'm expecting to see is syscall signature. In clone(2), it's not
even clear that this is a library call.
peter
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2013-04-09 18:08 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-05 16:01 clone(2) should be clone(3) Peter Schiffer
[not found] ` <515EF542.8090200-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2013-04-07 10:15 ` Michael Kerrisk (man-pages)
[not found] ` <CAKgNAkiRHNZsnWj0J3hizbMRtnq6yAbJpFSr0x_-77bu_9eFXA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2013-04-07 19:03 ` Mike Frysinger
[not found] ` <201304071503.07751.vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
2013-04-16 5:42 ` Michael Kerrisk (man-pages)
[not found] ` <CAKgNAkjQ1PfvrVgJ_UXUerG9MzLAoUt9ixgS07L9LAroCW7_Jw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2013-04-16 15:37 ` Mike Frysinger
[not found] ` <201304161137.49482.vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
2013-04-17 6:45 ` Michael Kerrisk (man-pages)
2013-04-09 18:08 ` Peter Schiffer [this message]
[not found] ` <51645912.5080602-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
2013-04-09 18:11 ` Mike Frysinger
[not found] ` <201304091411.12265.vapier-aBrp7R+bbdUdnm+yROfE0A@public.gmane.org>
2013-04-09 18:57 ` Peter Schiffer
2013-04-16 5:27 ` Michael Kerrisk (man-pages)
[not found] ` <CAKgNAkha5NvRZzDBQAbFMVD+yoBVYVaUb3LVwm84STUnLByiKw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2013-04-17 15:12 ` Peter Schiffer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=51645912.5080602@redhat.com \
--to=pschiffe-h+wxahxf7alqt0dzr+alfa@public.gmane.org \
--cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.