Fix documentation syntax of optional arguments in short options.
When an argument for an option is optional, like in -n from git-tag, puting a space between the option and the argument is interpreted as a missing argument for the option plus an isolated argument. Documentation now reflects the need to write the parameter following the option -n, as in "git tag -nARG", for instance. Signed-off-by: Carlos Rica <jasampler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
ee5a317e01
commit
3f36cbbaaf
@ -11,7 +11,7 @@ SYNOPSIS
|
||||
[verse]
|
||||
'git-tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <name> [<head>]
|
||||
'git-tag' -d <name>...
|
||||
'git-tag' [-n [<num>]] -l [<pattern>]
|
||||
'git-tag' [-n[<num>]] -l [<pattern>]
|
||||
'git-tag' -v <name>...
|
||||
|
||||
DESCRIPTION
|
||||
@ -54,7 +54,7 @@ OPTIONS
|
||||
-v::
|
||||
Verify the gpg signature of the given tag names.
|
||||
|
||||
-n <num>::
|
||||
-n<num>::
|
||||
<num> specifies how many lines from the annotation, if any,
|
||||
are printed when using -l.
|
||||
The default is not to print any annotation lines.
|
||||
|
@ -16,7 +16,7 @@
|
||||
static const char * const git_tag_usage[] = {
|
||||
"git-tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
|
||||
"git-tag -d <tagname>...",
|
||||
"git-tag -l [-n [<num>]] [<pattern>]",
|
||||
"git-tag -l [-n[<num>]] [<pattern>]",
|
||||
"git-tag -v <tagname>...",
|
||||
NULL
|
||||
};
|
||||
|
@ -330,7 +330,7 @@ void usage_with_options_internal(const char * const *usagestr,
|
||||
switch (opts->type) {
|
||||
case OPTION_INTEGER:
|
||||
if (opts->flags & PARSE_OPT_OPTARG)
|
||||
pos += fprintf(stderr, " [<n>]");
|
||||
pos += fprintf(stderr, "[<n>]");
|
||||
else
|
||||
pos += fprintf(stderr, " <n>");
|
||||
break;
|
||||
|
Loading…
Reference in New Issue
Block a user