Merge branch 'sn/doc-opt-notation' into maint
authorJunio C Hamano <gitster@pobox.com>
Thu, 21 Oct 2010 23:26:42 +0000 (16:26 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 21 Oct 2010 23:26:42 +0000 (16:26 -0700)
* sn/doc-opt-notation:
Fix {update,checkout}-index usage strings
Put a space between `<' and argument in pack-objects usage string
Remove stray quotes in --pretty and --format documentation
Use parentheses and `...' where appropriate
Fix odd markup in --diff-filter documentation
Use angles for placeholders consistently

1  2 
Documentation/git-show-branch.txt
Documentation/git-update-index.txt
Documentation/git.txt
Documentation/user-manual.txt
git-am.sh
index 8dbcf1acd4b3ebc77f34c59fdccd4349af435611,bd9f886f97bc893f504547e8449e40b03f55885b..3b0c88271a80ad9dfc989dcb44247479f09431bf
@@@ -12,7 -12,7 +12,7 @@@ SYNOPSI
                [--current] [--color[=<when>] | --no-color] [--sparse]
                [--more=<n> | --list | --independent | --merge-base]
                [--no-name | --sha1-name] [--topics]
-               [<rev> | <glob>]...
+               [(<rev> | <glob>)...]
  
  'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
  
@@@ -32,7 -32,7 +32,7 @@@ no <rev> nor <glob> is given on the com
  OPTIONS
  -------
  <rev>::
 -      Arbitrary extended SHA1 expression (see linkgit:gitrevisions[1])
 +      Arbitrary extended SHA1 expression (see linkgit:gitrevisions[7])
        that typically names a branch head or a tag.
  
  <glob>::
index 26fd8d0df8e26380f6e68f8f8381afdf859f4185,a5782a6d1442b4c1860c8e86bf94fa7e00f78fb6..1ca56c85aa66b96dc1774b77ba1e117d93847033
@@@ -12,7 -12,7 +12,7 @@@ SYNOPSI
  'git update-index'
             [--add] [--remove | --force-remove] [--replace]
             [--refresh] [-q] [--unmerged] [--ignore-missing]
-            [--cacheinfo <mode> <object> <file>]*
+            [(--cacheinfo <mode> <object> <file>)...]
             [--chmod=(+|-)x]
             [--assume-unchanged | --no-assume-unchanged]
             [--skip-worktree | --no-skip-worktree]
@@@ -21,7 -21,7 +21,7 @@@
             [--info-only] [--index-info]
             [-z] [--stdin]
             [--verbose]
-            [--] [<file>]*
+            [--] [<file>...]
  
  DESCRIPTION
  -----------
@@@ -144,8 -144,8 +144,8 @@@ you will need to handle the situation m
          Report what is being added and removed from index.
  
  -z::
 -      Only meaningful with `--stdin`; paths are separated with
 -      NUL character instead of LF.
 +      Only meaningful with `--stdin` or `--index-info`; paths are
 +      separated with NUL character instead of LF.
  
  \--::
        Do not interpret any more arguments as options.
diff --combined Documentation/git.txt
index b46c6f6d7729fd88dce586efd0384f2f3635cf30,8de86174e4e8d4670c09001d81448f8993bd0eed..416d58e201910d647a5449fc5a5cf4f562be7d7b
@@@ -9,11 -9,11 +9,11 @@@ git - the stupid content tracke
  SYNOPSIS
  --------
  [verse]
- 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
+ 'git' [--version] [--exec-path[=<path>]] [--html-path]
      [-p|--paginate|--no-pager] [--no-replace-objects]
-     [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
-     [-c name=value]
-     [--help] COMMAND [ARGS]
+     [--bare] [--git-dir=<path>] [--work-tree=<path>]
+     [-c <name>=<value>]
+     [--help] <command> [<args>]
  
  DESCRIPTION
  -----------
@@@ -28,7 -28,7 +28,7 @@@ also want to read linkgit:gitcvs-migrat
  the link:user-manual.html[Git User's Manual] for a more in-depth
  introduction.
  
- The COMMAND is either a name of a Git command (see below) or an alias
+ The '<command>' is either a name of a Git command (see below) or an alias
  as defined in the configuration file (see linkgit:git-config[1]).
  
  Formatted and hyperlinked version of the latest git
@@@ -252,7 -252,7 +252,7 @@@ help ...`
        The <name> is expected in the same format as listed by
        'git config' (subkeys separated by dots).
  
- --exec-path::
+ --exec-path[=<path>]::
        Path to wherever your core git programs are installed.
        This can also be controlled by setting the GIT_EXEC_PATH
        environment variable. If no path is given, 'git' will print
@@@ -495,7 -495,7 +495,7 @@@ HEAD:
        (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
  
  For a more complete list of ways to spell object names, see
 -"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
 +"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
  
  
  File/Directory Structure
index 77eb483b07bc3b04d5b32199553fff46c11fe7f0,cb3b98a18c974d3bf56108a7604e68396fa76976..fc56da677cb0ed3d9243bfb928686b60df213243
@@@ -397,7 -397,7 +397,7 @@@ is usually a shortcut for the HEAD bran
  For the complete list of paths which git checks for references, and
  the order it uses to decide which to choose when there are multiple
  references with the same shorthand name, see the "SPECIFYING
 -REVISIONS" section of linkgit:gitrevisions[1].
 +REVISIONS" section of linkgit:gitrevisions[7].
  
  [[Updating-a-repository-With-git-fetch]]
  Updating a repository with git fetch
@@@ -568,7 -568,7 +568,7 @@@ We have seen several ways of naming com
        - HEAD: refers to the head of the current branch
  
  There are many more; see the "SPECIFYING REVISIONS" section of the
 -linkgit:gitrevisions[1] man page for the complete list of ways to
 +linkgit:gitrevisions[7] man page for the complete list of ways to
  name revisions.  Some examples:
  
  -------------------------------------------------
@@@ -909,7 -909,7 +909,7 @@@ commits reachable from some head but no
  $ gitk $( git show-ref --heads ) --not  $( git show-ref --tags )
  -------------------------------------------------
  
 -(See linkgit:gitrevisions[1] for explanations of commit-selecting
 +(See linkgit:gitrevisions[7] for explanations of commit-selecting
  syntax such as `--not`.)
  
  [[making-a-release]]
@@@ -1635,7 -1635,7 +1635,7 @@@ you've checked out
  The reflogs are kept by default for 30 days, after which they may be
  pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
  how to control this pruning, and see the "SPECIFYING REVISIONS"
 -section of linkgit:gitrevisions[1] for details.
 +section of linkgit:gitrevisions[7] for details.
  
  Note that the reflog history is very different from normal git history.
  While normal history is shared by every repository that works on the
@@@ -2171,14 -2171,11 +2171,14 @@@ $ git push mytree releas
  
  Now to apply some patches from the community.  Think of a short
  snappy name for a branch to hold this patch (or related group of
 -patches), and create a new branch from the current tip of Linus's
 -branch:
 +patches), and create a new branch from a recent stable tag of
 +Linus's branch. Picking a stable base for your branch will:
 +1) help you: by avoiding inclusion of unrelated and perhaps lightly
 +tested changes
 +2) help future bug hunters that use "git bisect" to find problems
  
  -------------------------------------------------
 -$ git checkout -b speed-up-spinlocks origin
 +$ git checkout -b speed-up-spinlocks v2.6.35
  -------------------------------------------------
  
  Now you apply the patch(es), run some tests, and commit the change(s).  If
@@@ -3853,7 -3850,7 +3853,7 @@@ You create a commit object by giving i
  state at the time of the commit, and a list of parents:
  
  -------------------------------------------------
- $ git commit-tree <tree> -p <parent> [-p <parent2> ..]
+ $ git commit-tree <tree> -p <parent> [(-p <parent2>)...]
  -------------------------------------------------
  
  and then giving the reason for the commit on stdin (either through
diff --combined git-am.sh
index 5f249485df230bed0d2a620104369260b0ac8b66,6184101c2b0a6c4661210b6615b1ffcc1d1c2215..de116a29ef091a23f60603a28f1260ba60f054ac
+++ b/git-am.sh
@@@ -5,7 -5,7 +5,7 @@@
  SUBDIRECTORY_OK=Yes
  OPTIONS_KEEPDASHDASH=
  OPTIONS_SPEC="\
- git am [options] [<mbox>|<Maildir>...]
+ git am [options] [(<mbox>|<Maildir>)...]
  git am [options] (--resolved | --skip | --abort)
  --
  i,interactive   run interactively
@@@ -137,7 -137,7 +137,7 @@@ It does not apply to blobs recorded in 
      export GITHEAD_$his_tree
      if test -n "$GIT_QUIET"
      then
 -          export GIT_MERGE_VERBOSITY=0
 +          GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
      fi
      git-merge-recursive $orig_tree -- HEAD $his_tree || {
            git rerere $allow_rerere_autoupdate