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