aboutsummaryrefslogtreecommitdiffstats
path: root/man2
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 /man2
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 'man2')
-rw-r--r--man2/add_key.22
-rw-r--r--man2/futex.22
-rw-r--r--man2/getpriority.22
-rw-r--r--man2/inotify_rm_watch.22
-rw-r--r--man2/ioctl_userfaultfd.212
-rw-r--r--man2/mmap.24
-rw-r--r--man2/open_by_handle_at.22
-rw-r--r--man2/perfmonctl.22
-rw-r--r--man2/pidfd_getfd.22
-rw-r--r--man2/pidfd_open.22
-rw-r--r--man2/pidfd_send_signal.22
-rw-r--r--man2/poll.22
-rw-r--r--man2/pread.22
-rw-r--r--man2/readahead.22
-rw-r--r--man2/request_key.22
-rw-r--r--man2/sched_setattr.22
-rw-r--r--man2/seccomp.22
-rw-r--r--man2/shmop.24
-rw-r--r--man2/sysinfo.22
-rw-r--r--man2/write.22
20 files changed, 27 insertions, 27 deletions
diff --git a/man2/add_key.2 b/man2/add_key.2
index 0d136e4aa4..3b41580a24 100644
--- a/man2/add_key.2
+++ b/man2/add_key.2
@@ -147,7 +147,7 @@ On success,
returns the serial number of the key it created or updated.
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
.TP
.B EACCES
diff --git a/man2/futex.2 b/man2/futex.2
index 04df4896fb..5f41abaa04 100644
--- a/man2/futex.2
+++ b/man2/futex.2
@@ -1320,7 +1320,7 @@ was invoked via
.BR syscall (2)),
all operations return \-1 and set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.PP
The return value on success depends on the operation,
as described in the following list:
diff --git a/man2/getpriority.2 b/man2/getpriority.2
index 4646ca5332..e3fbeb4f30 100644
--- a/man2/getpriority.2
+++ b/man2/getpriority.2
@@ -123,7 +123,7 @@ On success,
returns the calling thread's nice value, which may be a negative number.
On error, it returns \-1 and sets
.I errno
-to indicate the cause of the error.
+to indicate the error.
.PP
Since a successful call to
.BR getpriority ()
diff --git a/man2/inotify_rm_watch.2 b/man2/inotify_rm_watch.2
index eae66d59d1..459642ebc2 100644
--- a/man2/inotify_rm_watch.2
+++ b/man2/inotify_rm_watch.2
@@ -53,7 +53,7 @@ On success,
returns zero.
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
.TP
.B EBADF
diff --git a/man2/ioctl_userfaultfd.2 b/man2/ioctl_userfaultfd.2
index 14dba42433..945badf089 100644
--- a/man2/ioctl_userfaultfd.2
+++ b/man2/ioctl_userfaultfd.2
@@ -235,7 +235,7 @@ This
operation returns 0 on success.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.TP
.B EFAULT
@@ -333,7 +333,7 @@ This
operation returns 0 on success.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.\" FIXME Is the following error list correct?
.\"
@@ -386,7 +386,7 @@ This
operation returns 0 on success.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.TP
.B EINVAL
@@ -466,7 +466,7 @@ operation returns 0 on success.
In this case, the entire area was copied.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.TP
.B EAGAIN
@@ -570,7 +570,7 @@ operation returns 0 on success.
In this case, the entire area was zeroed.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.TP
.B EAGAIN
@@ -636,7 +636,7 @@ This
operation returns 0 on success.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
Possible errors include:
.TP
.B EINVAL
diff --git a/man2/mmap.2 b/man2/mmap.2
index 30170fbedf..b44a8f1b78 100644
--- a/man2/mmap.2
+++ b/man2/mmap.2
@@ -497,14 +497,14 @@ On error, the value
.IR "(void\ *)\ \-1" )
is returned, and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.PP
On success,
.BR munmap ()
returns 0.
On failure, it returns \-1, and
.I errno
-is set to indicate the cause of the error (probably to
+is set to indicate the error (probably to
.BR EINVAL ).
.SH ERRORS
.TP
diff --git a/man2/open_by_handle_at.2 b/man2/open_by_handle_at.2
index 56228a1ae0..eb2ef1459f 100644
--- a/man2/open_by_handle_at.2
+++ b/man2/open_by_handle_at.2
@@ -282,7 +282,7 @@ returns a file descriptor (a nonnegative integer).
.PP
In the event of an error, both system calls return \-1 and set
.I errno
-to indicate the cause of the error.
+to indicate the error.
.SH ERRORS
.BR name_to_handle_at ()
and
diff --git a/man2/perfmonctl.2 b/man2/perfmonctl.2
index 8c010069d9..1c0197190f 100644
--- a/man2/perfmonctl.2
+++ b/man2/perfmonctl.2
@@ -193,7 +193,7 @@ Reset PMC registers to default values.
returns zero when the operation is successful.
On error, \-1 is returned and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.SH VERSIONS
.BR perfmonctl ()
is available since Linux 2.4.
diff --git a/man2/pidfd_getfd.2 b/man2/pidfd_getfd.2
index 1a1319aaec..636aa46cb1 100644
--- a/man2/pidfd_getfd.2
+++ b/man2/pidfd_getfd.2
@@ -74,7 +74,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
.TP
.B EBADF
diff --git a/man2/pidfd_open.2 b/man2/pidfd_open.2
index b6a3215625..51418d3dbc 100644
--- a/man2/pidfd_open.2
+++ b/man2/pidfd_open.2
@@ -53,7 +53,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
.TP
.B EINVAL
diff --git a/man2/pidfd_send_signal.2 b/man2/pidfd_send_signal.2
index da10c7d0f4..02b8fac4b9 100644
--- a/man2/pidfd_send_signal.2
+++ b/man2/pidfd_send_signal.2
@@ -96,7 +96,7 @@ On success,
returns 0.
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
.TP
.B EBADF
diff --git a/man2/poll.2 b/man2/poll.2
index b45e37f8a5..f32051522c 100644
--- a/man2/poll.2
+++ b/man2/poll.2
@@ -354,7 +354,7 @@ before any file descriptors became read.
.PP
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
.TP
.B EFAULT
diff --git a/man2/pread.2 b/man2/pread.2
index 9f2cabaa7a..0204671428 100644
--- a/man2/pread.2
+++ b/man2/pread.2
@@ -89,7 +89,7 @@ and
.PP
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
.BR pread ()
can fail and set
diff --git a/man2/readahead.2 b/man2/readahead.2
index c551d87714..4f606770e7 100644
--- a/man2/readahead.2
+++ b/man2/readahead.2
@@ -68,7 +68,7 @@ On success,
.BR readahead ()
returns 0; on failure, \-1 is returned, with
.I errno
-set to indicate the cause of the error.
+set to indicate the error.
.SH ERRORS
.TP
.B EBADF
diff --git a/man2/request_key.2 b/man2/request_key.2
index 997c221b7e..89bde01c36 100644
--- a/man2/request_key.2
+++ b/man2/request_key.2
@@ -378,7 +378,7 @@ On success,
returns the serial number of the key it found or caused to be created.
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
.TP
.B EACCES
diff --git a/man2/sched_setattr.2 b/man2/sched_setattr.2
index 3d255f6227..ecbdbffc4a 100644
--- a/man2/sched_setattr.2
+++ b/man2/sched_setattr.2
@@ -303,7 +303,7 @@ and
return 0.
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
.BR sched_getattr ()
and
diff --git a/man2/seccomp.2 b/man2/seccomp.2
index 181e89bfc2..cd1256a196 100644
--- a/man2/seccomp.2
+++ b/man2/seccomp.2
@@ -727,7 +727,7 @@ and
.BR gettid (2).)
On other errors, \-1 is returned, and
.IR errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.SH ERRORS
.BR seccomp ()
can fail for the following reasons:
diff --git a/man2/shmop.2 b/man2/shmop.2
index 111f2f4039..941ea66866 100644
--- a/man2/shmop.2
+++ b/man2/shmop.2
@@ -170,13 +170,13 @@ returns the address of the attached shared memory segment; on error,
.I (void\ *)\ \-1
is returned, and
.I errno
-is set to indicate the cause of the error.
+is set to indicate the error.
.PP
On success,
.BR shmdt ()
returns 0; 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
When
.BR shmat ()
diff --git a/man2/sysinfo.2 b/man2/sysinfo.2
index ab58dae885..eedf0755ff 100644
--- a/man2/sysinfo.2
+++ b/man2/sysinfo.2
@@ -104,7 +104,7 @@ On success,
returns zero.
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
.TP
.B EFAULT
diff --git a/man2/write.2 b/man2/write.2
index 37b251d9f8..b6c42df8a7 100644
--- a/man2/write.2
+++ b/man2/write.2
@@ -98,7 +98,7 @@ see NOTES for the upper limit on Linux.
.SH RETURN VALUE
On success, the number of bytes written is returned.
On error, \-1 is returned, and \fIerrno\fP is set
-to indicate the cause of the error.
+to indicate the error.
.PP
Note that a successful
.BR write ()
generated by cgit 1.2.3-korg (git 2.43.0) at 2025-11-30 00:29:42 +0000