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>
This commit is contained in:
Matthieu Moy
2010-11-02 16:31:24 +01:00
committed by Junio C Hamano
parent 8b3f3f84b2
commit 29b9a66f28
6 changed files with 18 additions and 15 deletions

View File

@ -601,8 +601,9 @@ branch.autosetupmerge::
this behavior can be chosen per-branch using the `--track` this behavior can be chosen per-branch using the `--track`
and `--no-track` options. The valid settings are: `false` -- no and `--no-track` options. The valid settings are: `false` -- no
automatic setup is done; `true` -- automatic setup is done when the automatic setup is done; `true` -- automatic setup is done when the
starting point is a remote branch; `always` -- automatic setup is starting point is a remote-tracking branch; `always` --
done when the starting point is either a local branch or remote automatic setup is done when the starting point is either a
local branch or remote-tracking
branch. This option defaults to true. branch. This option defaults to true.
branch.autosetuprebase:: branch.autosetuprebase::
@ -613,7 +614,7 @@ branch.autosetuprebase::
When `local`, rebase is set to true for tracked branches of When `local`, rebase is set to true for tracked branches of
other local branches. other local branches.
When `remote`, rebase is set to true for tracked branches of When `remote`, rebase is set to true for tracked branches of
remote branches. remote-tracking branches.
When `always`, rebase will be set to true for all tracking When `always`, rebase will be set to true for all tracking
branches. branches.
See "branch.autosetupmerge" for details on how to set up a See "branch.autosetupmerge" for details on how to set up a

View File

@ -37,9 +37,9 @@ Note that this will create the new branch, but it will not switch the
working tree to it; use "git checkout <newbranch>" to switch to the working tree to it; use "git checkout <newbranch>" to switch to the
new branch. new branch.
When a local branch is started off a remote branch, git sets up the When a local branch is started off a remote-tracking branch, git sets up the
branch so that 'git pull' will appropriately merge from branch so that 'git pull' will appropriately merge from
the remote branch. This behavior may be changed via the global the remote-tracking branch. This behavior may be changed via the global
`branch.autosetupmerge` configuration flag. That setting can be `branch.autosetupmerge` configuration flag. That setting can be
overridden by using the `--track` and `--no-track` options. overridden by using the `--track` and `--no-track` options.
@ -89,7 +89,8 @@ OPTIONS
Move/rename a branch even if the new branch name already exists. Move/rename a branch even if the new branch name already exists.
--color[=<when>]:: --color[=<when>]::
Color branches to highlight current, local, and remote branches. Color branches to highlight current, local, and
remote-tracking branches.
The value must be always (the default), never, or auto. The value must be always (the default), never, or auto.
--no-color:: --no-color::
@ -125,11 +126,11 @@ OPTIONS
it directs `git pull` without arguments to pull from the it directs `git pull` without arguments to pull from the
upstream when the new branch is checked out. upstream when the new branch is checked out.
+ +
This behavior is the default when the start point is a remote branch. This behavior is the default when the start point is a remote-tracking branch.
Set the branch.autosetupmerge configuration variable to `false` if you Set the branch.autosetupmerge configuration variable to `false` if you
want `git checkout` and `git branch` to always behave as if '--no-track' 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 were given. Set it to `always` if you want this behavior when the
start-point is either a local or remote branch. start-point is either a local or remote-tracking branch.
--no-track:: --no-track::
Do not set up "upstream" configuration, even if the Do not set up "upstream" configuration, even if the

View File

@ -98,7 +98,7 @@ entries; instead, unmerged entries are ignored.
"--track" in linkgit:git-branch[1] for details. "--track" in linkgit:git-branch[1] for details.
+ +
If no '-b' option is given, the name of the new branch will be If no '-b' option is given, the name of the new branch will be
derived from the remote branch. If "remotes/" or "refs/remotes/" derived from the remote-tracking branch. If "remotes/" or "refs/remotes/"
is prefixed it is stripped away, and then the part up to the is prefixed it is stripped away, and then the part up to the
next slash (which would be the nickname of the remote) is removed. next slash (which would be the nickname of the remote) is removed.
This would tell us to use "hack" as the local branch when branching This would tell us to use "hack" as the local branch when branching

View File

@ -131,7 +131,7 @@ objects from the source repository into a pack in the cloned repository.
Set up a mirror of the source repository. This implies `--bare`. Set up a mirror of the source repository. This implies `--bare`.
Compared to `--bare`, `--mirror` not only maps local branches of the Compared to `--bare`, `--mirror` not only maps local branches of the
source to local branches of the target, it maps all refs (including source to local branches of the target, it maps all refs (including
remote branches, notes etc.) and sets up a refspec configuration such remote-tracking branches, notes etc.) and sets up a refspec configuration such
that all these refs are overwritten by a `git remote update` in the that all these refs are overwritten by a `git remote update` in the
target repository. target repository.

View File

@ -37,7 +37,7 @@ OPTIONS
--all:: --all::
Instead of using only the annotated tags, use any ref Instead of using only the annotated tags, use any ref
found in `.git/refs/`. This option enables matching found in `.git/refs/`. This option enables matching
any known branch, remote branch, or lightweight tag. any known branch, remote-tracking branch, or lightweight tag.
--tags:: --tags::
Instead of using only the annotated tags, use any tag Instead of using only the annotated tags, use any tag

View File

@ -1724,7 +1724,8 @@ accomplish the above with just a simple
$ git pull $ git pull
------------------------------------------------- -------------------------------------------------
More generally, a branch that is created from a remote branch will pull More generally, a branch that is created from a remote-tracking branch
will pull
by default from that branch. See the descriptions of the by default from that branch. See the descriptions of the
branch.<name>.remote and branch.<name>.merge options in branch.<name>.remote and branch.<name>.merge options in
linkgit:git-config[1], and the discussion of the `--track` option in 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
$ cd work $ cd work
------------------------------------------------- -------------------------------------------------
Linus's tree will be stored in the remote branch named origin/master, Linus's tree will be stored in the remote-tracking branch named origin/master,
and can be updated using linkgit:git-fetch[1]; you can track other and can be updated using linkgit:git-fetch[1]; you can track other
public trees using linkgit:git-remote[1] to set up a "remote" and public trees using linkgit:git-remote[1] to set up a "remote" and
linkgit:git-fetch[1] to keep them up-to-date; see 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
may be lost, as we saw in the previous section. may be lost, as we saw in the previous section.
[[remote-branch-configuration]] [[remote-branch-configuration]]
Configuring remote branches Configuring remote-tracking branches
--------------------------- ------------------------------------
We saw above that "origin" is just a shortcut to refer to the We saw above that "origin" is just a shortcut to refer to the
repository that you originally cloned from. This information is repository that you originally cloned from. This information is