summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2015-01-29 01:46:32 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2015-01-29 01:46:32 +0000
commit62d2081c4784d2ba182ed5151850efe88187868b (patch)
treecaed3241c105775f47f689340427a611b365fc7d /lib
parentdc0fcb69386fa822e0e935c295c6498bcb087a16 (diff)
Use .Rv where appropriate, and move it to RETURN VALUES;
remove .Tn, and a few minor macro adjustments. Patch from Kaspars at Bankovskis dot net.
Diffstat (limited to 'lib')
-rw-r--r--lib/libc/compat-43/killpg.39
-rw-r--r--lib/libc/gen/raise.39
-rw-r--r--lib/libc/gen/statvfs.321
-rw-r--r--lib/libc/gen/time.36
-rw-r--r--lib/libc/gen/utime.313
-rw-r--r--lib/libc/net/getifaddrs.315
-rw-r--r--lib/libc/stdio/remove.311
-rw-r--r--lib/libc/stdlib/qsort.313
-rw-r--r--lib/libc/stdlib/radixsort.312
-rw-r--r--lib/libc/time/strftime.322
10 files changed, 47 insertions, 84 deletions
diff --git a/lib/libc/compat-43/killpg.3 b/lib/libc/compat-43/killpg.3
index 94fda92ebcc..a9c13ccf1e3 100644
--- a/lib/libc/compat-43/killpg.3
+++ b/lib/libc/compat-43/killpg.3
@@ -25,9 +25,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $OpenBSD: killpg.3,v 1.12 2013/06/05 03:39:22 tedu Exp $
+.\" $OpenBSD: killpg.3,v 1.13 2015/01/29 01:46:30 schwarze Exp $
.\"
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt KILLPG 3
.Os
.Sh NAME
@@ -58,10 +58,7 @@ the sender must be the superuser.
As a single special case the continue signal SIGCONT may be sent
to any process with the same session ID as the caller.
.Sh RETURN VALUES
-Upon successful completion, a value of 0 is returned.
-Otherwise, a value of \-1 is returned and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
.Fn killpg
will fail and no signal will be sent if:
diff --git a/lib/libc/gen/raise.3 b/lib/libc/gen/raise.3
index f6d3a479160..1aa2c25918d 100644
--- a/lib/libc/gen/raise.3
+++ b/lib/libc/gen/raise.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: raise.3,v 1.10 2013/06/05 03:39:22 tedu Exp $
+.\" $OpenBSD: raise.3,v 1.11 2015/01/29 01:46:30 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -31,7 +31,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt RAISE 3
.Os
.Sh NAME
@@ -48,10 +48,7 @@ function sends the signal
.Fa sig
to the current thread.
.Sh RETURN VALUES
-Upon successful completion, a value of 0 is returned.
-Otherwise, a value of \-1 is returned and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
.Fn raise
will fail and no signal will be sent if:
diff --git a/lib/libc/gen/statvfs.3 b/lib/libc/gen/statvfs.3
index 225eee2842b..1c36d8ac645 100644
--- a/lib/libc/gen/statvfs.3
+++ b/lib/libc/gen/statvfs.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: statvfs.3,v 1.7 2015/01/19 15:54:11 millert Exp $
+.\" $OpenBSD: statvfs.3,v 1.8 2015/01/29 01:46:30 schwarze Exp $
.\" $NetBSD: statfs.2,v 1.10 1995/06/29 11:40:48 cgd Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)statfs.2 8.3 (Berkeley) 2/11/94
.\"
-.Dd $Mdocdate: January 19 2015 $
+.Dd $Mdocdate: January 29 2015 $
.Dt STATVFS 3
.Os
.Sh NAME
@@ -72,18 +72,15 @@ struct statvfs {
.Ed
.Pp
The fields of type
-.Va fsblkcnt_t
+.Vt fsblkcnt_t
are reported in units of
-.Va f_frsize .
+.Fa f_frsize .
.Pp
.Fn fstatvfs
returns the same information about an open file referenced by descriptor
.Fa fd .
.Sh RETURN VALUES
-Upon successful completion, a value of 0 is returned.
-Otherwise, \-1 is returned and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
.Fn statvfs
fails if one or more of the following are true:
@@ -115,9 +112,7 @@ or
.Fa path
points to an invalid address.
.It Bq Er EIO
-An
-.Tn I/O
-error occurred while reading from or writing to the file system.
+An I/O error occurred while reading from or writing to the file system.
.El
.Pp
.Fn fstatvfs
@@ -130,9 +125,7 @@ is not a valid open file descriptor.
.Fa buf
points to an invalid address.
.It Bq Er EIO
-An
-.Tn I/O
-error occurred while reading from or writing to the file system.
+An I/O error occurred while reading from or writing to the file system.
.El
.Sh SEE ALSO
.Xr df 1 ,
diff --git a/lib/libc/gen/time.3 b/lib/libc/gen/time.3
index 53cfaba40b3..cc1bd4314ff 100644
--- a/lib/libc/gen/time.3
+++ b/lib/libc/gen/time.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: time.3,v 1.15 2013/07/17 05:42:11 schwarze Exp $
+.\" $OpenBSD: time.3,v 1.16 2015/01/29 01:46:30 schwarze Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -31,7 +31,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: July 17 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt TIME 3
.Os
.Sh NAME
@@ -53,7 +53,7 @@ pointer
If
.Fa tloc
is a null pointer, no value is stored.
-.Pp
+.Sh RETURN VALUES
Upon successful completion,
.Fn time
returns the value of time.
diff --git a/lib/libc/gen/utime.3 b/lib/libc/gen/utime.3
index 9a1c2f06add..cea13c16810 100644
--- a/lib/libc/gen/utime.3
+++ b/lib/libc/gen/utime.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: utime.3,v 1.21 2015/01/19 15:54:11 millert Exp $
+.\" $OpenBSD: utime.3,v 1.22 2015/01/29 01:46:30 schwarze Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd $Mdocdate: January 19 2015 $
+.Dd $Mdocdate: January 29 2015 $
.Dt UTIME 3
.Os
.Sh NAME
@@ -83,10 +83,7 @@ The calling process must be the owner of the file or be the superuser.
In either case, the inode change-time of the file is set to the current
time.
.Sh RETURN VALUES
-Upon successful completion, a value of 0 is returned.
-Otherwise, a value of \-1 is returned and
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
.Fn utime
will fail if:
@@ -109,9 +106,7 @@ points outside the process's allocated address space.
.It Bq Er EINVAL
The pathname contains a character with the high-order bit set.
.It Bq Er EIO
-An
-.Tn I/O
-error occurred while reading or writing the affected inode.
+An I/O error occurred while reading or writing the affected inode.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er ENAMETOOLONG
diff --git a/lib/libc/net/getifaddrs.3 b/lib/libc/net/getifaddrs.3
index 0b3538302a1..4abc01481ac 100644
--- a/lib/libc/net/getifaddrs.3
+++ b/lib/libc/net/getifaddrs.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getifaddrs.3,v 1.19 2014/04/07 17:57:56 schwarze Exp $
+.\" $OpenBSD: getifaddrs.3,v 1.20 2015/01/29 01:46:30 schwarze Exp $
.\" BSDI getifaddrs.3,v 2.5 2000/02/23 14:51:59 dab Exp
.\"
.\" Copyright (c) 1995, 1999
@@ -21,7 +21,7 @@
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
-.Dd $Mdocdate: April 7 2014 $
+.Dd $Mdocdate: January 29 2015 $
.Dt GETIFADDRS 3
.Os
.Sh NAME
@@ -43,11 +43,11 @@ function stores a reference to a linked list of the network interfaces
on the local machine in the memory referenced by
.Fa ifap .
The list consists of
-.Nm ifaddrs
+.Vt ifaddrs
structures, as defined in the include file
.In ifaddrs.h .
The
-.Nm ifaddrs
+.Vt ifaddrs
structure contains at least the following entries:
.Bd -literal
struct ifaddrs *ifa_next; /* Pointer to next struct */
@@ -102,7 +102,7 @@ References address family specific data.
For
.Dv AF_LINK
addresses it contains a pointer to the
-.Li struct if_data
+.Vt struct if_data
(as defined in include file
.In net/if.h )
which contains various interface attributes and statistics.
@@ -118,10 +118,7 @@ is dynamically allocated and should be freed using
.Fn freeifaddrs
when no longer needed.
.Sh RETURN VALUES
-Upon successful completion, a value of 0 is returned.
-Otherwise, a value of \-1 is returned and
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
The
.Fn getifaddrs
diff --git a/lib/libc/stdio/remove.3 b/lib/libc/stdio/remove.3
index 82081ef4605..e59c1363170 100644
--- a/lib/libc/stdio/remove.3
+++ b/lib/libc/stdio/remove.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: remove.3,v 1.12 2013/06/05 03:39:23 tedu Exp $
+.\" $OpenBSD: remove.3,v 1.13 2015/01/29 01:46:30 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -33,7 +33,7 @@
.\"
.\" @(#)remove.3 8.1 (Berkeley) 6/4/93
.\"
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt REMOVE 3
.Os
.Sh NAME
@@ -58,12 +58,7 @@ is the equivalent of
Otherwise, it is the equivalent of
.Fn unlink "path" .
.Sh RETURN VALUES
-Upon successful completion,
-.Fn remove
-returns 0.
-Otherwise, \-1 is returned and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
The
.Fn remove
diff --git a/lib/libc/stdlib/qsort.3 b/lib/libc/stdlib/qsort.3
index 4481a96ee4d..36eaed879b5 100644
--- a/lib/libc/stdlib/qsort.3
+++ b/lib/libc/stdlib/qsort.3
@@ -29,9 +29,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $OpenBSD: qsort.3,v 1.17 2013/07/17 05:42:11 schwarze Exp $
+.\" $OpenBSD: qsort.3,v 1.18 2015/01/29 01:46:31 schwarze Exp $
.\"
-.Dd $Mdocdate: July 17 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt QSORT 3
.Os
.Sh NAME
@@ -147,14 +147,7 @@ The
.Fn qsort
function returns no value.
.Pp
-Upon successful completion,
-.Fn heapsort
-and
-.Fn mergesort
-return 0.
-Otherwise, they return \-1 and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std heapsort mergesort
.Sh ERRORS
The
.Fn heapsort
diff --git a/lib/libc/stdlib/radixsort.3 b/lib/libc/stdlib/radixsort.3
index e62f7602706..e706b798b73 100644
--- a/lib/libc/stdlib/radixsort.3
+++ b/lib/libc/stdlib/radixsort.3
@@ -25,9 +25,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $OpenBSD: radixsort.3,v 1.12 2013/06/05 03:39:23 tedu Exp $
+.\" $OpenBSD: radixsort.3,v 1.13 2015/01/29 01:46:31 schwarze Exp $
.\"
-.Dd $Mdocdate: June 5 2013 $
+.Dd $Mdocdate: January 29 2015 $
.Dt RADIXSORT 3
.Os
.Sh NAME
@@ -78,8 +78,7 @@ If
is
.Dv NULL ,
the contents of the array are sorted in ascending order according to the
-.Tn ASCII
-order of the byte strings they reference and
+ASCII order of the byte strings they reference and
.Fa endbyte
has a sorting weight of 0.
.Pp
@@ -101,10 +100,7 @@ These functions are variants of most-significant-byte radix sorting; in
particular, see D.E. Knuth's Algorithm R and section 5.2.5, exercise 10.
They take linear time relative to the number of bytes in the strings.
.Sh RETURN VALUES
-Upon successful completion 0 is returned.
-Otherwise, \-1 is returned and the global variable
-.Va errno
-is set to indicate the error.
+.Rv -std
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL
diff --git a/lib/libc/time/strftime.3 b/lib/libc/time/strftime.3
index 58dbd50c95a..1dd0cd00b23 100644
--- a/lib/libc/time/strftime.3
+++ b/lib/libc/time/strftime.3
@@ -30,9 +30,9 @@
.\" SUCH DAMAGE.
.\"
.\" from: @(#)strftime.3 5.12 (Berkeley) 6/29/91
-.\" $OpenBSD: strftime.3,v 1.33 2014/09/08 01:27:54 schwarze Exp $
+.\" $OpenBSD: strftime.3,v 1.34 2015/01/29 01:46:31 schwarze Exp $
.\"
-.Dd $Mdocdate: September 8 2014 $
+.Dd $Mdocdate: January 29 2015 $
.Dt STRFTIME 3
.Os
.Sh NAME
@@ -64,13 +64,6 @@ and one other character.
No more than
.Fa maxsize
characters will be placed into the array.
-If the total number of resulting characters, including the terminating
-NUL character, is not more than
-.Fa maxsize ,
-.Fn strftime
-returns the number of characters placed in the array, not counting the
-terminating NUL.
-Otherwise, zero is returned.
.Pp
Each conversion specification is replaced by the characters as
follows which are then copied into the buffer.
@@ -127,9 +120,9 @@ is replaced by the month as a decimal number (01\-12).
is replaced by a newline.
.It Cm %p
is replaced by the locale's equivalent of either
-.Dq Tn AM
+.Dq AM
or
-.Dq Tn PM .
+.Dq PM .
.It Cm \&%R
is replaced by the time in the format
.Dq Li %H:%M .
@@ -196,6 +189,13 @@ is replaced by the date and time in
.Xr date 1
format.
.El
+.Sh RETURN VALUES
+If the total number of resulting characters, including the terminating
+NUL character, is not more than
+.Fa maxsize ,
+.Fn strftime
+returns the number of characters placed in the array, not counting the
+terminating NUL. Otherwise, zero is returned.
.Sh SEE ALSO
.Xr date 1 ,
.Xr printf 1 ,