From ff962a3f1900966d008d6f9eaf32095c42322b9d Mon Sep 17 00:00:00 2001 From: Pierre Habouzit Date: Sun, 2 Mar 2008 09:21:38 +0100 Subject: parse-opt: bring PARSE_OPT_HIDDEN and NONEG to git-rev-parse --parseopt Signed-off-by: Pierre Habouzit Signed-off-by: Junio C Hamano --- Documentation/git-rev-parse.txt | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'Documentation/git-rev-parse.txt') 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: ------------ -? SP+ help LF +* SP+ help LF ------------ ``:: @@ -334,10 +334,17 @@ Each line of options has this format: is necessary. `h,help`, `dry-run` and `f` are all three correct ``. -``:: - an `` tells the option parser if the option has an argument - (`=`), an optional one (`?` though its use is discouraged) or none - (no `` in that case). +``:: + `` 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. -- cgit v1.3