lib/glibc
1
0
Fork 0
mirror of https://sourceware.org/git/glibc.git synced 2025-10-12 19:04:54 +03:00
Code Activity

manual: Complete @standards in argp.texi.

Browse Source 
* manual/argp.texi (ARGP_HELP_USAGE): Add missing header and
	standard annotation.
	(ARGP_HELP_SHORT_USAGE): Likewise.
	(ARGP_HELP_SEE): Likewise.
	(ARGP_HELP_LONG): Likewise.
	(ARGP_HELP_PRE_DOC): Likewise.
	(ARGP_HELP_POST_DOC): Likewise.
	(ARGP_HELP_DOC): Likewise.
	(ARGP_HELP_BUG_ADDR): Likewise.
	(ARGP_HELP_LONG_ONLY): Likewise.
	(ARGP_HELP_EXIT_ERR): Likewise.
	(ARGP_HELP_EXIT_OK): Likewise.
	(ARGP_HELP_STD_ERR): Likewise.
	(ARGP_HELP_STD_USAGE): Likewise.
	(ARGP_HELP_STD_HELP): Likewise.
This commit is contained in:
Rical Jasan
2017-05-26 03:59:15 -07:00
parent d08a7e4cbe
commit 76b9ffef87
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
ChangeLog
View File

@@ -1,3 +1,21 @@
2017-06-16 Rical Jasan <ricaljasan@pacific.net>
* manual/argp.texi (ARGP_HELP_USAGE): Add missing header and
standard annotation.
(ARGP_HELP_SHORT_USAGE): Likewise.
(ARGP_HELP_SEE): Likewise.
(ARGP_HELP_LONG): Likewise.
(ARGP_HELP_PRE_DOC): Likewise.
(ARGP_HELP_POST_DOC): Likewise.
(ARGP_HELP_DOC): Likewise.
(ARGP_HELP_BUG_ADDR): Likewise.
(ARGP_HELP_LONG_ONLY): Likewise.
(ARGP_HELP_EXIT_ERR): Likewise.
(ARGP_HELP_EXIT_OK): Likewise.
(ARGP_HELP_STD_ERR): Likewise.
(ARGP_HELP_STD_USAGE): Likewise.
(ARGP_HELP_STD_HELP): Likewise.
2017-06-15 Rical Jasan <ricaljasan@pacific.net> 2017-06-15 Rical Jasan <ricaljasan@pacific.net>
* manual/Makefile: Generate summary.texi with summary.pl. Force * manual/Makefile: Generate summary.texi with summary.pl. Force

14
manual/argp.texi
View File

@@ -1092,35 +1092,44 @@ the following flags, or'd together:
@vtable @code @vtable @code
@item ARGP_HELP_USAGE @item ARGP_HELP_USAGE
@standards{GNU, argp.h}
A unix @samp{Usage:} message that explicitly lists all options. A unix @samp{Usage:} message that explicitly lists all options.
@item ARGP_HELP_SHORT_USAGE @item ARGP_HELP_SHORT_USAGE
@standards{GNU, argp.h}
A unix @samp{Usage:} message that displays an appropriate placeholder to A unix @samp{Usage:} message that displays an appropriate placeholder to
indicate where the options go; useful for showing the non-option indicate where the options go; useful for showing the non-option
argument syntax. argument syntax.
@item ARGP_HELP_SEE @item ARGP_HELP_SEE
@standards{GNU, argp.h}
A @samp{Try @dots{} for more help} message; @samp{@dots{}} contains the A @samp{Try @dots{} for more help} message; @samp{@dots{}} contains the
program name and @samp{--help}. program name and @samp{--help}.
@item ARGP_HELP_LONG @item ARGP_HELP_LONG
@standards{GNU, argp.h}
A verbose option help message that gives each option available along A verbose option help message that gives each option available along
with its documentation string. with its documentation string.
@item ARGP_HELP_PRE_DOC @item ARGP_HELP_PRE_DOC
@standards{GNU, argp.h}
The part of the argp parser doc string preceding the verbose option help. The part of the argp parser doc string preceding the verbose option help.
@item ARGP_HELP_POST_DOC @item ARGP_HELP_POST_DOC
@standards{GNU, argp.h}
The part of the argp parser doc string that following the verbose option help. The part of the argp parser doc string that following the verbose option help.
@item ARGP_HELP_DOC @item ARGP_HELP_DOC
@standards{GNU, argp.h}
@code{(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)} @code{(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)}
@item ARGP_HELP_BUG_ADDR @item ARGP_HELP_BUG_ADDR
@standards{GNU, argp.h}
A message that prints where to report bugs for this program, if the A message that prints where to report bugs for this program, if the
@code{argp_program_bug_address} variable contains this information. @code{argp_program_bug_address} variable contains this information.
@item ARGP_HELP_LONG_ONLY @item ARGP_HELP_LONG_ONLY
@standards{GNU, argp.h}
This will modify any output to reflect the @code{ARGP_LONG_ONLY} mode. This will modify any output to reflect the @code{ARGP_LONG_ONLY} mode.
@end vtable @end vtable
@@ -1130,9 +1139,11 @@ printing its output, or terminates the program:
@vtable @code @vtable @code
@item ARGP_HELP_EXIT_ERR @item ARGP_HELP_EXIT_ERR
@standards{GNU, argp.h}
This will terminate the program with @code{exit (argp_err_exit_status)}. This will terminate the program with @code{exit (argp_err_exit_status)}.
@item ARGP_HELP_EXIT_OK @item ARGP_HELP_EXIT_OK
@standards{GNU, argp.h}
This will terminate the program with @code{exit (0)}. This will terminate the program with @code{exit (0)}.
@end vtable @end vtable
@@ -1141,16 +1152,19 @@ standard messages:
@vtable @code @vtable @code
@item ARGP_HELP_STD_ERR @item ARGP_HELP_STD_ERR
@standards{GNU, argp.h}
Assuming that an error message for a parsing error has printed, this Assuming that an error message for a parsing error has printed, this
prints a message on how to get help, and terminates the program with an prints a message on how to get help, and terminates the program with an
error. error.
@item ARGP_HELP_STD_USAGE @item ARGP_HELP_STD_USAGE
@standards{GNU, argp.h}
This prints a standard usage message and terminates the program with an This prints a standard usage message and terminates the program with an
error. This is used when no other specific error messages are error. This is used when no other specific error messages are
appropriate or available. appropriate or available.
@item ARGP_HELP_STD_HELP @item ARGP_HELP_STD_HELP
@standards{GNU, argp.h}
This prints the standard response for a @samp{--help} option, and This prints the standard response for a @samp{--help} option, and
terminates the program successfully. terminates the program successfully.
@end vtable @end vtable