Re: [PATCH] EXIT_SUCCESS.3const EXIT_FAILURE.3const: Add pages

Alejandro Colomar
2022-11-17T00:48:18Z

[-- Attachment #1.1: Type: text/plain, Size: 3092 bytes --]

On 11/17/22 01:36, Thomas Voss wrote:
> Signed-off-by: Thomas Voss <mail@thomasvoss.com>
> ---
> Alright, hopefully this is it. Feels a bit weird not using mdoc(7) for once :P.

Heh. One last minor nitpick.

>
> man3const/EXIT_FAILURE.3const | 1 +
> man3const/EXIT_SUCCESS.3const | 60 +++++++++++++++++++++++++++++++++++
> 2 files changed, 61 insertions(+)
> create mode 100644 man3const/EXIT_FAILURE.3const
> create mode 100644 man3const/EXIT_SUCCESS.3const
>
> diff --git a/man3const/EXIT_FAILURE.3const b/man3const/EXIT_FAILURE.3const
> new file mode 100644
> index 000000000..ba0d62df9
> --- /dev/null
> +++ b/man3const/EXIT_FAILURE.3const
> @@ -0,0 +1 @@
> +.so man3const/EXIT_SUCCESS.3const
> diff --git a/man3const/EXIT_SUCCESS.3const b/man3const/EXIT_SUCCESS.3const
> new file mode 100644
> index 000000000..c0b478e89
> --- /dev/null
> +++ b/man3const/EXIT_SUCCESS.3const
> @@ -0,0 +1,60 @@
> +.\" Copyright (c) 2022 by Thomas Voss <mail@thomasvoss.com>
> +.\"
> +.\" SPDX-License-Identifier: Linux-man-pages-copyleft
> +.\"
> +.\"
> +.TH EXIT_SUCCESS 3const (date) "Linux man-pages (unreleased)"
> +.SH NAME
> +EXIT_SUCCESS, EXIT_FAILURE \- termination status constants
> +.SH LIBRARY
> +Standard C library
> +.RI ( libc )
> +.SH SYNOPSIS
> +.nf
> +.B #include <stdlib.h>
> +.PP
> +.BR "#define EXIT_SUCCESS " 0
> +.BR "#define EXIT_FAILURE " "/* nonzero */"
> +.fi
> +.SH DESCRIPTION
> +.B EXIT_SUCCESS
> +and
> +.B EXIT_FAILURE
> +represent a successful and unsuccessful exit status respectively and can be used
> +as arguments to the

I'd add a comma: s/respectively and/respectively, and/

After that, I'd break the line after the comma (and un-break it after "used").

See man-pages(7):
Use semantic newlines
In the source of a manual page, new sentences should be
started on new lines, long sentences should be split into
lines at clause breaks (commas, semicolons, colons, and
so on), and long clauses should be split at phrase bound‐
aries. This convention, sometimes known as "semantic
newlines", makes it easier to see the effect of patches,
which often operate at the level of individual sentences,
clauses, or phrases.

Cheers,

Alex

> +.BR exit (3)
> +function.
> +.SH CONFORMING TO
> +C99 and later;
> +POSIX.1-2001 and later.
> +.SH EXAMPLES
> +.\" SRC BEGIN (EXIT_SUCCESS.c)
> +.EX
> +#include <stdio.h>
> +#include <stdlib.h>
> +
> +int
> +main(int argc, char *argv[])
> +{
> + FILE *fp;
> +
> + if (argc != 2) {
> + fprintf(stderr, "Usage: %s <file>\en", argv[0]);
> + exit(EXIT_FAILURE);
> + }
> +
> + if ((fp = fopen(argv[1], "r")) == NULL) {
> + perror(argv[1]);
> + exit(EXIT_FAILURE);
> + }
> +
> + /* Other code omitted */
> +
> + fclose(fp);
> + exit(EXIT_SUCCESS);
> +}
> +.EE
> +.\" SRC END
> +.SH SEE ALSO
> +.BR exit (3),
> +.BR sysexits.h (3head)