diff options
author | Junio C Hamano <gitster@pobox.com> | 2008-03-09 08:29:59 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2008-03-09 08:29:59 +0300 |
commit | 1cbcefb107776ce2da374697bb4f6e2bd22ff73f (patch) | |
tree | 1d1bcd19b1433a8c18220e083414be93881657ca /Documentation | |
parent | 175f5595511b047a320e5c6163c642ac1fc34681 (diff) | |
parent | 580d5bffdea56dfae1e745dbda94f326bb161274 (diff) |
Merge branch 'ph/parseopt'
* ph/parseopt:
parse-options: new option type to treat an option-like parameter as an argument.
parse-opt: bring PARSE_OPT_HIDDEN and NONEG to git-rev-parse --parseopt
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-rev-parse.txt | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index f02f6bbb49..6513c2efe1 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -325,7 +325,7 @@ The lines after the separator describe the options. Each line of options has this format: ------------ -<opt_spec><arg_spec>? SP+ help LF +<opt_spec><flags>* SP+ help LF ------------ `<opt_spec>`:: @@ -334,10 +334,17 @@ Each line of options has this format: is necessary. `h,help`, `dry-run` and `f` are all three correct `<opt_spec>`. -`<arg_spec>`:: - an `<arg_spec>` tells the option parser if the option has an argument - (`=`), an optional one (`?` though its use is discouraged) or none - (no `<arg_spec>` in that case). +`<flags>`:: + `<flags>` are of `*`, `=`, `?` or `!`. + * Use `=` if the option takes an argument. + + * Use `?` to mean that the option is optional (though its use is discouraged). + + * Use `*` to mean that this option should not be listed in the usage + generated for the `-h` argument. It's shown for `--help-all` as + documented in linkgit:gitcli[5]. + + * Use `!` to not make the corresponding negated long option available. The remainder of the line, after stripping the spaces, is used as the help associated to the option. |