@matheusbsbs / matheus-bagliano / commits / 2eaf273d51
Fork 0

Update the git-branch man page to include the "-r" option,

and fix up asciidoc "callouts" Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca>

Sean Estabrooks committed Apr 28, 2006 at 09:15 UTC 2eaf273d518717c84d748051e05210656f7b7e88
2 files changed +40 -19
Documentation/git-branch.txt
+39 -18
@@ -3,22 +3,27 @@ git-branch(1)
3
4 NAME
5 ----
6 -git-branch - Create a new branch, or remove an old one
6 +git-branch - List, create, or delete branches.
7
8 SYNOPSIS
9 --------
10 [verse]
11 -'git-branch' [[-f] <branchname> [<start-point>]]
12 -'git-branch' (-d | -D) <branchname>
11 +'git-branch' [-r]
12 +'git-branch' [-f] <branchname> [<start-point>]
13 +'git-branch' (-d | -D) <branchname>...
14
15 DESCRIPTION
16 -----------
16 -If no argument is provided, show available branches and mark current
17 -branch with star. Otherwise, create a new branch of name <branchname>.
18 -If a starting point is also specified, that will be where the branch is
19 -created, otherwise it will be created at the current HEAD.
17 +With no arguments given (or just `-r`) a list of available branches
18 +will be shown, the current branch will be highlighted with an asterisk.
19
21 -With a `-d` or `-D` option, `<branchname>` will be deleted.
20 +In its second form, a new branch named <branchname> will be created.
21 +It will start out with a head equal to the one given as <start-point>.
22 +If no <start-point> is given, the branch will be created with a head
23 +equal to that of the currently checked out branch.
24 +
25 +With a `-d` or `-D` option, `<branchname>` will be deleted. You may
26 +specify more than one branch for deletion.
27
28
29 OPTIONS
@@ -30,40 +35,56 @@ OPTIONS
35 Delete a branch irrespective of its index status.
36
37 -f::
33 - Force a reset of <branchname> to <start-point> (or current head).
38 + Force the creation of a new branch even if it means deleting
39 + a branch that already exists with the same name.
40 +
41 +-r::
42 + List only the "remote" branches.
43
44 <branchname>::
45 The name of the branch to create or delete.
46
47 <start-point>::
39 - Where to create the branch; defaults to HEAD. This
40 - option has no meaning with -d and -D.
48 + The new branch will be created with a HEAD equal to this. It may
49 + be given as a branch name, a commit-id, or a tag. If this option
50 + is omitted, the current branch is assumed.
51 +
52
53
54 Examples
44 -~~~~~~~~
55 +--------
56
57 Start development off of a known tag::
58 +
59 ------------
60 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
61 $ cd my2.6
51 -$ git branch my2.6.14 v2.6.14 <1>
62 +$ git branch my2.6.14 v2.6.14 <1>
63 $ git checkout my2.6.14
53 -
54 -<1> These two steps are the same as "checkout -b my2.6.14 v2.6.14".
64 ------------
65 ++
66 +<1> This step and the next one could be combined into a single step with
67 +"checkout -b my2.6.14 v2.6.14".
68
69 Delete unneeded branch::
70 +
71 ------------
72 $ git clone git://git.kernel.org/.../git.git my.git
73 $ cd my.git
62 -$ git branch -D todo <1>
63 -
74 +$ git branch -D todo <1>
75 +------------
76 ++
77 <1> delete todo branch even if the "master" branch does not have all
78 commits from todo branch.
66 -------------
79 +
80 +
81 +Notes
82 +-----
83 +
84 +If you are creating a branch that you want to immediately checkout, it's
85 +easier to use the git checkout command with its `-b` option to create
86 +a branch and check it out with a single command.
87 +
88
89 Author
90 ------
git-branch.sh
+1 -1
@@ -1,6 +1,6 @@
1 #!/bin/sh
2
3 -USAGE='[(-d | -D) <branchname>] | [[-f] <branchname> [<start-point>]]'
3 +USAGE='[(-d | -D) <branchname>] | [[-f] <branchname> [<start-point>]] | -r'
4 LONG_USAGE='If no arguments, show available branches and mark current branch with a star.
5 If one argument, create a new branch <branchname> based off of current HEAD.
6 If two arguments, create a new branch <branchname> based off of <start-point>.'