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

Alejandro Colomar
2022-11-17T00:27:01Z

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

Hi Thomas,

You missed a few comments in v3. Please check below.
But mostly looks good.

Cheers,
Alex

On 11/17/22 01:19, Alejandro Colomar wrote:
>> 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..f125afb32
>> --- /dev/null
>> +++ b/man3const/EXIT_SUCCESS.3const
>> @@ -0,0 +1,59 @@
>> +.\" 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
>
> I prefer 2 spaces between the macro name and the expansion, so please one more
> space before the quote.

this

>
>> +.BR "#define EXIT_FAILURE "  /* nonzero */
>
> "/* nonzero */" needs to be quoted too.

this

>
>> +.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
>> +.BR exit ()
>
> .BR exit (3)

this

>
>> +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)
>
> Also interesting:
>
> .BR sysexits.h (3head)
>
> Cheers,
>
> Alex