libc manpages: various improvements from NetBSD

- Add STANDARDS and HISTORY sections within the appropriate manpages
- Mention two USENIX papers within kqueue(2) and strlcpy(3)

Reviewed by:	bcr (mentor)
Approved by:	bcr (mentor)
Obtained from:	NetBSD
MFC after:	7 days
Differential Revision: https://reviews.freebsd.org/D24650
This commit is contained in:
Gordon Bergling 2020-06-14 05:59:30 +00:00
parent 932a690c51
commit e0f7c06de2
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=362171
7 changed files with 76 additions and 7 deletions

View File

@ -32,7 +32,7 @@
.\" @(#)fflush.3 8.1 (Berkeley) 6/4/93 .\" @(#)fflush.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd January 23, 2020 .Dd May 1, 2020
.Dt FFLUSH 3 .Dt FFLUSH 3
.Os .Os
.Sh NAME .Sh NAME
@ -125,3 +125,12 @@ The
function function
conforms to conforms to
.St -isoC . .St -isoC .
.Sh HISTORY
The
.Fn fflush
function first appeared in
.At v4 .
The
.Fn fpurge
function first appeared in
.Bx 4.4 .

View File

@ -32,7 +32,7 @@
.\" @(#)fopen.3 8.1 (Berkeley) 6/4/93 .\" @(#)fopen.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd January 30, 2013 .Dd May 1, 2020
.Dt FOPEN 3 .Dt FOPEN 3
.Os .Os
.Sh NAME .Sh NAME
@ -356,3 +356,8 @@ The
.Dq Li b .Dq Li b
mode does not conform to any standard mode does not conform to any standard
but is also supported by glibc. but is also supported by glibc.
.Sh HISTORY
An
.Fn fopen
function appeared in
.At v1 .

View File

@ -32,7 +32,7 @@
.\" @(#)setbuf.3 8.1 (Berkeley) 6/4/93 .\" @(#)setbuf.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd February 18, 2013 .Dd May 1, 2020
.Dt SETBUF 3 .Dt SETBUF 3
.Os .Os
.Sh NAME .Sh NAME
@ -195,6 +195,23 @@ and
functions functions
conform to conform to
.St -isoC . .St -isoC .
.Sh HISTORY
The
.Fn setbuf
function first appeared in
.At v7 .
The
.Fn setbuffer
function first appeared in
.Bx 4.1c .
The
.Fn setlinebuf
function first appeared in
.Bx 4.2 .
The
.Fn setvbuf
function first appeared in
.Bx 4.4 .
.Sh BUGS .Sh BUGS
.Fn setbuf .Fn setbuf
usually uses a suboptimal buffer size and should be avoided. usually uses a suboptimal buffer size and should be avoided.

View File

@ -27,7 +27,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd February 26, 2016 .Dd May 1, 2020
.Dt STRLCPY 3 .Dt STRLCPY 3
.Os .Os
.Sh NAME .Sh NAME
@ -189,6 +189,16 @@ As a matter of fact, the first version of this manual page got it wrong.
.Xr strncat 3 , .Xr strncat 3 ,
.Xr strncpy 3 , .Xr strncpy 3 ,
.Xr wcslcpy 3 .Xr wcslcpy 3
.Rs
.%A Todd C. Miller
.%A Theo de Raadt
.%T strlcpy and strlcat -- Consistent, Safe, String Copy and Concatenation
.%I USENIX Association
.%B Proceedings of the FREENIX Track: 1999 USENIX Annual Technical Conference
.%D June 6-11, 1999
.%U http://www.usenix.org/publications/library/proceedings/usenix99/
.%U full_papers/millert/millert.pdf
.Re
.Sh HISTORY .Sh HISTORY
The The
.Fn strlcpy .Fn strlcpy

View File

@ -28,7 +28,7 @@
.\" @(#)getgid.2 8.1 (Berkeley) 6/4/93 .\" @(#)getgid.2 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd December 15, 2015 .Dd May 1, 2020
.Dt GETGID 2 .Dt GETGID 2
.Os .Os
.Sh NAME .Sh NAME
@ -78,3 +78,8 @@ and
.Fn getegid .Fn getegid
system calls are expected to conform to system calls are expected to conform to
.St -p1003.1-90 . .St -p1003.1-90 .
.Sh HISTORY
The
.Fn getgid
function appeared in
.At v4 .

View File

@ -28,7 +28,7 @@
.\" @(#)getitimer.2 8.3 (Berkeley) 5/16/95 .\" @(#)getitimer.2 8.3 (Berkeley) 5/16/95
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd May 16, 1995 .Dd May 1, 2020
.Dt GETITIMER 2 .Dt GETITIMER 2
.Os .Os
.Sh NAME .Sh NAME
@ -173,6 +173,21 @@ to be handled.
.Xr select 2 , .Xr select 2 ,
.Xr sigaction 2 , .Xr sigaction 2 ,
.Xr clocks 7 .Xr clocks 7
.Sh STANDARDS
The
.Fn getitimer
and
.Fn setitimer
functions conform to
.St -p1003.1-2001 .
The later
.St -p1003.1-2008
revision however marked both functions as obsolescent,
recommending the use of
.Xr timer_gettime 2
and
.Xr timer_settime 2
instead.
.Sh HISTORY .Sh HISTORY
The The
.Fn getitimer .Fn getitimer

View File

@ -24,7 +24,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd April 27, 2020 .Dd May 1, 2020
.Dt KQUEUE 2 .Dt KQUEUE 2
.Os .Os
.Sh NAME .Sh NAME
@ -776,6 +776,14 @@ have been applied.
.Xr write 2 , .Xr write 2 ,
.Xr pthread_setcancelstate 3 , .Xr pthread_setcancelstate 3 ,
.Xr signal 3 .Xr signal 3
.Rs
.%A Jonathan Lemon
.%T "Kqueue: A Generic and Scalable Event Notification Facility"
.%I USENIX Association
.%B Proceedings of the FREENIX Track: 2001 USENIX Annual Technical Conference
.%D June 25-30, 2001
.\".http://www.usenix.org/event/usenix01/freenix01/full_papers/lemon/lemon.pdf
.Re
.Sh HISTORY .Sh HISTORY
The The
.Fn kqueue .Fn kqueue