Change incorrect uses of "remote branch" meaning "remote-tracking"
"remote branch" is a branch hosted in a remote repository, while "remote-tracking branch" is a copy of such branch, hosted locally. The distinction is subtle when the copy is up-to-date, but rather fundamental to understand what "git fetch" and "git push" do. This patch should fix all incorrect usages in Documentation/ directory. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Nov 2, 2010 at 16:31 UTC
29b9a66f285f602ad67362ccbe2c6bfaac769f54
6 files changed
+18
-15
Documentation/config.txt
+4
-3
@@ -601,8 +601,9 @@ branch.autosetupmerge::
601
this behavior can be chosen per-branch using the `--track`
602
and `--no-track` options. The valid settings are: `false` -- no
603
automatic setup is done; `true` -- automatic setup is done when the
604
- starting point is a remote branch; `always` -- automatic setup is
605
- done when the starting point is either a local branch or remote
604
+ starting point is a remote-tracking branch; `always` --
605
+ automatic setup is done when the starting point is either a
606
+ local branch or remote-tracking
607
branch. This option defaults to true.
608
609
branch.autosetuprebase::
@@ -613,7 +614,7 @@ branch.autosetuprebase::
614
When `local`, rebase is set to true for tracked branches of
615
other local branches.
616
When `remote`, rebase is set to true for tracked branches of
616
- remote branches.
617
+ remote-tracking branches.
618
When `always`, rebase will be set to true for all tracking
619
branches.
620
See "branch.autosetupmerge" for details on how to set up a
Documentation/git-branch.txt
+6
-5
@@ -37,9 +37,9 @@ Note that this will create the new branch, but it will not switch the
37
working tree to it; use "git checkout <newbranch>" to switch to the
38
new branch.
39
40
-When a local branch is started off a remote branch, git sets up the
40
+When a local branch is started off a remote-tracking branch, git sets up the
41
branch so that 'git pull' will appropriately merge from
42
-the remote branch. This behavior may be changed via the global
42
+the remote-tracking branch. This behavior may be changed via the global
43
`branch.autosetupmerge` configuration flag. That setting can be
44
overridden by using the `--track` and `--no-track` options.
45
@@ -89,7 +89,8 @@ OPTIONS
89
Move/rename a branch even if the new branch name already exists.
90
91
--color[=<when>]::
92
- Color branches to highlight current, local, and remote branches.
92
+ Color branches to highlight current, local, and
93
+ remote-tracking branches.
94
The value must be always (the default), never, or auto.
95
96
--no-color::
@@ -125,11 +126,11 @@ OPTIONS
126
it directs `git pull` without arguments to pull from the
127
upstream when the new branch is checked out.
128
+
128
-This behavior is the default when the start point is a remote branch.
129
+This behavior is the default when the start point is a remote-tracking branch.
130
Set the branch.autosetupmerge configuration variable to `false` if you
131
want `git checkout` and `git branch` to always behave as if '--no-track'
132
were given. Set it to `always` if you want this behavior when the
132
-start-point is either a local or remote branch.
133
+start-point is either a local or remote-tracking branch.
134
135
--no-track::
136
Do not set up "upstream" configuration, even if the
Documentation/git-checkout.txt
+1
-1
@@ -98,7 +98,7 @@ entries; instead, unmerged entries are ignored.
98
"--track" in linkgit:git-branch[1] for details.
99
+
100
If no '-b' option is given, the name of the new branch will be
101
-derived from the remote branch. If "remotes/" or "refs/remotes/"
101
+derived from the remote-tracking branch. If "remotes/" or "refs/remotes/"
102
is prefixed it is stripped away, and then the part up to the
103
next slash (which would be the nickname of the remote) is removed.
104
This would tell us to use "hack" as the local branch when branching
Documentation/git-clone.txt
+1
-1
@@ -131,7 +131,7 @@ objects from the source repository into a pack in the cloned repository.
131
Set up a mirror of the source repository. This implies `--bare`.
132
Compared to `--bare`, `--mirror` not only maps local branches of the
133
source to local branches of the target, it maps all refs (including
134
- remote branches, notes etc.) and sets up a refspec configuration such
134
+ remote-tracking branches, notes etc.) and sets up a refspec configuration such
135
that all these refs are overwritten by a `git remote update` in the
136
target repository.
137
Documentation/git-describe.txt
+1
-1
@@ -37,7 +37,7 @@ OPTIONS
37
--all::
38
Instead of using only the annotated tags, use any ref
39
found in `.git/refs/`. This option enables matching
40
- any known branch, remote branch, or lightweight tag.
40
+ any known branch, remote-tracking branch, or lightweight tag.
41
42
--tags::
43
Instead of using only the annotated tags, use any tag
Documentation/user-manual.txt
+5
-4
@@ -1724,7 +1724,8 @@ accomplish the above with just a simple
1724
$ git pull
1725
-------------------------------------------------
1726
1727
-More generally, a branch that is created from a remote branch will pull
1727
+More generally, a branch that is created from a remote-tracking branch
1728
+will pull
1729
by default from that branch. See the descriptions of the
1730
branch.<name>.remote and branch.<name>.merge options in
1731
linkgit:git-config[1], and the discussion of the `--track` option in
@@ -2106,7 +2107,7 @@ $ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
2107
$ cd work
2108
-------------------------------------------------
2109
2109
-Linus's tree will be stored in the remote branch named origin/master,
2110
+Linus's tree will be stored in the remote-tracking branch named origin/master,
2111
and can be updated using linkgit:git-fetch[1]; you can track other
2112
public trees using linkgit:git-remote[1] to set up a "remote" and
2113
linkgit:git-fetch[1] to keep them up-to-date; see
@@ -2800,8 +2801,8 @@ Be aware that commits that the old version of example/master pointed at
2801
may be lost, as we saw in the previous section.
2802
2803
[[remote-branch-configuration]]
2803
-Configuring remote branches
2804
----------------------------
2804
+Configuring remote-tracking branches
2805
+------------------------------------
2806
2807
We saw above that "origin" is just a shortcut to refer to the
2808
repository that you originally cloned from. This information is