This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[COMMITTED PATCH] BZ#14218: Reword argp_parse description slightly.
- From: Roland McGrath <roland at hack dot frob dot com>
- To: libc-alpha at sourceware dot org
- Date: Mon, 11 Jun 2012 16:21:59 -0700 (PDT)
- Subject: [COMMITTED PATCH] BZ#14218: Reword argp_parse description slightly.
2012-06-11 Roland McGrath <roland@hack.frob.com>
[BZ #14218]
* manual/argp.texi (Argp): Reword argp_parse description slightly.
diff --git a/manual/argp.texi b/manual/argp.texi
index b372323..097c5c6 100644
--- a/manual/argp.texi
+++ b/manual/argp.texi
@@ -38,13 +38,13 @@ needed in @code{main}.
@deftypefun {error_t} argp_parse (const struct argp *@var{argp}, int @var{argc}, char **@var{argv}, unsigned @var{flags}, int *@var{arg_index}, void *@var{input})
The @code{argp_parse} function parses the arguments in @var{argv}, of
length @var{argc}, using the argp parser @var{argp}. @xref{Argp
-Parsers}.
+Parsers}. Passing a null pointer for @var{argp} is the same as using
+a @code{struct argp} containing all zeros.
-A value of zero is the same as a @code{struct argp}containing all
-zeros. @var{flags} is a set of flag bits that modify the parsing
-behavior. @xref{Argp Flags}. @var{input} is passed through to the argp
-parser @var{argp}, and has meaning defined by @var{argp}. A typical
-usage is to pass a pointer to a structure which is used for specifying
+@var{flags} is a set of flag bits that modify the parsing behavior.
+@xref{Argp Flags}. @var{input} is passed through to the argp parser
+@var{argp}, and has meaning defined by @var{argp}. A typical usage is
+to pass a pointer to a structure which is used for specifying
parameters to the parser and passing back the results.
Unless the @code{ARGP_NO_EXIT} or @code{ARGP_NO_HELP} flags are included