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