git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms
Date: Tue,  2 Nov 2010 16:31:26 +0100	[thread overview]
Message-ID: <1288711888-21528-9-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <1288711888-21528-1-git-send-email-Matthieu.Moy@imag.fr>

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>
---
 Documentation/user-manual.txt |   19 ++++++++++++++++---
 1 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index d70f3e0..6d6bd8d 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -344,7 +344,8 @@ Examining branches from a remote repository
 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
 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]:
 
 ------------------------------------------------
@@ -359,6 +360,13 @@ $ git branch -r
   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
 examine them on a branch of your own, just as you would a tag:
 
@@ -1716,14 +1724,19 @@ one step:
 $ git pull origin master
 -------------------------------------------------
 
-In fact, if you have "master" checked out, then by default "git pull"
-merges from the HEAD branch of the origin repository.  So often you can
+In fact, if you have "master" checked out, then this branch has been
+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
 
 -------------------------------------------------
 $ 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
 will pull
 by default from that branch.  See the descriptions of the
-- 
1.7.3.2.183.g2e7b0

  parent reply	other threads:[~2010-11-02 15:36 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-11-02 15:31 [PATCH 00/10 v4] More consistant terminology Matthieu Moy
2010-11-02 15:31 ` [PATCH 01/10] Better "Changed but not updated" message in git-status Matthieu Moy
2010-11-02 15:31 ` [PATCH 02/10] Replace "remote tracking" with "remote-tracking" Matthieu Moy
2010-11-02 15:31 ` [PATCH 03/10] Change remote tracking to remote-tracking in non-trivial places Matthieu Moy
2010-11-02 15:31 ` [PATCH 04/10] everyday.txt: change "tracking branch" to "remote-tracking branch" Matthieu Moy
2010-11-02 15:31 ` [PATCH 05/10] Change " Matthieu Moy
2010-11-02 15:43   ` Santi Béjar
2010-11-02 20:32     ` [PATCH] Forgotten 'tracking' -> 'remote-tracking' Matthieu Moy
2010-11-02 15:31 ` [PATCH 06/10] Change incorrect uses of "remote branch" meaning "remote-tracking" Matthieu Moy
2010-11-02 15:31 ` [PATCH 07/10] Change incorrect "remote branch" to "remote tracking branch" in C code Matthieu Moy
2010-11-09 16:15   ` What's the -s switch in git show? Will Hall
2010-11-09 17:12     ` [PATCH] Documentation: document show -s Jonathan Nieder
2010-11-02 15:31 ` Matthieu Moy [this message]
2010-11-02 22:58   ` [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms Peter Krefting
2010-11-02 21:06     ` [PATCH] " Matthieu Moy
2010-11-02 15:31 ` [PATCH 09/10] user-manual: remote-tracking can be checked out, with detached HEAD Matthieu Moy
2010-11-02 15:31 ` [PATCH 10/10] git-branch.txt: mention --set-upstream as a way to change upstream configuration Matthieu Moy
  -- strict thread matches above, loose matches on Subject: below --
2010-10-23 16:31 [PATCH 00/11] More consistant terminology ("remote-tracking branch", "not updated") Matthieu Moy
2010-10-28 18:21 ` [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms Matthieu Moy
2010-10-28 19:42   ` Jonathan Nieder
2010-10-28 23:40     ` Matthieu Moy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1288711888-21528-9-git-send-email-Matthieu.Moy@imag.fr \
    --to=matthieu.moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).