From: Junio C Hamano Date: Tue, 8 Apr 2014 19:00:08 +0000 (-0700) Subject: Merge branch 'ib/rev-parse-parseopt-argh' X-Git-Tag: v2.0.0-rc0~17 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/ed15e20ba36eaf85453915ef5130a770caa8d3e7?ds=inline;hp=-c Merge branch 'ib/rev-parse-parseopt-argh' Finishing touch to a new topic scheduled for 2.0. * ib/rev-parse-parseopt-argh: rev-parse: fix typo in example on manpage --- ed15e20ba36eaf85453915ef5130a770caa8d3e7 diff --combined Documentation/git-rev-parse.txt index c452f33a36,377d9d7235..987395d22a --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@@ -290,14 -290,14 +290,14 @@@ The lines after the separator describe Each line of options has this format: ------------ -*? SP+ help LF +*? SP+ help LF ------------ -``:: +``:: its format is the short option character, then the long option name separated by a comma. Both parts are not required, though at least one is necessary. `h,help`, `dry-run` and `f` are all three correct - ``. + ``. ``:: `` are of `*`, `=`, `?` or `!`. @@@ -313,11 -313,11 +313,11 @@@ * Use `!` to not make the corresponding negated long option available. -``:: - ``, if specified, is used as a name of the argument in the - help output, for options that take arguments. `` is - terminated by the first whitespace. When you need to use space in the - argument hint use dash instead. +``:: + ``, if specified, is used as a name of the argument in the + help output, for options that take arguments. `` is + terminated by the first whitespace. It is customary to use a + dash to separate words in a multi-word argument hint. The remainder of the line, after stripping the spaces, is used as the help associated to the option. @@@ -363,7 -363,7 +363,7 @@@ usage: some-command [options] .. -h, --help show the help --foo some nifty option --foo --bar ... some cool option --bar with an argument - --bar another cool option --baz with a named argument + --baz another cool option --baz with a named argument --qux[=] qux may take a path argument but has meaning by itself An option group Header