diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2021-11-06 19:48:51 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-11-09 18:39:11 +0100 |
| commit | 49cbad0edd4dcf53e373e9fd27a9c36a41fb044e (patch) | |
| tree | 1277d6695052d575c0b2278b8f1706062a5db581 /Documentation/git-help.txt | |
| parent | doc: split placeholders as individual tokens (diff) | |
| download | git-49cbad0edd4dcf53e373e9fd27a9c36a41fb044e.tar.xz git-49cbad0edd4dcf53e373e9fd27a9c36a41fb044e.zip | |
doc: express grammar placeholders between angle brackets
This discerns user inputs from verbatim options in the synopsis.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-help.txt')
| -rw-r--r-- | Documentation/git-help.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 44fe8860b3..48eec3ec7c 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -9,12 +9,12 @@ SYNOPSIS -------- [verse] 'git help' [-a|--all [--[no-]verbose]] [-g|--guides] - [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE] + [-i|--info|-m|--man|-w|--web] [<command>|<guide>] DESCRIPTION ----------- -With no options and no COMMAND or GUIDE given, the synopsis of the 'git' +With no options and no '<command>' or '<guide>' given, the synopsis of the 'git' command and a list of the most commonly used Git commands are printed on the standard output. @@ -31,7 +31,7 @@ variables. If an alias is given, git shows the definition of the alias on standard output. To get the manual page for the aliased command, use -`git COMMAND --help`. +`git <command> --help`. Note that `git --help ...` is identical to `git help ...` because the former is internally converted into the latter. |