mirror of
https://github.com/git/git
synced 2024-10-30 14:03:28 +00:00
e8e5d294dc
Add a "[no-]" prefix to options without the flag PARSE_OPT_NONEG to
document the fact that you can negate them.
This looks a bit strange for options that already start with "no-", e.g.
for the option --no-name of git show-branch:
--[no-]no-name suppress naming strings
You can actually use --no-no-name as an alias of --name, so the short
help is not wrong. If we strip off any of the "no-"s, we lose either
the ability to see if the remaining one belongs to the documented
variant or to see if it can be negated.
Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
36 lines
1.4 KiB
Text
Executable file
36 lines
1.4 KiB
Text
Executable file
cat <<\EOF
|
|
usage: some-command [options] <args>...
|
|
|
|
some-command does foo and bar!
|
|
|
|
-h, --help show the help
|
|
--[no-]foo some nifty option --foo
|
|
--[no-]bar ... some cool option --bar with an argument
|
|
-b, --[no-]baz a short and long option
|
|
|
|
An option group Header
|
|
-C[...] option C with an optional argument
|
|
-d, --[no-]data[=...] short and long option with an optional argument
|
|
|
|
Argument hints
|
|
-B <arg> short option required argument
|
|
--[no-]bar2 <arg> long option required argument
|
|
-e, --[no-]fuz <with-space>
|
|
short and long option required argument
|
|
-s[<some>] short option optional argument
|
|
--[no-]long[=<data>] long option optional argument
|
|
-g, --[no-]fluf[=<path>]
|
|
short and long option optional argument
|
|
--[no-]longest <very-long-argument-hint>
|
|
a very long argument hint
|
|
--[no-]pair <key=value>
|
|
with an equals sign in the hint
|
|
--[no-]aswitch help te=t contains? fl*g characters!`
|
|
--[no-]bswitch <hint> hint has trailing tab character
|
|
--[no-]cswitch switch has trailing tab character
|
|
--[no-]short-hint <a> with a one symbol hint
|
|
|
|
Extras
|
|
--[no-]extra1 line above used to cause a segfault but no longer does
|
|
|
|
EOF
|