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: Thore Husfeldt <thore.husfeldt@gmail.com>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Jakub Narebski <jnareb@gmail.com>,
	Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms
Date: Thu, 28 Oct 2010 20:21:55 +0200	[thread overview]
Message-ID: <1288290117-6734-9-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <1287851481-27952-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 |   20 +++++++++++++++++---
 1 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index d70f3e0..62b3788 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,14 @@ $ git branch -r
   origin/todo
 ------------------------------------------------
 
+In this case, "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 are created in
+the local repository at clone time, as a copy of the remote branches.
+They are references that will be updated by "git fetch" (hence by "git
+pull"), and by "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 +1725,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 the changes from the remote branches to your
+remote-tracking branches `origin/*`, and merge default branch in 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-10-28 18:28 UTC|newest]

Thread overview: 103+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-23 16:31 [PATCH 00/11] More consistant terminology ("remote-tracking branch", "not updated") Matthieu Moy
2010-10-23 16:31 ` [PATCH 01/10] Better "Changed but not updated" message in git-status Matthieu Moy
2010-10-23 18:13   ` Jonathan Nieder
2010-10-23 18:33     ` Matthieu Moy
2010-10-23 18:55     ` Jakub Narebski
2010-10-23 16:31 ` [PATCH 02/10] Remplace "remote tracking" with "remote-tracking" Matthieu Moy
2010-10-23 18:16   ` Jonathan Nieder
2010-10-23 18:31   ` Jonathan Nieder
2010-10-23 19:01     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 03/10] Change remote tracking to remote-tracking in non-trivial places Matthieu Moy
2010-10-23 18:44   ` Jonathan Nieder
2010-10-23 19:04     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 04/10] Change "tracking branch" to "remote-tracking branch" Matthieu Moy
2010-10-23 18:48   ` Jonathan Nieder
2010-10-28  1:55     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 05/10] Change "tracking branch" to "remote-tracking branch" in C code Matthieu Moy
2010-10-23 18:51   ` Jonathan Nieder
2010-10-26 22:15     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 06/10] Change incorrect uses of "remote branch" meaning "remote-tracking" Matthieu Moy
2010-10-23 16:31 ` [PATCH 07/10] Change incorrect "remote branch" to "remote tracking branch" in C code Matthieu Moy
2010-10-23 18:58   ` Jonathan Nieder
2010-10-23 19:19     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 08/10] Use 'remote-tracking branch' in generated merge messages Matthieu Moy
2010-10-23 19:04   ` Jonathan Nieder
2010-10-23 19:53     ` Matthieu Moy
2010-10-23 16:31 ` [PATCH 09/10] user-manual.txt: explain better the remote(-tracking) branch terms Matthieu Moy
2010-10-23 19:08   ` Jonathan Nieder
2010-10-23 19:34     ` Matthieu Moy
2010-10-24 14:47   ` Thore Husfeldt
2010-10-24 15:18     ` Jonathan Nieder
2010-10-24 23:32     ` Jakub Narebski
2010-10-26  3:11     ` Matthieu Moy
2010-10-26  4:16       ` Miles Bader
2010-10-23 16:31 ` [PATCH 10/10] git-branch.txt: mention --set-upstream as a way to change upstream configuration Matthieu Moy
2010-10-23 18:55 ` [PATCH 00/11] More consistant terminology ("remote-tracking branch", "not updated") Jakub Narebski
2010-10-23 19:11   ` Jonathan Nieder
2010-10-25 17:30     ` Matthieu Moy
2010-10-25  6:08 ` [PATCH v2 00/10] " Matthieu Moy
2010-10-25  6:08 ` [PATCH 01/10] Better "Changed but not updated" message in git-status Matthieu Moy
2010-10-25  6:08 ` [PATCH 02/10] Replace "remote tracking" with "remote-tracking" Matthieu Moy
2010-10-25  6:08 ` [PATCH 03/10] Change remote tracking to remote-tracking in non-trivial places Matthieu Moy
2010-10-25  6:08 ` [PATCH 04/10] Change "tracking branch" to "remote-tracking branch" Matthieu Moy
2010-10-25  6:08 ` [PATCH 05/10] Change "tracking branch" to "remote-tracking branch" in C code Matthieu Moy
2010-10-25  6:08 ` [PATCH 06/10] Change incorrect uses of "remote branch" meaning "remote-tracking" Matthieu Moy
2010-10-25  6:08 ` [PATCH 07/10] Change incorrect "remote branch" to "remote tracking branch" in C code Matthieu Moy
2010-10-25  6:08 ` [PATCH 08/10] Use 'remote-tracking branch' in generated merge messages Matthieu Moy
2010-10-25  6:08 ` [PATCH 09/10] user-manual.txt: explain better the remote(-tracking) branch terms Matthieu Moy
2010-10-26  6:07   ` Jay Soffian
2010-10-26 22:13     ` Matthieu Moy
2010-10-26  6:20   ` Jay Soffian
2010-10-27  0:01     ` Matthieu Moy
2010-10-27  0:06       ` [PATCH] " Matthieu Moy
2010-10-25  6:08 ` [PATCH 10/10] git-branch.txt: mention --set-upstream as a way to change upstream configuration Matthieu Moy
2010-10-25 17:52 ` [PATCH 00/11] More consistant terminology ("remote-tracking branch", "not updated") Drew Northup
2010-10-28 18:21 ` [PATCH 00/10 v3] " Matthieu Moy
2010-10-28 18:21 ` [PATCH 01/10] Better "Changed but not updated" message in git-status Matthieu Moy
2010-10-28 18:35   ` Jonathan Nieder
2010-10-28 21:46     ` Junio C Hamano
2010-10-28 22:09       ` Jonathan Nieder
2010-10-28 22:47         ` Matthieu Moy
2010-10-28 23:20           ` Junio C Hamano
2010-10-28 23:39             ` Matthieu Moy
2010-10-29 21:06         ` Drew Northup
2010-10-30  4:00           ` Matthieu Moy
2010-10-28 18:21 ` [PATCH 02/10] Replace "remote tracking" with "remote-tracking" Matthieu Moy
2010-10-28 19:52   ` Jonathan Nieder
2010-10-28 18:21 ` [PATCH 03/10] Change remote tracking to remote-tracking in non-trivial places Matthieu Moy
2010-10-28 18:39   ` Jonathan Nieder
2010-10-28 21:50     ` Matthieu Moy
2010-10-28 22:13       ` Jonathan Nieder
2010-10-28 22:40         ` Matthieu Moy
2010-10-29 17:26           ` Drew Northup
2010-10-28 18:21 ` [PATCH 04/10] Change "tracking branch" to "remote-tracking branch" Matthieu Moy
2010-10-28 19:56   ` Jonathan Nieder
2010-10-28 18:21 ` [PATCH 05/10] Change incorrect uses of "remote branch" meaning "remote-tracking" Matthieu Moy
2010-10-28 18:21 ` [PATCH 06/10] Change incorrect "remote branch" to "remote tracking branch" in C code Matthieu Moy
2010-10-28 19:13   ` Jonathan Nieder
2010-10-28 22:34     ` Matthieu Moy
2010-10-28 23:23       ` Jonathan Nieder
2010-10-28 18:21 ` [PATCH 07/10] Use 'remote-tracking branch' in generated merge messages Matthieu Moy
2010-10-28 18:21 ` Matthieu Moy [this message]
2010-10-28 19:42   ` [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms Jonathan Nieder
2010-10-28 23:40     ` Matthieu Moy
2010-10-28 18:21 ` [PATCH 09/10] user-manual: remote-tracking can be checked out, with detached HEAD Matthieu Moy
2010-10-28 18:21 ` [PATCH 10/10] git-branch.txt: mention --set-upstream as a way to change upstream configuration Matthieu Moy
2010-10-28 20:08   ` Jonathan Nieder
2010-10-30  4:10 ` [PATCH 00/11 v4] More consistant terminology Matthieu Moy
2010-10-30  6:58   ` Jonathan Nieder
2010-10-30  4:10 ` [PATCH 01/11] Better "Changed but not updated" message in git-status Matthieu Moy
2010-10-30  4:10 ` [PATCH 02/11] Replace "remote tracking" with "remote-tracking" Matthieu Moy
2010-10-30  4:10 ` [PATCH 03/11] Change remote tracking to remote-tracking in non-trivial places Matthieu Moy
2010-10-30  4:10 ` [PATCH 04/11] everyday.txt: change "tracking branch" to "remote-tracking branch" Matthieu Moy
2010-10-30  4:10 ` [PATCH 05/11] Change " Matthieu Moy
2010-10-30  4:10 ` [PATCH 06/11] Change incorrect uses of "remote branch" meaning "remote-tracking" Matthieu Moy
2010-10-30  4:10 ` [PATCH 07/11] Change incorrect "remote branch" to "remote tracking branch" in C code Matthieu Moy
2010-10-30  4:10 ` [PATCH 08/11] Use 'remote-tracking branch' in generated merge messages Matthieu Moy
2010-10-30  4:10 ` [PATCH 09/11] user-manual.txt: explain better the remote(-tracking) branch terms Matthieu Moy
2010-10-30  7:18   ` Jonathan Nieder
2010-10-31 14:57     ` Matthieu Moy
2010-10-30  4:10 ` [PATCH 10/11] user-manual: remote-tracking can be checked out, with detached HEAD Matthieu Moy
2010-10-30  4:10 ` [PATCH 11/11] 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-11-02 15:31 [PATCH 00/10 v4] More consistant terminology Matthieu Moy
2010-11-02 15:31 ` [PATCH 08/10] user-manual.txt: explain better the remote(-tracking) branch terms Matthieu Moy
2010-11-02 22:58   ` Peter Krefting

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=1288290117-6734-9-git-send-email-Matthieu.Moy@imag.fr \
    --to=matthieu.moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jnareb@gmail.com \
    --cc=jrnieder@gmail.com \
    --cc=thore.husfeldt@gmail.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).