diff options
| author |  Jeff King <peff@peff.net> | 2009-04-13 07:11:56 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2009-04-13 09:02:18 -0700 |
| commit | 167d7445433bb6dfac6b844b99ae455129326141 (patch) | |
| tree | 463da3bb726f40057de40f455d07d6ac7c09a463 | |
| parent | doc: clarify --no-track option (diff) | |
| download | tgif-167d7445433bb6dfac6b844b99ae455129326141.tar.xz | |
doc: refer to tracking configuration as "upstream"
The term "tracking" often creates confusion between remote
tracking branches and local branches which track a remote
branch. The term "upstream" captures more clearly the idea
of "branch A is based on branch B in some way", so it makes
sense to mention it.
At the same time, upstream branches are used for more
than just git-pull these days; let's mention that here.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-branch.txt | 24 | ||||
| -rw-r--r-- | Documentation/git-checkout.txt | 2 |
2 files changed, 14 insertions, 12 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 19f1b0d9f9..cbd4275871 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -112,19 +112,21 @@ OPTIONS Display the full sha1s in the output listing rather than abbreviating them. --track:: - When creating a new branch, set up the configuration so that 'git-pull' - will automatically retrieve data from the start point, which must be - a branch. Use this if you always pull from the same upstream branch - into the new branch, and if you do not want to use "git pull - <repository> <refspec>" explicitly. This behavior is the default - when the start point is a remote branch. Set the - branch.autosetupmerge configuration variable to `false` if you want - 'git-checkout' and 'git-branch' to always behave as if '--no-track' were - given. Set it to `always` if you want this behavior when the - start-point is either a local or remote branch. + When creating a new branch, set up configuration to mark the + start-point branch as "upstream" from the new branch. This + configuration will tell git to show the relationship between the + two branches in `git status` and `git branch -v`. Furthermore, + it directs `git pull` without arguments to pull from the + upstream when the new branch is checked out. ++ +This behavior is the default when the start point is a remote branch. +Set the branch.autosetupmerge configuration variable to `false` if you +want `git checkout` and `git branch` to always behave as if '--no-track' +were given. Set it to `always` if you want this behavior when the +start-point is either a local or remote branch. --no-track:: - Do not set up tracking configuration, even if the + Do not set up "upstream" configuration, even if the branch.autosetupmerge configuration variable is true. --contains <commit>:: diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 4992fc61eb..16d3c872a0 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -90,7 +90,7 @@ guessing results in an empty name, the guessing is aborted. You can explicitly give a name with '-b' in such a case. --no-track:: - Do not set up tracking configuration, even if the + Do not set up "upstream" configuration, even if the branch.autosetupmerge configuration variable is true. -l:: |