git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH 00/22] man2: Add [[deprecated]] attribute
@ 2021-10-30 21:31 Alejandro Colomar
  2021-10-30 21:31 ` [PATCH 01/22] bdflush.2: SYNOPSIS: Mark as [[deprecated]] Alejandro Colomar
                   ` (22 more replies)
  0 siblings, 23 replies; 24+ messages in thread
From: Alejandro Colomar @ 2021-10-30 21:31 UTC (permalink / raw)
  To: mtk.manpages, linux-man; +Cc: git, Alejandro Colomar, linux-kernel, libc-alpha

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(-)

-- 
2.33.1


^ permalink raw reply	[flat|nested] 24+ messages in thread

end of thread, other threads:[~2021-10-30 22:23 UTC | newest]

Thread overview: 24+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-30 21:31 [PATCH 00/22] man2: Add [[deprecated]] attribute Alejandro Colomar
2021-10-30 21:31 ` [PATCH 01/22] bdflush.2: SYNOPSIS: Mark as [[deprecated]] Alejandro Colomar
2021-10-30 21:31 ` [PATCH 02/22] create_module.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 03/22] get_kernel_syms.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 04/22] getunwind.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 05/22] iopl.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 06/22] query_module.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 07/22] remap_file_pages.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 08/22] sigprocmask.2: SYNOPSIS: Mark the legacy system call " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 09/22] statfs.2: SYNOPSIS: Mark " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 10/22] stime.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 11/22] ustat.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 12/22] pthread_mutex_consistent.3: Mark *_np() old function " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 13/22] sysctl.2: SYNOPSIS: Mark " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 14/22] vfork.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 15/22] tkill.2: SYNOPSIS: Mark tkill() " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 16/22] sgetmask.2: SYNOPSIS: Mark " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 17/22] getitimer.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 18/22] futimesat.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 19/22] gettimeofday.2: " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 20/22] setpgid.2: SYNOPSIS: Mark BSD versions of getpgrp() and setpgrp() " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 21/22] sysfs.2: SYNOPSIS: Mark " Alejandro Colomar
2021-10-30 21:31 ` [PATCH 22/22] uselib.2: " Alejandro Colomar
2021-10-30 22:23 ` [PATCH 00/22] man2: Add [[deprecated]] attribute Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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).