diff options
Diffstat (limited to 'Documentation/git-rev-parse.txt')
| -rw-r--r-- | Documentation/git-rev-parse.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index e05e6b3..c452f33 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/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. |