manual: complete example in error message documentation
commit7e7af3496ee4b13366726546dd8b712a698fa5c4
authorRical Jasan <ricaljasan@pacific.net>
Fri, 6 Mar 2015 05:59:49 +0000 (6 00:59 -0500)
committerMike Frysinger <vapier@gentoo.org>
Fri, 6 Mar 2015 05:59:49 +0000 (6 00:59 -0500)
treeaed8bc5f9a31d2246c079b00e461310090d38d20
parent4ca8ddfb05ea7d888347bb96cfa431e0eb7fcd9a
manual: complete example in error message documentation

The manual gives "an example showing how to handle failure to open a
file correctly."  The example function, open_sesame, uses the
newly-introduced strerror function and errno and
program_invocation_short_name variables.  It fails to specify GNU
extensions, however, so attempts to use it in the following way:

    int main (void) {open_sesame ("badname");}

fail during compilation with "error: ‘program_invocation_short_name’
undeclared", indicating the example is incomplete.  The presence of
"#include"s suggest everything neccesary for the function to work should
be present.  For completeness, the example is lacking the following line:

    #define _GNU_SOURCE

as the declarations of program_invocation_*name in errno.h are wrapped
in an "#ifdef __USE_GNU" conditional.

The documentation of the variables is also expanded, adding that their
definition lies in errno.h and noting specifically they are GNU
extensions.
ChangeLog
manual/errno.texi