From bc89b58def9c028d29a5faf3a03eee2b8b5337ae Mon Sep 17 00:00:00 2001 From: Gordon Bergling Date: Sun, 14 Jun 2020 05:35:02 +0000 Subject: [PATCH] libutil: Document function HISTORY within the manpages Reviewed by: bcr (mentor) Approved by: bcr (mentor) MFC after: 7 days Differential Revision: https://reviews.freebsd.org/D24795 --- lib/libutil/_secure_path.3 | 6 +++++- lib/libutil/hexdump.3 | 7 ++++++- lib/libutil/kinfo_getallproc.3 | 7 ++++++- lib/libutil/kinfo_getfile.3 | 5 +++++ lib/libutil/kinfo_getproc.3 | 7 ++++++- lib/libutil/kinfo_getvmmap.3 | 7 ++++++- lib/libutil/kinfo_getvmobject.3 | 7 ++++++- lib/libutil/login.conf.5 | 7 ++++++- lib/libutil/login_auth.3 | 9 ++++++++- lib/libutil/login_cap.3 | 20 +++++++++++++++++++- lib/libutil/login_class.3 | 12 +++++++++++- lib/libutil/login_ok.3 | 10 +++++++++- lib/libutil/login_times.3 | 12 +++++++++++- lib/libutil/login_tty.3 | 8 +++++++- lib/libutil/pidfile.3 | 11 ++++++++++- lib/libutil/pw_util.3 | 5 ++++- lib/libutil/realhostname.3 | 5 +++++ lib/libutil/trimdomain.3 | 5 +++++ lib/libutil/uucplock.3 | 10 +++++++++- 19 files changed, 144 insertions(+), 16 deletions(-) diff --git a/lib/libutil/_secure_path.3 b/lib/libutil/_secure_path.3 index cf89315a89e0..87a1baa38242 100644 --- a/lib/libutil/_secure_path.3 +++ b/lib/libutil/_secure_path.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 2, 1997 +.Dd May 10, 2020 .Dt _SECURE_PATH 3 .Os .Sh NAME @@ -69,6 +69,10 @@ reason, at LOG_ERR priority. Code from which this function was derived was contributed to the .Fx project by Berkeley Software Design, Inc. +The function +.Fn _secure_path +first appeared in +.Fx 2.2.5 . .Sh BUGS The checks carried out are rudimentary and no attempt is made to eliminate race conditions between use of this function and diff --git a/lib/libutil/hexdump.3 b/lib/libutil/hexdump.3 index ba23d2523651..5f2fe3065339 100644 --- a/lib/libutil/hexdump.3 +++ b/lib/libutil/hexdump.3 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 21, 2017 +.Dd May 8, 2020 .Dt HEXDUMP 3 .Os .Sh NAME @@ -83,6 +83,11 @@ Do not print the character values on each line. .Sh SEE ALSO .Xr ascii 7 , .Xr sbuf_hexdump 9 +.Sh HISTORY +The +.Fn hexdump +function first appeared in +.Fx 6.4 . .Sh AUTHORS This manual page was written by .An Scott Long . diff --git a/lib/libutil/kinfo_getallproc.3 b/lib/libutil/kinfo_getallproc.3 index 7005d4f2931a..c4a2bac809b6 100644 --- a/lib/libutil/kinfo_getallproc.3 +++ b/lib/libutil/kinfo_getallproc.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 27, 2015 +.Dd May 8, 2020 .Dt KINFO_GETALLPROC 3 .Os .Sh NAME @@ -73,3 +73,8 @@ function returns .Xr free 3 , .Xr malloc 3 , .Xr sysctl 3 +.Sh HISTORY +The +.Fn kinfo_getallproc +function first appeared in +.Fx 8.3 . diff --git a/lib/libutil/kinfo_getfile.3 b/lib/libutil/kinfo_getfile.3 index 2a35687bf25d..8190b93f2cd7 100644 --- a/lib/libutil/kinfo_getfile.3 +++ b/lib/libutil/kinfo_getfile.3 @@ -78,3 +78,8 @@ function returns .Xr kinfo_getvmmap 3 , .Xr malloc 3 , .Xr sysctl 3 +.Sh HISTORY +The +.Fn kinfo_getfile +function first appeared in +.Fx 7.0 . diff --git a/lib/libutil/kinfo_getproc.3 b/lib/libutil/kinfo_getproc.3 index f5ccbc5011ab..dea43a4334cd 100644 --- a/lib/libutil/kinfo_getproc.3 +++ b/lib/libutil/kinfo_getproc.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 27, 2015 +.Dd May 10, 2020 .Dt KINFO_GETPROC 3 .Os .Sh NAME @@ -72,3 +72,8 @@ function returns .Xr free 3 , .Xr malloc 3 , .Xr sysctl 3 +.Sh HISTORY +The +.Fn kinfo_getproc +function first appeared in +.Fx 7.0 . diff --git a/lib/libutil/kinfo_getvmmap.3 b/lib/libutil/kinfo_getvmmap.3 index 134b20a56ce0..c36f5fc5b6b5 100644 --- a/lib/libutil/kinfo_getvmmap.3 +++ b/lib/libutil/kinfo_getvmmap.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 18, 2017 +.Dd May 10, 2020 .Dt KINFO_GETVMMAP 3 .Os .Sh NAME @@ -84,3 +84,8 @@ function returns .Xr free 3 , .Xr kinfo_getfile 3 , .Xr malloc 3 +.Sh HISTORY +The +.Fn kinfo_getvmmap +function first appeared in +.Fx 7.0 . diff --git a/lib/libutil/kinfo_getvmobject.3 b/lib/libutil/kinfo_getvmobject.3 index 432c0d361b43..780134afec3f 100644 --- a/lib/libutil/kinfo_getvmobject.3 +++ b/lib/libutil/kinfo_getvmobject.3 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd May 27, 2015 +.Dd May 20, 2020 .Dt KINFO_GETVMOBJECT 3 .Os .Sh NAME @@ -71,3 +71,8 @@ function returns .Xr free 3 , .Xr kinfo_getvmmap 3 , .Xr malloc 3 +.Sh HISTORY +The +.Fn kinfo_getvmobject +function first appeared in +.Fx 10.2 . diff --git a/lib/libutil/login.conf.5 b/lib/libutil/login.conf.5 index 47b0daf91c0d..aafec9050b5c 100644 --- a/lib/libutil/login.conf.5 +++ b/lib/libutil/login.conf.5 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 19, 2020 +.Dd May 10, 2020 .Dt LOGIN.CONF 5 .Os .Sh NAME @@ -471,3 +471,8 @@ lists. .Xr ttys 5 , .Xr ftpd 8 , .Xr pam_passwdqc 8 +.Sh HISTORY +The file +.Nm +first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_auth.3 b/lib/libutil/login_auth.3 index 003f6e92ac02..3aef1fdf6d3c 100644 --- a/lib/libutil/login_auth.3 +++ b/lib/libutil/login_auth.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 29, 1996 +.Dd May 10, 2020 .Dt LOGIN_AUTH 3 .Os .Sh NAME @@ -70,3 +70,10 @@ by .Xr login_class 3 , .Xr login.conf 5 , .Xr termcap 5 +.Sh HISTORY +The functions +.Fn auth_checknologin +and +.Fn auth_cat +first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_cap.3 b/lib/libutil/login_cap.3 index 942171868d85..bc7f78cfbe79 100644 --- a/lib/libutil/login_cap.3 +++ b/lib/libutil/login_cap.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 14, 2007 +.Dd May 10, 2020 .Dt LOGIN_CAP 3 .Os .Sh NAME @@ -577,3 +577,21 @@ is returned to indicate this. .Xr login_class 3 , .Xr login.conf 5 , .Xr termcap 5 +.Sh HISTORY +The functions +.Fn login_close , +.Fn login_getcapbool , +.Fn login_getcaplist , +.Fn login_getcapnum , +.Fn login_getcapstr , +.Fn login_getcapsize , +.Fn login_getcaptime , +.Fn login_getclass , +.Fn login_getclassbyname , +.Fn login_getpwclass , +.Fn login_getstyle , +.Fn login_getuserclass +and +.Fn login_setcryptfmt +first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_class.3 b/lib/libutil/login_class.3 index ab2e8af02db4..7078a132f39f 100644 --- a/lib/libutil/login_class.3 +++ b/lib/libutil/login_class.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 24, 2011 +.Dd May 10, 2020 .Dt LOGIN_CLASS 3 .Os .Sh NAME @@ -221,3 +221,13 @@ with LOG_ERR priority and directed to the currently active facility. .Xr mac_set_proc 3 , .Xr login.conf 5 , .Xr termcap 5 +.Sh HISTORY +The functions +.Fn setclasscontext , +.Fn setclasscpumask , +.Fn setclassenvironment , +.Fn setclassresources +and +.Fn setusercontext +first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_ok.3 b/lib/libutil/login_ok.3 index 9022ff55d3a2..b43906e1f471 100644 --- a/lib/libutil/login_ok.3 +++ b/lib/libutil/login_ok.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd January 2, 1997 +.Dd May 10, 2020 .Dt LOGIN_OK 3 .Os .Sh NAME @@ -140,3 +140,11 @@ access list. .Xr login_times 3 , .Xr login.conf 5 , .Xr termcap 5 +.Sh HISTORY +The functions +.Fn auth_ttyok , +.Fn auth_hostok + and +.Fn auth_timeok +functions first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_times.3 b/lib/libutil/login_times.3 index 9d1f88d858c2..5a0d8177eabc 100644 --- a/lib/libutil/login_times.3 +++ b/lib/libutil/login_times.3 @@ -19,7 +19,7 @@ .\" .\" $FreeBSD$ .\" -.Dd October 20, 2008 +.Dd May 10, 2020 .Dt LOGIN_TIMES 3 .Os .Sh NAME @@ -177,3 +177,13 @@ time falls, or -1 if none of them apply. .Xr login_class 3 , .Xr login.conf 5 , .Xr termcap 5 +.Sh HISTORY +The functions +.Fn parse_lt , +.Fn in_lt , +.Fn in_ltm , +.Fn in_ltms +and +.Fn in_lts +first appeared in +.Fx 2.1.5 . diff --git a/lib/libutil/login_tty.3 b/lib/libutil/login_tty.3 index 907b97cd5cf7..89636d86686d 100644 --- a/lib/libutil/login_tty.3 +++ b/lib/libutil/login_tty.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" " -.Dd December 29, 1996 +.Dd May 10, 2020 .Dt LOGIN_TTY 3 .Os .Sh NAME @@ -63,3 +63,9 @@ the controlling terminal of the calling process, and 0 otherwise. .Xr ioctl 2 , .Xr setsid 2 , .Xr tty 4 +.Sh HISTORY +The function +.Fn login_tty +first appeared in +.Bx 4.4 . + diff --git a/lib/libutil/pidfile.3 b/lib/libutil/pidfile.3 index 845b11ae8d32..e969e654754c 100644 --- a/lib/libutil/pidfile.3 +++ b/lib/libutil/pidfile.3 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd February 8, 2012 +.Dd May 10, 2020 .Dt PIDFILE 3 .Os .Sh NAME @@ -286,6 +286,15 @@ Probably called not from the process which used .Xr open 2 , .Xr daemon 3 , .Xr flopen 3 +.Sh HISTORY +The functions +.Fn pidfile_open , +.Fn pidfile_write , +.Fn pidfile_close +and +.Fn pidfile_remove +first appeared in +.Fx 5.5 . .Sh AUTHORS .An -nosplit The diff --git a/lib/libutil/pw_util.3 b/lib/libutil/pw_util.3 index 2ebfa3915294..8855eba8d925 100644 --- a/lib/libutil/pw_util.3 +++ b/lib/libutil/pw_util.3 @@ -24,7 +24,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 26, 2018 +.Dd May 10, 2020 .Dt PW_UTIL 3 .Os .Sh NAME @@ -288,6 +288,9 @@ The .Fn pw_tmp returns an open file descriptor to the temporary password file or -1 in case of failure. +.Sh HISTORY +The functions for passwd file handling first appeared in +.Bx 4.4 . .Sh AUTHORS Portions of this software were developed for the .Fx diff --git a/lib/libutil/realhostname.3 b/lib/libutil/realhostname.3 index 28e232567bf9..55e3f2d021f1 100644 --- a/lib/libutil/realhostname.3 +++ b/lib/libutil/realhostname.3 @@ -100,3 +100,8 @@ now contains the numeric value of .Xr gethostbyname 3 , .Xr inet_ntoa 3 , .Xr realhostname_sa 3 +.Sh HISTORY +The +.Fn realhostname +function first appeared in +.Fx 3.2 . diff --git a/lib/libutil/trimdomain.3 b/lib/libutil/trimdomain.3 index 8d600c019213..679b35a695bb 100644 --- a/lib/libutil/trimdomain.3 +++ b/lib/libutil/trimdomain.3 @@ -83,3 +83,8 @@ The function does not return a value. .Sh SEE ALSO .Xr gethostname 3 +.Sh HISTORY +The function +.Fn trimdomain +first appeared in +.Fx 3.2 . diff --git a/lib/libutil/uucplock.3 b/lib/libutil/uucplock.3 index 5d8647d03191..a8dd68321e3d 100644 --- a/lib/libutil/uucplock.3 +++ b/lib/libutil/uucplock.3 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" " -.Dd March 30, 1997 +.Dd May 10, 2020 .Dt UUCPLOCK 3 .Os .Sh NAME @@ -170,6 +170,14 @@ for further details. .Xr open 2 , .Xr read 2 , .Xr write 2 +.Sh HISTORY +The functions +.Fn uu_lock , +.Fn uu_unlock +and +.Fn uu_lockerr +first appeared in +.Fx 2.0.5 . .Sh BUGS It is possible that a stale lock is not recognised as such if a new processes is assigned the same processes id as the program that left