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