mbox series

[00/22] man2: Add [[deprecated]] attribute

Message ID 20211030213131.140429-1-alx.manpages@gmail.com
Headers show
Series man2: Add [[deprecated]] attribute | expand

Message

Alejandro Colomar Oct. 30, 2021, 9:31 p.m. UTC 
Hello Michael,

I added the C2X [[deprecated]] attribute to the prototypes of some
system calls.  All of the cases where I added that were already
marked as deprecated or obsolete somewhere in the manual page,
so this is just about uniformity and visual effect rather than
a new deprecation notice.

There are cases where the syscalls have been simply removed, and
so they are obviously not to be used any more.

There are cases where some implementation (not necessarily Linux)
is dangerous.

In some other cases, the functions have been obsoleted by POSIX,
but are still there in Linux without any deprecation notices.
In these cases, if there's no clear replacement, or if the
replacement is not a straight drop-in, or if the replacement adds
more complexity, I didn't add the [[deprecated]] attribute.

A list of the system calls that I skipped in this patch set:

- utime(2)
	Many filesystems have 1 second resolution, so it makes
	sense to use it in those cases.  git(1) for example uses
	utime(2) consistently.  Although deprecated by POSIX, it
	is still part of POSIX; if it ever removes it, we can
	reconsider.

- setpgrp(2) (the POSIX/SysV version)
	POSIX deprecated it (not yet removed), but the manual page
	doesn't mention any replacement.

Cheers,

Alex


---

Alejandro Colomar (22):
  bdflush.2: SYNOPSIS: Mark as [[deprecated]]
  create_module.2: SYNOPSIS: Mark as [[deprecated]]
  get_kernel_syms.2: SYNOPSIS: Mark as [[deprecated]]
  getunwind.2: SYNOPSIS: Mark as [[deprecated]]
  iopl.2: SYNOPSIS: Mark as [[deprecated]]
  query_module.2: SYNOPSIS: Mark as [[deprecated]]
  remap_file_pages.2: SYNOPSIS: Mark as [[deprecated]]
  sigprocmask.2: SYNOPSIS: Mark the legacy system call as [[deprecated]]
  statfs.2: SYNOPSIS: Mark as [[deprecated]]
  stime.2: SYNOPSIS: Mark as [[deprecated]]
  ustat.2: SYNOPSIS: Mark as [[deprecated]]
  pthread_mutex_consistent.3: Mark *_np() old function as [[deprecated]]
  sysctl.2: SYNOPSIS: Mark as [[deprecated]]
  vfork.2: SYNOPSIS: Mark as [[deprecated]]
  tkill.2: SYNOPSIS: Mark tkill() as [[deprecated]]
  sgetmask.2: SYNOPSIS: Mark as [[deprecated]]
  getitimer.2: SYNOPSIS: Mark as [[deprecated]]
  futimesat.2: SYNOPSIS: Mark as [[deprecated]]
  gettimeofday.2: SYNOPSIS: Mark as [[deprecated]]
  setpgid.2: SYNOPSIS: Mark BSD versions of getpgrp() and setpgrp() as
    [[deprecated]]
  sysfs.2: SYNOPSIS: Mark as [[deprecated]]
  uselib.2: SYNOPSIS: Mark as [[deprecated]]

 man2/bdflush.2                  |  4 ++--
 man2/create_module.2            |  2 +-
 man2/futimesat.2                |  4 ++--
 man2/get_kernel_syms.2          |  2 +-
 man2/getitimer.2                |  7 ++++---
 man2/gettimeofday.2             |  8 ++++----
 man2/getunwind.2                |  3 ++-
 man2/iopl.2                     |  2 +-
 man2/query_module.2             |  5 +++--
 man2/remap_file_pages.2         |  5 +++--
 man2/setpgid.2                  |  8 ++++----
 man2/sgetmask.2                 |  4 ++--
 man2/sigprocmask.2              | 12 +++++++-----
 man2/statfs.2                   |  4 ++--
 man2/stime.2                    |  2 +-
 man2/sysctl.2                   |  2 +-
 man2/sysfs.2                    |  6 +++---
 man2/tkill.2                    |  2 +-
 man2/uselib.2                   |  2 +-
 man2/ustat.2                    |  2 +-
 man2/vfork.2                    |  2 +-
 man3/pthread_mutex_consistent.3 |  1 +
 22 files changed, 48 insertions(+), 41 deletions(-)