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