mirrors/git
0
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-24 18:33:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

user-manual.txt: explain better the remote(-tracking) branch terms

Browse Source 
Now that the documentation is mostly consistant in the use of "remote
branch" Vs "remote-tracking branch", let's make this distinction explicit
early in the user-manual.

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 22:06:20 +01:00 committed by Junio C Hamano
parent 13931236b9
commit 66a062a125
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/user-manual.txt
View File

@ -344,7 +344,8 @@ Examining branches from a remote repository
The "master" branch that was created at the time you cloned is a copy The "master" branch that was created at the time you cloned is a copy
of the HEAD in the repository that you cloned from. That repository of the HEAD in the repository that you cloned from. That repository
may also have had other branches, though, and your local repository may also have had other branches, though, and your local repository
keeps branches which track each of those remote branches, which you keeps branches which track each of those remote branches, called
remote-tracking branches, which you
can view using the "-r" option to linkgit:git-branch[1]: can view using the "-r" option to linkgit:git-branch[1]:
------------------------------------------------ ------------------------------------------------
@ -359,6 +360,13 @@ $ git branch -r
origin/todo origin/todo
------------------------------------------------ ------------------------------------------------
In this example, "origin" is called a remote repository, or "remote"
for short. The branches of this repository are called "remote
branches" from our point of view. The remote-tracking branches listed
above were created based on the remote branches at clone time and will
be updated by "git fetch" (hence "git pull") and "git push". See
<<Updating-a-repository-With-git-fetch>> for details.
You cannot check out these remote-tracking branches, but you can You cannot check out these remote-tracking branches, but you can
examine them on a branch of your own, just as you would a tag: examine them on a branch of your own, just as you would a tag:
@ -1716,14 +1724,19 @@ one step:
$ git pull origin master $ git pull origin master
------------------------------------------------- -------------------------------------------------
In fact, if you have "master" checked out, then by default "git pull" In fact, if you have "master" checked out, then this branch has been
merges from the HEAD branch of the origin repository. So often you can configured by "git clone" to get changes from the HEAD branch of the
origin repository. So often you can
accomplish the above with just a simple accomplish the above with just a simple
------------------------------------------------- -------------------------------------------------
$ git pull $ git pull
------------------------------------------------- -------------------------------------------------
This command will fetch changes from the remote branches to your
remote-tracking branches `origin/*`, and merge the default branch into
the current branch.
More generally, a branch that is created from a remote-tracking branch More generally, a branch that is created from a remote-tracking branch
will pull will pull
by default from that branch. See the descriptions of the by default from that branch. See the descriptions of the