diff options
author | Junio C Hamano <gitster@pobox.com> | 2009-06-01 03:57:42 +0400 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2009-06-01 03:57:42 +0400 |
commit | f9275c68af58e0f65e1557b5109ccbfdbbbc384a (patch) | |
tree | 7479d66d97277f47490de10e204cfcbc0a123885 /Documentation | |
parent | 714cdcd03e2caac6e2dc8d94debc7c800742f546 (diff) | |
parent | df217ed6430efe444a09fffdafd39720ae3f9864 (diff) |
Merge branch 'sb/opt-filename'
* sb/opt-filename:
parse-opts: add OPT_FILENAME and transition builtins
parse-opts: prepare for OPT_FILENAME
Conflicts:
builtin-log.c
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/technical/api-parse-options.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index b43458eae6..50f9e9ac17 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 @@ -167,6 +167,11 @@ There are some macros to easily define options: and the result will be put into `var`. See 'Option Callbacks' below for a more elaborate description. +`OPT_FILENAME(short, long, &var, description)`:: + Introduce an option with a filename argument. + The filename will be prefixed by passing the filename along with + the prefix argument of `parse_options()` to `prefix_filename()`. + `OPT_ARGUMENT(long, description)`:: Introduce a long-option argument that will be kept in `argv[]`. |