git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: [PATCH 5/9 v2] Documentation: clone: clarify discussion of initial branch
Date: Fri, 9 Oct 2009 18:07:39 -0500	[thread overview]
Message-ID: <20091009230739.GC4605@progeny.tock> (raw)
In-Reply-To: <7vskdsqlvh.fsf@alter.siamese.dyndns.org>

When saying the initial branch is equal to the currently active
remote branch, it is probably intended that the branch heads
point to the same commit.  Maybe it would be more useful to a
new user to emphasize that the tree contents and history are the
same.

More important, probably, is that this new branch is set up so
that "git pull" merges changes from the corresponding remote
branch.  The next paragraph addresses that directly.  What the
reader needs to know to begin with is that (1) the initial branch
is your own; if you do not pull, it won't get updated, and that
(2) the initial branch starts out at the same commit as the
upstream.

Thanks to Junio C Hamano for the wording.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Junio C Hamano wrote:

> Perhaps
> 
>     ... creates and checks out an initial branch that is forked from the
>     cloned repository's currently active branch.
> 
> would convey that (1) the initial branch is your own; if you do not pull,
> you won't get updated, and that (2) the initial branch starts out at the
> same commit as the upstream.

That does work better.  Explanation stolen for the commit message ---
I hope you don't mind.

Thanks,
Jonathan

 Documentation/git-clone.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index aacf4fd..5ebcba1 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -19,8 +19,9 @@ DESCRIPTION
 
 Clones a repository into a newly created directory, creates
 remote-tracking branches for each branch in the cloned repository
-(visible using `git branch -r`), and creates and checks out an initial
-branch equal to the cloned repository's currently active branch.
+(visible using `git branch -r`), and creates and checks out an
+initial branch that is forked from the cloned repository's
+currently active branch.
 
 After the clone, a plain `git fetch` without arguments will update
 all the remote-tracking branches, and a `git pull` without
-- 
1.6.5.rc1.199.g596ec

  reply	other threads:[~2009-10-09 23:02 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-09 10:14 [PATCH 0/9] Documentation tweaks Jonathan Nieder
2009-10-09 10:15 ` [PATCH 1/9] Describe DOCBOOK_XSL_172, ASCIIDOC_NO_ROFF options in Makefile Jonathan Nieder
2009-10-09 10:16 ` [PATCH 2/9] Documentation: git fmt-merge-message is not a script Jonathan Nieder
2009-10-09 10:16 ` [PATCH 3/9] Documentation: fix singular/plural mismatch Jonathan Nieder
2009-10-09 10:17 ` [PATCH 4/9] Documentation: say "the same" instead of "equal" Jonathan Nieder
2009-10-09 18:51   ` [PATCH 3-4/9 v2] Documentation: clarify mergeoptions description Jonathan Nieder
2009-10-09 10:18 ` [PATCH 5/9] Documentation: clone: clarify discussion of initial branch Jonathan Nieder
2009-10-09 21:48   ` Junio C Hamano
2009-10-09 23:07     ` Jonathan Nieder [this message]
2009-10-09 10:18 ` [PATCH 6/9] Documentation: branch: update --merged description Jonathan Nieder
2009-10-10  0:56   ` Junio C Hamano
2009-10-09 10:19 ` [PATCH 7/9] Documentation: clarify branch creation Jonathan Nieder
2009-10-09 16:21   ` Sean Estabrooks
2009-10-09 18:34     ` Jonathan Nieder
2009-10-10  0:57       ` Junio C Hamano
2009-10-09 10:20 ` [PATCH 8/9] Documentation: clarify "working tree" definition Jonathan Nieder
2009-10-09 10:25 ` [PATCH 9/9] racy-git.txt: explain nsec problem in more detail Jonathan Nieder
2009-10-10  0:56   ` Junio C Hamano
2009-10-10  0:58 ` [PATCH 0/9] Documentation tweaks Junio C Hamano

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=20091009230739.GC4605@progeny.tock \
    --to=jrnieder@gmail.com \
    --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).