diff options
Diffstat (limited to 'manual/errno.texi')
-rw-r--r-- | manual/errno.texi | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/manual/errno.texi b/manual/errno.texi index 1068be3..d5429a0 100644 --- a/manual/errno.texi +++ b/manual/errno.texi @@ -1322,13 +1322,13 @@ string in the user supplied buffer starting at @var{buf} with the length of @var{n} bytes. At most @var{n} characters are written (including the NUL byte) so it is -up to the user to select the buffer large enough. +up to the user to select a buffer large enough. This function should always be used in multi-threaded programs since there is no way to guarantee the string returned by @code{strerror} really belongs to the last call of the current thread. -This function @code{strerror_r} is a GNU extension and it is declared in +The function @code{strerror_r} is a GNU extension and it is declared in @file{string.h}. @end deftypefun @@ -1471,7 +1471,7 @@ the problem mentioned above that the error reporting function must be called immediately after the function causing the error since otherwise @code{errno} might have a different value. -The @code{error} prints first the program name. If the application +@code{error} prints first the program name. If the application defined a global variable @code{error_print_progname} and points it to a function this function will be called to print the program name. Otherwise the string from the global variable @code{program_name} is @@ -1488,7 +1488,7 @@ afterwards. The function will return unless the @var{status} parameter has a non-zero value. In this case the function will call @code{exit} with the @var{status} value for its parameter and therefore never return. If -@code{error} returns the global variable @code{error_message_count} is +@code{error} returns, the global variable @code{error_message_count} is incremented by one to keep track of the number of errors reported. @end deftypefun @@ -1506,13 +1506,13 @@ incremented by one to keep track of the number of errors reported. @c like error. The @code{error_at_line} function is very similar to the @code{error} -function. The only difference are the additional parameters @var{fname} +function. The only differences are the additional parameters @var{fname} and @var{lineno}. The handling of the other parameters is identical to that of @code{error} except that between the program name and the string generated by the format string additional text is inserted. Directly following the program name a colon, followed by the file name -pointer to by @var{fname}, another colon, and a value of @var{lineno} is +pointed to by @var{fname}, another colon, and the value of @var{lineno} is printed. This additional output of course is meant to be used to locate an error @@ -1523,13 +1523,13 @@ value @code{error_at_line} will avoid printing consecutive messages for the same file and line. Repetition which are not directly following each other are not caught. -Just like @code{error} this function only returned if @var{status} is +Just like @code{error} this function only returns if @var{status} is zero. Otherwise @code{exit} is called with the non-zero value. If -@code{error} returns the global variable @code{error_message_count} is +@code{error} returns, the global variable @code{error_message_count} is incremented by one to keep track of the number of errors reported. @end deftypefun -As mentioned above the @code{error} and @code{error_at_line} functions +As mentioned above, the @code{error} and @code{error_at_line} functions can be customized by defining a variable named @code{error_print_progname}. @@ -1541,7 +1541,7 @@ value the function pointed to is called by @code{error} or @code{error_at_line}. It is expected to print the program name or do something similarly useful. -The function is expected to be print to the @code{stderr} stream and +The function is expected to print to the @code{stderr} stream and must be able to handle whatever orientation the stream has. The variable is global and shared by all threads. @@ -1562,7 +1562,7 @@ The @code{error_one_per_line} variable influences only @code{error_at_line}. Normally the @code{error_at_line} function creates output for every invocation. If @code{error_one_per_line} is set to a non-zero value @code{error_at_line} keeps track of the last -file name and line number for which an error was reported and avoid +file name and line number for which an error was reported and avoids directly following messages for the same file and line. This variable is global and shared by all threads. @end deftypevar |