svn commit: r362171 - in head/lib/libc: stdio string sys

Sun Jun 14 05:59:32 UTC 2020

Author: gbe (doc committer)
Date: Sun Jun 14 05:59:30 2020
New Revision: 362171
URL: https://svnweb.freebsd.org/changeset/base/362171

Log:
  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

Modified:
  head/lib/libc/stdio/fflush.3
  head/lib/libc/stdio/fopen.3
  head/lib/libc/stdio/setbuf.3
  head/lib/libc/string/strlcpy.3
  head/lib/libc/sys/getgid.2
  head/lib/libc/sys/getitimer.2
  head/lib/libc/sys/kqueue.2

Modified: head/lib/libc/stdio/fflush.3
==============================================================================

--- head/lib/libc/stdio/fflush.3	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/stdio/fflush.3	Sun Jun 14 05:59:30 2020	(r362171)
@@ -32,7 +32,7 @@
 .\"     @(#)fflush.3	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd January 23, 2020
+.Dd May 1, 2020
 .Dt FFLUSH 3
 .Os
 .Sh NAME
@@ -125,3 +125,12 @@ The
 function
 conforms to
 .St -isoC .
+.Sh HISTORY
+The
+.Fn fflush
+function first appeared in
+.At v4 .
+The
+.Fn fpurge
+function first appeared in
+.Bx 4.4 .

Modified: head/lib/libc/stdio/fopen.3
==============================================================================
--- head/lib/libc/stdio/fopen.3	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/stdio/fopen.3	Sun Jun 14 05:59:30 2020	(r362171)
@@ -32,7 +32,7 @@
 .\"     @(#)fopen.3	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd January 30, 2013
+.Dd May 1, 2020
 .Dt FOPEN 3
 .Os
 .Sh NAME
@@ -356,3 +356,8 @@ The
 .Dq Li b
 mode does not conform to any standard
 but is also supported by glibc.
+.Sh HISTORY
+An
+.Fn fopen
+function appeared in
+.At v1 .

Modified: head/lib/libc/stdio/setbuf.3
==============================================================================
--- head/lib/libc/stdio/setbuf.3	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/stdio/setbuf.3	Sun Jun 14 05:59:30 2020	(r362171)
@@ -32,7 +32,7 @@
 .\"     @(#)setbuf.3	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd February 18, 2013
+.Dd May 1, 2020
 .Dt SETBUF 3
 .Os
 .Sh NAME
@@ -195,6 +195,23 @@ and
 functions
 conform to
 .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
 .Fn setbuf
 usually uses a suboptimal buffer size and should be avoided.

Modified: head/lib/libc/string/strlcpy.3
==============================================================================
--- head/lib/libc/string/strlcpy.3	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/string/strlcpy.3	Sun Jun 14 05:59:30 2020	(r362171)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd February 26, 2016
+.Dd May 1, 2020
 .Dt STRLCPY 3
 .Os
 .Sh NAME
@@ -189,6 +189,16 @@ As a matter of fact, the first version of this manual 
 .Xr strncat 3 ,
 .Xr strncpy 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
 The
 .Fn strlcpy

Modified: head/lib/libc/sys/getgid.2
==============================================================================
--- head/lib/libc/sys/getgid.2	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/sys/getgid.2	Sun Jun 14 05:59:30 2020	(r362171)
@@ -28,7 +28,7 @@
 .\"     @(#)getgid.2	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd December 15, 2015
+.Dd May 1, 2020
 .Dt GETGID 2
 .Os
 .Sh NAME
@@ -78,3 +78,8 @@ and
 .Fn getegid
 system calls are expected to conform to
 .St -p1003.1-90 .
+.Sh HISTORY
+The
+.Fn getgid
+function appeared in
+.At v4 .

Modified: head/lib/libc/sys/getitimer.2
==============================================================================
--- head/lib/libc/sys/getitimer.2	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/sys/getitimer.2	Sun Jun 14 05:59:30 2020	(r362171)
@@ -28,7 +28,7 @@
 .\"     @(#)getitimer.2	8.3 (Berkeley) 5/16/95
 .\" $FreeBSD$
 .\"
-.Dd May 16, 1995
+.Dd May 1, 2020 
 .Dt GETITIMER 2
 .Os
 .Sh NAME
@@ -173,6 +173,21 @@ to be handled.
 .Xr select 2 ,
 .Xr sigaction 2 ,
 .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
 The
 .Fn getitimer

Modified: head/lib/libc/sys/kqueue.2
==============================================================================
--- head/lib/libc/sys/kqueue.2	Sun Jun 14 05:50:28 2020	(r362170)
+++ head/lib/libc/sys/kqueue.2	Sun Jun 14 05:59:30 2020	(r362171)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 27, 2020
+.Dd May 1, 2020
 .Dt KQUEUE 2
 .Os
 .Sh NAME
@@ -776,6 +776,14 @@ have been applied.
 .Xr write 2 ,
 .Xr pthread_setcancelstate 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
 The
 .Fn kqueue
