Skip to contentSkip to conversation

error.3: What happens if status = 0

DISCUSSION Alejandro Colomar (man-pages) 3 participants 3 messages Feb 18, 2021 – Feb 19, 2021 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

Hi Michael,

I think it's not quite clear what happens when status = 0; for error[_at_line](3) from the text of the manual page. From the glibc documentation[1], it seems that error(0, ...) is similar to warn(...), isn't it?

Thanks,

Alex

[1]: <https://www.gnu.org/software/libc/manual/html_node/Error-Messages.html#Error-Messages>

Signature · 3 lines
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
#1 lore raw

Hi,
yes, error(0,...) is a bit like warn(), it returns to the programm.

That supports what my man page says:

" If status has a nonzero value, then error() calls exit(3) to terminate
the program using the given value as the exit status."

may be you want an add on like:

"Otherwise error() returns."

re,
wh
________________________________________
Von: Alejandro Colomar (man-pages) <[email protected]>
Gesendet: Donnerstag, 18. Februar 2021 22:55:13
An: Michael Kerrisk (man-pages)
Cc: [email protected]; [email protected]
Betreff: error.3: What happens if status = 0

Hi Michael,

I think it's not quite clear what happens when status = 0; for error[_at_line](3) from the text of the manual page. From the glibc documentation[1], it seems that error(0, ...) is similar to warn(...), isn't it?

Thanks,

Alex

[1]:
<https://www.gnu.org/software/libc/manual/html_node/Error-Messages.html#Error-Messages>

--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

#2 lore raw

Hi Alex, and Walter,

Quoted 21 lines · Walter Harms

Hi,
yes, error(0,...) is a bit like warn(), it returns to the programm.

That supports what my man page says:

" If status has a nonzero value, then error() calls exit(3) to terminate
the program using the given value as the exit status."

may be you want an add on like:

"Otherwise error() returns."

re,
wh
________________________________________
Von: Alejandro Colomar (man-pages) <[email protected]>
Gesendet: Donnerstag, 18. Februar 2021 22:55:13
An: Michael Kerrisk (man-pages)
Cc: [email protected]; [email protected]
Betreff: error.3: What happens if status = 0

Quoted 6 lines

Hi Michael,

I think it's not quite clear what happens when status = 0; for error[_at_line](3) from the text of the manual page. From the glibc documentation[1], it seems that error(0, ...) is similar to warn(...), isn't it?

Yes, I think so. Justin and I could have been clearer on that when the manual page was originally written. The point is that if status==0, then error() simply returns after printing its message. As Walter notes, the page implies this (see also the text on 'error_message_count'), without saying so outright.

I applied the patch below.

Cheers,

Michael

man3/error.3 +2 -1
index c3b4ccba4..87e454608 100644
@@ -75,7 +75,8 @@ If \fIstatus\fP has a nonzero value, then
 .BR error ()
 calls
 .BR exit (3)
-to terminate the program using the given value as the exit status.
+to terminate the program using the given value as the exit status;
+otherwise it returns after printing the error message.
 .PP
 The
 .BR error_at_line ()
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/