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