git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Martin Nordholts <enselic@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH] Clarify the git-branch documentation of default start-point
Date: Thu, 18 Jun 2009 07:41:13 +0200	[thread overview]
Message-ID: <1245303673.24201.3.camel@localhost.localdomain> (raw)

For someone not deeply into git it is easy to assume that start-point
of git-branch will deafult to origin/remotebranch when executing the
following command sequence:

  git checkout origin/remotebranch
  git branch localbranch

This change clarifies the git-branch documentation regarding this.
---
 Documentation/git-branch.txt |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index ae201de..426f707 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -148,7 +148,10 @@ start-point is either a local or remote branch.
 <start-point>::
 	The new branch will be created with a HEAD equal to this.  It may
 	be given as a branch name, a commit-id, or a tag.  If this option
-	is omitted, the current branch is assumed.
+	is omitted, the current branch is assumed.  Note that checking
+	out a remote branch does not make it the current branch.  If a
+	remote branch is desired as start-point it must be an explicity
+	specified.
 
 <oldbranch>::
 	The name of an existing branch to rename.
-- 
1.6.0.6

             reply	other threads:[~2009-06-18  5:39 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-06-18  5:41 Martin Nordholts [this message]
2009-06-18  5:48 ` [PATCH] Clarify the git-branch documentation of default start-point Junio C Hamano
2009-06-18  6:04   ` Martin Nordholts
2009-06-18  7:33     ` Junio C Hamano
2009-06-18 17:21       ` Martin Nordholts
2009-06-18  7:57     ` Michael J Gruber

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=1245303673.24201.3.camel@localhost.localdomain \
    --to=enselic@gmail.com \
    --cc=git@vger.kernel.org \
    /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).