Use proper syntax for replaceables in command docs

The standard for command documentation synopses appears to be:

  [...] means optional
  <...> means replaceable
  [<...>] means both optional and replaceable

So fix a number of doc pages that use incorrect variations of the
above.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
pull/500/head
Robert P. J. Day 4 years ago committed by Junio C Hamano
parent e144d126d7
commit de613050ef
  1. 2
      Documentation/git-annotate.txt
  2. 4
      Documentation/git-check-attr.txt
  3. 4
      Documentation/git-check-ignore.txt
  4. 2
      Documentation/git-check-mailmap.txt
  5. 2
      Documentation/git-credential-cache.txt
  6. 2
      Documentation/git-credential-store.txt
  7. 2
      Documentation/git-cvsserver.txt
  8. 26
      Documentation/git-diff.txt
  9. 2
      Documentation/git-fast-export.txt
  10. 2
      Documentation/git-fast-import.txt
  11. 4
      Documentation/git-interpret-trailers.txt
  12. 2
      Documentation/git-pull.txt
  13. 4
      Documentation/git-rebase.txt
  14. 6
      Documentation/git-rev-parse.txt
  15. 2
      Documentation/git-send-email.txt
  16. 2
      Documentation/git-show.txt
  17. 2
      Documentation/git-svn.txt
  18. 2
      Documentation/git-web--browse.txt
  19. 4
      Documentation/gitcli.txt

@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information
SYNOPSIS
--------
[verse]
'git annotate' [options] file [revision]
'git annotate' [<options>] <file> [<revision>]
DESCRIPTION
-----------

@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information
SYNOPSIS
--------
[verse]
'git check-attr' [-a | --all | attr...] [--] pathname...
'git check-attr' --stdin [-z] [-a | --all | attr...]
'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
'git check-attr' --stdin [-z] [-a | --all | <attr>...]
DESCRIPTION
-----------

@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
SYNOPSIS
--------
[verse]
'git check-ignore' [options] pathname...
'git check-ignore' [options] --stdin
'git check-ignore' [<options>] <pathname>...
'git check-ignore' [<options>] --stdin
DESCRIPTION
-----------

@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts
SYNOPSIS
--------
[verse]
'git check-mailmap' [options] <contact>...
'git check-mailmap' [<options>] <contact>...
DESCRIPTION

@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory
SYNOPSIS
--------
-----------------------------
git config credential.helper 'cache [options]'
git config credential.helper 'cache [<options>]'
-----------------------------
DESCRIPTION

@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk
SYNOPSIS
--------
-------------------
git config credential.helper 'store [options]'
git config credential.helper 'store [<options>]'
-------------------
DESCRIPTION

@ -22,7 +22,7 @@ cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
Usage:
[verse]
'git-cvsserver' [options] [pserver|server] [<directory> ...]
'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
OPTIONS
-------

@ -9,11 +9,11 @@ git-diff - Show changes between commits, commit and working tree, etc
SYNOPSIS
--------
[verse]
'git diff' [options] [<commit>] [--] [<path>...]
'git diff' [options] --cached [<commit>] [--] [<path>...]
'git diff' [options] <commit> <commit> [--] [<path>...]
'git diff' [options] <blob> <blob>
'git diff' [options] --no-index [--] <path> <path>
'git diff' [<options>] [<commit>] [--] [<path>...]
'git diff' [<options>] --cached [<commit>] [--] [<path>...]
'git diff' [<options>] <commit> <commit> [--] [<path>...]
'git diff' [<options>] <blob> <blob>
'git diff' [<options>] --no-index [--] <path> <path>
DESCRIPTION
-----------
@ -21,7 +21,7 @@ Show changes between the working tree and the index or a tree, changes
between the index and a tree, changes between two trees, changes between
two blob objects, or changes between two files on disk.
'git diff' [options] [--] [<path>...]::
'git diff' [<options>] [--] [<path>...]::
This form is to view the changes you made relative to
the index (staging area for the next commit). In other
@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
further add to the index but you still haven't. You can
stage these changes by using linkgit:git-add[1].
'git diff' [options] --no-index [--] <path> <path>::
'git diff' [<options>] --no-index [--] <path> <path>::
This form is to compare the given two paths on the
filesystem. You can omit the `--no-index` option when
@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
or when running the command outside a working tree
controlled by Git.
'git diff' [options] --cached [<commit>] [--] [<path>...]::
'git diff' [<options>] --cached [<commit>] [--] [<path>...]::
This form is to view the changes you staged for the next
commit relative to the named <commit>. Typically you
@ -48,7 +48,7 @@ two blob objects, or changes between two files on disk.
<commit> is not given, it shows all staged changes.
--staged is a synonym of --cached.
'git diff' [options] <commit> [--] [<path>...]::
'git diff' [<options>] <commit> [--] [<path>...]::
This form is to view the changes you have in your
working tree relative to the named <commit>. You can
@ -56,18 +56,18 @@ two blob objects, or changes between two files on disk.
branch name to compare with the tip of a different
branch.
'git diff' [options] <commit> <commit> [--] [<path>...]::
'git diff' [<options>] <commit> <commit> [--] [<path>...]::
This is to view the changes between two arbitrary
<commit>.
'git diff' [options] <commit>..<commit> [--] [<path>...]::
'git diff' [<options>] <commit>..<commit> [--] [<path>...]::
This is synonymous to the previous form. If <commit> on
one side is omitted, it will have the same effect as
using HEAD instead.
'git diff' [options] <commit>\...<commit> [--] [<path>...]::
'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
This form is to view the changes on the branch containing
and up to the second <commit>, starting at a common ancestor
@ -87,7 +87,7 @@ and the range notations ("<commit>..<commit>" and
"<commit>\...<commit>") do not mean a range as defined in the
"SPECIFYING RANGES" section in linkgit:gitrevisions[7].
'git diff' [options] <blob> <blob>::
'git diff' [<options>] <blob> <blob>::
This form is to view the differences between the raw
contents of two blob objects.

@ -9,7 +9,7 @@ git-fast-export - Git data exporter
SYNOPSIS
--------
[verse]
'git fast-export [options]' | 'git fast-import'
'git fast-export [<options>]' | 'git fast-import'
DESCRIPTION
-----------

@ -9,7 +9,7 @@ git-fast-import - Backend for fast Git data importers
SYNOPSIS
--------
[verse]
frontend | 'git fast-import' [options]
frontend | 'git fast-import' [<options>]
DESCRIPTION
-----------

@ -8,8 +8,8 @@ git-interpret-trailers - add or parse structured information in commit messages
SYNOPSIS
--------
[verse]
'git interpret-trailers' [options] [(--trailer <token>[(=|:)<value>])...] [<file>...]
'git interpret-trailers' [options] [--parse] [<file>...]
'git interpret-trailers' [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...]
'git interpret-trailers' [<options>] [--parse] [<file>...]
DESCRIPTION
-----------

@ -9,7 +9,7 @@ git-pull - Fetch from and integrate with another repository or a local branch
SYNOPSIS
--------
[verse]
'git pull' [options] [<repository> [<refspec>...]]
'git pull' [<options>] [<repository> [<refspec>...]]
DESCRIPTION

@ -8,9 +8,9 @@ git-rebase - Reapply commits on top of another base tip
SYNOPSIS
--------
[verse]
'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
[<upstream> [<branch>]]
'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
--root [<branch>]
'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch

@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters
SYNOPSIS
--------
[verse]
'git rev-parse' [ --option ] <args>...
'git rev-parse' [<options>] <args>...
DESCRIPTION
-----------
@ -360,7 +360,7 @@ Example
------------
OPTS_SPEC="\
some-command [options] <args>...
some-command [<options>] <args>...
some-command does foo and bar!
--
@ -385,7 +385,7 @@ When `"$@"` is `-h` or `--help` in the above example, the following
usage text would be shown:
------------
usage: some-command [options] <args>...
usage: some-command [<options>] <args>...
some-command does foo and bar!

@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
SYNOPSIS
--------
[verse]
'git send-email' [options] <file|directory|rev-list options>...
'git send-email' [<options>] <file|directory|rev-list options>...
'git send-email' --dump-aliases

@ -9,7 +9,7 @@ git-show - Show various types of objects
SYNOPSIS
--------
[verse]
'git show' [options] [<object>...]
'git show' [<options>] [<object>...]
DESCRIPTION
-----------

@ -8,7 +8,7 @@ git-svn - Bidirectional operation between a Subversion repository and Git
SYNOPSIS
--------
[verse]
'git svn' <command> [options] [arguments]
'git svn' <command> [<options>] [<arguments>]
DESCRIPTION
-----------

@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser
SYNOPSIS
--------
[verse]
'git web{litdd}browse' [OPTIONS] URL/FILE ...
'git web{litdd}browse' [<options>] <url|file>...
DESCRIPTION
-----------

@ -110,8 +110,8 @@ couple of magic command-line options:
+
---------------------------------------------
$ git describe -h
usage: git describe [options] <commit-ish>*
or: git describe [options] --dirty
usage: git describe [<options>] <commit-ish>*
or: git describe [<options>] --dirty
--contains find the tag that comes after the commit
--debug debug search strategy on stderr

Loading…
Cancel
Save