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