aboutsummaryrefslogtreecommitdiffstats
path: root/man3
diff options
context:
space:
mode:
authorMichael Kerrisk <mtk.manpages@gmail.com>2021-01-07 07:50:50 +0100
committerMichael Kerrisk <mtk.manpages@gmail.com>2021-01-07 14:27:27 +0100
commit855d489a7f90cfeaae45c55f80a65dc2135aaa75 (patch)
tree4abe8c4d7939f1411d3560bae3ca889c9db2959c /man3
parent3cf2958737d292a2e5205f0ed662d70f4e3c9187 (diff)
downloadman-pages-855d489a7f90cfeaae45c55f80a65dc2135aaa75.tar.gz
Various pages: Standardize wording around setting of 'errno' on error
In the RETURN VALUE sections, a number of different wordings are used in to describe the fact that 'errno' is set on error. There's no reason for the difference in wordings, since the same thing is being described in each case. Switch to a standard wording that is the same as FreeBSD and similar to the wording used in POSIX.1. In this change, "to indicate the cause of the error" is changed to "to indicate the error". Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man3')
-rw-r--r--man3/bindresvport.32
-rw-r--r--man3/ctime.32
-rw-r--r--man3/dirfd.32
-rw-r--r--man3/duplocale.32
-rw-r--r--man3/fpathconf.32
-rw-r--r--man3/get_phys_pages.32
-rw-r--r--man3/getlogin.32
-rw-r--r--man3/getspnam.32
-rw-r--r--man3/hsearch.34
-rw-r--r--man3/inet_net_pton.34
-rw-r--r--man3/newlocale.32
-rw-r--r--man3/posix_memalign.32
-rw-r--r--man3/pthread_mutex_consistent.32
-rw-r--r--man3/random.32
-rw-r--r--man3/random_r.32
-rw-r--r--man3/scandir.32
-rw-r--r--man3/setenv.32
-rw-r--r--man3/shm_open.32
-rw-r--r--man3/siginterrupt.32
-rw-r--r--man3/sigsetops.32
-rw-r--r--man3/strdup.32
-rw-r--r--man3/sysconf.32
-rw-r--r--man3/tempnam.32
-rw-r--r--man3/timegm.32
-rw-r--r--man3/uselocale.32
-rw-r--r--man3/usleep.32
-rw-r--r--man3/wcsdup.32
27 files changed, 29 insertions, 29 deletions
diff --git a/man3/bindresvport.3 b/man3/bindresvport.3
index 9bcecd047a..805a784cd5 100644
--- a/man3/bindresvport.3
+++ b/man3/bindresvport.3
@@ -70,7 +70,7 @@ has no way to return the port number actually allocated.
.BR bindresvport ()
returns 0 on success; otherwise \-1 is returned and
.I errno
-set to indicate the cause of the error.
+is set to indicate the error.
.SH ERRORS
.BR bindresvport ()
can fail for any of the same reasons as
diff --git a/man3/ctime.3 b/man3/ctime.3
index b06640a610..3aeb1c6920 100644
--- a/man3/ctime.3
+++ b/man3/ctime.3
@@ -311,7 +311,7 @@ returns the value
The remaining functions return NULL on error.
On error,
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.SH ERRORS
.TP
.B EOVERFLOW
diff --git a/man3/dirfd.3 b/man3/dirfd.3
index e38831ba0c..7a9ad353fe 100644
--- a/man3/dirfd.3
+++ b/man3/dirfd.3
@@ -64,7 +64,7 @@ On success,
returns a file descriptor (a nonnegative integer).
On error, \-1 is returned, and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.SH ERRORS
POSIX.1-2008 specifies two errors,
neither of which is returned by the current
diff --git a/man3/duplocale.3 b/man3/duplocale.3
index 751ab5bf52..bf473c28ad 100644
--- a/man3/duplocale.3
+++ b/man3/duplocale.3
@@ -66,7 +66,7 @@ On error, it returns
.IR "(locale_t)\ 0",
and sets
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B ENOMEM
diff --git a/man3/fpathconf.3 b/man3/fpathconf.3
index 7cca6f256f..e51d0643ca 100644
--- a/man3/fpathconf.3
+++ b/man3/fpathconf.3
@@ -176,7 +176,7 @@ The return value of these functions is one of the following:
.IP * 3
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error
+is set to indicate the error
(for example,
.BR EINVAL ,
indicating that
diff --git a/man3/get_phys_pages.3 b/man3/get_phys_pages.3
index 72bdae72c0..55935128f9 100644
--- a/man3/get_phys_pages.3
+++ b/man3/get_phys_pages.3
@@ -47,7 +47,7 @@ On success,
these functions return a nonnegative value as given in DESCRIPTION.
On failure, they return \-1 and set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B ENOSYS
diff --git a/man3/getlogin.3 b/man3/getlogin.3
index cebb2232d1..f3d4e01a2d 100644
--- a/man3/getlogin.3
+++ b/man3/getlogin.3
@@ -107,7 +107,7 @@ precisely because the user can set \fBLOGNAME\fP arbitrarily.
returns a pointer to the username when successful,
and NULL on failure, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.BR getlogin_r ()
returns 0 when successful, and nonzero on failure.
.SH ERRORS
diff --git a/man3/getspnam.3 b/man3/getspnam.3
index d7d781c768..a92627fc41 100644
--- a/man3/getspnam.3
+++ b/man3/getspnam.3
@@ -208,7 +208,7 @@ are available or if an error occurs during processing.
The functions which have \fIint\fP as the return value return 0 for
success and \-1 for failure, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.PP
For the nonreentrant functions, the return value may point to static area,
and may be overwritten by subsequent calls to these functions.
diff --git a/man3/hsearch.3 b/man3/hsearch.3
index a4d1a6422d..a2b00af215 100644
--- a/man3/hsearch.3
+++ b/man3/hsearch.3
@@ -175,7 +175,7 @@ and
return nonzero on success.
They return 0 on error, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.PP
On success,
.BR hsearch ()
@@ -189,7 +189,7 @@ cannot be found in the hash table.
returns nonzero on success, and 0 on error.
In the event of an error, these two functions set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.BR hcreate_r ()
and
diff --git a/man3/inet_net_pton.3 b/man3/inet_net_pton.3
index 94329ff8b7..4c16ea6fe4 100644
--- a/man3/inet_net_pton.3
+++ b/man3/inet_net_pton.3
@@ -125,7 +125,7 @@ On success,
returns the number of bits in the network number.
On error, it returns \-1, and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.PP
On success,
.BR inet_net_ntop ()
@@ -133,7 +133,7 @@ returns
.IR pres .
On error, it returns NULL, and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.SH ERRORS
.TP
.B EAFNOSUPPORT
diff --git a/man3/newlocale.3 b/man3/newlocale.3
index 82f651911f..d95c14ba9a 100644
--- a/man3/newlocale.3
+++ b/man3/newlocale.3
@@ -181,7 +181,7 @@ returns
.IR "(locale_t)\ 0",
and sets
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3
index a7d5d185b0..d063f8932f 100644
--- a/man3/posix_memalign.3
+++ b/man3/posix_memalign.3
@@ -135,7 +135,7 @@ and
.BR pvalloc ()
return a pointer to the allocated memory on success.
On error, NULL is returned, and \fIerrno\fP is set
-to indicate the cause of the error.
+to indicate the error.
.PP
.BR posix_memalign ()
returns zero on success, or one of the error values listed in the
diff --git a/man3/pthread_mutex_consistent.3 b/man3/pthread_mutex_consistent.3
index 2e56e44e0e..13a2163120 100644
--- a/man3/pthread_mutex_consistent.3
+++ b/man3/pthread_mutex_consistent.3
@@ -58,7 +58,7 @@ On success,
.IR pthread_mutex_consistent ()
returns 0.
Otherwise,
-it returns a positive error number to indicate the cause of the error.
+it returns a positive error number to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/random.3 b/man3/random.3
index d77a9b200c..639e9a18c6 100644
--- a/man3/random.3
+++ b/man3/random.3
@@ -138,7 +138,7 @@ On success,
returns a pointer to the previous state array.
On error, it returns NULL, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/random_r.3 b/man3/random_r.3
index 7be96e59dc..5363e5e781 100644
--- a/man3/random_r.3
+++ b/man3/random_r.3
@@ -127,7 +127,7 @@ or be the result of a previous call of
All of these functions return 0 on success.
On error, \-1 is returned, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/scandir.3 b/man3/scandir.3
index 8a11720d55..328c70f690 100644
--- a/man3/scandir.3
+++ b/man3/scandir.3
@@ -178,7 +178,7 @@ function returns the number of directory entries
selected.
On error, \-1 is returned, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.PP
The
.BR alphasort ()
diff --git a/man3/setenv.3 b/man3/setenv.3
index 40f15d1e42..2d61cda6de 100644
--- a/man3/setenv.3
+++ b/man3/setenv.3
@@ -107,7 +107,7 @@ and
functions return zero on success,
or \-1 on error, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/shm_open.3 b/man3/shm_open.3
index 7f18dc1587..580e03cf6c 100644
--- a/man3/shm_open.3
+++ b/man3/shm_open.3
@@ -178,7 +178,7 @@ returns 0 on success, or \-1 on error.
.SH ERRORS
On failure,
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Values which may appear in
.I errno
include the following:
diff --git a/man3/siginterrupt.3 b/man3/siginterrupt.3
index 79b7c153b5..bd4bb36614 100644
--- a/man3/siginterrupt.3
+++ b/man3/siginterrupt.3
@@ -77,7 +77,7 @@ signal number
.I sig
is invalid, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/sigsetops.3 b/man3/sigsetops.3
index 6f3389029e..4c0af1e2af 100644
--- a/man3/sigsetops.3
+++ b/man3/sigsetops.3
@@ -121,7 +121,7 @@ is not a member, and \-1 on error.
.PP
On error, these functions set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/strdup.3 b/man3/strdup.3
index 8900a26d75..65ee22df91 100644
--- a/man3/strdup.3
+++ b/man3/strdup.3
@@ -109,7 +109,7 @@ function returns a pointer to the duplicated
string.
It returns NULL if insufficient memory was available, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B ENOMEM
diff --git a/man3/sysconf.3 b/man3/sysconf.3
index 8c256421d6..05eda466cf 100644
--- a/man3/sysconf.3
+++ b/man3/sysconf.3
@@ -330,7 +330,7 @@ is one of the following:
.IP * 3
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error
+is set to indicate the error
(for example,
.BR EINVAL ,
indicating that
diff --git a/man3/tempnam.3 b/man3/tempnam.3
index cb66c953a7..1c450f375b 100644
--- a/man3/tempnam.3
+++ b/man3/tempnam.3
@@ -102,7 +102,7 @@ On success, the
function returns a pointer to a unique temporary filename.
It returns NULL if a unique name cannot be generated, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B ENOMEM
diff --git a/man3/timegm.3 b/man3/timegm.3
index de0fdc6346..7779e85cc1 100644
--- a/man3/timegm.3
+++ b/man3/timegm.3
@@ -71,7 +71,7 @@ On error, they return the value
.I (time_t)\ \-1
and set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B EOVERFLOW
diff --git a/man3/uselocale.3 b/man3/uselocale.3
index 2018646efb..a3007313bb 100644
--- a/man3/uselocale.3
+++ b/man3/uselocale.3
@@ -81,7 +81,7 @@ On error, it returns
.IR "(locale_t)\ 0" ,
and sets
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.TP
.B EINVAL
diff --git a/man3/usleep.3 b/man3/usleep.3
index 7eaeb820ae..519c5f0f2d 100644
--- a/man3/usleep.3
+++ b/man3/usleep.3
@@ -69,7 +69,7 @@ The
function returns 0 on success.
On error, \-1 is returned, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EINTR
diff --git a/man3/wcsdup.3 b/man3/wcsdup.3
index 823cc18ba4..a6e7a83287 100644
--- a/man3/wcsdup.3
+++ b/man3/wcsdup.3
@@ -56,7 +56,7 @@ On success,
returns a pointer to the new wide-character string.
On error, it returns NULL, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B ENOMEM
generated by cgit 1.2.3-korg (git 2.43.0) at 2025-11-29 09:19:51 +0000