Hi Petr,
> Subject: Re: [PATCH v2 1/2] Unify error wording
I've amended the subject to:
man/: RETURN VALUE: Unify error wording
On Fri, Jul 12, 2024 at 07:22:45PM GMT, Petr Vorel wrote:
> Follow the pattern to replace "to indicate the cause of the error"
> with "to indicate the error".
>
> Suggested-by: Alejandro Colomar <alx@xxxxxxxxxx>
I've added here:
Acked-by: Günther Noack <gnoack@xxxxxxxxxx>
Cc: Mickaël Salaün <mic@xxxxxxxxxxxxxxxxxxx>
Cc: Mickaël Salaün <mic@xxxxxxxxxxx>
> Signed-off-by: Petr Vorel <pvorel@xxxxxxx>
> ---
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=3cea93bf3b6768a3e6fcad0bab69a8b2f361401f>
Patch applied. See minor typo below (I've amended it). Thanks!
Have a lovely day!
Alex
> changes v1->v2:
> New in this version.
>
> man/man2/mount_setattr.2 | 2 +-
> man/man2/seccomp_unotify.2 | 6 +++---
> man/man3/aio_cancel.3 | 2 +-
> man/man3/dlinfo.3 | 2 +-
> man/man3/dlsym.3 | 2 +-
> man/man3/fts.3 | 2 +-
> man/man3/resolver.3 | 2 +-
> man/man3/rpmatch.3 | 2 +-
> 8 files changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/man/man2/mount_setattr.2 b/man/man2/mount_setattr.2
> index f4bbc088b..96d1c5d7f 100644
> --- a/man/man2/mount_setattr.2
> +++ b/man/man2/mount_setattr.2
> @@ -390,7 +390,7 @@ 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/man/man2/seccomp_unotify.2 b/man/man2/seccomp_unotify.2
> index 7092f9491..c7ce0cc74 100644
> --- a/man/man2/seccomp_unotify.2
> +++ b/man/man2/seccomp_unotify.2
> @@ -370,7 +370,7 @@ for details of this structure.
> .P
> On success, this operation returns 0; on failure, \-1 is returned, and
> .I errno
> -is set to indicate the cause of the error.
> +is set to indicate the error.
> This operation can fail with the following errors:
> .TP
> .BR EINVAL " (since Linux 5.5)"
> @@ -612,7 +612,7 @@ field contains a nonzero value.
> .P
> On success, this operation returns 0; on failure, \-1 is returned, and
> .I errno
> -is set to indicate the cause of the error.
> +is set to indicate the error.
> This operation can fail with the following errors:
> .TP
> .B EINPROGRESS
> @@ -790,7 +790,7 @@ operation.
> .P
> On error, \-1 is returned and
> .I errno
> -is set to indicate the cause of the error.
> +is set to indicate the error.
> .P
> This operation can fail with the following errors:
> .TP
> diff --git a/man/man3/aio_cancel.3 b/man/man3/aio_cancel.3
> index 4e32cd2bd..2798eba61 100644
> --- a/man/man3/aio_cancel.3
> +++ b/man/man3/aio_cancel.3
> @@ -81,7 +81,7 @@ All requests had already been completed before the call.
> .TP
> \-1
> An error occurred.
> -The cause of the error can be found by inspecting
> +the error can be found by inspecting
s/t/T/
> .IR errno .
> .SH ERRORS
> .TP
> diff --git a/man/man3/dlinfo.3 b/man/man3/dlinfo.3
> index ada8f643e..8ca490957 100644
> --- a/man/man3/dlinfo.3
> +++ b/man/man3/dlinfo.3
> @@ -198,7 +198,7 @@ NULL is placed in
> On success,
> .BR dlinfo ()
> returns 0.
> -On failure, it returns \-1; the cause of the error can be diagnosed using
> +On failure, it returns \-1; the error can be diagnosed using
> .BR dlerror (3).
> .SH ATTRIBUTES
> For an explanation of the terms used in this section, see
> diff --git a/man/man3/dlsym.3 b/man/man3/dlsym.3
> index 74cc36af2..577e83296 100644
> --- a/man/man3/dlsym.3
> +++ b/man/man3/dlsym.3
> @@ -100,7 +100,7 @@ On success,
> these functions return the address associated with
> .IR symbol .
> On failure, they return NULL;
> -the cause of the error can be diagnosed using
> +the error can be diagnosed using
> .BR dlerror (3).
> .SH ATTRIBUTES
> For an explanation of the terms used in this section, see
> diff --git a/man/man3/fts.3 b/man/man3/fts.3
> index d2c520450..461ff88b0 100644
> --- a/man/man3/fts.3
> +++ b/man/man3/fts.3
> @@ -270,7 +270,7 @@ the
> field contains the error number (i.e., the
> .I errno
> value)
> -specifying the cause of the error.
> +specifying the error.
> Otherwise, the contents of the
> .I fts_errno
> field are undefined.
> diff --git a/man/man3/resolver.3 b/man/man3/resolver.3
> index c54337218..c7dec6a36 100644
> --- a/man/man3/resolver.3
> +++ b/man/man3/resolver.3
> @@ -462,7 +462,7 @@ the global variable
> .I h_errno
> (see
> .BR gethostbyname (3))
> -can be consulted to determine the cause of the error.
> +can be consulted to determine the error.
> .SH FILES
> .TP
> .I /etc/resolv.conf
> diff --git a/man/man3/rpmatch.3 b/man/man3/rpmatch.3
> index 5ef3ca5f9..50f753d38 100644
> --- a/man/man3/rpmatch.3
> +++ b/man/man3/rpmatch.3
> @@ -98,7 +98,7 @@ can fail for any of the reasons that
> .BR regcomp (3)
> or
> .BR regexec (3)
> -can fail; the cause of the error
> +can fail; the error
> is not available from
> .I errno
> or anywhere else, but indicates a
> --
> 2.45.2
>
>
--
<https://www.alejandro-colomar.es/>
Attachment:
signature.asc
Description: PGP signature
