aboutsummaryrefslogtreecommitdiffstats
path: root/man3head
diff options
authorAlejandro Colomar <alx@kernel.org>2023-03-17 17:08:01 +0100
committerAlejandro Colomar <alx@kernel.org>2023-03-30 15:14:55 +0200
commit4131356cdab8d37fc395ca5466a0401c8573380c (patch)
tree8c4c6f1c3172358b735b481cbbfdd9cc04b00ed9 /man3head
parentfd00f831b52d61a91d59cb3b46182869145d9700 (diff)
downloadman-pages-4131356cdab8d37fc395ca5466a0401c8573380c.tar.gz
man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections
- Add a new HISTORY section that covers the history of an API, both regarding implementations and regarding old standards. This was previously covered in VERSIONS, and in some cases in STANDARDS. - Repurpose VERSIONS to cover differing implementations in _current_ systems. - STANDARDS is reduced to only cover current versions of standards. That basically means only C11 (C99 has been superseeded by C11; C17 is just a bugfix of C11, so not really a new version), and POSIX.1-2008 (*-2001 was superseeded by *-2008; *-2017 was just a bugfix for *-2008). The section also mentions for example 'Linux', 'GNU' or 'BSD' when a non-standard API is Linux- or GNU-only or if it's (de-facto) standard in the BSDs. - In some cases content that should go into one of these sections was in NOTES. Move it from there to where it corresponds. - In the SYNOPSIS, I added [[deprecated]] in some functions that I found are deprecated by the relevant standards. - A few other related changes... Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man3head')
-rw-r--r--man3head/printf.h.3head6
-rw-r--r--man3head/sysexits.h.3head6
2 files changed, 6 insertions, 6 deletions
diff --git a/man3head/printf.h.3head b/man3head/printf.h.3head
index 8f1aa6a37e..e432d3cb9a 100644
--- a/man3head/printf.h.3head
+++ b/man3head/printf.h.3head
@@ -221,7 +221,9 @@ On error, it should return \-1.
.TP
.B EINVAL
The specifier was not a valid character.
-.SH VERSIONS
+.SH STANDARDS
+GNU.
+.SH HISTORY
.BR \%register_printf_function (3)
is an older function similar to
.BR \%register_printf_specifier (),
@@ -231,8 +233,6 @@ That function can't handle user-defined types.
.BR \%register_printf_specifier ()
superseeds
.BR \%register_printf_function (3).
-.SH STANDARDS
-These nonstandard functions are present in glibc.
.SH EXAMPLES
The following example program registers the 'b' and 'B' specifiers
to print integers in binary format,
diff --git a/man3head/sysexits.h.3head b/man3head/sysexits.h.3head
index 33e23b9105..4014b80284 100644
--- a/man3head/sysexits.h.3head
+++ b/man3head/sysexits.h.3head
@@ -185,14 +185,14 @@ Something was found in an unconfigured or misconfigured state.
The numerical values corresponding to the symbolical ones
are given in parenthesis for easy reference.
.SH STANDARDS
-Not in POSIX.1.
-Present on the BSDs.
+BSD.
+.SH HISTORY
The
.I <sysexits.h>
file appeared in 4.0BSD for use by the deliverymail utility,
later renamed to
.BR sendmail (8).
-.SH BUGS
+.SH CAVEATS
The choice of an appropriate exit value is often ambiguous.
.SH SEE ALSO
.BR err (3),