diff options
| author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-06-30 01:09:04 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-07-01 17:20:15 -0700 |
| commit | b1889c36d85514e5e70462294c561a02c2edfe2b (patch) | |
| tree | 9a171d7e3fb8063c239a2c9c4dcec744a202de07 /Documentation | |
| parent | 46e56e81b3bc91af7071809fbda8dcdec22c4cb1 (diff) | |
| download | git-b1889c36d85514e5e70462294c561a02c2edfe2b.tar.gz | |
Documentation: be consistent about "git-" versus "git "
Since the git-* commands are not installed in $(bindir), using
"git-command <parameters>" in examples in the documentation is
not a good idea. On the other hand, it is nice to be able to
refer to each command using one hyphenated word. (There is no
escaping it, anyway: man page names cannot have spaces in them.)
This patch retains the dash in naming an operation, command,
program, process, or action. Complete command lines that can
be entered at a shell (i.e., without options omitted) are
made to use the dashless form.
The changes consist only of replacing some spaces with hyphens
and vice versa. After a "s/ /-/g", the unpatched and patched
versions are identical.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
131 files changed, 462 insertions, 462 deletions
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 2b0ccb3c93..011a743652 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -8,7 +8,7 @@ git-add - Add file contents to the index SYNOPSIS -------- [verse] -'git-add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p] +'git add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p] [--update | -u] [--refresh] [--ignore-errors] [--] <filepattern>... diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 46544a0769..1296b91172 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -9,11 +9,11 @@ git-am - Apply a series of patches from a mailbox SYNOPSIS -------- [verse] -'git-am' [--signoff] [--keep] [--utf8 | --no-utf8] +'git am' [--signoff] [--keep] [--utf8 | --no-utf8] [--3way] [--interactive] [--binary] [--whitespace=<option>] [-C<n>] [-p<n>] <mbox>|<Maildir>... -'git-am' [--skip | --resolved] +'git am' [--skip | --resolved] DESCRIPTION ----------- diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt index da15379ae5..d05ec197b5 100644 --- a/Documentation/git-annotate.txt +++ b/Documentation/git-annotate.txt @@ -7,7 +7,7 @@ git-annotate - Annotate file lines with commit info SYNOPSIS -------- -git-annotate [options] file [revision] +git annotate [options] file [revision] DESCRIPTION ----------- diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index c5ee636fa9..138f735fd3 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -9,7 +9,7 @@ git-apply - Apply a patch on a git index file and a working tree SYNOPSIS -------- [verse] -'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] +'git apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] [--no-add] [--build-fake-ancestor <file>] [-R | --reverse] [--allow-binary-replacement | --binary] [--reject] [-z] [-pNUM] [-CNUM] [--inaccurate-eof] [--recount] [--cached] diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index 603117c796..ffd01ae549 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -9,7 +9,7 @@ git-archimport - Import an Arch repository into git SYNOPSIS -------- [verse] -'git-archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] +'git archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] <archive/branch>[:<git-branch>] ... DESCRIPTION diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt index 9b5f3ae5ed..1b0d7829f0 100644 --- a/Documentation/git-archive.txt +++ b/Documentation/git-archive.txt @@ -9,7 +9,7 @@ git-archive - Create an archive of files from a named tree SYNOPSIS -------- [verse] -'git-archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>] +'git archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>] [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish> [path...] diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index 3ca0d330ad..fdb040b07f 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -26,7 +26,7 @@ on the subcommand: git bisect log git bisect run <cmd>... -This command uses 'git-rev-list --bisect' option to help drive the +This command uses 'git rev-list --bisect' option to help drive the binary search process to find which change introduced a bug, given an old "good" commit object name and a later "bad" commit object name. diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 8f4fb46685..738249a97e 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -8,7 +8,7 @@ git-blame - Show what revision and author last modified each line of a file SYNOPSIS -------- [verse] -'git-blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m] +'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-p] [-w] [--incremental] [-L n,m] [-S <revs-file>] [-M] [-C] [-C] [--since=<date>] [<rev> | --contents <file>] [--] <file> diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 0fd58083eb..dce8c45ce9 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -8,12 +8,12 @@ git-branch - List, create, or delete branches SYNOPSIS -------- [verse] -'git-branch' [--color | --no-color] [-r | -a] [--merged | --no-merged] +'git branch' [--color | --no-color] [-r | -a] [--merged | --no-merged] [-v [--abbrev=<length> | --no-abbrev]] [--contains <commit>] -'git-branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>] -'git-branch' (-m | -M) [<oldbranch>] <newbranch> -'git-branch' (-d | -D) [-r] <branchname>... +'git branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>] +'git branch' (-m | -M) [<oldbranch>] <newbranch> +'git branch' (-d | -D) [-r] <branchname>... DESCRIPTION ----------- diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index f6a06129ab..9b1b13dbb6 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -9,10 +9,10 @@ git-bundle - Move objects and refs by archive SYNOPSIS -------- [verse] -'git-bundle' create <file> <git-rev-list args> -'git-bundle' verify <file> -'git-bundle' list-heads <file> [refname...] -'git-bundle' unbundle <file> [refname...] +'git bundle' create <file> <git-rev-list args> +'git bundle' verify <file> +'git bundle' list-heads <file> [refname...] +'git bundle' unbundle <file> [refname...] DESCRIPTION ----------- @@ -116,7 +116,7 @@ We set a tag in R1 (lastR2bundle) after the previous such transport, and move it afterwards to help build the bundle. ------------ -$ git-bundle create mybundle master ^lastR2bundle +$ git bundle create mybundle master ^lastR2bundle $ git tag -f lastR2bundle master ------------ @@ -141,8 +141,8 @@ $ git bundle create mybundle master -n 10 Then you move mybundle from A to B, and in R2 on B: ------------ -$ git-bundle verify mybundle -$ git-fetch mybundle master:localRef +$ git bundle verify mybundle +$ git fetch mybundle master:localRef ------------ With something like this in the config in R2: diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index f58013ca60..d35e8a04fe 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -9,8 +9,8 @@ git-cat-file - Provide content or type/size information for repository objects SYNOPSIS -------- [verse] -'git-cat-file' [-t | -s | -e | -p | <type>] <object> -'git-cat-file' [--batch | --batch-check] < <list-of-objects> +'git cat-file' [-t | -s | -e | -p | <type>] <object> +'git cat-file' [--batch | --batch-check] < <list-of-objects> DESCRIPTION ----------- diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index ef16b93982..abe1f1b7dd 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -8,7 +8,7 @@ git-check-attr - Display gitattributes information. SYNOPSIS -------- -'git-check-attr' attr... [--] pathname... +'git check-attr' attr... [--] pathname... DESCRIPTION ----------- diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index c560c0aa6d..12cdfcd376 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -7,7 +7,7 @@ git-check-ref-format - Make sure ref name is well formed SYNOPSIS -------- -'git-check-ref-format' <refname> +'git check-ref-format' <refname> DESCRIPTION ----------- @@ -47,7 +47,7 @@ refname expressions (see linkgit:git-rev-parse[1]). Namely: . colon `:` is used as in `srcref:dstref` to mean "use srcref\'s value and store it in dstref" in fetch and push operations. It may also be used to select a specific object such as with - linkgit:git-cat-file[1] "git-cat-file blob v1.3.3:refs.c". + linkgit:git-cat-file[1] "git cat-file blob v1.3.3:refs.c". GIT diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 676203b2eb..daa6aee558 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -9,7 +9,7 @@ git-checkout-index - Copy files from the index to the working tree SYNOPSIS -------- [verse] -'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] +'git checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] [--stage=<number>|all] [--temp] [-z] [--stdin] @@ -73,16 +73,16 @@ OPTIONS The order of the flags used to matter, but not anymore. -Just doing `git-checkout-index` does nothing. You probably meant -`git-checkout-index -a`. And if you want to force it, you want -`git-checkout-index -f -a`. +Just doing `git checkout-index` does nothing. You probably meant +`git checkout-index -a`. And if you want to force it, you want +`git checkout-index -f -a`. Intuitiveness is not the goal here. Repeatability is. The reason for the "no arguments means no work" behavior is that from scripts you are supposed to be able to do: ---------------- -$ find . -name '*.h' -print0 | xargs -0 git-checkout-index -f -- +$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f -- ---------------- which will force all existing `*.h` files to be replaced with their @@ -91,7 +91,7 @@ force-refresh everything in the index, which was not the point. But since git-checkout-index accepts --stdin it would be faster to use: ---------------- -$ find . -name '*.h' -print0 | git-checkout-index -f -z --stdin +$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin ---------------- The `--` is just a good idea when you know the rest will be filenames; @@ -144,7 +144,7 @@ EXAMPLES To update and refresh only the files already checked out:: + ---------------- -$ git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh +$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh ---------------- Using `git-checkout-index` to "export an entire tree":: @@ -153,10 +153,10 @@ Using `git-checkout-index` to "export an entire tree":: Just read the desired tree into the index, and do: + ---------------- -$ git-checkout-index --prefix=git-export-dir/ -a +$ git checkout-index --prefix=git-export-dir/ -a ---------------- + -`git-checkout-index` will "export" the index into the specified +`git checkout-index` will "export" the index into the specified directory. + The final "/" is important. The exported name is literally just @@ -166,7 +166,7 @@ following example. Export files with a prefix:: + ---------------- -$ git-checkout-index --prefix=.merged- Makefile +$ git checkout-index --prefix=.merged- Makefile ---------------- + This will check out the currently cached copy of `Makefile` diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 3ad9760a4d..fd048ea62e 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -8,8 +8,8 @@ git-checkout - Checkout a branch or paths to the working tree SYNOPSIS -------- [verse] -'git-checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>] -'git-checkout' [<tree-ish>] <paths>... +'git checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>] +'git checkout' [<tree-ish>] <paths>... DESCRIPTION ----------- @@ -23,7 +23,7 @@ options, which will be passed to `git branch`. When <paths> are given, this command does *not* switch branches. It updates the named paths in the working tree from -the index file (i.e. it runs `git-checkout-index -f -u`), or +the index file (i.e. it runs `git checkout-index -f -u`), or from a named commit. In this case, the `-f` and `-b` options are meaningless and giving either of them results in an error. <tree-ish> argument can be @@ -112,7 +112,7 @@ current branch and directly point at the commit named by the tag (`v2.6.18` in the above example). You can use usual git commands while in this state. You can use -`git-reset --hard $othercommit` to further move around, for +`git reset --hard $othercommit` to further move around, for example. You can make changes and create a new commit on top of a detached HEAD. You can even create a merge by using `git merge $othercommit`. diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 5ac9cfb0ef..197ef944ad 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -7,7 +7,7 @@ git-cherry-pick - Apply the change introduced by an existing commit SYNOPSIS -------- -'git-cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] <commit> +'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] <commit> DESCRIPTION ----------- diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt index ef7caf61e1..d63d33b886 100644 --- a/Documentation/git-cherry.txt +++ b/Documentation/git-cherry.txt @@ -7,7 +7,7 @@ git-cherry - Find commits not merged upstream SYNOPSIS -------- -'git-cherry' [-v] <upstream> [<head>] [<limit>] +'git cherry' [-v] <upstream> [<head>] [<limit>] DESCRIPTION ----------- diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 37a82ee4b8..f001f8f8da 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree SYNOPSIS -------- [verse] -'git-clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>... +'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>... DESCRIPTION ----------- diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 7973e6af4c..852b4785da 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -9,7 +9,7 @@ git-clone - Clone a repository into a new directory SYNOPSIS -------- [verse] -'git-clone' [--template=<template_directory>] +'git clone' [--template=<template_directory>] [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>] [--reference <repository>] [--depth <depth>] [--] <repository> [<directory>] diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 728c2fae89..620c45f735 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -8,7 +8,7 @@ git-commit-tree - Create a new commit object SYNOPSIS -------- -'git-commit-tree' <tree> [-p <parent commit>]\* < changelog +'git commit-tree' <tree> [-p <parent commit>]\* < changelog DESCRIPTION ----------- diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 656d4db593..c351424b3f 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -8,7 +8,7 @@ git-commit - Record changes to the repository SYNOPSIS -------- [verse] -'git-commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] +'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [(-c | -C) <commit>] [-F <file> | -m <msg>] [--allow-empty] [--no-verify] [-e] [--author=<author>] [--cleanup=<mode>] [--] [[-i | -o ]<file>...] @@ -207,7 +207,7 @@ When recording your own work, the contents of modified files in your working tree are temporarily stored to a staging area called the "index" with linkgit:git-add[1]. A file can be reverted back, only in the index but not in the working tree, -to that of the last commit with `git-reset HEAD -- <file>`, +to that of the last commit with `git reset HEAD -- <file>`, which effectively reverts `git-add` and prevents the changes to this file from participating in the next commit. After building the state to be committed incrementally with these commands, diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index c90421ee7f..d0a0d30798 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -9,19 +9,19 @@ git-config - Get and set repository or global options SYNOPSIS -------- [verse] -'git-config' [<file-option>] [type] [-z|--null] name [value [value_regex]] -'git-config' [<file-option>] [type] --add name value -'git-config' [<file-option>] [type] --replace-all name [value [value_regex]] -'git-config' [<file-option>] [type] [-z|--null] --get name [value_regex] -'git-config' [<file-option>] [type] [-z|--null] --get-all name [value_regex] -'git-config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex] -'git-config' [<file-option>] --unset name [value_regex] -'git-config' [<file-option>] --unset-all name [value_regex] -'git-config' [<file-option>] --rename-section old_name new_name -'git-config' [<file-option>] --remove-section name -'git-config' [<file-option>] [-z|--null] -l | --list -'git-config' [<file-option>] --get-color name [default] -'git-config' [<file-option>] --get-colorbool name [stdout-is-tty] +'git config' [<file-option>] [type] [-z|--null] name [value [value_regex]] +'git config' [<file-option>] [type] --add name value +'git config' [<file-option>] [type] --replace-all name [value [value_regex]] +'git config' [<file-option>] [type] [-z|--null] --get name [value_regex] +'git config' [<file-option>] [type] [-z|--null] --get-all name [value_regex] +'git config' [<file-option>] [type] [-z|--null] --get-regexp name_regex [value_regex] +'git config' [<file-option>] --unset name [value_regex] +'git config' [<file-option>] --unset-all name [value_regex] +'git config' [<file-option>] --rename-section old_name new_name +'git config' [<file-option>] --remove-section name +'git config' [<file-option>] [-z|--null] -l | --list +'git config' [<file-option>] --get-color name [default] +'git config' [<file-option>] --get-colorbool name [stdout-is-tty] DESCRIPTION ----------- diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt index 1ba85a259a..c069cc8b04 100644 --- a/Documentation/git-count-objects.txt +++ b/Documentation/git-count-objects.txt @@ -7,7 +7,7 @@ git-count-objects - Count unpacked number of objects and their disk consumption SYNOPSIS -------- -'git-count-objects' [-v] +'git count-objects' [-v] DESCRIPTION ----------- @@ -22,7 +22,7 @@ OPTIONS In addition to the number of loose objects and disk space consumed, it reports the number of in-pack objects, number of packs, and number of objects that can be - removed by running `git-prune-packed`. + removed by running `git prune-packed`. Author diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 5fa91e51ad..614c2e5e89 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -8,7 +8,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout SYNOPSIS -------- -'git-cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID +'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID DESCRIPTION @@ -89,14 +89,14 @@ Merge one patch into CVS:: ------------ $ export GIT_DIR=~/project/.git $ cd ~/project_cvs_checkout -$ git-cvsexportcommit -v <commit-sha1> +$ git cvsexportcommit -v <commit-sha1> $ cvs commit -F .msg <files> ------------ Merge one patch into CVS (-c and -w options). The working directory is within the Git Repo:: + ------------ - $ git-cvsexportcommit -v -c -w ~/project_cvs_checkout <commit-sha1> + $ git cvsexportcommit -v -c -w ~/project_cvs_checkout <commit-sha1> ------------ Merge pending patches into CVS automatically -- only if you really know what you are doing:: @@ -104,7 +104,7 @@ Merge pending patches into CVS automatically -- only if you really know what you ------------ $ export GIT_DIR=~/project/.git $ cd ~/project_cvs_checkout -$ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit -c -p -v +$ git cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git cvsexportcommit -c -p -v ------------ Author diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index 2f9b35f622..7890851ded 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -9,7 +9,7 @@ git-cvsimport - Salvage your data out of another SCM people love to hate SYNOPSIS -------- [verse] -'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] +'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] [-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>] [-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>] [-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>] @@ -27,7 +27,7 @@ At least version 2.1 is required. You should *never* do any work of your own on the branches that are created by git-cvsimport. By default initial import will create and populate a "master" branch from the CVS repository's main branch which you're free -to work with; after that, you need to 'git merge' incremental imports, or +to work with; after that, you need to 'git-merge' incremental imports, or any CVS branches, yourself. It is advisable to specify a named remote via -r to separate and protect the incoming branches. diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 3310ae25ff..2401516f01 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -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 ------- diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index b71eb94d54..266458bed8 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -8,7 +8,7 @@ git-daemon - A really simple server for git repositories SYNOPSIS -------- [verse] -'git-daemon' [--verbose] [--syslog] [--export-all] +'git daemon' [--verbose] [--syslog] [--export-all] [--timeout=n] [--init-timeout=n] [--strict-paths] [--base-path=path] [--user-path | --user-path=path] [--interpolated-path=pathtemplate] diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 9f6f483186..b6c86c2aea 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -8,7 +8,7 @@ git-describe - Show the most recent tag that is reachable from a commit SYNOPSIS -------- -'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... +'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>... DESCRIPTION ----------- @@ -78,7 +78,7 @@ EXAMPLES With something like git.git current tree, I get: - [torvalds@g5 git]$ git-describe parent + [torvalds@g5 git]$ git describe parent v1.0.4-14-g2414721 i.e. the current head of my "parent" branch is based on v1.0.4, @@ -94,7 +94,7 @@ of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`). Doing a "git-describe" on a tag-name will just show the tag name: - [torvalds@g5 git]$ git-describe v1.0.4 + [torvalds@g5 git]$ git describe v1.0.4 v1.0.4 With --all, the command can use branch heads as references, so @@ -115,13 +115,13 @@ closest tagname without any suffix: SEARCH STRATEGY --------------- -For each committish supplied "git describe" will first look for +For each committish supplied "git-describe" will first look for a tag which tags exactly that commit. Annotated tags will always be preferred over lightweight tags, and tags with newer dates will always be preferred over tags with older dates. If an exact match is found, its name will be output and searching will stop. -If an exact match was not found "git describe" will walk back +If an exact match was not found "git-describe" will walk back through the commit history to locate an ancestor commit which has been tagged. The ancestor's tag will be output along with an abbreviation of the input committish's SHA1. diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 8a64869d27..378f34964c 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -8,7 +8,7 @@ git-diff-files - Compares files in the working tree and the index SYNOPSIS -------- -'git-diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...] +'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...] DESCRIPTION ----------- diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index f6e844fe61..2474745254 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -8,7 +8,7 @@ git-diff-index - Compares content and mode of blobs between the index and reposi SYNOPSIS -------- -'git-diff-index' [-m] [--cached] [<common diff options>] <tree-ish> [<path>...] +'git diff-index' [-m] [--cached] [<common diff options>] <tree-ish> [<path>...] DESCRIPTION ----------- @@ -57,20 +57,20 @@ some files in the index and are ready to commit. You want to see exactly *what* you are going to commit, without having to write a new tree object and compare it that way, and to do that, you just do - git-diff-index --cached HEAD + git diff-index --cached HEAD Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had done an "git-update-index" to make that effective in the index file. -"git-diff-files" wouldn't show anything at all, since the index file +"git diff-files" wouldn't show anything at all, since the index file matches my working directory. But doing a "git-diff-index" does: - torvalds@ppc970:~/git> git-diff-index --cached HEAD + torvalds@ppc970:~/git> git diff-index --cached HEAD -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c +100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c You can see easily that the above is a rename. -In fact, "git-diff-index --cached" *should* always be entirely equivalent to +In fact, "git diff-index --cached" *should* always be entirely equivalent to actually doing a "git-write-tree" and comparing that. Except this one is much nicer for the case where you just want to check where you are. @@ -98,7 +98,7 @@ show that. So let's say that you have edited `kernel/sched.c`, but have not actually done a "git-update-index" on it yet - there is no "object" associated with the new state, and you get: - torvalds@ppc970:~/v2.6/linux> git-diff-index HEAD + torvalds@ppc970:~/v2.6/linux> git diff-index HEAD *100644->100664 blob 7476bb......->000000...... kernel/sched.c i.e., it shows that the tree has changed, and that `kernel/sched.c` has is diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 56caeb2d26..7d41a0f6cd 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -9,7 +9,7 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object SYNOPSIS -------- [verse] -'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] +'git diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [-c | --cc] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...] @@ -112,13 +112,13 @@ Limiting Output If you're only interested in differences in a subset of files, for example some architecture-specific files, you might do: - git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64 + git diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64 and it will only show you what changed in those two directories. Or if you are searching for what changed in just `kernel/sched.c`, just do - git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c + git diff-tree -r <tree-ish> <tree-ish> kernel/sched.c and it will ignore all differences to other files. @@ -129,7 +129,7 @@ so it can be used to name subdirectories. An example of normal usage is: - torvalds@ppc970:~/git> git-diff-tree 5319e4...... + torvalds@ppc970:~/git> git diff-tree 5319e4...... *100664->100664 blob ac348b.......->a01513....... git-fsck-objects.c which tells you that the last commit changed just one file (it's from diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 7acd428964..c53eba557d 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -8,14 +8,14 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- -'git-diff' [<common diff options>] <commit>{0,2} [--] [<path>...] +'git diff' [<common diff options>] <commit>{0,2} [--] [<path>...] DESCRIPTION ----------- Show changes between two trees, a tree and the working tree, a tree and the index file, or the index file and the working tree. -'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 @@ -27,14 +27,14 @@ If exactly two paths are given, and at least one is untracked, compare the two files / directories. This behavior can be forced by --no-index. -'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 would want comparison with the latest commit, so if you do not give <commit>, it defaults to HEAD. -'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 @@ -42,23 +42,23 @@ forced by --no-index. 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 - of both <commit>. "git-diff A\...B" is equivalent to - "git-diff $(git-merge-base A B) B". You can omit any one + of both <commit>. "git diff A\...B" is equivalent to + "git diff $(git-merge-base A B) B". You can omit any one of <commit>, which has the same effect as using HEAD instead. Just in case if you are doing something exotic, it should be diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index 277a547a02..b21cd77505 100644 --- a/Documentation/git-fast-export.txt +++ b/Documentation/git-fast-export.txt @@ -8,7 +8,7 @@ git-fast-export - Git data exporter SYNOPSIS -------- -'git-fast-export [options]' | 'git-fast-import' +'git fast-export [options]' | 'git fast-import' DESCRIPTION ----------- diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 395c055f95..8881686fa7 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -8,7 +8,7 @@ git-fast-import - Backend for fast Git data importers SYNOPSIS -------- -frontend | 'git-fast-import' [options] +frontend | 'git fast-import' [options] DESCRIPTION ----------- @@ -126,7 +126,7 @@ Parallel Operation ------------------ Like `git-push` or `git-fetch`, imports handled by fast-import are safe to run alongside parallel `git repack -a -d` or `git gc` invocations, -or any other Git operation (including `git prune`, as loose objects +or any other Git operation (including `git-prune`, as loose objects are never used by fast-import). fast-import does not lock the branch or tag refs it is actively importing. @@ -803,7 +803,7 @@ Callers may wish to process the output through a tool such as sed to remove the leading part of the line, for example: ==== - frontend | git-fast-import | sed 's/^progress //' + frontend | git fast-import | sed 's/^progress //' ==== Placing a `progress` command immediately after a `checkpoint` will @@ -851,7 +851,7 @@ An example crash: M 777 inline bob END_OF_INPUT - $ git-fast-import <in + $ git fast-import <in fatal: Corrupt mode: M 777 inline bob fast-import: dumping crash report to .git/fast_import_crash_8434 diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index 282fcaf17f..ff328abd2b 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -8,7 +8,7 @@ git-fetch-pack - Receive missing objects from another repository SYNOPSIS -------- -'git-fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...] +'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...] DESCRIPTION ----------- diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index 489b2b17e6..e4b529710c 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -8,7 +8,7 @@ git-fetch - Download objects and refs from another repository SYNOPSIS -------- -'git-fetch' <options> <repository> <refspec>... +'git fetch' <options> <repository> <refspec>... DESCRIPTION @@ -18,7 +18,7 @@ the objects necessary to complete them. The ref names and their object names of fetched refs are stored in `.git/FETCH_HEAD`. This information is left for a later merge -operation done by "git merge". +operation done by "git-merge". When <refspec> stores the fetched result in tracking branches, the tags that point at these branches are automatically diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index ea77f1fce5..924afb28c3 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -8,7 +8,7 @@ git-filter-branch - Rewrite branches SYNOPSIS -------- [verse] -'git-filter-branch' [--env-filter <command>] [--tree-filter <command>] +'git filter-branch' [--env-filter <command>] [--tree-filter <command>] [--index-filter <command>] [--parent-filter <command>] [--msg-filter <command>] [--commit-filter <command>] [--tag-name-filter <command>] [--subdirectory-filter <directory>] @@ -266,7 +266,7 @@ git filter-branch --msg-filter ' To restrict rewriting to only part of the history, specify a revision range in addition to the new branch name. The new branch name will -point to the top-most revision that a 'git rev-list' of this range +point to the top-most revision that a 'git-rev-list' of this range will print. *NOTE* the changes introduced by the commits, and which are not reverted diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt index 2a7cfb980b..46d4a4acac 100644 --- a/Documentation/git-fmt-merge-msg.txt +++ b/Documentation/git-fmt-merge-msg.txt @@ -9,8 +9,8 @@ git-fmt-merge-msg - Produce a merge commit message SYNOPSIS -------- [verse] -git-fmt-merge-msg [--log | --no-log] <$GIT_DIR/FETCH_HEAD -git-fmt-merge-msg [--log | --no-log] -F <file> +git fmt-merge-msg [--log | --no-log] <$GIT_DIR/FETCH_HEAD +git fmt-merge-msg [--log | --no-log] -F <file> DESCRIPTION ----------- diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index b347bfbb14..29c29f8830 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -8,7 +8,7 @@ git-for-each-ref - Output information on each ref SYNOPSIS -------- [verse] -'git-for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] +'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl] [--sort=<key>]\* [--format=<format>] [<pattern>...] DESCRIPTION @@ -119,7 +119,7 @@ An example directly producing formatted text. Show the most recent ------------ #!/bin/sh -git-for-each-ref --count=3 --sort='-*authordate' \ +git for-each-ref --count=3 --sort='-*authordate' \ --format='From: %(*authorname) %(*authoremail) Subject: %(*subject) Date: %(*authordate) @@ -135,7 +135,7 @@ demonstrating the use of --shell. List the prefixes of all heads:: ------------ #!/bin/sh -git-for-each-ref --shell --format="ref=%(refname)" refs/heads | \ +git for-each-ref --shell --format="ref=%(refname)" refs/heads | \ while read entry do eval "$entry" @@ -189,7 +189,7 @@ Its message reads as: fi ' -eval=`git-for-each-ref --shell --format="$fmt" \ +eval=`git for-each-ref --shell --format="$fmt" \ --sort='*objecttype' \ --sort=-taggerdate \ refs/tags` diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 4dafa39a92..ce1af821b7 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -9,7 +9,7 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-k] [-o <dir> | --stdout] [--thread] +'git format-patch' [-k] [-o <dir> | --stdout] [--thread] [--attach[=<boundary>] | --inline[=<boundary>]] [-s | --signoff] [<common diff options>] [-n | --numbered | -N | --no-numbered] diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt index 6e9f717642..965a8279c1 100644 --- a/Documentation/git-fsck-objects.txt +++ b/Documentation/git-fsck-objects.txt @@ -8,7 +8,7 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the SYNOPSIS -------- -'git-fsck-objects' ... +'git fsck-objects' ... DESCRIPTION ----------- diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index 9846c859cf..c26b40a31f 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -9,7 +9,7 @@ git-fsck - Verifies the connectivity and validity of the objects in the database SYNOPSIS -------- [verse] -'git-fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs] +'git fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs] [--full] [--strict] [--verbose] [--lost-found] [<object>*] DESCRIPTION @@ -79,7 +79,7 @@ that aren't readable from any of the specified head nodes. So for example - git-fsck --unreachable HEAD $(cat .git/refs/heads/*) + git fsck --unreachable HEAD $(cat .git/refs/heads/*) will do quite a _lot_ of verification on the tree. There are a few extra validity tests to be added (make sure that tree objects are diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 6ace615d80..587ce14512 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -8,7 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository SYNOPSIS -------- -'git-gc' [--aggressive] [--auto] [--quiet] +'git gc' [--aggressive] [--auto] [--quiet] DESCRIPTION ----------- @@ -41,7 +41,7 @@ OPTIONS few hundred changesets or so. --auto:: - With this option, `git gc` checks whether any housekeeping is + With this option, `git-gc` checks whether any housekeeping is required; if not, it exits without performing any work. Some git commands run `git gc --auto` after performing operations that could create many loose objects. @@ -89,7 +89,7 @@ how long records of conflicted merge you have not resolved are kept. This defaults to 15 days. The optional configuration variable 'gc.packrefs' determines if -`git gc` runs `git-pack-refs`. This can be set to "nobare" to enable +`git-gc` runs `git-pack-refs`. This can be set to "nobare" to enable it within all non-bare repos or it can be set to a boolean value. This defaults to true. diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt index c13bf98697..5a047b08c9 100644 --- a/Documentation/git-get-tar-commit-id.txt +++ b/Documentation/git-get-tar-commit-id.txt @@ -8,7 +8,7 @@ git-get-tar-commit-id - Extract commit ID from an archive created using git-arch SYNOPSIS -------- -'git-get-tar-commit-id' < <tarfile> +'git get-tar-commit-id' < <tarfile> DESCRIPTION diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 1b646b73f0..cbda116581 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -9,7 +9,7 @@ git-grep - Print lines matching a pattern SYNOPSIS -------- [verse] -'git-grep' [--cached] +'git grep' [--cached] [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp] [-v | --invert-match] [-h|-H] [--full-name] [-E | --extended-regexp] [-G | --basic-regexp] diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index cf3dce8a4a..ca232e0866 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -8,7 +8,7 @@ git-hash-object - Compute object ID and optionally creates a blob from a file SYNOPSIS -------- -'git-hash-object' [-t <type>] [-w] [--stdin | --stdin-paths] [--] <file>... +'git hash-object' [-t <type>] [-w] [--stdin | --stdin-paths] [--] <file>... DESCRIPTION ----------- diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 70fb635291..e7c796155f 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -8,7 +8,7 @@ git-http-fetch - Download from a remote git repository via HTTP SYNOPSIS -------- -'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin] <commit> <url> +'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin] <commit> <url> DESCRIPTION ----------- diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index d69b20549b..aef383e0b1 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt @@ -8,7 +8,7 @@ git-http-push - Push objects over HTTP/DAV to another repository SYNOPSIS -------- -'git-http-push' [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...] +'git http-push' [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...] DESCRIPTION ----------- diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index f4fdc24283..27d3de973f 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -8,7 +8,7 @@ git-imap-send - Dump a mailbox from stdin into an imap folder SYNOPSIS -------- -'git-imap-send' +'git imap-send' DESCRIPTION @@ -20,7 +20,7 @@ files directly. Typical usage is something like: -git-format-patch --signoff --stdout --attach origin | git-imap-send +git format-patch --signoff --stdout --attach origin | git imap-send CONFIGURATION diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index 6409363ae5..902056153e 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -9,8 +9,8 @@ git-index-pack - Build pack index file for an existing packed archive SYNOPSIS -------- [verse] -'git-index-pack' [-v] [-o <index-file>] <pack-file> -'git-index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>] +'git index-pack' [-v] [-o <index-file>] <pack-file> +'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>] [<pack-file>] diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt index 439cabb737..1fd0ff2610 100644 --- a/Documentation/git-init-db.txt +++ b/Documentation/git-init-db.txt @@ -8,7 +8,7 @@ git-init-db - Creates an empty git repository SYNOPSIS -------- -'git-init-db' [-q | --quiet] [--template=<template_directory>] [--shared[=<permissions>]] +'git init-db' [-q | --quiet] [--template=<template_directory>] [--shared[=<permissions>]] DESCRIPTION diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 792643c809..45244737fd 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -8,7 +8,7 @@ git-init - Create an empty git repository or reinitialize an existing one SYNOPSIS -------- -'git-init' [-q | --quiet] [--bare] [--template=<template_directory>] [--shared[=<permissions>]] +'git init' [-q | --quiet] [--bare] [--template=<template_directory>] [--shared[=<permissions>]] OPTIONS @@ -105,8 +105,8 @@ Start a new git repository for an existing code base:: + ---------------- $ cd /path/to/my/codebase -$ git-init <1> -$ git-add . <2> +$ git init <1> +$ git add . <2> ---------------- + <1> prepare /path/to/my/codebase/.git directory diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt index 7da5b8d9a9..522a58d10e 100644 --- a/Documentation/git-instaweb.txt +++ b/Documentation/git-instaweb.txt @@ -8,9 +8,9 @@ git-instaweb - Instantly browse your working repository in gitweb SYNOPSIS -------- [verse] -'git-instaweb' [--local] [--httpd=<httpd>] [--port=<port>] +'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>] [--browser=<browser>] -'git-instaweb' [--start] [--stop] [--restart] +'git instaweb' [--start] [--stop] [--restart] DESCRIPTION ----------- diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index db61bc96c7..cf1ab7beee 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -8,7 +8,7 @@ git-log - Show commit logs SYNOPSIS -------- -'git-log' <option>... +'git log' <option>... DESCRIPTION ----------- diff --git a/Documentation/git-lost-found.txt b/Documentation/git-lost-found.txt index 4dc475e0de..602b8d5d4d 100644 --- a/Documentation/git-lost-found.txt +++ b/Documentation/git-lost-found.txt @@ -7,7 +7,7 @@ git-lost-found - Recover lost refs that luckily have not yet been pruned SYNOPSIS -------- -'git-lost-found' +'git lost-found' DESCRIPTION ----------- diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 560594e25f..adcec3c242 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -9,7 +9,7 @@ git-ls-files - Show information about files in the index and the working tree SYNOPSIS -------- [verse] -'git-ls-files' [-z] [-t] [-v] +'git ls-files' [-z] [-t] [-v] (--[cached|deleted|others|ignored|stage|unmerged|killed|modified])\* (-[c|d|o|i|s|u|k|m])\* [-x <pattern>|--exclude=<pattern>] diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index f92f3ca186..061909d3f4 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository SYNOPSIS -------- [verse] -'git-ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>] +'git ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>] <repository> <refs>... DESCRIPTION diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index d9881fbbbe..1cdec222a1 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -9,7 +9,7 @@ git-ls-tree - List the contents of a tree object SYNOPSIS -------- [verse] -'git-ls-tree' [-d] [-r] [-t] [-l] [-z] +'git ls-tree' [-d] [-r] [-t] [-l] [-z] [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]] <tree-ish> [paths...] diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 6a73b7371a..87cfa45147 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -8,7 +8,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message SYNOPSIS -------- -'git-mailinfo' [-k] [-u | --encoding=<encoding>] <msg> <patch> +'git mailinfo' [-k] [-u | --encoding=<encoding>] <msg> <patch> DESCRIPTION @@ -30,7 +30,7 @@ OPTIONS whitespaces, (3) '[' up to ']', typically '[PATCH]', and then prepends "[PATCH] ". This flag forbids this munging, and is most useful when used to read back - 'git format-patch -k' output. + 'git-format-patch -k' output. -u:: The commit log message, author name and author email are diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt index 9a2aedd480..acd712b1cd 100644 --- a/Documentation/git-mailsplit.txt +++ b/Documentation/git-mailsplit.txt @@ -7,7 +7,7 @@ git-mailsplit - Simple UNIX mbox splitter program SYNOPSIS -------- -'git-mailsplit' [-b] [-f<nn>] [-d<prec>] -o<directory> [--] [<mbox>|<Maildir>...] +'git mailsplit' [-b] [-f<nn>] [-d<prec>] -o<directory> [--] [<mbox>|<Maildir>...] DESCRIPTION ----------- diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index bbe8512397..9105735906 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -8,13 +8,13 @@ git-merge-base - Find as good common ancestors as possible for a merge SYNOPSIS -------- -'git-merge-base' [--all] <commit> <commit> +'git merge-base' [--all] <commit> <commit> DESCRIPTION ----------- "git-merge-base" finds as good a common ancestor as possible between -the two commits. That is, given two commits A and B 'git-merge-base A +the two commits. That is, given two commits A and B 'git merge-base A B' will output a commit which is reachable from both A and B through the parent relationship. diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt index 149f131051..2a683f14e6 100644 --- a/Documentation/git-merge-file.txt +++ b/Documentation/git-merge-file.txt @@ -9,7 +9,7 @@ git-merge-file - Run a three-way file merge SYNOPSIS -------- [verse] -'git-merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]] +'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]] [-p|--stdout] [-q|--quiet] <current-file> <base-file> <other-file> @@ -51,7 +51,7 @@ OPTIONS This option may be given up to three times, and specifies labels to be used in place of the corresponding file names in conflict reports. That is, - `git-merge-file -L x -L y -L z a b c` generates output that + `git merge-file -L x -L y -L z a b c` generates output that looks like it came from files x, y and z instead of from files a, b and c. diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index a0ead2bbf3..fb55e92e3b 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -8,7 +8,7 @@ git-merge-index - Run a merge for files needing merging SYNOPSIS -------- -'git-merge-index' [-o] [-q] <merge-program> (-a | [--] <file>\*) +'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>\*) DESCRIPTION ----------- @@ -53,7 +53,7 @@ original is first. But the argument order to the 3-way merge program Examples: - torvalds@ppc970:~/merge-test> git-merge-index cat MM + torvalds@ppc970:~/merge-test> git merge-index cat MM This is MM from the original tree. # original This is modified MM in the branch A. # merge1 This is modified MM in the branch B. # merge2 @@ -61,7 +61,7 @@ Examples: or - torvalds@ppc970:~/merge-test> git-merge-index cat AA MM + torvalds@ppc970:~/merge-test> git merge-index cat AA MM cat: : No such file or directory This is added AA in the branch A. This is added AA in the branch B. diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt index b785e0f6e0..dbb0c18668 100644 --- a/Documentation/git-merge-tree.txt +++ b/Documentation/git-merge-tree.txt @@ -8,7 +8,7 @@ git-merge-tree - Show three-way merge without touching index SYNOPSIS -------- -'git-merge-tree' <base-tree> <branch1> <branch2> +'git merge-tree' <base-tree> <branch1> <branch2> DESCRIPTION ----------- diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 55bc367479..7e328ea9dc 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -9,9 +9,9 @@ git-merge - Join two or more development histories together SYNOPSIS -------- [verse] -'git-merge' [-n] [--stat] [--no-commit] [--squash] [-s <strategy>]... +'git merge' [-n] [--stat] [--no-commit] [--squash] [-s <strategy>]... [-m <msg>] <remote> <remote>... -'git-merge' <msg> HEAD <remote>... +'git merge' <msg> HEAD <remote>... DESCRIPTION ----------- @@ -60,7 +60,7 @@ A merge is always between the current `HEAD` and one or more commits (usually, branch head or tag), and the index file must exactly match the tree of `HEAD` commit (i.e. the contents of the last commit) when -it happens. In other words, `git-diff --cached HEAD` must +it happens. In other words, `git diff --cached HEAD` must report no changes. [NOTE] @@ -128,7 +128,7 @@ When there are conflicts, these things happen: 3. For conflicting paths, the index file records up to three versions; stage1 stores the version from the common ancestor, stage2 from `HEAD`, and stage3 from the remote branch (you - can inspect the stages with `git-ls-files -u`). The working + can inspect the stages with `git ls-files -u`). The working tree files have the result of "merge" program; i.e. 3-way merge result with familiar conflict markers `<<< === >>>`. @@ -144,7 +144,7 @@ After seeing a conflict, you can do two things: up working tree changes made by 2. and 3.; `git-reset` can be used for this. - * Resolve the conflicts. `git-diff` would report only the + * Resolve the conflicts. `git diff` would report only the conflicting paths because of the above 2. and 3.. Edit the working tree files into a desirable shape, `git-add` or `git-rm` them, to make the index file contain what the merge result diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 83525609c6..fc1b030026 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -7,7 +7,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts SYNOPSIS -------- -'git-mergetool' [--tool=<tool>] [<file>]... +'git mergetool' [--tool=<tool>] [<file>]... DESCRIPTION ----------- @@ -17,7 +17,7 @@ merge conflicts. It is typically run after linkgit:git-merge[1]. If one or more <file> parameters are given, the merge tool program will be run to resolve differences on each file. If no <file> names are -specified, `git mergetool` will run the merge tool program on every file +specified, `git-mergetool` will run the merge tool program on every file with merge conflicts. OPTIONS @@ -27,23 +27,23 @@ OPTIONS Valid merge tools are: kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff + -If a merge resolution program is not specified, `git mergetool` +If a merge resolution program is not specified, `git-mergetool` will use the configuration variable `merge.tool`. If the -configuration variable `merge.tool` is not set, `git mergetool` +configuration variable `merge.tool` is not set, `git-mergetool` will pick a suitable default. + You can explicitly provide a full path to the tool by setting the configuration variable `mergetool.<tool>.path`. For example, you can configure the absolute path to kdiff3 by setting -`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the +`mergetool.kdiff3.path`. Otherwise, `git-mergetool` assumes the tool is available in PATH. + Instead of running one of the known merge tool programs -`git mergetool` can be customized to run an alternative program +`git-mergetool` can be customized to run an alternative program by specifying the command line to invoke in a configration variable `mergetool.<tool>.cmd`. + -When `git mergetool` is invoked with this tool (either through the +When `git-mergetool` is invoked with this tool (either through the `-t` or `--tool` option or the `merge.tool` configuration variable) the configured command line will be invoked with `$BASE` set to the name of a temporary file containing the common base for @@ -57,7 +57,7 @@ merge resolution. If the custom merge tool correctly indicates the success of a merge resolution with its exit code then the configuration variable `mergetool.<tool>.trustExitCode` can be set to `true`. -Otherwise, `git mergetool` will prompt the user to indicate the +Otherwise, `git-mergetool` will prompt the user to indicate the success of the resolution after the custom tool has exited. Author diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index 232bc1a338..8bcc11443d 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -8,7 +8,7 @@ git-mktag - Creates a tag object SYNOPSIS -------- -'git-mktag' < signature_file +'git mktag' < signature_file DESCRIPTION ----------- diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt index 1ddbf00afc..0be32e2612 100644 --- a/Documentation/git-mktree.txt +++ b/Documentation/git-mktree.txt @@ -8,7 +8,7 @@ git-mktree - Build a tree-object from ls-tree formatted text SYNOPSIS -------- -'git-mktree' [-z] +'git mktree' [-z] DESCRIPTION ----------- diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt index 339190600a..9c5660275b 100644 --- a/Documentation/git-mv.txt +++ b/Documentation/git-mv.txt @@ -8,14 +8,14 @@ git-mv - Move or rename a file, a directory, or a symlink SYNOPSIS -------- -'git-mv' <options>... <args>... +'git mv' <options>... <args>... DESCRIPTION ----------- This script is used to move or rename a file, directory or symlink. - git-mv [-f] [-n] <source> <destination> - git-mv [-f] [-n] [-k] <source> ... <destination directory> + git mv [-f] [-n] <source> <destination> + git mv [-f] [-n] [-k] <source> ... <destination directory> In the first form, it renames <source>, which must exist and be either a file, symlink or directory, to <destination>. diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index ffac3f8f56..b2d40a7e70 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -9,7 +9,7 @@ git-name-rev - Find symbolic names for given revs SYNOPSIS -------- [verse] -'git-name-rev' [--tags] [--refs=<pattern>] +'git name-rev' [--tags] [--refs=<pattern>] ( --all | --stdin | <committish>... ) DESCRIPTION diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index f4d8d68e34..c4ac3a7921 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -9,7 +9,7 @@ git-pack-objects - Create a packed archive of objects SYNOPSIS -------- [verse] -'git-pack-objects' [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty] +'git pack-objects' [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty] [--local] [--incremental] [--window=N] [--depth=N] [--all-progress] [--revs [--unpacked | --all]*] [--stdout | base-name] < object-list diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index 6737326f0b..95bf39978e 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -8,7 +8,7 @@ git-pack-redundant - Find redundant pack files SYNOPSIS -------- -'git-pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... > +'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... > DESCRIPTION ----------- @@ -21,8 +21,8 @@ given will be ignored when checking which packs are required. This makes the following command useful when wanting to remove packs which contain unreachable objects. -git-fsck --full --unreachable | cut -d ' ' -f3 | \ -git-pack-redundant --all | xargs rm +git fsck --full --unreachable | cut -d ' ' -f3 | \ +git pack-redundant --all | xargs rm OPTIONS ------- diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt index c0718468d5..a5244d35f4 100644 --- a/Documentation/git-pack-refs.txt +++ b/Documentation/git-pack-refs.txt @@ -7,7 +7,7 @@ git-pack-refs - Pack heads and tags for efficient repository access SYNOPSIS -------- -'git-pack-refs' [--all] [--no-prune] +'git pack-refs' [--all] [--no-prune] DESCRIPTION ----------- @@ -31,7 +31,7 @@ Subsequent updates to branches always creates new file under A recommended practice to deal with a repository with too many refs is to pack its refs with `--all --prune` once, and -occasionally run `git-pack-refs \--prune`. Tags are by +occasionally run `git pack-refs \--prune`. Tags are by definition stationary and are not expected to change. Branch heads will be packed with the initial `pack-refs --all`, but only the currently active branch heads will become unpacked, diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt index bb8a079254..c9970f5ab6 100644 --- a/Documentation/git-patch-id.txt +++ b/Documentation/git-patch-id.txt @@ -7,7 +7,7 @@ git-patch-id - Compute unique ID for a patch SYNOPSIS -------- -'git-patch-id' < <patch> +'git patch-id' < <patch> DESCRIPTION ----------- diff --git a/Documentation/git-peek-remote.txt b/Documentation/git-peek-remote.txt index ffbf93a799..05027d2c93 100644 --- a/Documentation/git-peek-remote.txt +++ b/Documentation/git-peek-remote.txt @@ -8,7 +8,7 @@ git-peek-remote - List the references in a remote repository SYNOPSIS -------- -'git-peek-remote' [--upload-pack=<git-upload-pack>] [<host>:]<directory> +'git peek-remote' [--upload-pack=<git-upload-pack>] [<host>:]<directory> DESCRIPTION ----------- diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt index f330b8a5b9..b5f26cee13 100644 --- a/Documentation/git-prune-packed.txt +++ b/Documentation/git-prune-packed.txt @@ -8,7 +8,7 @@ git-prune-packed - Remove extra objects that are already in pack files SYNOPSIS -------- -'git-prune-packed' [-n] [-q] +'git prune-packed' [-n] [-q] DESCRIPTION diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index ec335d6fab..10930000c5 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -22,7 +22,7 @@ objects specified on the command line, and prunes all unpacked objects unreachable from any of these head objects from the object database. In addition, it prunes the unpacked objects that are also found in packs by -running `git prune-packed`. +running `git-prune-packed`. Note that unreachable, packed objects will remain. If this is not desired, see linkgit:git-repack[1]. @@ -53,7 +53,7 @@ borrows from your repository via its `.git/objects/info/alternates`: ------------ -$ git prune $(cd ../another && $(git-rev-parse --all)) +$ git prune $(cd ../another && $(git rev-parse --all)) ------------ Notes diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index d0f1595f7e..99eb7eda36 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -8,7 +8,7 @@ git-pull - Fetch from and merge with another repository or a local branch SYNOPSIS -------- -'git-pull' <options> <repository> <refspec>... +'git pull' <options> <repository> <refspec>... DESCRIPTION diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index f3d5d883a7..176379134e 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -9,7 +9,7 @@ git-push - Update remote refs along with associated objects SYNOPSIS -------- [verse] -'git-push' [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>] +'git push' [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>] [--repo=all] [-f | --force] [-v | --verbose] [<repository> <refspec>...] DESCRIPTION diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt index 0600379394..d4037de512 100644 --- a/Documentation/git-quiltimport.txt +++ b/Documentation/git-quiltimport.txt @@ -9,7 +9,7 @@ git-quiltimport - Applies a quilt patchset onto the current branch SYNOPSIS -------- [verse] -'git-quiltimport' [--dry-run] [--author <author>] [--patches <dir>] +'git quiltimport' [--dry-run] [--author <author>] [--patches <dir>] DESCRIPTION diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 58fb906ef6..1a57f58071 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -8,7 +8,7 @@ git-read-tree - Reads tree information into the index SYNOPSIS -------- -'git-read-tree' (<tree-ish> | [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>] [-u | -i]] [--exclude-per-directory=<gitignore>] [--index-output=<file>] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) +'git read-tree' (<tree-ish> | [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>] [-u | -i]] [--exclude-per-directory=<gitignore>] [--index-output=<file>] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) DESCRIPTION @@ -127,8 +127,8 @@ given pathname, and the contents of the path matches with the tree being read, the stat info from the index is used. (In other words, the index's stat()s take precedence over the merged tree's). -That means that if you do a `git-read-tree -m <newtree>` followed by a -`git-checkout-index -f -u -a`, the `git-checkout-index` only checks out +That means that if you do a `git read-tree -m <newtree>` followed by a +`git checkout-index -f -u -a`, the `git-checkout-index` only checks out the stuff that really changed. This is used to avoid unnecessary false hits when `git-diff-files` is @@ -138,7 +138,7 @@ run after `git-read-tree`. Two Tree Merge ~~~~~~~~~~~~~~ -Typically, this is invoked as `git-read-tree -m $H $M`, where $H +Typically, this is invoked as `git read-tree -m $H $M`, where $H is the head commit of the current repository, and $M is the head of a foreign tree, which is simply ahead of $H (i.e. we are in a fast forward situation). @@ -151,7 +151,7 @@ the following: 2. The user wants to fast-forward to $M. -In this case, the `git-read-tree -m $H $M` command makes sure +In this case, the `git read-tree -m $H $M` command makes sure that no local change is lost as the result of this "merge". Here are the "carry forward" rules: @@ -198,13 +198,13 @@ operating under the -u flag. When this form of git-read-tree returns successfully, you can see what "local changes" you made are carried forward by running -`git-diff-index --cached $M`. Note that this does not -necessarily match `git-diff-index --cached $H` would have +`git diff-index --cached $M`. Note that this does not +necessarily match `git diff-index --cached $H` would have produced before such a two tree merge. This is because of cases 18 and 19 --- if you already had the changes in $M (e.g. maybe -you picked it up via e-mail in a patch form), `git-diff-index +you picked it up via e-mail in a patch form), `git diff-index --cached $H` would have told you about the change before this -merge, but it would not show in `git-diff-index --cached $M` +merge, but it would not show in `git diff-index --cached $M` output after two-tree merge. @@ -219,7 +219,7 @@ starts out at 1. This means that you can do ---------------- -$ git-read-tree -m <tree1> <tree2> <tree3> +$ git read-tree -m <tree1> <tree2> <tree3> ---------------- and you will end up with an index with all of the <tree1> entries in @@ -304,8 +304,8 @@ commit. To illustrate, suppose you start from what has been committed last to your repository: ---------------- -$ JC=`git-rev-parse --verify "HEAD^0"` -$ git-checkout-index -f -u -a $JC +$ JC=`git rev-parse --verify "HEAD^0"` +$ git checkout-index -f -u -a $JC ---------------- You do random edits, without running git-update-index. And then @@ -313,7 +313,7 @@ you notice that the tip of your "upstream" tree has advanced since you pulled from him: ---------------- -$ git-fetch git://.... linus +$ git fetch git://.... linus $ LT=`cat .git/FETCH_HEAD` ---------------- @@ -323,10 +323,10 @@ added or modified index entries since $JC, and if you haven't, then does the right thing. So with the following sequence: ---------------- -$ git-read-tree -m -u `git-merge-base $JC $LT` $JC $LT -$ git-merge-index git-merge-one-file -a +$ git read-tree -m -u `git merge-base $JC $LT` $JC $LT +$ git merge-index git-merge-one-file -a $ echo "Merge with Linus" | \ - git-commit-tree `git-write-tree` -p $JC -p $LT + git commit-tree `git write-tree` -p $JC -p $LT ---------------- what you would commit is a pure merge between $JC and $LT without diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 7166414355..2753f74701 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -8,11 +8,11 @@ git-rebase - Forward-port local commits to the updated upstream head SYNOPSIS -------- [verse] -'git-rebase' [-i | --interactive] [-v | --verbose] [-m | --merge] +'git rebase' [-i | --interactive] [-v | --verbose] [-m | --merge] [-s <strategy> | --strategy=<strategy>] [-C<n>] [ --whitespace=<option>] [-p | --preserve-merges] [--onto <newbase>] <upstream> [<branch>] -'git-rebase' --continue | --skip | --abort +'git rebase' --continue | --skip | --abort DESCRIPTION ----------- @@ -52,8 +52,8 @@ Assume the following history exists and the current branch is "topic": From this point, the result of either of the following commands: - git-rebase master - git-rebase master topic + git rebase master + git rebase master topic would be: @@ -68,7 +68,7 @@ followed by `git rebase master`. If the upstream branch already contains a change you have made (e.g., because you mailed a patch which was applied upstream), then that commit -will be skipped. For example, running `git-rebase master` on the +will be skipped. For example, running `git rebase master` on the following history (in which A' and A introduce the same set of changes, but have different committer information): @@ -116,7 +116,7 @@ got merged into more stable 'master' branch, like this: We can get this using the following command: - git-rebase --onto master next topic + git rebase --onto master next topic Another example of --onto option is to rebase part of a @@ -132,7 +132,7 @@ branch. If we have the following situation: then the command - git-rebase --onto master topicA topicB + git rebase --onto master topicA topicB would result in: @@ -155,7 +155,7 @@ the following situation: then the command - git-rebase --onto topicA~5 topicA~3 topicA + git rebase --onto topicA~5 topicA~3 topicA would result in the removal of commits F and G: @@ -168,7 +168,7 @@ part of topicA. Note that the argument to --onto and the <upstream> parameter can be any valid commit-ish. In case of conflict, git-rebase will stop at the first problematic commit -and leave conflict markers in the tree. You can use git diff to locate +and leave conflict markers in the tree. You can use git-diff to locate the markers (<<<<<<) and make edits to resolve the conflict. For each file you edit, you need to tell git that the conflict has been resolved, typically this would be done with @@ -364,7 +364,7 @@ SPLITTING COMMITS ----------------- In interactive mode, you can mark commits with the action "edit". However, -this does not necessarily mean that 'git rebase' expects the result of this +this does not necessarily mean that 'git-rebase' expects the result of this edit to be exactly one commit. Indeed, you can undo the commit, or you can add other commits. This can be used to split a commit into two: diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index a70c7168f6..8c696296a7 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt @@ -8,7 +8,7 @@ git-receive-pack - Receive what is pushed into the repository SYNOPSIS -------- -'git-receive-pack' <directory> +'git receive-pack' <directory> DESCRIPTION ----------- @@ -111,10 +111,10 @@ ref listing the commits pushed to the repository: if expr "$oval" : '0*$' >/dev/null then echo "Created a new ref, with the following commits:" - git-rev-list --pretty "$nval" + git rev-list --pretty "$nval" else echo "New commits:" - git-rev-list --pretty "$nval" "^$oval" + git rev-list --pretty "$nval" "^$oval" fi | mail -s "Changes to ref $ref" commit-list@mydomain done @@ -140,11 +140,11 @@ The exit code from this hook invocation is ignored; the only thing left for git-receive-pack to do at that point is to exit itself anyway. -This hook can be used, for example, to run "git-update-server-info" +This hook can be used, for example, to run "git update-server-info" if the repository is packed and is served via a dumb transport. #!/bin/sh - exec git-update-server-info + exec git update-server-info SEE ALSO diff --git a/Documentation/git-relink.txt b/Documentation/git-relink.txt index f6dafd4495..25ff8f9dcb 100644 --- a/Documentation/git-relink.txt +++ b/Documentation/git-relink.txt @@ -7,7 +7,7 @@ git-relink - Hardlink common objects in local repositories SYNOPSIS -------- -'git-relink' [--safe] <dir> [<dir>]\* <master_dir> +'git relink' [--safe] <dir> [<dir>]\* <master_dir> DESCRIPTION ----------- diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 345943a264..32db0aed11 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -9,12 +9,12 @@ git-remote - manage set of tracked repositories SYNOPSIS -------- [verse] -'git-remote' [-v | --verbose] -'git-remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> -'git-remote' rm <name> -'git-remote' show [-n] <name> -'git-remote' prune [-n | --dry-run] <name> -'git-remote' update [group] +'git remote' [-v | --verbose] +'git remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> +'git remote' rm <name> +'git remote' show [-n] <name> +'git remote' prune [-n | --dry-run] <name> +'git remote' update [group] DESCRIPTION ----------- diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 9011d06e7d..6bc5975379 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -8,7 +8,7 @@ git-repack - Pack unpacked objects in a repository SYNOPSIS -------- -'git-repack' [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N] +'git repack' [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N] DESCRIPTION ----------- @@ -55,20 +55,20 @@ OPTIONS Also runs linkgit:git-prune-packed[1]. -l:: - Pass the `--local` option to `git pack-objects`, see + Pass the `--local` option to `git-pack-objects`, see linkgit:git-pack-objects[1]. -f:: - Pass the `--no-reuse-delta` option to `git pack-objects`, see + Pass the `--no-reuse-delta` option to `git-pack-objects`, see linkgit:git-pack-objects[1]. -q:: - Pass the `-q` option to `git pack-objects`, see + Pass the `-q` option to `git-pack-objects`, see linkgit:git-pack-objects[1]. -n:: Do not update the server information with - `git update-server-info`. This option skips + `git-update-server-info`. This option skips updating local catalog files needed to publish this repository (or a direct copy of it) over HTTP or FTP. See gitlink:git-update-server-info[1]. diff --git a/Documentation/git-repo-config.txt b/Documentation/git-repo-config.txt index 2ca39946b7..e5bdb5533e 100644 --- a/Documentation/git-repo-config.txt +++ b/Documentation/git-repo-config.txt @@ -8,7 +8,7 @@ git-repo-config - Get and set repository or global options SYNOPSIS -------- -'git-repo-config' ... +'git repo-config' ... DESCRIPTION diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt index c71d86985e..ca6843032a 100644 --- a/Documentation/git-request-pull.txt +++ b/Documentation/git-request-pull.txt @@ -7,7 +7,7 @@ git-request-pull - Generates a summary of pending changes SYNOPSIS -------- -'git-request-pull' <start> <url> [<end>] +'git request-pull' <start> <url> [<end>] DESCRIPTION ----------- diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 8030ec4d01..d712f62c5f 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges SYNOPSIS -------- -'git-rerere' [clear|diff|status|gc] +'git rerere' [clear|diff|status|gc] DESCRIPTION ----------- @@ -198,7 +198,7 @@ you could run `git rebase master topic`, to keep yourself up-to-date even before your topic is ready to be sent upstream. This would result in falling back to three-way merge, and it would conflict the same way the test merge you resolved earlier. -`git-rerere` is run by `git rebase` to help you resolve this +`git-rerere` is run by `git-rebase` to help you resolve this conflict. diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index c9b0950321..61ec6dca8b 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -59,7 +59,7 @@ stop at that point. Their parents are implied. Thus the following command: ----------------------------------------------------------------------- - $ git-rev-list foo bar ^baz + $ git rev-list foo bar ^baz ----------------------------------------------------------------------- means "list all the commits which are included in 'foo' and 'bar', but @@ -70,8 +70,8 @@ short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of the following may be used interchangeably: ----------------------------------------------------------------------- - $ git-rev-list origin..HEAD - $ git-rev-list HEAD ^origin + $ git rev-list origin..HEAD + $ git rev-list HEAD ^origin ----------------------------------------------------------------------- Another special notation is "'<commit1>'...'<commit2>'" which is useful @@ -79,8 +79,8 @@ for merges. The resulting set of commits is the symmetric difference between the two operands. The following two commands are equivalent: ----------------------------------------------------------------------- - $ git-rev-list A B --not $(git-merge-base --all A B) - $ git-rev-list A...B + $ git rev-list A B --not $(git merge-base --all A B) + $ git rev-list A...B ----------------------------------------------------------------------- linkgit:git-rev-list[1] is a very essential git program, since it diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 59e95adf42..e9fb2b1579 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -8,7 +8,7 @@ git-rev-parse - Pick out and massage parameters SYNOPSIS -------- -'git-rev-parse' [ --option ] <args>... +'git rev-parse' [ --option ] <args>... DESCRIPTION ----------- @@ -296,7 +296,7 @@ reachable from `r1` from the set of commits reachable from A similar notation "`r1\...r2`" is called symmetric difference of `r1` and `r2` and is defined as -"`r1 r2 --not $(git-merge-base --all r1 r2)`". +"`r1 r2 --not $(git merge-base --all r1 r2)`". It is the set of commits that are reachable from either one of `r1` or `r2` but not from both. @@ -384,7 +384,7 @@ bar= some cool option --bar with an argument An option group Header C? option C with an optional argument" -eval `echo "$OPTS_SPEC" | git-rev-parse --parseopt -- "$@" || echo exit $?` +eval `echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?` ------------ EXAMPLES diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 5b49b81386..3d0c5aba93 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -7,7 +7,7 @@ git-revert - Revert an existing commit SYNOPSIS -------- -'git-revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit> +'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit> DESCRIPTION ----------- diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index d88554bedc..41e00d9a6a 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -7,12 +7,12 @@ git-rm - Remove files from the working tree and from the index SYNOPSIS -------- -'git-rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>... +'git rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>... DESCRIPTION ----------- Remove files from the index, or from the working tree and the index. -`git rm` will not remove a file from just your working directory. +`git-rm` will not remove a file from just your working directory. (There is no option to remove a file only from the work tree and yet keep it in the index; use `/bin/rm` if you want to do that.) The files being removed have to be identical to the tip of the branch, @@ -82,7 +82,7 @@ also remove all of directory `d2`. EXAMPLES -------- -git-rm Documentation/\\*.txt:: +git rm Documentation/\\*.txt:: Removes all `\*.txt` files from the index that are under the `Documentation` directory and any of its subdirectories. + @@ -90,7 +90,7 @@ Note that the asterisk `\*` is quoted from the shell in this example; this lets git, and not the shell, expand the pathnames of files and subdirectories under the `Documentation/` directory. -git-rm -f git-*.sh:: +git rm -f git-*.sh:: Because this example lets the shell expand the asterisk (i.e. you are listing the files explicitly), it does not remove `subdir/git-foo.sh`. diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index dc7eb7bd4e..afbb294a7f 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -8,7 +8,7 @@ git-send-email - Send a collection of patches as emails SYNOPSIS -------- -'git-send-email' [options] <file|directory> [... file|directory] +'git send-email' [options] <file|directory> [... file|directory] diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index ba2fdaec08..dba015fbe9 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -8,7 +8,7 @@ git-send-pack - Push objects over git protocol to another repository SYNOPSIS -------- -'git-send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...] +'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...] DESCRIPTION ----------- diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index daa64d4d81..b55301bb97 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -8,12 +8,12 @@ git-shortlog - Summarize 'git log' output SYNOPSIS -------- [verse] -git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] [-e] [-w] -git-shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...] +git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w] +git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...] DESCRIPTION ----------- -Summarizes 'git log' output in a format suitable for inclusion +Summarizes 'git-log' output in a format suitable for inclusion in release announcements. Each commit will be grouped by author and the first line of the commit message will be shown. diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index de9e8f885f..b9228dc887 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -8,10 +8,10 @@ git-show-branch - Show branches and their commits SYNOPSIS -------- [verse] -'git-show-branch' [--all] [--remotes] [--topo-order] [--current] +'git show-branch' [--all] [--remotes] [--topo-order] [--current] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] [<rev> | <glob>]... -'git-show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>] +'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>] DESCRIPTION ----------- diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt index 891f0eff27..4227cbbd9a 100644 --- a/Documentation/git-show-index.txt +++ b/Documentation/git-show-index.txt @@ -8,7 +8,7 @@ git-show-index - Show packed archive index SYNOPSIS -------- -'git-show-index' < idx-file +'git show-index' < idx-file DESCRIPTION diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index 6b99529b6b..c1f03d4bd7 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -8,9 +8,9 @@ git-show-ref - List references in a local repository SYNOPSIS -------- [verse] -'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference] +'git show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference] [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>... -'git-show-ref' --exclude-existing[=pattern] +'git show-ref' --exclude-existing[=pattern] DESCRIPTION ----------- @@ -144,7 +144,7 @@ For scripting, you can ask it to be quiet with the "--quiet" flag, which allows you to do things like ----------------------------------------------------------------------------- - git-show-ref --quiet --verify -- "refs/heads/$headname" || + git show-ref --quiet --verify -- "refs/heads/$headname" || echo "$headname is not a valid branch" ----------------------------------------------------------------------------- diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index baaf2bc8fe..44570d92d4 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -8,7 +8,7 @@ git-show - Show various types of objects SYNOPSIS -------- -'git-show' [options] <object>... +'git show' [options] <object>... DESCRIPTION ----------- diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index baa4f55b48..f994679d95 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -8,13 +8,13 @@ git-stash - Stash the changes in a dirty working directory away SYNOPSIS -------- [verse] -'git-stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) -'git-stash' [save [<message>]] +'git stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) +'git stash' [save [<message>]] DESCRIPTION ----------- -Use 'git-stash' when you want to record the current state of the +Use 'git stash' when you want to record the current state of the working directory and the index, but want to go back to a clean working directory. The command saves your local modifications away and reverts the working directory to match the `HEAD` commit. @@ -22,7 +22,7 @@ and reverts the working directory to match the `HEAD` commit. The modifications stashed away by this command can be listed with `git-stash list`, inspected with `git-stash show`, and restored (potentially on top of a different commit) with `git-stash apply`. -Calling git-stash without any arguments is equivalent to `git-stash +Calling git stash without any arguments is equivalent to `git stash save`. A stash is by default listed as "WIP on 'branchname' ...", but you can give a more descriptive message on the command line when you create one. @@ -38,7 +38,7 @@ OPTIONS save [<message>]:: - Save your local modifications to a new 'stash', and run `git-reset + Save your local modifications to a new 'stash', and run `git reset --hard` to revert them. This is the default action when no subcommand is given. The <message> part is optional and gives the description along with the stashed state. @@ -64,7 +64,7 @@ show [<stash>]:: Show the changes recorded in the stash as a diff between the stashed state and its original parent. When no `<stash>` is given, shows the latest one. By default, the command shows the diffstat, but - it will accept any format known to `git-diff` (e.g., `git-stash show + it will accept any format known to `git-diff` (e.g., `git stash show -p stash@\{1}` to view the second most recent stash in patch form). apply [--index] [<stash>]:: diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index fef62b16df..c9d4a046c7 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -8,7 +8,7 @@ git-status - Show the working tree status SYNOPSIS -------- -'git-status' <options>... +'git status' <options>... DESCRIPTION ----------- @@ -17,7 +17,7 @@ current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not tracked by git (and are not ignored by linkgit:gitignore[5]). The first are what you _would_ commit by running `git commit`; the second and -third are what you _could_ commit by running `git add` before running +third are what you _could_ commit by running `git-add` before running `git commit`. The command takes the same set of options as `git-commit`; it @@ -26,7 +26,7 @@ shows what would be committed if the same options are given to If there is no path that is different between the index file and the current HEAD commit (i.e., there is nothing to commit by running -`git-commit`), the command exits with non-zero status. +`git commit`), the command exits with non-zero status. OUTPUT diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index 8421a39f26..7508c0e42d 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -8,7 +8,7 @@ git-stripspace - Filter out empty lines SYNOPSIS -------- -'git-stripspace' [-s | --strip-comments] < <stream> +'git stripspace' [-s | --strip-comments] < <stream> DESCRIPTION ----------- diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 441ae1483b..c1deec98d1 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -9,11 +9,11 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- [verse] -'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] -'git-submodule' [--quiet] status [--cached] [--] [<path>...] -'git-submodule' [--quiet] init [--] [<path>...] -'git-submodule' [--quiet] update [--init] [--] [<path>...] -'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...] +'git submodule' [--quiet] add [-b branch] [--] <repository> [<path>] +'git submodule' [--quiet] status [--cached] [--] [<path>...] +'git submodule' [--quiet] init [--] [<path>...] +'git submodule' [--quiet] update [--init] [--] [<path>...] +'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...] COMMANDS diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index c350ad0f83..6ddfed3a9c 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -7,7 +7,7 @@ git-svn - Bidirectional operation between a single Subversion branch and git SYNOPSIS -------- -'git-svn' <command> [options] [arguments] +'git svn' <command> [options] [arguments] DESCRIPTION ----------- @@ -173,7 +173,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn client converts the UTC time to the local time (or based on the TZ= environment). This command has the same behaviour. + -Any other arguments are passed directly to `git log' +Any other arguments are passed directly to `git-log' 'blame':: Show what revision and author last modified each line of a file. The @@ -184,7 +184,7 @@ Any other arguments are passed directly to `git log' arguments are passed directly to git-blame. + --git-format;; - Produce output in the same format as `git blame', but with + Produce output in the same format as `git-blame', but with SVN revision numbers instead of git commit hashes. In this mode, changes that haven't been committed to SVN (including local working-copy edits) are shown as revision 0. @@ -466,7 +466,7 @@ Tracking and contributing to the trunk of a Subversion-managed project: ------------------------------------------------------------------------ # Clone a repo (like git clone): - git-svn clone http://svn.foo.org/project/trunk + git svn clone http://svn.foo.org/project/trunk # Enter the newly cloned directory: cd trunk # You should be on master branch, double-check with git-branch @@ -475,12 +475,12 @@ Tracking and contributing to the trunk of a Subversion-managed project: git commit ... # Something is committed to SVN, rebase your local changes against the # latest changes in SVN: - git-svn rebase + git svn rebase # Now commit your changes (that were committed previously using git) to SVN, # as well as automatically updating your working HEAD: - git-svn dcommit + git svn dcommit # Append svn:ignore settings to the default git exclude file: - git-svn show-ignore >> .git/info/exclude + git svn show-ignore >> .git/info/exclude ------------------------------------------------------------------------ Tracking and contributing to an entire Subversion-managed project @@ -488,7 +488,7 @@ Tracking and contributing to an entire Subversion-managed project ------------------------------------------------------------------------ # Clone a repo (like git clone): - git-svn clone http://svn.foo.org/project -T trunk -b branches -t tags + git svn clone http://svn.foo.org/project -T trunk -b branches -t tags # View all branches and tags you have cloned: git branch -r # Reset your master to trunk (or any other branch, replacing 'trunk' @@ -503,22 +503,22 @@ The initial 'git-svn clone' can be quite time-consuming people (or one person with multiple machines) want to use git-svn to interact with the same Subversion repository, you can do the initial 'git-svn clone' to a repository on a server and -have each person clone that repository with 'git clone': +have each person clone that repository with 'git-clone': ------------------------------------------------------------------------ # Do the initial import on a server - ssh server "cd /pub && git-svn clone http://svn.foo.org/project + ssh server "cd /pub && git svn clone http://svn.foo.org/project # Clone locally - make sure the refs/remotes/ space matches the server mkdir project cd project - git-init + git init git remote add origin server:/pub/project git config --add remote.origin.fetch '+refs/remotes/*:refs/remotes/*' git fetch # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server) - git-svn init http://svn.foo.org/project + git svn init http://svn.foo.org/project # Pull the latest changes from Subversion - git-svn rebase + git svn rebase ------------------------------------------------------------------------ REBASE VS. PULL/MERGE @@ -526,12 +526,12 @@ REBASE VS. PULL/MERGE Originally, git-svn recommended that the remotes/git-svn branch be pulled or merged from. This is because the author favored -'git-svn set-tree B' to commit a single head rather than the -'git-svn set-tree A..B' notation to commit multiple commits. +'git svn set-tree B' to commit a single head rather than the +'git svn set-tree A..B' notation to commit multiple commits. -If you use 'git-svn set-tree A..B' to commit several diffs and you do +If you use 'git svn set-tree A..B' to commit several diffs and you do not have the latest remotes/git-svn merged into my-branch, you should -use 'git-svn rebase' to update your work branch instead of 'git pull' or +use 'git svn rebase' to update your work branch instead of 'git pull' or 'git merge'. 'pull/merge' can cause non-linear history to be flattened when committing into SVN, which can lead to merge commits reversing previous commits in SVN. diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index 3d3a059c5e..243e26ebf1 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -7,7 +7,7 @@ git-symbolic-ref - Read and modify symbolic refs SYNOPSIS -------- -'git-symbolic-ref' [-q] [-m <reason>] <name> [<ref>] +'git symbolic-ref' [-q] [-m <reason>] <name> [<ref>] DESCRIPTION ----------- diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 0c41711115..95531349a2 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -9,10 +9,10 @@ git-tag - Create, list, delete or verify a tag object signed with GPG SYNOPSIS -------- [verse] -'git-tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <name> [<head>] -'git-tag' -d <name>... -'git-tag' [-n[<num>]] -l [<pattern>] -'git-tag' -v <name>... +'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <name> [<head>] +'git tag' -d <name>... +'git tag' [-n[<num>]] -l [<pattern>] +'git tag' -v <name>... DESCRIPTION ----------- @@ -118,12 +118,12 @@ and be done with it. . The insane thing. You really want to call the new version "X" too, 'even though' -others have already seen the old one. So just use "git tag -f" +others have already seen the old one. So just use "git-tag -f" again, as if you hadn't already published the old one. However, Git does *not* (and it should not) change tags behind users back. So if somebody already got the old tag, doing a -"git pull" on your tree shouldn't just make them overwrite the old +"git-pull" on your tree shouldn't just make them overwrite the old one. If somebody got a release tag from you, you cannot just change @@ -177,7 +177,7 @@ private anchor point tags from the other person. You would notice "please pull" messages on the mailing list says repo URL and branch name alone. This is designed to be easily -cut&pasted to "git fetch" command line: +cut&pasted to "git-fetch" command line: ------------ Linus, please pull from diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt index 74ed06525e..4995dc245a 100644 --- a/Documentation/git-tar-tree.txt +++ b/Documentation/git-tar-tree.txt @@ -8,7 +8,7 @@ git-tar-tree - Create a tar archive of the files in the named tree object SYNOPSIS -------- -'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ] +'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ] DESCRIPTION ----------- diff --git a/Documentation/git-unpack-file.txt b/Documentation/git-unpack-file.txt index d0552b2c74..995db9fead 100644 --- a/Documentation/git-unpack-file.txt +++ b/Documentation/git-unpack-file.txt @@ -9,7 +9,7 @@ git-unpack-file - Creates a temporary file with a blob's contents SYNOPSIS -------- -'git-unpack-file' <blob> +'git unpack-file' <blob> DESCRIPTION ----------- diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt index b9c4279a88..ae17cc2b44 100644 --- a/Documentation/git-unpack-objects.txt +++ b/Documentation/git-unpack-objects.txt @@ -8,7 +8,7 @@ git-unpack-objects - Unpack objects from a packed archive SYNOPSIS -------- -'git-unpack-objects' [-n] [-q] [-r] [--strict] <pack-file +'git unpack-objects' [-n] [-q] [-r] [--strict] <pack-file DESCRIPTION diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index bbb0a6ad57..5295702fd3 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -9,7 +9,7 @@ git-update-index - Register file contents in the working tree to the index SYNOPSIS -------- [verse] -'git-update-index' +'git update-index' [--add] [--remove | --force-remove] [--replace] [--refresh] [-q] [--unmerged] [--ignore-missing] [--cacheinfo <mode> <object> <file>]\* @@ -157,7 +157,7 @@ merging. To pretend you have a file with mode and sha1 at path, say: ---------------- -$ git-update-index --cacheinfo mode sha1 path +$ git update-index --cacheinfo mode sha1 path ---------------- '--info-only' is used to register files without placing them in the object @@ -247,13 +247,13 @@ In order to set "assume unchanged" bit, use `--assume-unchanged` option. To unset, use `--no-assume-unchanged`. The command looks at `core.ignorestat` configuration variable. When -this is true, paths updated with `git-update-index paths...` and +this is true, paths updated with `git update-index paths...` and paths updated with other git commands that update both index and working tree (e.g. `git-apply --index`, `git-checkout-index -u`, and `git-read-tree -u`) are automatically marked as "assume unchanged". Note that "assume unchanged" bit is *not* set if -`git-update-index --refresh` finds the working tree file matches -the index (use `git-update-index --really-refresh` if you want +`git update-index --refresh` finds the working tree file matches +the index (use `git update-index --really-refresh` if you want to mark them as "assume unchanged"). @@ -262,7 +262,7 @@ Examples To update and refresh only the files already checked out: ---------------- -$ git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh +$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh ---------------- On an inefficient filesystem with `core.ignorestat` set:: diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index bae2c8b7ec..9639f705af 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -7,18 +7,18 @@ git-update-ref - Update the object name stored in a ref safely SYNOPSIS -------- -'git-update-ref' [-m <reason>] (-d <ref> [<oldvalue>] | [--no-deref] <ref> <newvalue> [<oldvalue>]) +'git update-ref' [-m <reason>] (-d <ref> [<oldvalue>] | [--no-deref] <ref> <newvalue> [<oldvalue>]) DESCRIPTION ----------- Given two arguments, stores the <newvalue> in the <ref>, possibly -dereferencing the symbolic refs. E.g. `git-update-ref HEAD +dereferencing the symbolic refs. E.g. `git update-ref HEAD <newvalue>` updates the current branch head to the new object. Given three arguments, stores the <newvalue> in the <ref>, possibly dereferencing the symbolic refs, after verifying that the current value of the <ref> matches <oldvalue>. -E.g. `git-update-ref refs/heads/master <newvalue> <oldvalue>` +E.g. `git update-ref refs/heads/master <newvalue> <oldvalue>` updates the master branch head to <newvalue> only if its current value is <oldvalue>. You can specify 40 "0" or an empty string as <oldvalue> to make sure that the ref you are creating does @@ -41,7 +41,7 @@ the result of following the symbolic pointers. In general, using - git-update-ref HEAD "$head" + git update-ref HEAD "$head" should be a _lot_ safer than doing @@ -61,7 +61,7 @@ still contains <oldvalue>. Logging Updates --------------- If config parameter "core.logAllRefUpdates" is true or the file -"$GIT_DIR/logs/<ref>" exists then `git-update-ref` will append +"$GIT_DIR/logs/<ref>" exists then `git update-ref` will append a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all symbolic refs before creating the log name) describing the change in ref value. Log lines are formatted as: diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index 0102410821..bc1207a317 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt @@ -8,7 +8,7 @@ git-update-server-info - Update auxiliary info file to help dumb servers SYNOPSIS -------- -'git-update-server-info' [--force] +'git update-server-info' [--force] DESCRIPTION ----------- diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt index e49f68f68e..bbd7617587 100644 --- a/Documentation/git-upload-archive.txt +++ b/Documentation/git-upload-archive.txt @@ -8,7 +8,7 @@ git-upload-archive - Send archive back to git-archive SYNOPSIS -------- -'git-upload-archive' <directory> +'git upload-archive' <directory> DESCRIPTION ----------- diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt index bac465e13f..b8e49dce4a 100644 --- a/Documentation/git-upload-pack.txt +++ b/Documentation/git-upload-pack.txt @@ -8,7 +8,7 @@ git-upload-pack - Send objects packed back to git-fetch-pack SYNOPSIS -------- -'git-upload-pack' [--strict] [--timeout=<n>] <directory> +'git upload-pack' [--strict] [--timeout=<n>] <directory> DESCRIPTION ----------- diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 67e8e1f93a..10d1e19cc0 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -8,7 +8,7 @@ git-var - Show a git logical variable SYNOPSIS -------- -'git-var' [ -l | <variable> ] +'git var' [ -l | <variable> ] DESCRIPTION ----------- @@ -24,7 +24,7 @@ OPTIONS EXAMPLE -------- - $ git-var GIT_AUTHOR_IDENT + $ git var GIT_AUTHOR_IDENT Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600 diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index 478f236996..8536a18361 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -8,7 +8,7 @@ git-verify-pack - Validate packed git archive files SYNOPSIS -------- -'git-verify-pack' [-v] [--] <pack>.idx ... +'git verify-pack' [-v] [--] <pack>.idx ... DESCRIPTION diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt index dffba8906a..2231f6d0c7 100644 --- a/Documentation/git-verify-tag.txt +++ b/Documentation/git-verify-tag.txt @@ -7,7 +7,7 @@ git-verify-tag - Check the GPG signature of tags SYNOPSIS -------- -'git-verify-tag' <tag>... +'git verify-tag' <tag>... DESCRIPTION ----------- diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt index e80a7c1cc4..c2cd216df0 100644 --- a/Documentation/git-web--browse.txt +++ b/Documentation/git-web--browse.txt @@ -7,7 +7,7 @@ git-web--browse - git helper script to launch a web browser SYNOPSIS -------- -'git-web--browse' [OPTIONS] URL/FILE ... +'git web--browse' [OPTIONS] URL/FILE ... DESCRIPTION ----------- @@ -70,7 +70,7 @@ browser.<tool>.cmd When the browser, specified by options or configuration variables, is not among the supported ones, then the corresponding 'browser.<tool>.cmd' configuration variable will be looked up. If this -variable exists then "git web--browse" will treat the specified tool +variable exists then "git-web--browse" will treat the specified tool as a custom command and will use a shell eval to run the command with the URLs passed as arguments. @@ -96,7 +96,7 @@ the following: cmd = A_PATH_TO/konqueror ------------------------------------------------ -Note about git config --global +Note about git-config --global ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Note that these configuration variables should probably be set using diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index f5d39c7870..d7fad15329 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -8,7 +8,7 @@ git-whatchanged - Show logs with difference each commit introduces SYNOPSIS -------- -'git-whatchanged' <option>... +'git whatchanged' <option>... DESCRIPTION ----------- @@ -52,12 +52,12 @@ include::pretty-formats.txt[] Examples -------- -git-whatchanged -p v2.6.12.. include/scsi drivers/scsi:: +git whatchanged -p v2.6.12.. include/scsi drivers/scsi:: Show as patches the commits since version 'v2.6.12' that changed any file in the include/scsi or drivers/scsi subdirectories -git-whatchanged --since="2 weeks ago" \-- gitk:: +git whatchanged --since="2 weeks ago" \-- gitk:: Show the changes during the last two weeks to the file 'gitk'. The "--" is necessary to avoid confusion with the *branch* named diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt index 8744f6535d..19d979bcc7 100644 --- a/Documentation/git-write-tree.txt +++ b/Documentation/git-write-tree.txt @@ -8,7 +8,7 @@ git-write-tree - Create a tree object from the current index SYNOPSIS -------- -'git-write-tree' [--missing-ok] [--prefix=<prefix>/] +'git write-tree' [--missing-ok] [--prefix=<prefix>/] DESCRIPTION ----------- diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 6e67990f64..e96d3cdcac 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -87,9 +87,9 @@ Checking-out and checking-in These attributes affect how the contents stored in the repository are copied to the working tree files when commands -such as `git checkout` and `git merge` run. They also affect how +such as `git-checkout` and `git-merge` run. They also affect how git stores the contents you prepare in the working tree in the -repository upon `git add` and `git commit`. +repository upon `git-add` and `git-commit`. `crlf` ^^^^^^ @@ -148,16 +148,16 @@ an irreversible conversion. The safety triggers to prevent such a conversion done to the files in the work tree, but there are a few exceptions. Even though... -- "git add" itself does not touch the files in the work tree, the +- "git-add" itself does not touch the files in the work tree, the next checkout would, so the safety triggers; -- "git apply" to update a text file with a patch does touch the files +- "git-apply" to update a text file with a patch does touch the files in the work tree, but the operation is about text files and CRLF conversion is about fixing the line ending inconsistencies, so the safety does not trigger; -- "git diff" itself does not touch the files in the work tree, it is - often run to inspect the changes you intend to next "git add". To +- "git-diff" itself does not touch the files in the work tree, it is + often run to inspect the changes you intend to next "git-add". To catch potential problems early, safety triggers. @@ -214,7 +214,7 @@ with `crlf`, and then `ident` and fed to `filter`. Generating diff text ~~~~~~~~~~~~~~~~~~~~ -The attribute `diff` affects if `git diff` generates textual +The attribute `diff` affects if `git-diff` generates textual patch for the path or just says `Binary files differ`. It also can affect what line is shown on the hunk header `@@ -k,l +n,m @@` line. diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 6bb32a8258..ce197d59f4 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -49,7 +49,7 @@ subdirectory, and initialize the git infrastructure with `git-init`: ------------------------------------------------ $ mkdir git-tutorial $ cd git-tutorial -$ git-init +$ git init ------------------------------------------------ to which git will reply @@ -149,7 +149,7 @@ adding a new entry with the `\--add` flag (or removing an entry with the So to populate the index with the two files you just created, you can do ------------------------------------------------ -$ git-update-index --add hello example +$ git update-index --add hello example ------------------------------------------------ and you have now told git to track those two files. @@ -177,7 +177,7 @@ If you want to, you can use `git-cat-file` to look at those objects, but you'll have to use the object name, not the filename of the object: ---------------- -$ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 +$ git cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 ---------------- where the `-t` tells `git-cat-file` to tell you what the "type" of the @@ -185,7 +185,7 @@ object is. git will tell you that you have a "blob" object (i.e., just a regular file), and you can see the contents with ---------------- -$ git-cat-file "blob" 557db03 +$ git cat-file "blob" 557db03 ---------------- which will print out "Hello World". The object `557db03` is nothing @@ -231,7 +231,7 @@ git what has changed in the tree compared to your old index, using the `git-diff-files` command: ------------ -$ git-diff-files +$ git diff-files ------------ Oops. That wasn't very readable. It just spit out its own internal @@ -243,7 +243,7 @@ To make it readable, we can tell git-diff-files to output the differences as a patch, using the `-p` flag: ------------ -$ git-diff-files -p +$ git diff-files -p diff --git a/hello b/hello index 557db03..263414f 100644 --- a/hello @@ -259,7 +259,7 @@ In other words, `git-diff-files` always shows us the difference between what is recorded in the index, and what is currently in the working tree. That's very useful. -A common shorthand for `git-diff-files -p` is to just write `git +A common shorthand for `git diff-files -p` is to just write `git diff`, which will do the same thing. ------------ @@ -284,14 +284,14 @@ object as a 'commit' object together with an explanation of what the tree was all about, along with information of how we came to that state. Creating a tree object is trivial, and is done with `git-write-tree`. -There are no options or other input: git-write-tree will take the +There are no options or other input: git write-tree will take the current index state, and write an object that describes that whole index. In other words, we're now tying together all the different filenames with their contents (and their permissions), and we're creating the equivalent of a git "directory" object: ------------------------------------------------ -$ git-write-tree +$ git write-tree ------------------------------------------------ and this will just output the name of the resulting tree, in this case @@ -302,9 +302,9 @@ and this will just output the name of the resulting tree, in this case ---------------- which is another incomprehensible object name. Again, if you want to, -you can use `git-cat-file -t 8988d\...` to see that this time the object +you can use `git cat-file -t 8988d\...` to see that this time the object is not a "blob" object, but a "tree" object (you can also use -`git-cat-file` to actually output the raw object contents, but you'll see +`git cat-file` to actually output the raw object contents, but you'll see mainly a binary mess, so that's less interesting). However -- normally you'd never use `git-write-tree` on its own, because @@ -327,9 +327,9 @@ that's exactly what `git-commit-tree` spits out, we can do this all with a sequence of simple shell commands: ------------------------------------------------ -$ tree=$(git-write-tree) -$ commit=$(echo 'Initial commit' | git-commit-tree $tree) -$ git-update-ref HEAD $commit +$ tree=$(git write-tree) +$ commit=$(echo 'Initial commit' | git commit-tree $tree) +$ git update-ref HEAD $commit ------------------------------------------------ In this case this creates a totally new commit that is not related to @@ -356,7 +356,7 @@ that on purpose, to show the difference between the index state, and the state in the working tree, and how they don't have to match, even when we commit things. -As before, if we do `git-diff-files -p` in our git-tutorial project, +As before, if we do `git diff-files -p` in our git-tutorial project, we'll still see the same difference we saw last time: the index file hasn't changed by the act of committing anything. However, now that we have committed something, we can also learn to use a new command: @@ -372,7 +372,7 @@ didn't have anything to diff against. But now we can do ---------------- -$ git-diff-index -p HEAD +$ git diff-index -p HEAD ---------------- (where `-p` has the same meaning as it did in `git-diff-files`), and it @@ -394,7 +394,7 @@ In other words, `git-diff-index` normally compares a tree against the working tree, but when given the `\--cached` flag, it is told to instead compare against just the index cache contents, and ignore the current working tree state entirely. Since we just wrote the index -file to HEAD, doing `git-diff-index \--cached -p HEAD` should thus return +file to HEAD, doing `git diff-index \--cached -p HEAD` should thus return an empty set of differences, and that's exactly what it does. [NOTE] @@ -422,15 +422,15 @@ work through the index file, so the first thing we need to do is to update the index cache: ------------------------------------------------ -$ git-update-index hello +$ git update-index hello ------------------------------------------------ (note how we didn't need the `\--add` flag this time, since git knew about the file already). Note what happens to the different `git-diff-\*` versions here. After -we've updated `hello` in the index, `git-diff-files -p` now shows no -differences, but `git-diff-index -p HEAD` still *does* show that the +we've updated `hello` in the index, `git diff-files -p` now shows no +differences, but `git diff-index -p HEAD` still *does* show that the current state is different from the state we committed. In fact, now `git-diff-index` shows the same difference whether we use the `--cached` flag or not, since now the index is coherent with the working tree. @@ -477,7 +477,7 @@ of that commit itself, and show the difference directly. Thus, to get the same diff that we've already seen several times, we can now do ---------------- -$ git-diff-tree -p HEAD +$ git diff-tree -p HEAD ---------------- (again, `-p` means to show the difference as a human-readable patch), @@ -542,7 +542,7 @@ with the associated patches use the more complex (and much more powerful) ---------------- -$ git-whatchanged -p +$ git whatchanged -p ---------------- and you will see exactly what has changed in the repository over its @@ -653,7 +653,7 @@ information for the files involved) will likely need to be refreshed. So after you do a `cp -a` to create a new copy, you'll want to do + ---------------- -$ git-update-index --refresh +$ git update-index --refresh ---------------- + in the new repository to make sure that the index file is up-to-date. @@ -669,15 +669,15 @@ known state (you don't know *what* they've done and not yet checked in), so usually you'll precede the `git-update-index` with a ---------------- -$ git-read-tree --reset HEAD -$ git-update-index --refresh +$ git read-tree --reset HEAD +$ git update-index --refresh ---------------- which will force a total index re-build from the tree pointed to by `HEAD`. It resets the index contents to `HEAD`, and then the `git-update-index` makes sure to match up all index entries with the checked-out files. If the original repository had uncommitted changes in its -working tree, `git-update-index --refresh` notices them and +working tree, `git update-index --refresh` notices them and tells you they need to be updated. The above can also be written as simply @@ -690,7 +690,7 @@ and in fact a lot of the common git command combinations can be scripted with the `git xyz` interfaces. You can learn things by just looking at what the various git scripts do. For example, `git reset` used to be the above two lines implemented in `git-reset`, but some things like -`git status` and `git commit` are slightly more complex scripts around +`git-status` and `git-commit` are slightly more complex scripts around the basic git commands. Many (most?) public remote repositories will not contain any of @@ -713,7 +713,7 @@ $ rsync -rL rsync://rsync.kernel.org/pub/scm/git/git.git/ .git followed by ---------------- -$ git-read-tree HEAD +$ git read-tree HEAD ---------------- to populate the index. However, now you have populated the index, and @@ -722,7 +722,7 @@ actually have any of the working tree files to work on. To get those, you'd check them out with ---------------- -$ git-checkout-index -u -a +$ git checkout-index -u -a ---------------- where the `-u` flag means that you want the checkout to keep the index @@ -839,7 +839,7 @@ $ git commit -m "Some work." -i hello ------------------------------------------------ Here, we just added another line to `hello`, and we used a shorthand for -doing both `git-update-index hello` and `git commit` by just giving the +doing both `git update-index hello` and `git commit` by just giving the filename directly to `git commit`, with an `-i` flag (it tells git to 'include' that file in addition to what you have done to the index file so far when making the commit). The `-m` flag is to give the @@ -938,7 +938,7 @@ Another useful tool, especially if you do not always work in X-Window environment, is `git show-branch`. ------------------------------------------------ -$ git-show-branch --topo-order --more=1 master mybranch +$ git show-branch --topo-order --more=1 master mybranch * [master] Merge work in mybranch ! [mybranch] Some work. -- @@ -981,7 +981,7 @@ merge commit visible in this case. Now, let's pretend you are the one who did all the work in `mybranch`, and the fruit of your hard work has finally been merged to the `master` branch. Let's go back to `mybranch`, and run -`git merge` to get the "upstream changes" back to your branch. +`git-merge` to get the "upstream changes" back to your branch. ------------ $ git checkout mybranch @@ -1198,7 +1198,7 @@ algorithm. First, it finds the common ancestor between them. The command it uses is `git-merge-base`: ------------ -$ mb=$(git-merge-base HEAD mybranch) +$ mb=$(git merge-base HEAD mybranch) ------------ The command writes the commit object name of the common ancestor @@ -1208,7 +1208,7 @@ ancestor commit is the "New day." commit in this case. You can tell it by: ------------ -$ git-name-rev $mb +$ git name-rev $mb my-first-tag ------------ @@ -1216,7 +1216,7 @@ After finding out a common ancestor commit, the second step is this: ------------ -$ git-read-tree -m -u $mb HEAD mybranch +$ git read-tree -m -u $mb HEAD mybranch ------------ This is the same `git-read-tree` command we have already seen, @@ -1235,7 +1235,7 @@ trees are left in non-zero stages. At this point, you can inspect the index file with this command: ------------ -$ git-ls-files --stage +$ git ls-files --stage 100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello @@ -1252,7 +1252,7 @@ stages. To look at only non-zero stages, use `\--unmerged` flag: ------------ -$ git-ls-files --unmerged +$ git ls-files --unmerged 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello 100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello @@ -1264,7 +1264,7 @@ file, using 3-way merge. This is done by giving `git-merge-index` command: ------------ -$ git-merge-index git-merge-one-file hello +$ git merge-index git-merge-one-file hello Auto-merging hello. merge: warning: conflicts during merge ERROR: Merge conflict in hello. @@ -1282,7 +1282,7 @@ the working tree.. This can be seen if you run `ls-files --stage` again at this point: ------------ -$ git-ls-files --stage +$ git ls-files --stage 100644 7f8b141b65fdcee47321e399a2598a235a032422 0 example 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello @@ -1290,9 +1290,9 @@ $ git-ls-files --stage ------------ This is the state of the index file and the working file after -`git merge` returns control back to you, leaving the conflicting +`git-merge` returns control back to you, leaving the conflicting merge for you to resolve. Notice that the path `hello` is still -unmerged, and what you see with `git diff` at this point is +unmerged, and what you see with `git-diff` at this point is differences since stage 2 (i.e. your version). @@ -1329,7 +1329,7 @@ into it later. Obviously, this repository creation needs to be done only once. [NOTE] -`git push` uses a pair of programs, +`git-push` uses a pair of programs, `git-send-pack` on your local machine, and `git-receive-pack` on the remote machine. The communication between the two over the network internally uses an SSH connection. @@ -1349,7 +1349,7 @@ Then, make that directory into a git repository by running `.git`, we do things slightly differently: ------------ -$ GIT_DIR=my-git.git git-init +$ GIT_DIR=my-git.git git init ------------ Make sure this directory is available for others you want your @@ -1368,7 +1368,7 @@ your login shell is `bash`, only `.bashrc` is read and not If you plan to publish this repository to be accessed over http, you should do `chmod +x my-git.git/hooks/post-update` at this point. This makes sure that every time you push into this -repository, `git-update-server-info` is run. +repository, `git update-server-info` is run. Your "public repository" is now ready to accept your changes. Come back to the machine you have your private repository. From @@ -1495,9 +1495,9 @@ keeps the necessary files up-to-date. 3. Push into the public repository from your primary repository. -4. `git repack` the public repository. This establishes a big +4. `git-repack` the public repository. This establishes a big pack that contains the initial set of objects as the - baseline, and possibly `git prune` if the transport + baseline, and possibly `git-prune` if the transport used for pulling from your repository supports packed repositories. @@ -1511,14 +1511,14 @@ You can repack this private repository whenever you feel like. 6. Push your changes to the public repository, and announce it to the public. -7. Every once in a while, "git repack" the public repository. +7. Every once in a while, "git-repack" the public repository. Go back to step 5. and continue working. A recommended work cycle for a "subsystem maintainer" who works on that project and has an own "public repository" goes like this: -1. Prepare your work repository, by `git clone` the public +1. Prepare your work repository, by `git-clone` the public repository of the "project lead". The URL used for the initial cloning is stored in the remote.origin.url configuration variable. @@ -1533,7 +1533,7 @@ on that project and has an own "public repository" goes like this: point at the repository you are borrowing from. 4. Push into the public repository from your primary - repository. Run `git repack`, and possibly `git prune` if the + repository. Run `git-repack`, and possibly `git-prune` if the transport used for pulling from your repository supports packed repositories. @@ -1550,7 +1550,7 @@ like. "project lead" and possibly your "sub-subsystem maintainers" to pull from it. -7. Every once in a while, `git repack` the public repository. +7. Every once in a while, `git-repack` the public repository. Go back to step 5. and continue working. @@ -1558,7 +1558,7 @@ A recommended work cycle for an "individual developer" who does not have a "public" repository is somewhat different. It goes like this: -1. Prepare your work repository, by `git clone` the public +1. Prepare your work repository, by `git-clone` the public repository of the "project lead" (or a "subsystem maintainer", if you work on a subsystem). The URL used for the initial cloning is stored in the remote.origin.url diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index d65265835d..518d5d6d19 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -47,7 +47,7 @@ them first before running git pull. [NOTE] ================================ The `pull` command knows where to get updates from because of certain -configuration variables that were set by the first `git clone` +configuration variables that were set by the first `git-clone` command; see `git config -l` and the linkgit:git-config[1] man page for details. ================================ @@ -60,12 +60,12 @@ $ git push origin master ------------------------------------------------ to "push" those commits to the shared repository. If someone else has -updated the repository more recently, `git push`, like `cvs commit`, will +updated the repository more recently, `git-push`, like `cvs commit`, will complain, in which case you must pull any changes before attempting the push again. -In the `git push` command above we specify the name of the remote branch -to update (`master`). If we leave that out, `git push` tries to update +In the `git-push` command above we specify the name of the remote branch +to update (`master`). If we leave that out, `git-push` tries to update any branches in the remote repository that have the same name as a branch in the local repository. So the last `push` can be done with either of: diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 4d56c85260..8f473d8e11 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -84,7 +84,7 @@ of filepairs included: :100644 100644 bcd1234... 0123456... M junkfile ------------------------------------------------ -but the command invocation was "git-diff-files myfile", then the +but the command invocation was "git diff-files myfile", then the junkfile entry would be removed from the list because only "myfile" is under consideration. diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 262a4f1626..6a0d098f7c 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -147,7 +147,7 @@ properties. post-merge ----------- -This hook is invoked by `git-merge`, which happens when a `git pull` +This hook is invoked by `git-merge`, which happens when a `git-pull` is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of `git-merge` and is not executed, @@ -163,7 +163,7 @@ pre-receive ----------- This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git push` is done on a local repository. +which happens when a `git-push` is done on a local repository. Just before starting to update refs on the remote repository, the pre-receive hook is invoked. Its exit status determines the success or failure of the update. @@ -192,7 +192,7 @@ update ------ This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git push` is done on a local repository. +which happens when a `git-push` is done on a local repository. Just before updating the ref on the remote repository, the update hook is invoked. Its exit status determines the success or failure of the ref update. @@ -235,7 +235,7 @@ post-receive ------------ This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git push` is done on a local repository. +which happens when a `git-push` is done on a local repository. It executes on the remote repository once after all the refs have been updated. @@ -265,7 +265,7 @@ post-update ----------- This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git push` is done on a local repository. +which happens when a `git-push` is done on a local repository. It executes on the remote repository once after all the refs have been updated. diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt index 2881c9cb92..812ae8336b 100644 --- a/Documentation/gitignore.txt +++ b/Documentation/gitignore.txt @@ -92,7 +92,7 @@ Patterns have the following format: An example: -------------------------------------------------------------- - $ git-status + $ git status [...] # Untracked files: [...] @@ -110,7 +110,7 @@ An example: *.html # except foo.html which is maintained by hand !foo.html - $ git-status + $ git status [...] # Untracked files: [...] diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index 2afc5a3e88..e6b30cac45 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -64,7 +64,7 @@ objects/info/packs:: are available in this object store. Whenever a pack is added or removed, `git update-server-info` should be run to keep this file up-to-date if the repository is - published for dumb transports. `git repack` does this + published for dumb transports. `git-repack` does this by default. objects/info/alternates:: @@ -85,7 +85,7 @@ objects/info/http-alternates:: refs:: References are stored in subdirectories of this - directory. The `git prune` command knows to keep + directory. The `git-prune` command knows to keep objects reachable from refs found in this directory and its subdirectories. @@ -125,7 +125,7 @@ details. branches:: A slightly deprecated way to store shorthands to be used - to specify URL to `git fetch`, `git pull` and `git push` + to specify URL to `git-fetch`, `git-pull` and `git-push` commands is to store a file in `branches/<name>` and give 'name' to these commands in place of 'repository' argument. @@ -133,7 +133,7 @@ branches:: hooks:: Hooks are customization scripts used by various git commands. A handful of sample hooks are installed when - `git init` is run, but all of them are disabled by + `git-init` is run, but all of them are disabled by default. To enable, they need to be made executable. Read linkgit:githooks[5] for more details about each hook. @@ -150,10 +150,10 @@ info/refs:: This file helps dumb transports discover what refs are available in this repository. If the repository is published for dumb transports, this file should be - regenerated by `git update-server-info` every time a tag + regenerated by `git-update-server-info` every time a tag or branch is created or modified. This is normally done from the `hooks/update` hook, which is run by the - `git-receive-pack` command when you `git push` into the + `git-receive-pack` command when you `git-push` into the repository. info/grafts:: @@ -167,14 +167,14 @@ info/grafts:: info/exclude:: This file, by convention among Porcelains, stores the exclude pattern list. `.gitignore` is the per-directory - ignore file. `git status`, `git add`, `git rm` and - `git clean` look at it but the core git commands do not look + ignore file. `git-status`, `git-add`, `git-rm` and + `git-clean` look at it but the core git commands do not look at it. See also: linkgit:gitignore[5]. remotes:: Stores shorthands to be used to give URL and default refnames to interact with remote repository to - `git fetch`, `git pull` and `git push` commands. + `git-fetch`, `git-pull` and `git-push` commands. logs:: Records of changes made to refs are stored in this diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index 2c5467057a..f2624aa22b 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -212,7 +212,7 @@ designate such an argument. The index file -------------- -The primary tool we've been using to create commits is "git commit +The primary tool we've been using to create commits is "git-commit -a", which creates a commit including every change you've made to your working tree. But what if you want to commit changes only to certain files? Or only certain changes to certain files? @@ -255,7 +255,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -So "git diff" is comparing against something other than the head. +So "git-diff" is comparing against something other than the head. The thing that it's comparing against is actually the index file, which is stored in .git/index in a binary format, but whose contents we can examine with ls-files: @@ -270,9 +270,9 @@ hello world! hello world, again ------------------------------------------------ -So what our "git add" did was store a new blob and then put +So what our "git-add" did was store a new blob and then put a reference to it in the index file. If we modify the file again, -we'll see that the new modifications are reflected in the "git diff" +we'll see that the new modifications are reflected in the "git-diff" output: ------------------------------------------------ @@ -287,7 +287,7 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -With the right arguments, git diff can also show us the difference +With the right arguments, git-diff can also show us the difference between the working directory and the last commit, or between the index and the last commit: @@ -311,7 +311,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -At any time, we can create a new commit using "git commit" (without +At any time, we can create a new commit using "git-commit" (without the -a option), and verify that the state committed only includes the changes stored in the index file, not the additional change that is still only in our working tree: @@ -329,11 +329,11 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -So by default "git commit" uses the index to create the commit, not +So by default "git-commit" uses the index to create the commit, not the working tree; the -a option to commit tells it to first update the index with all changes in the working tree. -Finally, it's worth looking at the effect of "git add" on the index +Finally, it's worth looking at the effect of "git-add" on the index file: ------------------------------------------------ @@ -341,7 +341,7 @@ $ echo "goodbye, world" >closing.txt $ git add closing.txt ------------------------------------------------ -The effect of the "git add" was to add one entry to the index file: +The effect of the "git-add" was to add one entry to the index file: ------------------------------------------------ $ git ls-files --stage diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 144bacd3de..87e60379eb 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -117,7 +117,7 @@ $ git commit This will again prompt you for a message describing the change, and then record a new version of the project. -Alternatively, instead of running `git add` beforehand, you can use +Alternatively, instead of running `git-add` beforehand, you can use ------------------------------------------------ $ git commit -a @@ -138,7 +138,7 @@ Git tracks content not files Many revision control systems provide an "add" command that tells the system to start tracking changes to a new file. Git's "add" command -does something simpler and more powerful: `git add` is used both for new +does something simpler and more powerful: `git-add` is used both for new and newly modified files, and in both cases it takes a snapshot of the given files and stages that content in the index, ready for inclusion in the next commit. @@ -316,7 +316,7 @@ $ git remote add bob /home/bob/myrepo ------------------------------------------------ With this, Alice can perform the first operation alone using the -"git fetch" command without merging them with her own branch, +"git-fetch" command without merging them with her own branch, using: ------------------------------------- @@ -324,7 +324,7 @@ $ git fetch bob ------------------------------------- Unlike the longhand form, when Alice fetches from Bob using a -remote repository shorthand set up with `git remote`, what was +remote repository shorthand set up with `git-remote`, what was fetched is stored in a remote tracking branch, in this case `bob/master`. So after this: @@ -398,7 +398,7 @@ Exploring history ----------------- Git history is represented as a series of interrelated commits. We -have already seen that the git log command can list those commits. +have already seen that the git-log command can list those commits. Note that first line of each git log entry also gives a name for the commit: @@ -411,7 +411,7 @@ Date: Tue May 16 17:18:22 2006 -0700 merge-base: Clarify the comments on post processing. ------------------------------------- -We can give this name to git show to see the details about this +We can give this name to git-show to see the details about this commit. ------------------------------------- @@ -447,7 +447,7 @@ $ git show HEAD^2 # show the second parent of HEAD You can also give commits names of your own; after running ------------------------------------- -$ git-tag v2.5 1b2e1d63ff +$ git tag v2.5 1b2e1d63ff ------------------------------------- you can refer to 1b2e1d63ff by the name "v2.5". If you intend to @@ -469,13 +469,13 @@ $ git reset --hard HEAD^ # reset your current branch and working Be careful with that last command: in addition to losing any changes in the working directory, it will also remove all later commits from this branch. If this branch is the only branch containing those -commits, they will be lost. Also, don't use "git reset" on a +commits, they will be lost. Also, don't use "git-reset" on a publicly-visible branch that other developers pull from, as it will force needless merges on other developers to clean up the history. If you need to undo changes that you have pushed, use linkgit:git-revert[1] instead. -The git grep command can search for strings in any version of your +The git-grep command can search for strings in any version of your project, so ------------------------------------- @@ -484,7 +484,7 @@ $ git grep "hello" v2.5 searches for all occurrences of "hello" in v2.5. -If you leave out the commit name, git grep will search any of the +If you leave out the commit name, git-grep will search any of the files it manages in your current directory. So ------------------------------------- @@ -494,7 +494,7 @@ $ git grep "hello" is a quick way to search just the files that are tracked by git. Many git commands also take sets of commits, which can be specified -in a number of ways. Here are some examples with git log: +in a number of ways. Here are some examples with git-log: ------------------------------------- $ git log v2.5..v2.6 # commits between v2.5 and v2.6 @@ -504,7 +504,7 @@ $ git log v2.5.. Makefile # commits since v2.5 which modify # Makefile ------------------------------------- -You can also give git log a "range" of commits where the first is not +You can also give git-log a "range" of commits where the first is not necessarily an ancestor of the second; for example, if the tips of the branches "stable-release" and "master" diverged from a common commit some time ago, then @@ -523,9 +523,9 @@ $ git log experimental..stable will show the list of commits made on the stable branch but not the experimental branch. -The "git log" command has a weakness: it must present commits in a +The "git-log" command has a weakness: it must present commits in a list. When the history has lines of development that diverged and -then merged back together, the order in which "git log" presents +then merged back together, the order in which "git-log" presents those commits is meaningless. Most projects with multiple contributors (such as the linux kernel, @@ -549,7 +549,7 @@ of the file: $ git diff v2.5:Makefile HEAD:Makefile.in ------------------------------------- -You can also use "git show" to see any such file: +You can also use "git-show" to see any such file: ------------------------------------- $ git show v2.5:Makefile diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 36ab372204..ca13266b11 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -178,7 +178,7 @@ As you can see, a commit shows who made the latest change, what they did, and why. Every commit has a 40-hexdigit id, sometimes called the "object name" or the -"SHA1 id", shown on the first line of the "git show" output. You can usually +"SHA1 id", shown on the first line of the "git-show" output. You can usually refer to a commit by a shorter name, such as a tag or a branch name, but this longer name can also be useful. Most importantly, it is a globally unique name for this commit: so if you tell somebody else the object name (for @@ -390,7 +390,7 @@ references with the same shorthand name, see the "SPECIFYING REVISIONS" section of linkgit:git-rev-parse[1]. [[Updating-a-repository-with-git-fetch]] -Updating a repository with git fetch +Updating a repository with git-fetch ------------------------------------ Eventually the developer cloned from will do additional work in her @@ -417,7 +417,7 @@ $ git fetch linux-nfs ------------------------------------------------- New remote-tracking branches will be stored under the shorthand name -that you gave "git remote add", in this case linux-nfs: +that you gave "git-remote add", in this case linux-nfs: ------------------------------------------------- $ git branch -r @@ -1048,7 +1048,7 @@ $ git diff shows the difference between the working tree and the index file. -Note that "git add" always adds just the current contents of a file +Note that "git-add" always adds just the current contents of a file to the index; further changes to the same file will be ignored unless you run git-add on the file again. @@ -1111,7 +1111,7 @@ Ignoring files A project will often generate files that you do 'not' want to track with git. This typically includes files generated by a build process or temporary backup files made by your editor. Of course, 'not' tracking files with git -is just a matter of 'not' calling "`git add`" on them. But it quickly becomes +is just a matter of 'not' calling "`git-add`" on them. But it quickly becomes annoying to have these untracked files lying around; e.g. they make "`git add .`" and "`git commit -a`" practically useless, and they keep showing up in the output of "`git status`". @@ -1449,7 +1449,7 @@ Checking out an old version of a file In the process of undoing a previous bad change, you may find it useful to check out an older version of a particular file using -linkgit:git-checkout[1]. We've used git checkout before to switch +linkgit:git-checkout[1]. We've used git-checkout before to switch branches, but it has quite different behavior if it is given a path name: the command @@ -1651,7 +1651,7 @@ Sharing development with others =============================== [[getting-updates-with-git-pull]] -Getting updates with git pull +Getting updates with git-pull ----------------------------- After you clone a repository and make a few changes of your own, you @@ -1770,7 +1770,7 @@ Public git repositories Another way to submit changes to a project is to tell the maintainer of that project to pull the changes from your repository using linkgit:git-pull[1]. In the section "<<getting-updates-with-git-pull, -Getting updates with git pull>>" we described this as a way to get +Getting updates with git-pull>>" we described this as a way to get updates from the "main" repository, but it works just as well in the other direction. @@ -2735,7 +2735,7 @@ unless you've already created a reference of your own pointing to them. [[forcing-fetch]] -Forcing git fetch to do non-fast-forward updates +Forcing git-fetch to do non-fast-forward updates ------------------------------------------------ If git fetch fails because the new head of a branch is not a @@ -2810,7 +2810,7 @@ You can also add a "+" to force the update each time: $ git config remote.example.fetch +master:ref/remotes/example/master ------------------------------------------------- -Don't do this unless you're sure you won't mind "git fetch" possibly +Don't do this unless you're sure you won't mind "git-fetch" possibly throwing away commits on mybranch. Also note that all of the above configuration can be performed by @@ -3234,7 +3234,7 @@ it is with linkgit:git-fsck[1]; this may be time-consuming. Assume the output looks like this: ------------------------------------------------ -$ git-fsck --full +$ git fsck --full broken link from tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8 to blob 4b9458b3786228369c63936db65827de3cc06200 missing blob 4b9458b3786228369c63936db65827de3cc06200 @@ -3464,14 +3464,14 @@ done NOTE: Do not use local URLs here if you plan to publish your superproject! -See what files `git submodule` created: +See what files `git-submodule` created: ------------------------------------------------- $ ls -a . .. .git .gitmodules a b c d ------------------------------------------------- -The `git submodule add` command does a couple of things: +The `git-submodule add` command does a couple of things: - It clones the submodule under the current directory and by default checks out the master branch. @@ -3517,7 +3517,7 @@ init` to add the submodule repository URLs to `.git/config`: $ git submodule init ------------------------------------------------- -Now use `git submodule update` to clone the repositories and check out the +Now use `git-submodule update` to clone the repositories and check out the commits specified in the superproject: ------------------------------------------------- @@ -3527,8 +3527,8 @@ $ ls -a . .. .git a.txt ------------------------------------------------- -One major difference between `git submodule update` and `git submodule add` is -that `git submodule update` checks out a specific commit, rather than the tip +One major difference between `git-submodule update` and `git-submodule add` is +that `git-submodule update` checks out a specific commit, rather than the tip of a branch. It's like checking out a tag: the head is detached, so you're not working on a branch. @@ -3729,7 +3729,7 @@ unsaved state that you might want to restore later!) your current index. Normal operation is just ------------------------------------------------- -$ git-read-tree <sha1 of tree> +$ git read-tree <sha1 of tree> ------------------------------------------------- and your index file will now be equivalent to the tree that you saved @@ -3752,7 +3752,7 @@ index file with read-tree, and then you need to check out the result with ------------------------------------------------- -$ git-checkout-index filename +$ git checkout-index filename ------------------------------------------------- or, if you want to check out all of the index, use `-a`. @@ -3789,7 +3789,7 @@ You create a commit object by giving it the tree that describes the 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 @@ -3852,14 +3852,14 @@ linkgit:git-cat-file[1] to examine details about the object: ------------------------------------------------- -$ git-cat-file -t <objectname> +$ git cat-file -t <objectname> ------------------------------------------------- shows the type of the object, and once you have the type (which is usually implicit in where you find the object), you can use ------------------------------------------------- -$ git-cat-file blob|tree|commit|tag <objectname> +$ git cat-file blob|tree|commit|tag <objectname> ------------------------------------------------- to show its contents. NOTE! Trees have binary content, and as a result @@ -3873,7 +3873,7 @@ follow the convention of having the top commit name in `.git/HEAD`, you can do ------------------------------------------------- -$ git-cat-file commit HEAD +$ git cat-file commit HEAD ------------------------------------------------- to see what the top commit was. @@ -3897,7 +3897,7 @@ To get the "base" for the merge, you first look up the common parent of two commits with ------------------------------------------------- -$ git-merge-base <commit1> <commit2> +$ git merge-base <commit1> <commit2> ------------------------------------------------- which will return you the commit they are both based on. You should @@ -3905,7 +3905,7 @@ now look up the "tree" objects of those commits, which you can easily do with (for example) ------------------------------------------------- -$ git-cat-file commit <commitname> | head -1 +$ git cat-file commit <commitname> | head -1 ------------------------------------------------- since the tree object information is always the first line in a commit @@ -3922,7 +3922,7 @@ you have in your current index anyway). To do the merge, do ------------------------------------------------- -$ git-read-tree -m -u <origtree> <yourtree> <targettree> +$ git read-tree -m -u <origtree> <yourtree> <targettree> ------------------------------------------------- which will do all trivial merge operations for you directly in the @@ -3941,18 +3941,18 @@ entries" in it. Such an index tree can 'NOT' be written out to a tree object, and you will have to resolve any such merge clashes using other tools before you can write out the result. -You can examine such index state with `git-ls-files --unmerged` +You can examine such index state with `git ls-files --unmerged` command. An example: ------------------------------------------------ -$ git-read-tree -m $orig HEAD $target -$ git-ls-files --unmerged +$ git read-tree -m $orig HEAD $target +$ git ls-files --unmerged 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello.c 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello.c 100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello.c ------------------------------------------------ -Each line of the `git-ls-files --unmerged` output begins with +Each line of the `git ls-files --unmerged` output begins with the blob mode bits, blob SHA1, 'stage number', and the filename. The 'stage number' is git's way to say which tree it came from: stage 1 corresponds to `$orig` tree, stage 2 `HEAD` @@ -3970,9 +3970,9 @@ program, e.g. `diff3`, `merge`, or git's own merge-file, on the blob objects from these three stages yourself, like this: ------------------------------------------------ -$ git-cat-file blob 263414f... >hello.c~1 -$ git-cat-file blob 06fa6a2... >hello.c~2 -$ git-cat-file blob cc44c73... >hello.c~3 +$ git cat-file blob 263414f... >hello.c~1 +$ git cat-file blob 06fa6a2... >hello.c~2 +$ git cat-file blob cc44c73... >hello.c~3 $ git merge-file hello.c~2 hello.c~1 hello.c~3 ------------------------------------------------ @@ -3983,7 +3983,7 @@ merge result for this file is by: ------------------------------------------------- $ mv -f hello.c~2 hello.c -$ git-update-index hello.c +$ git update-index hello.c ------------------------------------------------- When a path is in unmerged state, running `git-update-index` for @@ -3996,10 +3996,10 @@ for this. There is `git-merge-index` program that extracts the stages to temporary files and calls a "merge" script on it: ------------------------------------------------- -$ git-merge-index git-merge-one-file hello.c +$ git merge-index git-merge-one-file hello.c ------------------------------------------------- -and that is what higher level `git merge -s resolve` is implemented with. +and that is what higher level `git-merge -s resolve` is implemented with. [[hacking-git]] Hacking git @@ -4127,7 +4127,7 @@ commits one by one with the function `get_revision()`. If you are interested in more details of the revision walking process, just have a look at the first implementation of `cmd_log()`; call -`git-show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you +`git show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you no longer need to call `setup_pager()` directly). Nowadays, `git log` is a builtin, which means that it is _contained_ in the @@ -4218,10 +4218,10 @@ To find out how the result can be used, just read on in `cmd_cat_file()`: ----------------------------------- Sometimes, you do not know where to look for a feature. In many such cases, -it helps to search through the output of `git log`, and then `git show` the +it helps to search through the output of `git log`, and then `git-show` the corresponding commit. -Example: If you know that there was some test case for `git bundle`, but +Example: If you know that there was some test case for `git-bundle`, but do not remember where it was (yes, you _could_ `git grep bundle t/`, but that does not illustrate the point!): |