diff options
| author |  Stephen Boyd <bebarino@gmail.com> | 2009-05-23 11:53:12 -0700 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2009-05-25 01:07:25 -0700 |
| commit | 377829201783b8a648e07af6ce7d747e0f45dc19 (patch) | |
| tree | fe989294bc3d3c8adb2c6d6b8fb7702be7c23acf /Documentation | |
| parent | Merge branch 'jc/mktree' into sb/opt-filename (diff) | |
| download | tgif-377829201783b8a648e07af6ce7d747e0f45dc19.tar.xz | |
parse-opts: prepare for OPT_FILENAME
To give OPT_FILENAME the prefix, we pass the prefix to parse_options()
which passes the prefix to parse_options_start() which sets the prefix
member of parse_opts_ctx accordingly. If there isn't a prefix in the
calling context, passing NULL will suffice.
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/technical/api-parse-options.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index b43458eae6..aace5801ca 100644 --- a/Documentation/technical/api-parse-options.txt +++ b/Documentation/technical/api-parse-options.txt @@ -60,13 +60,13 @@ Steps to parse options . in `cmd_foo(int argc, const char **argv, const char *prefix)` call - argc = parse_options(argc, argv, builtin_foo_options, builtin_foo_usage, flags); + argc = parse_options(argc, argv, prefix, builtin_foo_options, builtin_foo_usage, flags); + `parse_options()` will filter out the processed options of `argv[]` and leave the non-option arguments in `argv[]`. `argc` is updated appropriately because of the assignment. + -You can also pass NULL instead of a usage array as fourth parameter of +You can also pass NULL instead of a usage array as the fifth parameter of parse_options(), to avoid displaying a help screen with usage info and option list. This should only be done if necessary, e.g. to implement a limited parser for only a subset of the options that needs to be run |