diff options
| author | Carlos Rica <jasampler@gmail.com> | 2008-04-09 13:07:14 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-04-10 00:20:31 -0700 |
| commit | 3f36cbbaaf87b67abafa851e2808735553f92b06 (patch) | |
| tree | ddd8abf256cc0925937be005da0d34b874d3410d | |
| parent | ee5a317e0130ab2db59db97c644576335530512d (diff) | |
| download | git-3f36cbbaaf87b67abafa851e2808735553f92b06.tar.gz git-3f36cbbaaf87b67abafa851e2808735553f92b06.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-tag.txt | 4 | ||||
| -rw-r--r-- | builtin-tag.c | 2 | ||||
| -rw-r--r-- | parse-options.c | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index b62a3d1c5..74b461f66 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -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. diff --git a/builtin-tag.c b/builtin-tag.c index 9a59caf70..95ecfdbab 100644 --- a/builtin-tag.c +++ b/builtin-tag.c @@ -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 }; diff --git a/parse-options.c b/parse-options.c index d9562ba50..59dc9ce6b 100644 --- a/parse-options.c +++ b/parse-options.c @@ -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; |