Documentation: clarify mergeoptions description
[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]
b773fc34 11'git branch' [--color | --no-color] [-r | -a]
049716b3
JH
12 [-v [--abbrev=<length> | --no-abbrev]]
13 [(--merged | --no-merged | --contains) [<commit>]]
b1889c36
JN
14'git branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>]
15'git branch' (-m | -M) [<oldbranch>] <newbranch>
16'git branch' (-d | -D) [-r] <branchname>...
7fc9d69f
JH
17
18DESCRIPTION
19-----------
049716b3 20
e5ac1217 21With no arguments, existing branches are listed and the current branch will
049716b3
JH
22be highlighted with an asterisk. Option `-r` causes the remote-tracking
23branches to be listed, and option `-a` shows both.
24
e5ac1217
DM
25With `--contains`, shows only the branches that contain the named commit
26(in other words, the branches whose tip commits are descendants of the
049716b3
JH
27named commit). With `--merged`, only branches merged into the named
28commit (i.e. the branches whose tip commits are reachable from the named
29commit) will be listed. With `--no-merged` only branches not merged into
e5ac1217
DM
30the named commit will be listed. If the <commit> argument is missing it
31defaults to 'HEAD' (i.e. the tip of the current branch).
7fc9d69f 32
e5ac1217 33In the command's second form, a new branch named <branchname> will be created.
2eaf273d
SE
34It will start out with a head equal to the one given as <start-point>.
35If no <start-point> is given, the branch will be created with a head
36equal to that of the currently checked out branch.
37
46749204
FMQ
38Note that this will create the new branch, but it will not switch the
39working tree to it; use "git checkout <newbranch>" to switch to the
40new branch.
41
572fc81d 42When a local branch is started off a remote branch, git sets up the
ba020ef5 43branch so that 'git-pull' will appropriately merge from
572fc81d
JS
44the remote branch. This behavior may be changed via the global
45`branch.autosetupmerge` configuration flag. That setting can be
46overridden by using the `--track` and `--no-track` options.
0746d19a 47
c976d415
LH
48With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
49If <oldbranch> had a corresponding reflog, it is renamed to match
50<newbranch>, and a reflog entry is created to remember the branch
51renaming. If <newbranch> exists, -M must be used to force the rename
52to happen.
53
2eaf273d 54With a `-d` or `-D` option, `<branchname>` will be deleted. You may
3a4b3f26 55specify more than one branch for deletion. If the branch currently
1e72a40d
JH
56has a reflog then the reflog will also be deleted.
57
58Use -r together with -d to delete remote-tracking branches. Note, that it
59only makes sense to delete remote-tracking branches if they no longer exist
e5ac1217
DM
60in the remote repository or if 'git-fetch' was configured not to fetch
61them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
62way to clean up all obsolete remote-tracking branches.
dd181119
JL
63
64
7fc9d69f
JH
65OPTIONS
66-------
d4072c97 67-d::
1e72a40d 68 Delete a branch. The branch must be fully merged in HEAD.
d4072c97
AE
69
70-D::
1e72a40d 71 Delete a branch irrespective of its merged status.
d4072c97 72
3a4b3f26 73-l::
792d2370
JK
74 Create the branch's reflog. This activates recording of
75 all changes made to the branch ref, enabling use of date
967506bb 76 based sha1 expressions such as "<branchname>@\{yesterday}".
3a4b3f26 77
075dd8ee 78-f::
f7aec129 79--force::
fcfdf797
MG
80 Reset <branchname> to <startpoint> if <branchname> exists
81 already. Without `-f` 'git-branch' refuses to change an existing branch.
2eaf273d 82
c976d415
LH
83-m::
84 Move/rename a branch and the corresponding reflog.
85
86-M::
e5ac1217 87 Move/rename a branch even if the new branch name already exists.
c976d415 88
f3673988
BG
89--color::
90 Color branches to highlight current, local, and remote branches.
91
92--no-color::
93 Turn off branch colors, even when the configuration file gives the
94 default to color output.
95
2eaf273d 96-r::
7dda22e3 97 List or delete (if used with -d) the remote-tracking branches.
bfcc9214
AP
98
99-a::
100 List both remote-tracking branches and local branches.
075dd8ee 101
3240240f
SB
102-v::
103--verbose::
2d8a7f0b
JK
104 Show sha1 and commit subject line for each head, along with
105 relationship to upstream branch (if any). If given twice, print
106 the name of the upstream branch, as well.
75e6e213
LH
107
108--abbrev=<length>::
e5ac1217
DM
109 Alter the sha1's minimum display length in the output listing.
110 The default value is 7.
75e6e213 111
5e00f6fa 112--no-abbrev::
e5ac1217 113 Display the full sha1s in the output listing rather than abbreviating them.
5e00f6fa 114
be427d75 115-t::
84d176ce 116--track::
167d7445
JK
117 When creating a new branch, set up configuration to mark the
118 start-point branch as "upstream" from the new branch. This
119 configuration will tell git to show the relationship between the
120 two branches in `git status` and `git branch -v`. Furthermore,
121 it directs `git pull` without arguments to pull from the
122 upstream when the new branch is checked out.
123+
124This behavior is the default when the start point is a remote branch.
125Set the branch.autosetupmerge configuration variable to `false` if you
126want `git checkout` and `git branch` to always behave as if '--no-track'
127were given. Set it to `always` if you want this behavior when the
128start-point is either a local or remote branch.
84d176ce
FMQ
129
130--no-track::
167d7445 131 Do not set up "upstream" configuration, even if the
70e96647 132 branch.autosetupmerge configuration variable is true.
84d176ce 133
9a7ea2b1
LH
134--contains <commit>::
135 Only list branches which contain the specified commit.
136
137--merged::
138 Only list branches which are fully contained by HEAD.
139
140--no-merged::
141 Do not list branches which are fully contained by HEAD.
142
52a22d1e 143<branchname>::
d4072c97 144 The name of the branch to create or delete.
2b1f4247 145 The new branch name must pass all checks defined by
5162e697 146 linkgit:git-check-ref-format[1]. Some of these checks
2b1f4247 147 may restrict the characters allowed in a branch name.
7fc9d69f 148
075dd8ee 149<start-point>::
2eaf273d
SE
150 The new branch will be created with a HEAD equal to this. It may
151 be given as a branch name, a commit-id, or a tag. If this option
152 is omitted, the current branch is assumed.
153
c976d415
LH
154<oldbranch>::
155 The name of an existing branch to rename.
156
157<newbranch>::
158 The new name for an existing branch. The same restrictions as for
e5ac1217 159 <branchname> apply.
7fc9d69f 160
1e2ccd3a
JH
161
162Examples
2eaf273d 163--------
1e2ccd3a 164
e5ac1217 165Start development from a known tag::
1e2ccd3a
JH
166+
167------------
168$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
169$ cd my2.6
2eaf273d 170$ git branch my2.6.14 v2.6.14 <1>
1e2ccd3a 171$ git checkout my2.6.14
1e2ccd3a 172------------
2eaf273d
SE
173+
174<1> This step and the next one could be combined into a single step with
175"checkout -b my2.6.14 v2.6.14".
1e2ccd3a 176
e5ac1217 177Delete an unneeded branch::
1e2ccd3a
JH
178+
179------------
180$ git clone git://git.kernel.org/.../git.git my.git
181$ cd my.git
33b1f3d5
FM
182$ git branch -d -r origin/todo origin/html origin/man <1>
183$ git branch -D test <2>
2eaf273d
SE
184------------
185+
e5ac1217
DM
186<1> Delete the remote-tracking branches "todo", "html" and "man". The next
187'fetch' or 'pull' will create them again unless you configure them not to.
188See linkgit:git-fetch[1].
189<2> Delete the "test" branch even if the "master" branch (or whichever branch
190is currently checked out) does not have all commits from the test branch.
2eaf273d
SE
191
192
193Notes
194-----
195
e5ac1217 196If you are creating a branch that you want to checkout immediately, it is
2eaf273d
SE
197easier to use the git checkout command with its `-b` option to create
198a branch and check it out with a single command.
199
e5ac1217 200The options `--contains`, `--merged` and `--no-merged` serve three related
9a7ea2b1
LH
201but different purposes:
202
203- `--contains <commit>` is used to find all branches which will need
204 special attention if <commit> were to be rebased or amended, since those
205 branches contain the specified <commit>.
206
207- `--merged` is used to find all branches which can be safely deleted,
208 since those branches are fully contained by HEAD.
209
210- `--no-merged` is used to find branches which are candidates for merging
211 into HEAD, since those branches are not fully contained by HEAD.
1e2ccd3a 212
b85e6c5f
NS
213SEE ALSO
214--------
215linkgit:git-check-ref-format[1],
216linkgit:git-fetch[1],
217linkgit:git-remote[1].
218
7fc9d69f
JH
219Author
220------
59eb68aa 221Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com>
7fc9d69f
JH
222
223Documentation
224--------------
225Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
226
227GIT
228---
9e1f0a85 229Part of the linkgit:git[1] suite