mbox series

[00/39] man2: SYNOPSIS: Fix headers, use syscall(), and other fixes

Message ID 20210510175546.28445-1-alx.manpages@gmail.com
Headers show
Series man2: SYNOPSIS: Fix headers, use syscall(), and other fixes | expand

Message

Alejandro Colomar \(man-pages\) May 10, 2021, 5:55 p.m. UTC
Hi Michael,

This is the second set of SYNOPSIS fixes, mostly about fixing the includes,
giving reasons why they are being included, and using syscall(SYS_...) when
needed.  Other minor fixes that I have noticed while doing this are also
included in this set.

After this set, about a 60% of man2 will be fixed.

As with the previous patch set, please review thoroughly.  I might have
overlooked something.  It looks good, but it's been a long time...

I must notice that there are a few discrepancies (see the last mails there):
<https://lore.kernel.org/linux-man/3d6feff0-f65b-f086-aa2a-be21ff90ccfe@gmail.com/T/#u>.

Cheers,

Alex



Alejandro Colomar (39):
  futex.2: Use syscall(SYS_...); for system calls without a wrapper
  getdents.2: Use syscall(SYS_...); for system calls without a wrapper
  ioctl_tty.2: Fix includes
  ioctl_userfaultfd.2: SYNOPSIS: Add <linux/userfaultfd.h>
  io_destroy.2: Use syscall(SYS_...); for system calls without a wrapper
  io_getevents.2: Use syscall(SYS_...); for system calls without a
    wrapper
  ioperm.2: Remove obvious comment
  ioprio_set.2: Use syscall(SYS_...); for system calls without a wrapper
  ipc.2: Use syscall(SYS_...); for system calls without a wrapper
  ipc.2: Add needed include
  kcmp.2: Use syscall(SYS_...); for system calls without a wrapper
  kcmp.2: tfix
  kexec_load.2: Use syscall(SYS_...); for system calls without a wrapper
  scripts/bash_aliases: man_lsfunc(): Extract syscall name from
    syscall(SYS_...)
  keyctl.2: Use syscall(SYS_...); for system calls without a glibc
    wrapper
  link.2: ffix
  llseek.2: Use syscall(SYS_...); for system calls without a wrapper
  lookup_dcookie.2: Use syscall(SYS_...); for system calls without a
    wrapper
  membarrier.2: Use syscall(SYS_...); for system calls without a wrapper
  mincore.2: Remove unused include
  mknod.2: Remove unused includes
  mmap2.2: Use syscall(SYS_...); for system calls without a wrapper
  modify_ldt.2: Use syscall(SYS_...); for system calls without a wrapper
  mq_getsetattr.2: Use syscall(SYS_...); for system calls without a
    wrapper
  alloc_hugepages.2, arch_prctl.2, capget.2, clone.2, delete_module.2,
    exit_group.2, get_robust_list.2, getunwind.2, init_module.2: Add
    note about the use of syscall(2)
  open.2: Remove unused <sys/stat.h>
  openat2.2: Use syscall(SYS_...); for system calls without a wrapper;
    fix includes too
  perf_event_open.2: Use syscall(SYS_...); for system calls without a
    wrapper
  pidfd_getfd.2: Use syscall(SYS_...); for system calls without a
    wrapper
  pidfd_open.2: Use syscall(SYS_...); for system calls without a wrapper
  pidfd_send_signal.2: Use syscall(SYS_...); for system calls without a
    wrapper. Fix includes too
  pipe.2: wfix
  pivot_root.2: Use syscall(SYS_...); for system calls without a wrapper
  poll.2: Remove <signal.h>
  process_madvise.2: Use syscall(SYS_...); for system calls without a
    wrapper. Fix includes too.
  quotactl.2: Better detail why <xfs/xqm.h> is included
  readdir.2: Use syscall(SYS_...); for system calls without a wrapper
  readlink.2: ffix
  reboot.2: Use syscall(SYS_...); for system calls without a wrapper

 man2/alloc_hugepages.2   |  5 +++++
 man2/arch_prctl.2        |  6 ++++++
 man2/capget.2            |  5 +++++
 man2/clone.2             |  6 ++++++
 man2/delete_module.2     |  6 ++++++
 man2/exit_group.2        |  6 ++++++
 man2/futex.2             | 21 +++++++++++----------
 man2/get_robust_list.2   |  5 +++++
 man2/getdents.2          | 20 +++++++++++++++-----
 man2/getunwind.2         |  6 ++++++
 man2/init_module.2       |  5 +++++
 man2/io_destroy.2        | 16 +++++++++-------
 man2/io_getevents.2      | 21 +++++++++++----------
 man2/ioctl_tty.2         |  6 +++---
 man2/ioctl_userfaultfd.2 |  1 +
 man2/ioperm.2            |  2 +-
 man2/ioprio_set.2        | 15 +++++++++------
 man2/ipc.2               | 19 ++++++++++++-------
 man2/kcmp.2              | 18 ++++++++++--------
 man2/kexec_load.2        | 24 +++++++++++++-----------
 man2/keyctl.2            | 17 +++++++----------
 man2/link.2              |  2 +-
 man2/llseek.2            | 13 +++++++------
 man2/lookup_dcookie.2    | 14 +++++++++-----
 man2/membarrier.2        | 16 ++++++++++------
 man2/mincore.2           |  1 -
 man2/mknod.2             |  2 --
 man2/mmap2.2             | 10 ++++++----
 man2/modify_ldt.2        | 15 ++++++++++-----
 man2/mq_getsetattr.2     | 15 ++++++---------
 man2/open.2              |  1 -
 man2/openat2.2           | 20 +++++++++++---------
 man2/perf_event_open.2   | 21 +++++++++++----------
 man2/pidfd_getfd.2       | 14 +++++++++-----
 man2/pidfd_open.2        | 13 ++++++++-----
 man2/pidfd_send_signal.2 | 16 ++++++++++------
 man2/pipe.2              |  4 ++--
 man2/pivot_root.2        | 14 +++++++++-----
 man2/poll.2              |  3 +--
 man2/process_madvise.2   | 20 ++++++++++++--------
 man2/quotactl.2          |  4 +++-
 man2/readdir.2           | 12 +++++++-----
 man2/readlink.2          |  2 +-
 man2/reboot.2            | 12 +++++++-----
 scripts/bash_aliases     |  1 +
 45 files changed, 293 insertions(+), 182 deletions(-)

Comments

Michael Kerrisk \(man-pages\) May 11, 2021, 5:27 a.m. UTC | #1
Hello Alex,

On 5/11/21 5:55 AM, Alejandro Colomar wrote:
> 
> Hi Michael,
> 
> This is the second set of SYNOPSIS fixes, mostly about fixing the includes,
> giving reasons why they are being included, and using syscall(SYS_...) when
> needed.  Other minor fixes that I have noticed while doing this are also
> included in this set.
> 
> After this set, about a 60% of man2 will be fixed.
> 
> As with the previous patch set, please review thoroughly.  I might have
> overlooked something.  It looks good, but it's been a long time...

Things looked okay to me. I dropped the patch you asked me
to drop, and made a formatting after the getdents.2 patch

> I must notice that there are a few discrepancies (see the last mails there):
> <https://lore.kernel.org/linux-man/3d6feff0-f65b-f086-aa2a-be21ff90ccfe@gmail.com/T/#u>.

Yep. I real the discussion. I think I'm okay with your choice.

I've applied all of the patches.

Thanks,

Michael

> Alejandro Colomar (39):
>   futex.2: Use syscall(SYS_...); for system calls without a wrapper
>   getdents.2: Use syscall(SYS_...); for system calls without a wrapper
>   ioctl_tty.2: Fix includes
>   ioctl_userfaultfd.2: SYNOPSIS: Add <linux/userfaultfd.h>
>   io_destroy.2: Use syscall(SYS_...); for system calls without a wrapper
>   io_getevents.2: Use syscall(SYS_...); for system calls without a
>     wrapper
>   ioperm.2: Remove obvious comment
>   ioprio_set.2: Use syscall(SYS_...); for system calls without a wrapper
>   ipc.2: Use syscall(SYS_...); for system calls without a wrapper
>   ipc.2: Add needed include
>   kcmp.2: Use syscall(SYS_...); for system calls without a wrapper
>   kcmp.2: tfix
>   kexec_load.2: Use syscall(SYS_...); for system calls without a wrapper
>   scripts/bash_aliases: man_lsfunc(): Extract syscall name from
>     syscall(SYS_...)
>   keyctl.2: Use syscall(SYS_...); for system calls without a glibc
>     wrapper
>   link.2: ffix
>   llseek.2: Use syscall(SYS_...); for system calls without a wrapper
>   lookup_dcookie.2: Use syscall(SYS_...); for system calls without a
>     wrapper
>   membarrier.2: Use syscall(SYS_...); for system calls without a wrapper
>   mincore.2: Remove unused include
>   mknod.2: Remove unused includes
>   mmap2.2: Use syscall(SYS_...); for system calls without a wrapper
>   modify_ldt.2: Use syscall(SYS_...); for system calls without a wrapper
>   mq_getsetattr.2: Use syscall(SYS_...); for system calls without a
>     wrapper
>   alloc_hugepages.2, arch_prctl.2, capget.2, clone.2, delete_module.2,
>     exit_group.2, get_robust_list.2, getunwind.2, init_module.2: Add
>     note about the use of syscall(2)
>   open.2: Remove unused <sys/stat.h>
>   openat2.2: Use syscall(SYS_...); for system calls without a wrapper;
>     fix includes too
>   perf_event_open.2: Use syscall(SYS_...); for system calls without a
>     wrapper
>   pidfd_getfd.2: Use syscall(SYS_...); for system calls without a
>     wrapper
>   pidfd_open.2: Use syscall(SYS_...); for system calls without a wrapper
>   pidfd_send_signal.2: Use syscall(SYS_...); for system calls without a
>     wrapper. Fix includes too
>   pipe.2: wfix
>   pivot_root.2: Use syscall(SYS_...); for system calls without a wrapper
>   poll.2: Remove <signal.h>
>   process_madvise.2: Use syscall(SYS_...); for system calls without a
>     wrapper. Fix includes too.
>   quotactl.2: Better detail why <xfs/xqm.h> is included
>   readdir.2: Use syscall(SYS_...); for system calls without a wrapper
>   readlink.2: ffix
>   reboot.2: Use syscall(SYS_...); for system calls without a wrapper
> 
>  man2/alloc_hugepages.2   |  5 +++++
>  man2/arch_prctl.2        |  6 ++++++
>  man2/capget.2            |  5 +++++
>  man2/clone.2             |  6 ++++++
>  man2/delete_module.2     |  6 ++++++
>  man2/exit_group.2        |  6 ++++++
>  man2/futex.2             | 21 +++++++++++----------
>  man2/get_robust_list.2   |  5 +++++
>  man2/getdents.2          | 20 +++++++++++++++-----
>  man2/getunwind.2         |  6 ++++++
>  man2/init_module.2       |  5 +++++
>  man2/io_destroy.2        | 16 +++++++++-------
>  man2/io_getevents.2      | 21 +++++++++++----------
>  man2/ioctl_tty.2         |  6 +++---
>  man2/ioctl_userfaultfd.2 |  1 +
>  man2/ioperm.2            |  2 +-
>  man2/ioprio_set.2        | 15 +++++++++------
>  man2/ipc.2               | 19 ++++++++++++-------
>  man2/kcmp.2              | 18 ++++++++++--------
>  man2/kexec_load.2        | 24 +++++++++++++-----------
>  man2/keyctl.2            | 17 +++++++----------
>  man2/link.2              |  2 +-
>  man2/llseek.2            | 13 +++++++------
>  man2/lookup_dcookie.2    | 14 +++++++++-----
>  man2/membarrier.2        | 16 ++++++++++------
>  man2/mincore.2           |  1 -
>  man2/mknod.2             |  2 --
>  man2/mmap2.2             | 10 ++++++----
>  man2/modify_ldt.2        | 15 ++++++++++-----
>  man2/mq_getsetattr.2     | 15 ++++++---------
>  man2/open.2              |  1 -
>  man2/openat2.2           | 20 +++++++++++---------
>  man2/perf_event_open.2   | 21 +++++++++++----------
>  man2/pidfd_getfd.2       | 14 +++++++++-----
>  man2/pidfd_open.2        | 13 ++++++++-----
>  man2/pidfd_send_signal.2 | 16 ++++++++++------
>  man2/pipe.2              |  4 ++--
>  man2/pivot_root.2        | 14 +++++++++-----
>  man2/poll.2              |  3 +--
>  man2/process_madvise.2   | 20 ++++++++++++--------
>  man2/quotactl.2          |  4 +++-
>  man2/readdir.2           | 12 +++++++-----
>  man2/readlink.2          |  2 +-
>  man2/reboot.2            | 12 +++++++-----
>  scripts/bash_aliases     |  1 +
>  45 files changed, 293 insertions(+), 182 deletions(-)
>