public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
From: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Cc: linux-man@vger.kernel.org, libc-alpha@sourceware.org
Subject: Re: [PATCH v5 00/35] SYNOPSIS: Use syscall(SYS_...); and fix '#include's
Date: Sun, 11 Apr 2021 21:30:02 +0200	[thread overview]
Message-ID: <f48a1f0f-a1cd-2dfb-6dc9-12165b5687be@gmail.com> (raw)
In-Reply-To: <7750fa83-c252-7a60-bddc-34fb7ebed0bf@gmail.com>

On 4/11/21 9:23 PM, Alejandro Colomar (man-pages) wrote:
> Hi Michael,
> 
> On 4/5/21 1:49 PM, Michael Kerrisk (man-pages) wrote:
>> So, I think I'm okay with the syscall() changes in the SYNOPSIS.
>> It might just take me a moment to get used to them. However, I do
>> wonder if it is worth retaining a comment in the SYSNOPSIS,
>> something like:
>>
>>     SYNOPSIS
>>         #include <asm/prctl.h>        /* Definition of ARCH_* 
>> constants */
>>         #include <sys/syscall.h>      /* Definition of SYS_* constants */
>>         #include <unistd.h>
>>
>>         int syscall(SYS_arch_prctl, int code, unsigned long addr);
>>         int syscall(SYS_arch_prctl, int code, unsigned long *addr);
>>
>>         Note: glibc provides no wrapper for arch_prctl(), necessitating
>>         the use of syscall(2).

I'm not sure what text to write in cases such as faccessat2(2).  Could 
you have a look at that?

There's actually a wrapper, but it's faccessat(2).

>>
>> Without something like this, the reader may be puzzled at the use of
>> syscall().
>>
>> What do you think?
> 
> Yes.  I had doubts, and you confirmed them.  I'll add that.
> 

Thanks,

Alex

-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

  reply	other threads:[~2021-04-11 19:30 UTC|newest]

Thread overview: 114+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-03 19:39 [PATCH v4 " Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 01/35] system_data_types.7: Add 'struct sockaddr' Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 02/35] sockaddr.3: New link to system_data_types(7) Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 03/35] system_data_types.7: Add 'socklen_t' Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 04/35] socklen_t.3: New link to system_data_types(7) Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 05/35] access.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 06/35] add_key.2: Remove unused include Alejandro Colomar
2021-04-03 19:39 ` [PATCH v4 07/35] alloc_hugepages.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 08/35] arch_prctl.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 09/35] arch_prctl.2: SYNOPSIS: Remove unused includes Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 10/35] capget.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 11/35] clone.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 12/35] delete_module.2: Add missing include Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 13/35] dup.2: SYNOPSIS: Use consistent comments through pages Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 14/35] execveat.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 15/35] exit_group.2: Use 'noreturn' in prototypes Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 16/35] exit_group.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 17/35] fanotify_init.2: Add comment: why more than one include is needed Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 18/35] fcntl.2: Remove unused include Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 19/35] futex.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 20/35] futimesat.2: ffix Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 21/35] getdents.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 22/35] getpriority.2: Remove unused include Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 23/35] getrlimit.2, getrusage.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 24/35] getunwind.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 25/35] get_robust_list.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 26/35] delete_module.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 27/35] init_module.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 28/35] io_cancel.2: " Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 29/35] ioctl_fat.2: Make clear why is each header exactly needed Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 30/35] ioctl_fat.2: ffix Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 31/35] ioctl_ficlonerange.2: Make clear why is each header exactly needed Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 32/35] ioctl_fideduperange.2: Make clear why exactly is each header needed Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 33/35] ioctl_fslabel.2: ffix Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 34/35] ioctl_fslabel.2: Make clear why exactly is each header needed Alejandro Colomar
2021-04-03 19:40 ` [PATCH v4 35/35] ioctl_getfsmap.2: " Alejandro Colomar
2021-04-04 11:58 ` [PATCH v5 00/35] SYNOPSIS: Use syscall(SYS_...); and fix '#include's Alejandro Colomar
2021-04-05 11:49   ` Michael Kerrisk (man-pages)
2021-04-11 19:23     ` Alejandro Colomar (man-pages)
2021-04-11 19:30       ` Alejandro Colomar (man-pages) [this message]
2021-04-12  6:17     ` Florian Weimer
2021-04-12  6:39       ` Jakub Wilk
2021-04-12  9:09       ` Alejandro Colomar (man-pages)
2021-04-21  5:41         ` Florian Weimer
2021-04-24 15:46           ` Alejandro Colomar (man-pages)
2021-04-04 11:58 ` [PATCH v5 01/35] system_data_types.7: Add 'struct sockaddr' Alejandro Colomar
2021-04-05 10:40   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 02/35] sockaddr.3: New link to system_data_types(7) Alejandro Colomar
2021-04-04 11:58 ` [PATCH v5 03/35] system_data_types.7: Add 'socklen_t' Alejandro Colomar
2021-04-05 10:40   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 04/35] socklen_t.3: New link to system_data_types(7) Alejandro Colomar
2021-04-05 10:41   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 05/35] access.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:17   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 06/35] add_key.2: Remove unused include Alejandro Colomar
2021-04-05 10:51   ` Michael Kerrisk (man-pages)
2021-04-05 10:55   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 07/35] alloc_hugepages.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:22   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 08/35] arch_prctl.2: " Alejandro Colomar
2021-04-05 11:25   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 09/35] arch_prctl.2: SYNOPSIS: Remove unused includes Alejandro Colomar
2021-04-05 11:26   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 10/35] capget.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:29   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 11/35] clone.2: " Alejandro Colomar
2021-04-05 11:31   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 12/35] delete_module.2: Add missing include Alejandro Colomar
2021-04-05 10:48   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 13/35] dup.2: SYNOPSIS: Use consistent comments through pages Alejandro Colomar
2021-04-05 11:32   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 14/35] execveat.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:33   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 15/35] exit_group.2: Use 'noreturn' in prototypes Alejandro Colomar
2021-04-05 10:43   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 16/35] exit_group.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:36   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 17/35] fanotify_init.2: Add comment: why more than one include is needed Alejandro Colomar
2021-04-05 10:50   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 18/35] fcntl.2: Remove unused include Alejandro Colomar
2021-04-05 10:44   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 19/35] futex.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-04 11:58 ` [PATCH v5 20/35] futimesat.2: ffix Alejandro Colomar
2021-04-05 10:42   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 21/35] getdents.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:37   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 22/35] getpriority.2: Remove unused include Alejandro Colomar
2021-04-05 10:49   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 23/35] getrlimit.2, getrusage.2: " Alejandro Colomar
2021-04-05 10:48   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 24/35] getunwind.2: Use syscall(SYS_...); for system calls without a wrapper Alejandro Colomar
2021-04-05 11:37   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 25/35] get_robust_list.2: " Alejandro Colomar
2021-04-05 11:39   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 26/35] delete_module.2: " Alejandro Colomar
2021-04-05 11:41   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 27/35] init_module.2: " Alejandro Colomar
2021-04-05 11:41   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 28/35] io_cancel.2: " Alejandro Colomar
2021-04-05 11:43   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 29/35] ioctl_fat.2: Make clear why is each header exactly needed Alejandro Colomar
2021-04-05 11:02   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 30/35] ioctl_fat.2: ffix Alejandro Colomar
2021-04-05 11:03   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 31/35] ioctl_ficlonerange.2: Make clear why is each header exactly needed Alejandro Colomar
2021-04-05 11:13   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 32/35] ioctl_fideduperange.2: Make clear why exactly is each header needed Alejandro Colomar
2021-04-05 11:16   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 33/35] ioctl_fslabel.2: ffix Alejandro Colomar
2021-04-05 11:10   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 34/35] ioctl_fslabel.2: Make clear why exactly is each header needed Alejandro Colomar
2021-04-05 11:04   ` Michael Kerrisk (man-pages)
2021-04-04 11:58 ` [PATCH v5 35/35] ioctl_getfsmap.2: " Alejandro Colomar
2021-04-05 11:10   ` Michael Kerrisk (man-pages)

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=f48a1f0f-a1cd-2dfb-6dc9-12165b5687be@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).