Git development
 help / color / mirror / Atom feed
From: Sean Estabrooks <seanlkml@sympatico.ca>
To: git@vger.kernel.org
Cc: Sean Estabrooks <seanlkml@sympatico.ca>
Subject: [PATCH] Update the git-branch man page to include the "-r" option,
Date: Fri, 28 Apr 2006 09:15:04 -0400	[thread overview]
Message-ID: <BAYC1-PASMTP12A9682774BA94F33C4BBDAEB20@CEZ.ICE> (raw)
Message-ID: <11462301063885-git-send-email-seanlkml@sympatico.ca> (raw)
In-Reply-To: <11462301062278-git-send-email-seanlkml@sympatico.ca>

and fix up asciidoc "callouts"

Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca>


---

 Documentation/git-branch.txt |   57 +++++++++++++++++++++++++++++-------------
 1 files changed, 39 insertions(+), 18 deletions(-)

5f70eb7e8c318528885cdd9b35bfa1d92cbf6782
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 71ecd85..050e1f7 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -3,22 +3,27 @@ git-branch(1)
 
 NAME
 ----
-git-branch - Create a new branch, or remove an old one
+git-branch - List, create, or delete branches.
 
 SYNOPSIS
 --------
 [verse]
-'git-branch' [[-f] <branchname> [<start-point>]]
-'git-branch' (-d | -D) <branchname>
+'git-branch' [-r]
+'git-branch' [-f] <branchname> [<start-point>]
+'git-branch' (-d | -D) <branchname>...
 
 DESCRIPTION
 -----------
-If no argument is provided, show available branches and mark current
-branch with star. Otherwise, create a new branch of name <branchname>.
-If a starting point is also specified, that will be where the branch is
-created, otherwise it will be created at the current HEAD.
+With no arguments given (or just `-r`) a list of available branches
+will be shown, the current branch will be highlighted with an asterisk.
 
-With a `-d` or `-D` option, `<branchname>` will be deleted.
+In its second form, a new branch named <branchname> will be created.
+It will start out with a head equal to the one given as <start-point>.
+If no <start-point> is given, the branch will be created with a head
+equal to that of the currently checked out branch.
+
+With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
+specify more than one branch for deletion.
 
 
 OPTIONS
@@ -30,40 +35,56 @@ OPTIONS
 	Delete a branch irrespective of its index status.
 
 -f::
-	Force a reset of <branchname> to <start-point> (or current head).
+	Force the creation of a new branch even if it means deleting
+	a branch that already exists with the same name.
+
+-r::
+	List only the "remote" branches.
 
 <branchname>::
 	The name of the branch to create or delete.
 
 <start-point>::
-	Where to create the branch; defaults to HEAD. This
-	option has no meaning with -d and -D.
+	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.
+
 
 
 Examples
-~~~~~~~~
+--------
 
 Start development off of a known tag::
 +
 ------------
 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 $ cd my2.6
-$ git branch my2.6.14 v2.6.14 <1>
+$ git branch my2.6.14 v2.6.14   <1>
 $ git checkout my2.6.14
-
-<1> These two steps are the same as "checkout -b my2.6.14 v2.6.14".
 ------------
++
+<1> This step and the next one could be combined into a single step with 
+"checkout -b my2.6.14 v2.6.14".
 
 Delete unneeded branch::
 +
 ------------
 $ git clone git://git.kernel.org/.../git.git my.git
 $ cd my.git
-$ git branch -D todo <1>
-
+$ git branch -D todo    <1>
+------------
++
 <1> delete todo branch even if the "master" branch does not have all
 commits from todo branch.
-------------
+
+
+Notes
+-----
+
+If you are creating a branch that you want to immediately checkout, it's 
+easier to use the git checkout command with its `-b` option to create
+a branch and check it out with a single command.
+
 
 Author
 ------
-- 
1.3.1.gc672

  parent reply	other threads:[~2006-04-28 13:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <11462301062278-git-send-email-seanlkml@sympatico.ca>
2006-04-28 13:15 ` [PATCH] Fix trivial typo in git-log man page Sean Estabrooks
     [not found] ` <11462301063885-git-send-email-seanlkml@sympatico.ca>
2006-04-28 13:15   ` Sean Estabrooks [this message]
     [not found]   ` <1146230106696-git-send-email-seanlkml@sympatico.ca>
2006-04-28 13:15     ` [PATCH] Fix up remaining man pages that use asciidoc "callouts" Sean Estabrooks
     [not found]     ` <11462301063607-git-send-email-seanlkml@sympatico.ca>
2006-04-28 13:15       ` [PATCH] Properly render asciidoc "callouts" in git man pages Sean Estabrooks

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=BAYC1-PASMTP12A9682774BA94F33C4BBDAEB20@CEZ.ICE \
    --to=seanlkml@sympatico.ca \
    --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