From: Jonathan Nieder <jrnieder@gmail.com>
To: Konstantin Khomoutov <flatworm@users.sourceforge.net>
Cc: "João Paulo Melo de Sampaio" <jpmelos@gmail.com>,
"GIT Mailing List" <git@vger.kernel.org>,
"Jakub Narebski" <jnareb@gmail.com>
Subject: [PATCH 2/2] Documentation/branch: briefly explain what a branch is
Date: Sun, 30 Jan 2011 15:35:10 -0600 [thread overview]
Message-ID: <20110130213510.GC10039@burratino> (raw)
In-Reply-To: <20110130213258.GA10039@burratino>
The new reader might not know what git refs are, that history is a
graph, the distinction between local, remote-tracking, and remote
branches, or how to visualize what is going on. After this change,
those things are still probably not evident but at least there is an
early reminder of some of it.
Also explain how to create a branch before explaining how to list
them. Based roughly on the description of v0.99.1~53 (Add "git
branch" script, 2005-07-11).
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Documentation/git-branch.txt | 35 ++++++++++++++++++++---------------
1 files changed, 20 insertions(+), 15 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index d3eeb94..abad7ba 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -18,6 +18,26 @@ SYNOPSIS
DESCRIPTION
-----------
+Branches are references to commit objects, representing the tip of a
+line of history. The branch you are working on is referred to
+by HEAD and the corresponding reference is updated each time
+linkgit:git-commit[1] or linkgit:git-merge[1] makes a new commit.
+
+'git branch' <branchname> [<start-point>]::
+ Creates a new branch named `<branchname>`.
+ If a starting point is specified, that will be where the branch
+ is created; otherwise, the new branch points to the `HEAD` commit.
++
+This will create a new branch, but it does not switch the working tree
+to it. Use "git checkout <newbranch>" to start working on the new branch.
+
+When a local branch is started off a remote-tracking branch, git sets up the
+branch so that 'git pull' will appropriately merge from
+the remote-tracking branch. This behavior may be changed via the global
+`branch.autosetupmerge` configuration flag. That setting can be
+overridden by using the `--track` and `--no-track` options, and
+changed later using `git branch --set-upstream`.
+
'git branch' [-r | -a]::
With no arguments, existing branches are listed and the current
branch will be highlighted with an asterisk.
@@ -34,21 +54,6 @@ DESCRIPTION
commit will be listed. If the <commit> argument is missing it
defaults to 'HEAD' (i.e. the tip of the current branch).
-'git branch' <branchname> [<start-point>]::
- The command's second form creates a new branch head named <branchname>
- which points to the current 'HEAD', or <start-point> if given.
-+
-Note that this will create the new branch, but it will not switch the
-working tree to it; use "git checkout <newbranch>" to switch to the
-new branch.
-+
-When a local branch is started off a remote-tracking branch, git sets up the
-branch so that 'git pull' will appropriately merge from
-the remote-tracking branch. This behavior may be changed via the global
-`branch.autosetupmerge` configuration flag. That setting can be
-overridden by using the `--track` and `--no-track` options, and
-changed later using `git branch --set-upstream`.
-
'git branch' (-m | -M) <oldbranch> <newbranch>::
With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
If <oldbranch> had a corresponding reflog, it is renamed to match
--
1.7.4.rc3
next prev parent reply other threads:[~2011-01-30 21:35 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-01-30 15:05 Remote branchs -- how can I check them out? João Paulo Melo de Sampaio
2011-01-30 16:05 ` Konstantin Khomoutov
2011-01-30 21:32 ` [RFC/PATCH 0/2] " Jonathan Nieder
2011-01-30 21:33 ` [PATCH 1/2] Documentation/branch: split description into subsections Jonathan Nieder
2011-01-31 1:55 ` Sverre Rabbelier
2011-01-30 21:35 ` Jonathan Nieder [this message]
2011-01-31 2:51 ` [PATCH 2/2] Documentation/branch: briefly explain what a branch is Junio C Hamano
2011-01-31 0:35 ` [RFC/PATCH 0/2] Re: Remote branchs -- how can I check them out? João Paulo Melo de Sampaio
2011-01-30 16:35 ` Jakub Narebski
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=20110130213510.GC10039@burratino \
--to=jrnieder@gmail.com \
--cc=flatworm@users.sourceforge.net \
--cc=git@vger.kernel.org \
--cc=jnareb@gmail.com \
--cc=jpmelos@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).