From: Junio C Hamano Date: Thu, 21 Oct 2010 23:26:42 +0000 (-0700) Subject: Merge branch 'sn/doc-opt-notation' into maint X-Git-Tag: v1.7.3.2~1 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/f7bff60de95951d2c82601350cb3771b347e83ee?ds=inline;hp=-c Merge branch 'sn/doc-opt-notation' into maint * 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 --- f7bff60de95951d2c82601350cb3771b347e83ee diff --combined Documentation/git-show-branch.txt index 8dbcf1acd4,bd9f886f97..3b0c88271a --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@@ -12,7 -12,7 +12,7 @@@ SYNOPSI [--current] [--color[=] | --no-color] [--sparse] [--more= | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] - [ | ]... + [( | )...] 'git show-branch' (-g|--reflog)[=[,]] [--list] [] @@@ -32,7 -32,7 +32,7 @@@ no nor is given on the com OPTIONS ------- :: - 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. :: diff --combined Documentation/git-update-index.txt index 26fd8d0df8,a5782a6d14..1ca56c85aa --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@@ -12,7 -12,7 +12,7 @@@ SYNOPSI 'git update-index' [--add] [--remove | --force-remove] [--replace] [--refresh] [-q] [--unmerged] [--ignore-missing] - [--cacheinfo ]* + [(--cacheinfo )...] [--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] - [--] []* + [--] [...] 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 b46c6f6d77,8de86174e4..416d58e201 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@@ -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[=]] [--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=] [--work-tree=] + [-c =] + [--help] [] 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 '' 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 is expected in the same format as listed by 'git config' (subkeys separated by dots). - --exec-path:: + --exec-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/`). 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 diff --combined Documentation/user-manual.txt index 77eb483b07,cb3b98a18c..fc56da677c --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@@ -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 -p [-p ..] + $ git commit-tree -p [(-p )...] ------------------------------------------------- and then giving the reason for the commit on stdin (either through diff --combined git-am.sh index 5f249485df,6184101c2b..de116a29ef --- a/git-am.sh +++ b/git-am.sh @@@ -5,7 -5,7 +5,7 @@@ SUBDIRECTORY_OK=Yes OPTIONS_KEEPDASHDASH= OPTIONS_SPEC="\ - git am [options] [|...] + git am [options] [(|)...] 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