diff options
| author | Junio C Hamano <gitster@pobox.com> | 2014-04-08 12:48:38 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-04-08 12:48:38 -0700 |
| commit | d75148af8e54fe1d655796c75a601e5f79804808 (patch) | |
| tree | 1aed2433cb2e2d7db853a72387f48ec081ce01dc /git-rev-parse.txt | |
| parent | 624dd4c072be7e13e57519eb729f35089386fec9 (diff) | |
| download | git-htmldocs-d75148af8e54fe1d655796c75a601e5f79804808.tar.gz | |
Autogenerated HTML docs for v1.9.1-506-g7bf27
Diffstat (limited to 'git-rev-parse.txt')
| -rw-r--r-- | git-rev-parse.txt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/git-rev-parse.txt b/git-rev-parse.txt index e05e6b359..987395d22 100644 --- a/git-rev-parse.txt +++ b/git-rev-parse.txt @@ -290,14 +290,14 @@ The lines after the separator describe the options. Each line of options has this format: ------------ -<opt_spec><flags>*<arg_hint>? SP+ help LF +<opt-spec><flags>*<arg-hint>? SP+ help LF ------------ -`<opt_spec>`:: +`<opt-spec>`:: 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 - `<opt_spec>`. + `<opt-spec>`. `<flags>`:: `<flags>` are of `*`, `=`, `?` or `!`. @@ -313,11 +313,11 @@ Each line of options has this format: * Use `!` to not make the corresponding negated long option available. -`<arg_hint>`:: - `<arg_hint>`, if specified, is used as a name of the argument in the - help output, for options that take arguments. `<arg_hint>` is - terminated by the first whitespace. When you need to use space in the - argument hint use dash instead. +`<arg-hint>`:: + `<arg-hint>`, if specified, is used as a name of the argument in the + help output, for options that take arguments. `<arg-hint>` 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 @@ usage: some-command [options] <args>... -h, --help show the help --foo some nifty option --foo --bar ... some cool option --bar with an argument - --bar <arg> another cool option --baz with a named argument + --baz <arg> another cool option --baz with a named argument --qux[=<path>] qux may take a path argument but has meaning by itself An option group Header |