On Fri, Apr 28, 2006 at 07:55:44AM +0200, Michael Kerrisk wrote:
> tags 186307 fixed-upstream
> thanks
>
> Justin,
>
> Below is the draft that I have added to 2.31. I added and changed
> quite a few thinbgs. If you see anything to fix, let me know.
Your #include is missing in the formatted output.
> .SH NAME
> error, error_at_line, error_message_count, error_on_per_line, \
> error_print_progname \- glibc error reporting functions
Thanks, mentioning multiple things was the next bit to add; you might
consider also adding program_invocation_name, but perhaps not..
> \fBconst char *\fIfilename,
Did you intend to add a trailing backslash to this line too?
> The program name printed by
> .BR error ()
> is the value of the global variable
> .IR program_invocation_name
> (which initially has the same value as
> .IR main ()'s
> .IR argv[0] ),
> declared as
> .IR "extern char *program_invocation_name"
> in
> .IR <errno.h>
> if the feature test macro _GNU_SOURCE is defined.
This is a "run on" sentence, and should be somehow split up. This
could perhaps be done at the same time as making a separate sentence
for p-i-n, justifying this as its manpage (although it is declared in
a different header file, so I don't know if I like it..).
{ The program name printed by
{ .BR error ()
{ is the value of the global variable
{ .IR program_invocation_name.
{ .IR program_invocation_name has the the same initial value as
{ .IR main ()'s
{ .IR argv[0] ), and is
{ declared as
{ .IR "extern char *program_invocation_name"
{ in
{ .IR <errno.h>
{ if the feature test macro _GNU_SOURCE is defined.
If you like, I'll patch errno.3 for this, or write a new manpage
(ugh).
> .I filename
> and
> .IR linenum .
> The output produced is as for
> .BR error (),
> except that after the program name are written: a colon, the value of
A better english phrase would be:
except that the output is: the program name, a colon, the value of
> The global variable \fIerror_message_count\fP counts the number of
> messages that have been output by
> \fBerror\fP() and \fBerror_at_line\fP().
Could you document that the glibc manual is, at best, unclear about
the value of that variable? (Lines printed, not times called)
> .SH SEE ALSO
> .BR errno (3),
> .BR perror (3),
> .BR strerror (3),
> .BR err (3),
> .BR exit (3)
Could we keep the reference to the glibc manual? Could you also add
some SEE ALSOs back to error()?
Thanks
Justin
--
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
