Merge branch 'js/attach'
[git/git.git] / Documentation / git-branch.txt
CommitLineData
215a7ad1
JH
1git-branch(1)
2=============
7fc9d69f
JH
3
4NAME
5----
c3f0baac 6git-branch - List, create, or delete branches
7fc9d69f
JH
7
8SYNOPSIS
9--------
dd181119 10[verse]
5e00f6fa
JP
11'git-branch' [--color | --no-color] [-r | -a]
12 [-v [--abbrev=<length> | --no-abbrev]]
3a4b3f26 13'git-branch' [-l] [-f] <branchname> [<start-point>]
c976d415 14'git-branch' (-m | -M) [<oldbranch>] <newbranch>
7dda22e3 15'git-branch' (-d | -D) [-r] <branchname>...
7fc9d69f
JH
16
17DESCRIPTION
18-----------
bfcc9214 19With no arguments given a list of existing branches
2eaf273d 20will be shown, the current branch will be highlighted with an asterisk.
bfcc9214
AP
21Option `-r` causes the remote-tracking branches to be listed,
22and option `-a` shows both.
7fc9d69f 23
2eaf273d
SE
24In its second form, a new branch named <branchname> will be created.
25It will start out with a head equal to the one given as <start-point>.
26If no <start-point> is given, the branch will be created with a head
27equal to that of the currently checked out branch.
28
c976d415
LH
29With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
30If <oldbranch> had a corresponding reflog, it is renamed to match
31<newbranch>, and a reflog entry is created to remember the branch
32renaming. If <newbranch> exists, -M must be used to force the rename
33to happen.
34
2eaf273d 35With a `-d` or `-D` option, `<branchname>` will be deleted. You may
3a4b3f26 36specify more than one branch for deletion. If the branch currently
7dda22e3
QT
37has a ref log then the ref log will also be deleted. Use -r together with -d
38to delete remote-tracking branches.
dd181119
JL
39
40
7fc9d69f
JH
41OPTIONS
42-------
d4072c97
AE
43-d::
44 Delete a branch. The branch must be fully merged.
45
46-D::
47 Delete a branch irrespective of its index status.
48
3a4b3f26
SP
49-l::
50 Create the branch's ref log. This activates recording of
51 all changes to made the branch ref, enabling use of date
52 based sha1 expressions such as "<branchname>@{yesterday}".
53
075dd8ee 54-f::
2eaf273d
SE
55 Force the creation of a new branch even if it means deleting
56 a branch that already exists with the same name.
57
c976d415
LH
58-m::
59 Move/rename a branch and the corresponding reflog.
60
61-M::
62 Move/rename a branch even if the new branchname already exists.
63
f3673988
BG
64--color::
65 Color branches to highlight current, local, and remote branches.
66
67--no-color::
68 Turn off branch colors, even when the configuration file gives the
69 default to color output.
70
2eaf273d 71-r::
7dda22e3 72 List or delete (if used with -d) the remote-tracking branches.
bfcc9214
AP
73
74-a::
75 List both remote-tracking branches and local branches.
075dd8ee 76
75e6e213 77-v::
23bfbb81 78 Show sha1 and commit subject line for each head.
75e6e213
LH
79
80--abbrev=<length>::
81 Alter minimum display length for sha1 in output listing,
82 default value is 7.
83
5e00f6fa
JP
84--no-abbrev::
85 Display the full sha1s in output listing rather than abbreviating them.
86
52a22d1e 87<branchname>::
d4072c97 88 The name of the branch to create or delete.
2b1f4247
SP
89 The new branch name must pass all checks defined by
90 gitlink:git-check-ref-format[1]. Some of these checks
91 may restrict the characters allowed in a branch name.
7fc9d69f 92
075dd8ee 93<start-point>::
2eaf273d
SE
94 The new branch will be created with a HEAD equal to this. It may
95 be given as a branch name, a commit-id, or a tag. If this option
96 is omitted, the current branch is assumed.
97
c976d415
LH
98<oldbranch>::
99 The name of an existing branch to rename.
100
101<newbranch>::
102 The new name for an existing branch. The same restrictions as for
103 <branchname> applies.
7fc9d69f 104
1e2ccd3a
JH
105
106Examples
2eaf273d 107--------
1e2ccd3a 108
dd181119 109Start development off of a known tag::
1e2ccd3a
JH
110+
111------------
112$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
113$ cd my2.6
2eaf273d 114$ git branch my2.6.14 v2.6.14 <1>
1e2ccd3a 115$ git checkout my2.6.14
1e2ccd3a 116------------
2eaf273d
SE
117+
118<1> This step and the next one could be combined into a single step with
119"checkout -b my2.6.14 v2.6.14".
1e2ccd3a
JH
120
121Delete unneeded branch::
122+
123------------
124$ git clone git://git.kernel.org/.../git.git my.git
125$ cd my.git
7dda22e3
QT
126$ git branch -d -r todo html man <1>
127$ git branch -D test <2>
2eaf273d
SE
128------------
129+
7dda22e3
QT
130<1> delete remote-tracking branches "todo", "html", "man"
131<2> delete "test" branch even if the "master" branch does not have all
1e2ccd3a 132commits from todo branch.
2eaf273d
SE
133
134
135Notes
136-----
137
138If you are creating a branch that you want to immediately checkout, it's
139easier to use the git checkout command with its `-b` option to create
140a branch and check it out with a single command.
141
1e2ccd3a 142
7fc9d69f
JH
143Author
144------
145Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
146
147Documentation
148--------------
149Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
150
151GIT
152---
a7154e91 153Part of the gitlink:git[7] suite
7fc9d69f 154