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>
Jeff King committed
Apr 13, 2009 at 07:11 UTC
167d7445433bb6dfac6b844b99ae455129326141
2 files changed
+14
-12
Documentation/git-branch.txt
+13
-11
@@ -112,19 +112,21 @@ OPTIONS
112
Display the full sha1s in the output listing rather than abbreviating them.
113
114
--track::
115
- When creating a new branch, set up the configuration so that 'git-pull'
116
- will automatically retrieve data from the start point, which must be
117
- a branch. Use this if you always pull from the same upstream branch
118
- into the new branch, and if you do not want to use "git pull
119
- <repository> <refspec>" explicitly. This behavior is the default
120
- when the start point is a remote branch. Set the
121
- branch.autosetupmerge configuration variable to `false` if you want
122
- 'git-checkout' and 'git-branch' to always behave as if '--no-track' were
123
- given. Set it to `always` if you want this behavior when the
124
- start-point is either a local or remote branch.
115
+ When creating a new branch, set up configuration to mark the
116
+ start-point branch as "upstream" from the new branch. This
117
+ configuration will tell git to show the relationship between the
118
+ two branches in `git status` and `git branch -v`. Furthermore,
119
+ it directs `git pull` without arguments to pull from the
120
+ upstream when the new branch is checked out.
121
++
122
+This behavior is the default when the start point is a remote branch.
123
+Set the branch.autosetupmerge configuration variable to `false` if you
124
+want `git checkout` and `git branch` to always behave as if '--no-track'
125
+were given. Set it to `always` if you want this behavior when the
126
+start-point is either a local or remote branch.
127
128
--no-track::
127
- Do not set up tracking configuration, even if the
129
+ Do not set up "upstream" configuration, even if the
130
branch.autosetupmerge configuration variable is true.
131
132
--contains <commit>::
Documentation/git-checkout.txt
+1
-1
@@ -90,7 +90,7 @@ guessing results in an empty name, the guessing is aborted. You can
90
explicitly give a name with '-b' in such a case.
91
92
--no-track::
93
- Do not set up tracking configuration, even if the
93
+ Do not set up "upstream" configuration, even if the
94
branch.autosetupmerge configuration variable is true.
95
96
-l::