Sections 2 and 3 have RETURN VALUES, not DIAGNOSTICS

2022-12-04 01:29:31 +00:00 · 2022-12-04 01:29:31 +00:00 · e6fc3c59c2
parent 254727163e
commit e6fc3c59c2
26 changed files with 52 additions and 57 deletions
--- a/lib/libbluetooth/bluetooth.3
+++ b/lib/libbluetooth/bluetooth.3
@ -1,4 +1,4 @@
-.\" $NetBSD: bluetooth.3,v 1.9 2017/07/03 21:32:49 wiz Exp $
+.\" $NetBSD: bluetooth.3,v 1.10 2022/12/04 01:29:31 uwe Exp $
 .\"
 .\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
 .\" All rights reserved.
@ -208,7 +208,7 @@ if ((hp = bt_gethostbyaddr((const char *)&bd,

 printf("name associated with %s is %s\en", bdstr, hp->h_name);
 .Ed
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Error return status from
 .Fn bt_gethostent ,
 .Fn bt_gethostbyname ,
--- a/lib/libc/gen/cgetcap.3
+++ b/lib/libc/gen/cgetcap.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: cgetcap.3,v 1.9 2017/10/24 18:42:06 abhinav Exp $
+.\"	$NetBSD: cgetcap.3,v 1.10 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1992, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -315,7 +315,7 @@ is declared and all subsequent files in the file array.
 can be used to control if
 .Qq tc
 expansion is performed or not.
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 .Fn cgetent ,
 .Fn cgetset ,
 .Fn cgetmatch ,
--- a/lib/libc/gen/getusershell.3
+++ b/lib/libc/gen/getusershell.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: getusershell.3,v 1.10 2004/11/23 04:38:19 lukem Exp $
+.\"	$NetBSD: getusershell.3,v 1.11 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1985, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -75,7 +75,7 @@ closes it.
 .Bl -tag -width /etc/shells -compact
 .It Pa /etc/shells
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 The routine
 .Fn getusershell
 returns a null pointer (0) on
--- a/lib/libc/gen/scandir.3
+++ b/lib/libc/gen/scandir.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: scandir.3,v 1.16 2016/12/17 10:25:49 wiz Exp $
+.\"	$NetBSD: scandir.3,v 1.17 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -88,7 +88,7 @@ parameter to sort the array alphabetically.
 The memory allocated for the array can be deallocated with
 .Xr free 3 ,
 by freeing each pointer in the array and then the array itself.
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Returns \-1 if the directory cannot be opened for reading or if
 .Xr malloc 3
 cannot allocate enough memory to hold all the data structures.
--- a/lib/libc/gen/wordexp.3
+++ b/lib/libc/gen/wordexp.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: wordexp.3,v 1.4 2021/12/10 20:36:02 andvar Exp $
+.\"	$NetBSD: wordexp.3,v 1.5 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 2002 Tim J. Robbins
 .\" All rights reserved.
@ -189,7 +189,7 @@ wordexp_t we;
 wordexp("${EDITOR:-vi} *.c /etc/motd", &we, 0);
 execvp(we->we_wordv[0], we->we_wordv);
 .Ed
-.Sh DIAGNOSTICS
+.Sh DIAGNOSTICS		\" sic!
 Diagnostic messages from the shell are written to the standard error output
 if
 .Dv WRDE_SHOWERR
--- a/lib/libc/inet/inet.3
+++ b/lib/libc/inet/inet.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet.3,v 1.5 2012/07/25 14:51:15 ginsbach Exp $
+.\"	$NetBSD: inet.3,v 1.6 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1990, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -277,7 +277,7 @@ or in compressed form:
 ::FFFF:129.144.52.38
 .Ed
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 The constant
 .Dv INADDR_NONE
 is returned by
--- a/lib/libc/inet/inet6_option_space.3
+++ b/lib/libc/inet/inet6_option_space.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_option_space.3,v 1.3 2010/03/22 19:30:54 joerg Exp $
+.\"	$NetBSD: inet6_option_space.3,v 1.4 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_option_space.3,v 1.7 2000/05/17 14:32:13 itojun Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993
@ -392,7 +392,7 @@ is not
 .Sh EXAMPLES
 RFC 2292 gives comprehensive examples in chapter 6.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 .Fn inet6_option_init
 and
 .Fn inet6_option_append
--- a/lib/libc/inet/inet6_rthdr_space.3
+++ b/lib/libc/inet/inet6_rthdr_space.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_rthdr_space.3,v 1.3 2017/07/03 21:32:49 wiz Exp $
+.\"	$NetBSD: inet6_rthdr_space.3,v 1.4 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_rthdr_space.3,v 1.8 2000/05/17 14:30:15 itojun Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993
@ -267,7 +267,7 @@ to maintain consistency with the terminology and figures in RFC 2460.
 .Sh EXAMPLES
 RFC 2292 gives comprehensive examples in chapter 8.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 .Fn inet6_rthdr_space
 returns 0 on errors.
 .Pp
--- a/lib/libc/net/gethostbyname.3
+++ b/lib/libc/net/gethostbyname.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: gethostbyname.3,v 1.29 2013/08/19 07:18:42 christos Exp $
+.\"	$NetBSD: gethostbyname.3,v 1.30 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -216,7 +216,7 @@ parameter.
 .Bl -tag -width /etc/hosts -compact
 .It Pa /etc/hosts
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Error return status from
 .Fn gethostbyent ,
 .Fn gethostbyname ,
--- a/lib/libc/net/getnetent.3
+++ b/lib/libc/net/getnetent.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: getnetent.3,v 1.16 2018/02/21 14:11:09 uwe Exp $
+.\"	$NetBSD: getnetent.3,v 1.17 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -118,7 +118,7 @@ Network numbers are supplied in host byte order.
 .Bl -tag -width /etc/networks -compact
 .It Pa /etc/networks
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Null pointer
 .Dv ( NULL )
 returned on
--- a/lib/libc/net/inet6_opt_init.3
+++ b/lib/libc/net/inet6_opt_init.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_opt_init.3,v 1.2 2014/01/04 15:37:26 wiz Exp $
+.\"	$NetBSD: inet6_opt_init.3,v 1.3 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_opt_init.3,v 1.7 2004/12/27 05:08:23 itojun Exp $
 .\"
 .\" Copyright (C) 2004 WIDE Project.
@ -306,7 +306,7 @@ KAME also provides examples in the
 .Pa advapitest
 directory of its kit.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 All the functions return
 \-1
 on an error.
--- a/lib/libc/net/inet6_option_space.3
+++ b/lib/libc/net/inet6_option_space.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_option_space.3,v 1.17 2010/03/22 19:30:54 joerg Exp $
+.\"	$NetBSD: inet6_option_space.3,v 1.18 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_option_space.3,v 1.7 2000/05/17 14:32:13 itojun Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993
@ -392,7 +392,7 @@ is not
 .Sh EXAMPLES
 RFC 2292 gives comprehensive examples in chapter 6.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 .Fn inet6_option_init
 and
 .Fn inet6_option_append
--- a/lib/libc/net/inet6_rth_space.3
+++ b/lib/libc/net/inet6_rth_space.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_rth_space.3,v 1.2 2014/01/04 15:37:46 wiz Exp $
+.\"	$NetBSD: inet6_rth_space.3,v 1.3 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_rth_space.3,v 1.7 2005/01/05 03:00:44 itojun Exp $
 .\"
 .\" Copyright (C) 2004 WIDE Project.
@ -184,7 +184,7 @@ RFC 3542 gives extensive examples in Section 21, Appendix B.
 .Pp
 KAME also provides examples in the advapitest directory of its kit.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 The
 .Fn inet6_rth_space
 and
--- a/lib/libc/net/inet6_rthdr_space.3
+++ b/lib/libc/net/inet6_rthdr_space.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: inet6_rthdr_space.3,v 1.17 2017/07/03 21:32:49 wiz Exp $
+.\"	$NetBSD: inet6_rthdr_space.3,v 1.18 2022/12/04 01:29:32 uwe Exp $
 .\"	$KAME: inet6_rthdr_space.3,v 1.8 2000/05/17 14:30:15 itojun Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993
@ -267,7 +267,7 @@ to maintain consistency with the terminology and figures in RFC 2460.
 .Sh EXAMPLES
 RFC 2292 gives comprehensive examples in chapter 8.
 .\"
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 .Fn inet6_rthdr_space
 returns 0 on errors.
 .Pp
--- a/lib/libc/net/rcmd.3
+++ b/lib/libc/net/rcmd.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: rcmd.3,v 1.28 2010/03/22 19:30:54 joerg Exp $
+.\"	$NetBSD: rcmd.3,v 1.29 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -258,7 +258,7 @@ When using the
 function, this variable is used as the program to run instead of
 .Xr rcmd 1 .
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 The
 .Fn rcmd
 function
--- a/lib/libc/regex/regex.3
+++ b/lib/libc/regex/regex.3
@ -1,4 +1,4 @@
-.\" $NetBSD: regex.3,v 1.32 2021/03/11 18:49:18 christos Exp $
+.\" $NetBSD: regex.3,v 1.33 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1992, 1993, 1994 Henry Spencer.
 .\" Copyright (c) 1992, 1993, 1994
@ -711,7 +711,7 @@ and
 beginning and ending subexpressions in obsolete
 .Pq Dq basic
 REs are anchors, not ordinary characters.
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Non-zero error codes from
 .Fn regcomp
 and
--- a/lib/libc/rpc/getrpcent.3
+++ b/lib/libc/rpc/getrpcent.3
@ -1,5 +1,5 @@
 .\"	@(#)getrpcent.3n	2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI
-.\"	$NetBSD: getrpcent.3,v 1.14 2004/08/16 10:18:27 wiz Exp $
+.\"	$NetBSD: getrpcent.3,v 1.15 2022/12/04 01:29:32 uwe Exp $
 .\"
 .Dd August 16, 2004
 .Dt GETRPCENT 3
@ -79,7 +79,7 @@ of the file until a matching rpc program name or
 program number is found, or until end-of-file is encountered.
 .Sh FILES
 .Pa /etc/rpc
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 A
 .Dv NULL
 pointer is returned on
--- a/lib/libc/stdlib/getopt.3
+++ b/lib/libc/stdlib/getopt.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: getopt.3,v 1.35 2017/07/03 21:32:50 wiz Exp $
+.\"	$NetBSD: getopt.3,v 1.36 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1988, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -195,7 +195,7 @@ while ((ch = getopt(argc, argv, "bf:")) != -1) {
 argc -= optind;
 argv += optind;
 .Ed
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 If the
 .Fn getopt
 function encounters a character not found in the string
--- a/lib/libc/stdlib/jemalloc.3
+++ b/lib/libc/stdlib/jemalloc.3
@ -1,4 +1,4 @@
-.\" $NetBSD: jemalloc.3,v 1.11 2021/12/05 14:25:04 rillig Exp $
+.\" $NetBSD: jemalloc.3,v 1.12 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1980, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -314,7 +314,7 @@ on calls to these functions:
 .Bd -literal -offset indent
 _malloc_options = "X";
 .Ed
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 If any of the memory allocation/deallocation functions detect an error or
 warning condition, a message will be printed to file descriptor
 .Dv STDERR_FILENO .
--- a/lib/libc/stdlib/random.3
+++ b/lib/libc/stdlib/random.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: random.3,v 1.22 2017/07/03 21:32:50 wiz Exp $
+.\"	$NetBSD: random.3,v 1.23 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1983, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -159,7 +159,7 @@ generator is greater than
 .if t 2\u\s769\s10\d,
 .if n 2**69
 which should be sufficient for most purposes.
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 If
 .Fn initstate
 is called with less than 8 bytes of state information, or if
--- a/lib/libc/sys/intro.2
+++ b/lib/libc/sys/intro.2
@ -1,4 +1,4 @@
-.\"	$NetBSD: intro.2,v 1.61 2020/03/08 22:09:42 mgorny Exp $
+.\"	$NetBSD: intro.2,v 1.62 2022/12/04 01:29:32 uwe Exp $
 .\"
 .\" Copyright (c) 1980, 1983, 1986, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@ -45,7 +45,7 @@ their error returns, and other common definitions and concepts.
 .\".Sy System call restart
 .\".Pp
 .\"<more later...>
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Nearly all of the system calls provide an error number in the external
 variable
 .Va errno .
--- a/lib/libcompat/4.1/stty.3
+++ b/lib/libcompat/4.1/stty.3
@ -26,7 +26,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     from: @(#)stty.3	8.1 (Berkeley) 6/4/93
-.\"	$NetBSD: stty.3,v 1.10 2019/09/01 23:42:19 sevan Exp $
+.\"	$NetBSD: stty.3,v 1.11 2022/12/04 01:29:32 uwe Exp $
 .\"
 .Dd September 2, 2019
 .Dt STTY 3
@ -76,11 +76,8 @@ See
 and
 .Xr tty 4
 for an explanation.
-.Sh DIAGNOSTICS
-If the call is successful 0 is returned, otherwise \-1 is
-returned and the global variable
-.Va errno
-contains the reason for the failure.
+.Sh RETURN VALUES
+.Rv -std gtty stty
 .Sh SEE ALSO
 .Xr ioctl 2 ,
 .Xr tty 4
--- a/lib/libcompat/4.3/re_comp.3
+++ b/lib/libcompat/4.3/re_comp.3
@ -26,7 +26,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     from: @(#)re_comp.3	8.1 (Berkeley) 6/4/93
-.\"	$NetBSD: re_comp.3,v 1.12 2015/08/11 18:15:41 dholland Exp $
+.\"	$NetBSD: re_comp.3,v 1.13 2022/12/04 01:29:32 uwe Exp $
 .\"
 .Dd June 4, 1993
 .Dt RE_COMP 3
@ -92,7 +92,7 @@ they are terminated by
 The regular expressions recognized are described in the manual entry for
 .Xr ed 1 ,
 given the above difference.
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 The
 .Fn re_exec
 function
--- a/lib/librmt/rmtops.3
+++ b/lib/librmt/rmtops.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: rmtops.3,v 1.15 2017/07/03 21:32:51 wiz Exp $
+.\"	$NetBSD: rmtops.3,v 1.16 2022/12/04 01:29:33 uwe Exp $
 .\"
 .Dd October 16, 2001
 .Dt RMTOPS 3
@ -127,7 +127,7 @@ and must have the same calling conventions as
 .It Pa /usr/lib/librmt.a
 remote tape library
 .El
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 Several of these routines will return \-1 and set
 .Va errno
 to EOPNOTSUPP, if they are given a remote file name or a file descriptor
--- a/lib/librt/aio_read.3
+++ b/lib/librt/aio_read.3
@ -1,4 +1,4 @@
-.\" $NetBSD: aio_read.3,v 1.5 2017/07/03 21:32:51 wiz Exp $
+.\" $NetBSD: aio_read.3,v 1.6 2022/12/04 01:29:33 uwe Exp $
 .\"
 .\" Copyright (c) 1998 Terry Lambert
 .\" All rights reserved.
@ -110,8 +110,6 @@ is past the offset maximum for
 no I/O will occur.
 .Sh RETURN VALUES
 .Rv -std aio_read
-.Sh DIAGNOSTICS
-None.
 .Sh ERRORS
 The
 .Fn aio_read
--- a/lib/libutil/getmntopts.3
+++ b/lib/libutil/getmntopts.3
@ -1,4 +1,4 @@
-.\"	$NetBSD: getmntopts.3,v 1.14 2017/07/03 21:32:51 wiz Exp $
+.\"	$NetBSD: getmntopts.3,v 1.15 2022/12/04 01:29:33 uwe Exp $
 .\"
 .\" Copyright (c) 1994
 .\"	The Regents of the University of California.  All rights reserved.
@ -255,7 +255,7 @@ if (mp == NULL)
 val = getmntoptnum(mp, "rsize");
 freemntopts(mp);
 .Ed
-.Sh DIAGNOSTICS
+.Sh RETURN VALUES
 If the external integer variable
 .Va getmnt_silent
 is zero then the