Git 1.7.12
[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]
73e9da01 11'git branch' [--color[=<when>] | --no-color] [-r | -a]
cddd127b 12 [--list] [-v [--abbrev=<length> | --no-abbrev]]
ebe31ef2 13 [--column[=<options>] | --no-column]
d8d33736 14 [(--merged | --no-merged | --contains) [<commit>]] [<pattern>...]
4fc50066 15'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
b1889c36
JN
16'git branch' (-m | -M) [<oldbranch>] <newbranch>
17'git branch' (-d | -D) [-r] <branchname>...
b7200e83 18'git branch' --edit-description [<branchname>]
7fc9d69f
JH
19
20DESCRIPTION
21-----------
049716b3 22
e5ac1217 23With no arguments, existing branches are listed and the current branch will
049716b3 24be highlighted with an asterisk. Option `-r` causes the remote-tracking
cddd127b 25branches to be listed, and option `-a` shows both. This list mode is also
7b787599 26activated by the `--list` option (see below).
d8d33736 27<pattern> restricts the output to matching branches, the pattern is a shell
3ea2232d 28wildcard (i.e., matched using fnmatch(3)).
ebab9894 29Multiple patterns may be given; if any of them matches, the branch is shown.
049716b3 30
e5ac1217
DM
31With `--contains`, shows only the branches that contain the named commit
32(in other words, the branches whose tip commits are descendants of the
049716b3
JH
33named commit). With `--merged`, only branches merged into the named
34commit (i.e. the branches whose tip commits are reachable from the named
35commit) will be listed. With `--no-merged` only branches not merged into
e5ac1217
DM
36the named commit will be listed. If the <commit> argument is missing it
37defaults to 'HEAD' (i.e. the tip of the current branch).
7fc9d69f 38
bb35f35e
JN
39The command's second form creates a new branch head named <branchname>
40which points to the current 'HEAD', or <start-point> if given.
2eaf273d 41
46749204
FMQ
42Note that this will create the new branch, but it will not switch the
43working tree to it; use "git checkout <newbranch>" to switch to the
44new branch.
45
29b9a66f 46When a local branch is started off a remote-tracking branch, git sets up the
0b444cdb 47branch so that 'git pull' will appropriately merge from
29b9a66f 48the remote-tracking branch. This behavior may be changed via the global
572fc81d 49`branch.autosetupmerge` configuration flag. That setting can be
4eec6f98
MM
50overridden by using the `--track` and `--no-track` options, and
51changed later using `git branch --set-upstream`.
0746d19a 52
3ea2232d 53With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
c976d415
LH
54If <oldbranch> had a corresponding reflog, it is renamed to match
55<newbranch>, and a reflog entry is created to remember the branch
56renaming. If <newbranch> exists, -M must be used to force the rename
57to happen.
58
2eaf273d 59With a `-d` or `-D` option, `<branchname>` will be deleted. You may
3a4b3f26 60specify more than one branch for deletion. If the branch currently
1e72a40d
JH
61has a reflog then the reflog will also be deleted.
62
3ea2232d 63Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
1e72a40d 64only makes sense to delete remote-tracking branches if they no longer exist
0b444cdb 65in the remote repository or if 'git fetch' was configured not to fetch
e5ac1217
DM
66them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
67way to clean up all obsolete remote-tracking branches.
dd181119
JL
68
69
7fc9d69f
JH
70OPTIONS
71-------
d4072c97 72-d::
171edcbb 73--delete::
fff0d0ab
JN
74 Delete a branch. The branch must be fully merged in its
75 upstream branch, or in `HEAD` if no upstream was set with
76 `--track` or `--set-upstream`.
d4072c97
AE
77
78-D::
1e72a40d 79 Delete a branch irrespective of its merged status.
d4072c97 80
3a4b3f26 81-l::
171edcbb 82--create-reflog::
792d2370
JK
83 Create the branch's reflog. This activates recording of
84 all changes made to the branch ref, enabling use of date
967506bb 85 based sha1 expressions such as "<branchname>@\{yesterday}".
4c35f0db
JK
86 Note that in non-bare repositories, reflogs are usually
87 enabled by default by the `core.logallrefupdates` config option.
3a4b3f26 88
075dd8ee 89-f::
f7aec129 90--force::
fcfdf797 91 Reset <branchname> to <startpoint> if <branchname> exists
0b444cdb 92 already. Without `-f` 'git branch' refuses to change an existing branch.
2eaf273d 93
c976d415 94-m::
171edcbb 95--move::
c976d415
LH
96 Move/rename a branch and the corresponding reflog.
97
98-M::
e5ac1217 99 Move/rename a branch even if the new branch name already exists.
c976d415 100
73e9da01 101--color[=<when>]::
29b9a66f
MM
102 Color branches to highlight current, local, and
103 remote-tracking branches.
73e9da01 104 The value must be always (the default), never, or auto.
f3673988
BG
105
106--no-color::
107 Turn off branch colors, even when the configuration file gives the
108 default to color output.
73e9da01 109 Same as `--color=never`.
f3673988 110
ebe31ef2
NTND
111--column[=<options>]::
112--no-column::
113 Display branch listing in columns. See configuration variable
114 column.branch for option syntax.`--column` and `--no-column`
115 without options are equivalent to 'always' and 'never' respectively.
116+
117This option is only applicable in non-verbose mode.
118
2eaf273d 119-r::
171edcbb 120--remotes::
7dda22e3 121 List or delete (if used with -d) the remote-tracking branches.
bfcc9214
AP
122
123-a::
171edcbb 124--all::
bfcc9214 125 List both remote-tracking branches and local branches.
075dd8ee 126
cddd127b 127--list::
d8d33736
MG
128 Activate the list mode. `git branch <pattern>` would try to create a branch,
129 use `git branch --list <pattern>` to list matching branches.
cddd127b 130
3240240f
SB
131-v::
132--verbose::
7b787599
MG
133 When in list mode,
134 show sha1 and commit subject line for each head, along with
2d8a7f0b
JK
135 relationship to upstream branch (if any). If given twice, print
136 the name of the upstream branch, as well.
75e6e213 137
d65ddf19
JK
138-q::
139--quiet::
140 Be more quiet when creating or deleting a branch, suppressing
141 non-error messages.
142
75e6e213 143--abbrev=<length>::
e5ac1217 144 Alter the sha1's minimum display length in the output listing.
b792c067
NK
145 The default value is 7 and can be overridden by the `core.abbrev`
146 config option.
75e6e213 147
5e00f6fa 148--no-abbrev::
e5ac1217 149 Display the full sha1s in the output listing rather than abbreviating them.
5e00f6fa 150
be427d75 151-t::
84d176ce 152--track::
167d7445
JK
153 When creating a new branch, set up configuration to mark the
154 start-point branch as "upstream" from the new branch. This
155 configuration will tell git to show the relationship between the
156 two branches in `git status` and `git branch -v`. Furthermore,
157 it directs `git pull` without arguments to pull from the
158 upstream when the new branch is checked out.
159+
29b9a66f 160This behavior is the default when the start point is a remote-tracking branch.
167d7445
JK
161Set the branch.autosetupmerge configuration variable to `false` if you
162want `git checkout` and `git branch` to always behave as if '--no-track'
163were given. Set it to `always` if you want this behavior when the
29b9a66f 164start-point is either a local or remote-tracking branch.
84d176ce
FMQ
165
166--no-track::
167d7445 167 Do not set up "upstream" configuration, even if the
70e96647 168 branch.autosetupmerge configuration variable is true.
84d176ce 169
4fc50066 170--set-upstream::
3ea2232d
VR
171 If specified branch does not exist yet or if `--force` has been
172 given, acts exactly like `--track`. Otherwise sets up configuration
173 like `--track` would when creating the branch, except that where
4fc50066
IL
174 branch points to is not changed.
175
b7200e83
JH
176--edit-description::
177 Open an editor and edit the text to explain what the branch is
178 for, to be used by various other commands (e.g. `request-pull`).
179
f36ed6db
VR
180--contains [<commit>]::
181 Only list branches which contain the specified commit (HEAD
182 if not specified).
9a7ea2b1 183
58d2c961
JN
184--merged [<commit>]::
185 Only list branches whose tips are reachable from the
186 specified commit (HEAD if not specified).
9a7ea2b1 187
58d2c961
JN
188--no-merged [<commit>]::
189 Only list branches whose tips are not reachable from the
190 specified commit (HEAD if not specified).
9a7ea2b1 191
52a22d1e 192<branchname>::
d4072c97 193 The name of the branch to create or delete.
2b1f4247 194 The new branch name must pass all checks defined by
5162e697 195 linkgit:git-check-ref-format[1]. Some of these checks
2b1f4247 196 may restrict the characters allowed in a branch name.
7fc9d69f 197
075dd8ee 198<start-point>::
bb35f35e
JN
199 The new branch head will point to this commit. It may be
200 given as a branch name, a commit-id, or a tag. If this
201 option is omitted, the current HEAD will be used instead.
2eaf273d 202
c976d415
LH
203<oldbranch>::
204 The name of an existing branch to rename.
205
206<newbranch>::
207 The new name for an existing branch. The same restrictions as for
e5ac1217 208 <branchname> apply.
7fc9d69f 209
1e2ccd3a
JH
210
211Examples
2eaf273d 212--------
1e2ccd3a 213
e5ac1217 214Start development from a known tag::
1e2ccd3a
JH
215+
216------------
217$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
218$ cd my2.6
2eaf273d 219$ git branch my2.6.14 v2.6.14 <1>
1e2ccd3a 220$ git checkout my2.6.14
1e2ccd3a 221------------
2eaf273d
SE
222+
223<1> This step and the next one could be combined into a single step with
224"checkout -b my2.6.14 v2.6.14".
1e2ccd3a 225
e5ac1217 226Delete an unneeded branch::
1e2ccd3a
JH
227+
228------------
229$ git clone git://git.kernel.org/.../git.git my.git
230$ cd my.git
33b1f3d5
FM
231$ git branch -d -r origin/todo origin/html origin/man <1>
232$ git branch -D test <2>
2eaf273d
SE
233------------
234+
e5ac1217
DM
235<1> Delete the remote-tracking branches "todo", "html" and "man". The next
236'fetch' or 'pull' will create them again unless you configure them not to.
237See linkgit:git-fetch[1].
238<2> Delete the "test" branch even if the "master" branch (or whichever branch
239is currently checked out) does not have all commits from the test branch.
2eaf273d
SE
240
241
242Notes
243-----
244
e5ac1217 245If you are creating a branch that you want to checkout immediately, it is
2eaf273d
SE
246easier to use the git checkout command with its `-b` option to create
247a branch and check it out with a single command.
248
e5ac1217 249The options `--contains`, `--merged` and `--no-merged` serve three related
9a7ea2b1
LH
250but different purposes:
251
252- `--contains <commit>` is used to find all branches which will need
253 special attention if <commit> were to be rebased or amended, since those
254 branches contain the specified <commit>.
255
256- `--merged` is used to find all branches which can be safely deleted,
257 since those branches are fully contained by HEAD.
258
259- `--no-merged` is used to find branches which are candidates for merging
260 into HEAD, since those branches are not fully contained by HEAD.
1e2ccd3a 261
b85e6c5f
NS
262SEE ALSO
263--------
264linkgit:git-check-ref-format[1],
265linkgit:git-fetch[1],
bb35f35e
JN
266linkgit:git-remote[1],
267link:user-manual.html#what-is-a-branch[``Understanding history: What is
268a branch?''] in the Git User's Manual.
b85e6c5f 269
7fc9d69f
JH
270GIT
271---
9e1f0a85 272Part of the linkgit:git[1] suite