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