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