mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

builtin/show-ref: explicitly spell out different modes in synopsis

Browse Source 
The synopsis treats the `--verify` and the implicit mode the same. They
are slightly different though:

    - They accept different sets of flags.

    - The implicit mode accepts patterns while the `--verify` mode
      accepts references.

Split up the synopsis for these two modes such that we can disambiguate
those differences.

While at it, drop "--quiet" from the pattern mode's synopsis. It does
not make a lot of sense to list patterns, but squelch the listing output
itself. The description for "--quiet" is adapted accordingly.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Patrick Steinhardt
2023-10-31 09:16:50 +01:00
committed by Junio C Hamano
parent 199970e72f
commit 1307d5e86f
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/git-show-ref.txt
View File

@ -8,9 +8,12 @@ git-show-ref - List references in a local repository
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git show-ref' [-q | --quiet] [--verify] [--head] [-d | --dereference] 'git show-ref' [--head] [-d | --dereference]
[-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags] [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags]
[--heads] [--] [<pattern>...] [--heads] [--] [<pattern>...]
'git show-ref' --verify [-q | --quiet] [-d | --dereference]
[-s | --hash[=<n>]] [--abbrev[=<n>]]
[--] [<ref>...]
'git show-ref' --exclude-existing[=<pattern>] 'git show-ref' --exclude-existing[=<pattern>]
DESCRIPTION DESCRIPTION
@ -70,8 +73,8 @@ OPTIONS
-q:: -q::
--quiet:: --quiet::
Do not print any results to stdout. When combined with `--verify`, this Do not print any results to stdout. Can be used with `--verify` to
can be used to silently check if a reference exists. silently check if a reference exists.
--exclude-existing[=<pattern>]:: --exclude-existing[=<pattern>]::

5
builtin/show-ref.c
View File

@ -11,9 +11,12 @@
#include "parse-options.h" #include "parse-options.h"
static const char * const show_ref_usage[] = { static const char * const show_ref_usage[] = {
N_("git show-ref [-q | --quiet] [--verify] [--head] [-d | --dereference]\n" N_("git show-ref [--head] [-d | --dereference]\n"
" [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags]\n" " [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags]\n"
" [--heads] [--] [<pattern>...]"), " [--heads] [--] [<pattern>...]"),
N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n"
" [-s | --hash[=<n>]] [--abbrev[=<n>]]\n"
" [--] [<ref>...]"),
N_("git show-ref --exclude-existing[=<pattern>]"), N_("git show-ref --exclude-existing[=<pattern>]"),
NULL NULL
}; };