pack-protocol.txt: fix pkt-line lengths
[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>]]
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::
1e72a40d 66 Delete a branch. The branch must be fully merged in HEAD.
d4072c97
AE
67
68-D::
1e72a40d 69 Delete a branch irrespective of its merged status.
d4072c97 70
3a4b3f26 71-l::
792d2370
JK
72 Create the branch's reflog. This activates recording of
73 all changes made to the branch ref, enabling use of date
967506bb 74 based sha1 expressions such as "<branchname>@\{yesterday}".
3a4b3f26 75
075dd8ee 76-f::
f7aec129 77--force::
fcfdf797 78 Reset <branchname> to <startpoint> if <branchname> exists
0b444cdb 79 already. Without `-f` 'git branch' refuses to change an existing branch.
2eaf273d 80
c976d415
LH
81-m::
82 Move/rename a branch and the corresponding reflog.
83
84-M::
e5ac1217 85 Move/rename a branch even if the new branch name already exists.
c976d415 86
f3673988
BG
87--color::
88 Color branches to highlight current, local, and remote branches.
89
90--no-color::
91 Turn off branch colors, even when the configuration file gives the
92 default to color output.
93
2eaf273d 94-r::
7dda22e3 95 List or delete (if used with -d) the remote-tracking branches.
bfcc9214
AP
96
97-a::
98 List both remote-tracking branches and local branches.
075dd8ee 99
3240240f
SB
100-v::
101--verbose::
2d8a7f0b
JK
102 Show sha1 and commit subject line for each head, along with
103 relationship to upstream branch (if any). If given twice, print
104 the name of the upstream branch, as well.
75e6e213
LH
105
106--abbrev=<length>::
e5ac1217
DM
107 Alter the sha1's minimum display length in the output listing.
108 The default value is 7.
75e6e213 109
5e00f6fa 110--no-abbrev::
e5ac1217 111 Display the full sha1s in the output listing rather than abbreviating them.
5e00f6fa 112
be427d75 113-t::
84d176ce 114--track::
167d7445
JK
115 When creating a new branch, set up configuration to mark the
116 start-point branch as "upstream" from the new branch. This
117 configuration will tell git to show the relationship between the
118 two branches in `git status` and `git branch -v`. Furthermore,
119 it directs `git pull` without arguments to pull from the
120 upstream when the new branch is checked out.
121+
122This behavior is the default when the start point is a remote branch.
123Set the branch.autosetupmerge configuration variable to `false` if you
124want `git checkout` and `git branch` to always behave as if '--no-track'
125were given. Set it to `always` if you want this behavior when the
126start-point is either a local or remote branch.
84d176ce
FMQ
127
128--no-track::
167d7445 129 Do not set up "upstream" configuration, even if the
70e96647 130 branch.autosetupmerge configuration variable is true.
84d176ce 131
4fc50066
IL
132--set-upstream::
133 If specified branch does not exist yet or if '--force' has been
134 given, acts exactly like '--track'. Otherwise sets up configuration
135 like '--track' would when creating the branch, except that where
136 branch points to is not changed.
137
9a7ea2b1
LH
138--contains <commit>::
139 Only list branches which contain the specified commit.
140
58d2c961
JN
141--merged [<commit>]::
142 Only list branches whose tips are reachable from the
143 specified commit (HEAD if not specified).
9a7ea2b1 144
58d2c961
JN
145--no-merged [<commit>]::
146 Only list branches whose tips are not reachable from the
147 specified commit (HEAD if not specified).
9a7ea2b1 148
52a22d1e 149<branchname>::
d4072c97 150 The name of the branch to create or delete.
2b1f4247 151 The new branch name must pass all checks defined by
5162e697 152 linkgit:git-check-ref-format[1]. Some of these checks
2b1f4247 153 may restrict the characters allowed in a branch name.
7fc9d69f 154
075dd8ee 155<start-point>::
bb35f35e
JN
156 The new branch head will point to this commit. It may be
157 given as a branch name, a commit-id, or a tag. If this
158 option is omitted, the current HEAD will be used instead.
2eaf273d 159
c976d415
LH
160<oldbranch>::
161 The name of an existing branch to rename.
162
163<newbranch>::
164 The new name for an existing branch. The same restrictions as for
e5ac1217 165 <branchname> apply.
7fc9d69f 166
1e2ccd3a
JH
167
168Examples
2eaf273d 169--------
1e2ccd3a 170
e5ac1217 171Start development from a known tag::
1e2ccd3a
JH
172+
173------------
174$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
175$ cd my2.6
2eaf273d 176$ git branch my2.6.14 v2.6.14 <1>
1e2ccd3a 177$ git checkout my2.6.14
1e2ccd3a 178------------
2eaf273d
SE
179+
180<1> This step and the next one could be combined into a single step with
181"checkout -b my2.6.14 v2.6.14".
1e2ccd3a 182
e5ac1217 183Delete an unneeded branch::
1e2ccd3a
JH
184+
185------------
186$ git clone git://git.kernel.org/.../git.git my.git
187$ cd my.git
33b1f3d5
FM
188$ git branch -d -r origin/todo origin/html origin/man <1>
189$ git branch -D test <2>
2eaf273d
SE
190------------
191+
e5ac1217
DM
192<1> Delete the remote-tracking branches "todo", "html" and "man". The next
193'fetch' or 'pull' will create them again unless you configure them not to.
194See linkgit:git-fetch[1].
195<2> Delete the "test" branch even if the "master" branch (or whichever branch
196is currently checked out) does not have all commits from the test branch.
2eaf273d
SE
197
198
199Notes
200-----
201
e5ac1217 202If you are creating a branch that you want to checkout immediately, it is
2eaf273d
SE
203easier to use the git checkout command with its `-b` option to create
204a branch and check it out with a single command.
205
e5ac1217 206The options `--contains`, `--merged` and `--no-merged` serve three related
9a7ea2b1
LH
207but different purposes:
208
209- `--contains <commit>` is used to find all branches which will need
210 special attention if <commit> were to be rebased or amended, since those
211 branches contain the specified <commit>.
212
213- `--merged` is used to find all branches which can be safely deleted,
214 since those branches are fully contained by HEAD.
215
216- `--no-merged` is used to find branches which are candidates for merging
217 into HEAD, since those branches are not fully contained by HEAD.
1e2ccd3a 218
b85e6c5f
NS
219SEE ALSO
220--------
221linkgit:git-check-ref-format[1],
222linkgit:git-fetch[1],
bb35f35e
JN
223linkgit:git-remote[1],
224link:user-manual.html#what-is-a-branch[``Understanding history: What is
225a branch?''] in the Git User's Manual.
b85e6c5f 226
7fc9d69f
JH
227Author
228------
59eb68aa 229Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com>
7fc9d69f
JH
230
231Documentation
232--------------
233Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
234
235GIT
236---
9e1f0a85 237Part of the linkgit:git[1] suite