]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-branch(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-branch - List, create, or delete branches |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
dd181119 | 10 | [verse] |
ecf55ae4 | 11 | 'git branch' [--color[=<when>] | --no-color] [--show-current] |
cda34e0d | 12 | [-v [--abbrev=<n> | --no-abbrev]] |
783b8292 | 13 | [--column[=<options>] | --no-column] [--sort=<key>] |
21bf9339 | 14 | [--merged [<commit>]] [--no-merged [<commit>]] |
6069eccd | 15 | [--contains [<commit>]] [--no-contains [<commit>]] |
1fde99cf PO |
16 | [--points-at <object>] [--format=<format>] |
17 | [(-r | --remotes) | (-a | --all)] | |
18 | [--list] [<pattern>...] | |
961b130d GC |
19 | 'git branch' [--track[=(direct|inherit)] | --no-track] [-f] |
20 | [--recurse-submodules] <branchname> [<start-point>] | |
6183d826 | 21 | 'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>] |
b84869ef | 22 | 'git branch' --unset-upstream [<branchname>] |
b1889c36 | 23 | 'git branch' (-m | -M) [<oldbranch>] <newbranch> |
52d59cc6 | 24 | 'git branch' (-c | -C) [<oldbranch>] <newbranch> |
b1889c36 | 25 | 'git branch' (-d | -D) [-r] <branchname>... |
b7200e83 | 26 | 'git branch' --edit-description [<branchname>] |
7fc9d69f JH |
27 | |
28 | DESCRIPTION | |
29 | ----------- | |
049716b3 | 30 | |
de90ff81 | 31 | If `--list` is given, or if there are no non-option arguments, existing |
ab313814 NB |
32 | branches are listed; the current branch will be highlighted in green and |
33 | marked with an asterisk. Any branches checked out in linked worktrees will | |
34 | be highlighted in cyan and marked with a plus sign. Option `-r` causes the | |
35 | remote-tracking branches to be listed, | |
1fde99cf PO |
36 | and option `-a` shows both local and remote branches. |
37 | ||
38 | If a `<pattern>` | |
de90ff81 JK |
39 | is given, it is used as a shell wildcard to restrict the output to |
40 | matching branches. If multiple patterns are given, a branch is shown if | |
1fde99cf PO |
41 | it matches any of the patterns. |
42 | ||
43 | Note that when providing a | |
44 | `<pattern>`, you must use `--list`; otherwise the command may be interpreted | |
de90ff81 | 45 | as branch creation. |
049716b3 | 46 | |
e5ac1217 DM |
47 | With `--contains`, shows only the branches that contain the named commit |
48 | (in other words, the branches whose tip commits are descendants of the | |
783b8292 ÆAB |
49 | named commit), `--no-contains` inverts it. With `--merged`, only branches |
50 | merged into the named commit (i.e. the branches whose tip commits are | |
51 | reachable from the named commit) will be listed. With `--no-merged` only | |
52 | branches not merged into the named commit will be listed. If the <commit> | |
53 | argument is missing it defaults to `HEAD` (i.e. the tip of the current | |
54 | branch). | |
7fc9d69f | 55 | |
bb35f35e | 56 | The command's second form creates a new branch head named <branchname> |
e3d6539d DL |
57 | which points to the current `HEAD`, or <start-point> if given. As a |
58 | special case, for <start-point>, you may use `"A...B"` as a shortcut for | |
59 | the merge base of `A` and `B` if there is exactly one merge base. You | |
60 | can leave out at most one of `A` and `B`, in which case it defaults to | |
61 | `HEAD`. | |
2eaf273d | 62 | |
46749204 | 63 | Note that this will create the new branch, but it will not switch the |
328c6cb8 | 64 | working tree to it; use "git switch <newbranch>" to switch to the |
46749204 FMQ |
65 | new branch. |
66 | ||
2de9b711 | 67 | When a local branch is started off a remote-tracking branch, Git sets up the |
fef0e991 JH |
68 | branch (specifically the `branch.<name>.remote` and `branch.<name>.merge` |
69 | configuration entries) so that 'git pull' will appropriately merge from | |
29b9a66f | 70 | the remote-tracking branch. This behavior may be changed via the global |
da0005b8 | 71 | `branch.autoSetupMerge` configuration flag. That setting can be |
4eec6f98 | 72 | overridden by using the `--track` and `--no-track` options, and |
6183d826 | 73 | changed later using `git branch --set-upstream-to`. |
0746d19a | 74 | |
3ea2232d | 75 | With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>. |
c976d415 LH |
76 | If <oldbranch> had a corresponding reflog, it is renamed to match |
77 | <newbranch>, and a reflog entry is created to remember the branch | |
78 | renaming. If <newbranch> exists, -M must be used to force the rename | |
79 | to happen. | |
80 | ||
52d59cc6 | 81 | The `-c` and `-C` options have the exact same semantics as `-m` and |
27dc071b JK |
82 | `-M`, except instead of the branch being renamed, it will be copied to a |
83 | new name, along with its config and reflog. | |
52d59cc6 | 84 | |
2eaf273d | 85 | With a `-d` or `-D` option, `<branchname>` will be deleted. You may |
3a4b3f26 | 86 | specify more than one branch for deletion. If the branch currently |
1e72a40d JH |
87 | has a reflog then the reflog will also be deleted. |
88 | ||
3ea2232d | 89 | Use `-r` together with `-d` to delete remote-tracking branches. Note, that it |
1e72a40d | 90 | only makes sense to delete remote-tracking branches if they no longer exist |
0b444cdb | 91 | in the remote repository or if 'git fetch' was configured not to fetch |
e5ac1217 DM |
92 | them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a |
93 | way to clean up all obsolete remote-tracking branches. | |
dd181119 JL |
94 | |
95 | ||
7fc9d69f JH |
96 | OPTIONS |
97 | ------- | |
d4072c97 | 98 | -d:: |
171edcbb | 99 | --delete:: |
fff0d0ab JN |
100 | Delete a branch. The branch must be fully merged in its |
101 | upstream branch, or in `HEAD` if no upstream was set with | |
a060f3d3 | 102 | `--track` or `--set-upstream-to`. |
d4072c97 AE |
103 | |
104 | -D:: | |
83fe1670 | 105 | Shortcut for `--delete --force`. |
d4072c97 | 106 | |
171edcbb | 107 | --create-reflog:: |
792d2370 JK |
108 | Create the branch's reflog. This activates recording of |
109 | all changes made to the branch ref, enabling use of date | |
967506bb | 110 | based sha1 expressions such as "<branchname>@\{yesterday}". |
4c35f0db | 111 | Note that in non-bare repositories, reflogs are usually |
c3342b36 | 112 | enabled by default by the `core.logAllRefUpdates` config option. |
67c70bd9 CW |
113 | The negated form `--no-create-reflog` only overrides an earlier |
114 | `--create-reflog`, but currently does not negate the setting of | |
c3342b36 | 115 | `core.logAllRefUpdates`. |
3a4b3f26 | 116 | |
075dd8ee | 117 | -f:: |
f7aec129 | 118 | --force:: |
27875aee | 119 | Reset <branchname> to <start-point>, even if <branchname> exists |
e61cb19a | 120 | already. Without `-f`, 'git branch' refuses to change an existing branch. |
8482d042 | 121 | In combination with `-d` (or `--delete`), allow deleting the |
597a9774 RS |
122 | branch irrespective of its merged status, or whether it even |
123 | points to a valid commit. In combination with | |
8482d042 | 124 | `-m` (or `--move`), allow renaming the branch even if the new |
52d59cc6 | 125 | branch name already exists, the same applies for `-c` (or `--copy`). |
bf08abac JH |
126 | + |
127 | Note that 'git branch -f <branchname> [<start-point>]', even with '-f', | |
128 | refuses to change an existing branch `<branchname>` that is checked out | |
129 | in another worktree linked to the same repository. | |
2eaf273d | 130 | |
c976d415 | 131 | -m:: |
171edcbb | 132 | --move:: |
8252ec30 | 133 | Move/rename a branch, together with its config and reflog. |
c976d415 LH |
134 | |
135 | -M:: | |
83fe1670 | 136 | Shortcut for `--move --force`. |
c976d415 | 137 | |
52d59cc6 SD |
138 | -c:: |
139 | --copy:: | |
8252ec30 | 140 | Copy a branch, together with its config and reflog. |
52d59cc6 SD |
141 | |
142 | -C:: | |
143 | Shortcut for `--copy --force`. | |
144 | ||
73e9da01 | 145 | --color[=<when>]:: |
29b9a66f MM |
146 | Color branches to highlight current, local, and |
147 | remote-tracking branches. | |
73e9da01 | 148 | The value must be always (the default), never, or auto. |
f3673988 BG |
149 | |
150 | --no-color:: | |
151 | Turn off branch colors, even when the configuration file gives the | |
152 | default to color output. | |
73e9da01 | 153 | Same as `--color=never`. |
f3673988 | 154 | |
3bb16a8b NTND |
155 | -i:: |
156 | --ignore-case:: | |
157 | Sorting and filtering branches are case insensitive. | |
158 | ||
aabfdc95 ØW |
159 | --omit-empty:: |
160 | Do not print a newline after formatted refs where the format expands | |
161 | to the empty string. | |
162 | ||
ebe31ef2 NTND |
163 | --column[=<options>]:: |
164 | --no-column:: | |
165 | Display branch listing in columns. See configuration variable | |
1b5b8cf0 | 166 | `column.branch` for option syntax. `--column` and `--no-column` |
ebe31ef2 NTND |
167 | without options are equivalent to 'always' and 'never' respectively. |
168 | + | |
169 | This option is only applicable in non-verbose mode. | |
170 | ||
2eaf273d | 171 | -r:: |
171edcbb | 172 | --remotes:: |
7dda22e3 | 173 | List or delete (if used with -d) the remote-tracking branches. |
1fde99cf | 174 | Combine with `--list` to match the optional pattern(s). |
bfcc9214 AP |
175 | |
176 | -a:: | |
171edcbb | 177 | --all:: |
bfcc9214 | 178 | List both remote-tracking branches and local branches. |
1fde99cf | 179 | Combine with `--list` to match optional pattern(s). |
075dd8ee | 180 | |
a15d5981 | 181 | -l:: |
cddd127b | 182 | --list:: |
75ec4a6c JH |
183 | List branches. With optional `<pattern>...`, e.g. `git |
184 | branch --list 'maint-*'`, list only the branches that match | |
185 | the pattern(s). | |
cddd127b | 186 | |
0ecb1fc7 DU |
187 | --show-current:: |
188 | Print the name of the current branch. In detached HEAD state, | |
189 | nothing is printed. | |
190 | ||
3240240f | 191 | -v:: |
f0970faa | 192 | -vv:: |
3240240f | 193 | --verbose:: |
7b787599 MG |
194 | When in list mode, |
195 | show sha1 and commit subject line for each head, along with | |
2d8a7f0b | 196 | relationship to upstream branch (if any). If given twice, print |
6e938146 NB |
197 | the path of the linked worktree (if any) and the name of the upstream |
198 | branch, as well (see also `git remote show <remote>`). Note that the | |
199 | current worktree's HEAD will not have its path printed (it will always | |
200 | be your current directory). | |
75e6e213 | 201 | |
d65ddf19 JK |
202 | -q:: |
203 | --quiet:: | |
204 | Be more quiet when creating or deleting a branch, suppressing | |
205 | non-error messages. | |
206 | ||
cda34e0d JH |
207 | --abbrev=<n>:: |
208 | In the verbose listing that show the commit object name, | |
209 | show the shortest prefix that is at least '<n>' hexdigits | |
210 | long that uniquely refers the object. | |
b792c067 NK |
211 | The default value is 7 and can be overridden by the `core.abbrev` |
212 | config option. | |
75e6e213 | 213 | |
5e00f6fa | 214 | --no-abbrev:: |
e5ac1217 | 215 | Display the full sha1s in the output listing rather than abbreviating them. |
5e00f6fa | 216 | |
be427d75 | 217 | -t:: |
6327f0ef | 218 | --track[=(direct|inherit)]:: |
fef0e991 | 219 | When creating a new branch, set up `branch.<name>.remote` and |
d3115660 JS |
220 | `branch.<name>.merge` configuration entries to set "upstream" tracking |
221 | configuration for the new branch. This | |
167d7445 JK |
222 | configuration will tell git to show the relationship between the |
223 | two branches in `git status` and `git branch -v`. Furthermore, | |
224 | it directs `git pull` without arguments to pull from the | |
225 | upstream when the new branch is checked out. | |
226 | + | |
d3115660 | 227 | The exact upstream branch is chosen depending on the optional argument: |
6327f0ef RS |
228 | `-t`, `--track`, or `--track=direct` means to use the start-point branch |
229 | itself as the upstream; `--track=inherit` means to copy the upstream | |
230 | configuration of the start-point branch. | |
d3115660 | 231 | + |
bdaf1dfa TK |
232 | The branch.autoSetupMerge configuration variable specifies how `git switch`, |
233 | `git checkout` and `git branch` should behave when neither `--track` nor | |
234 | `--no-track` are specified: | |
235 | + | |
236 | The default option, `true`, behaves as though `--track=direct` | |
237 | were given whenever the start-point is a remote-tracking branch. | |
238 | `false` behaves as if `--no-track` were given. `always` behaves as though | |
239 | `--track=direct` were given. `inherit` behaves as though `--track=inherit` | |
240 | were given. `simple` behaves as though `--track=direct` were given only when | |
241 | the start-point is a remote-tracking branch and the new branch has the same | |
242 | name as the remote branch. | |
d3115660 JS |
243 | + |
244 | See linkgit:git-pull[1] and linkgit:git-config[1] for additional discussion on | |
245 | how the `branch.<name>.remote` and `branch.<name>.merge` options are used. | |
84d176ce FMQ |
246 | |
247 | --no-track:: | |
167d7445 | 248 | Do not set up "upstream" configuration, even if the |
d3115660 | 249 | branch.autoSetupMerge configuration variable is set. |
84d176ce | 250 | |
961b130d GC |
251 | --recurse-submodules:: |
252 | THIS OPTION IS EXPERIMENTAL! Causes the current command to | |
253 | recurse into submodules if `submodule.propagateBranches` is | |
254 | enabled. See `submodule.propagateBranches` in | |
255 | linkgit:git-config[1]. Currently, only branch creation is | |
256 | supported. | |
257 | + | |
258 | When used in branch creation, a new branch <branchname> will be created | |
259 | in the superproject and all of the submodules in the superproject's | |
260 | <start-point>. In submodules, the branch will point to the submodule | |
261 | commit in the superproject's <start-point> but the branch's tracking | |
262 | information will be set up based on the submodule's branches and remotes | |
263 | e.g. `git branch --recurse-submodules topic origin/main` will create the | |
264 | submodule branch "topic" that points to the submodule commit in the | |
265 | superproject's "origin/main", but tracks the submodule's "origin/main". | |
266 | ||
4fc50066 | 267 | --set-upstream:: |
52668846 KS |
268 | As this option had confusing syntax, it is no longer supported. |
269 | Please use `--track` or `--set-upstream-to` instead. | |
4fc50066 | 270 | |
6183d826 CMN |
271 | -u <upstream>:: |
272 | --set-upstream-to=<upstream>:: | |
273 | Set up <branchname>'s tracking information so <upstream> is | |
274 | considered <branchname>'s upstream branch. If no <branchname> | |
275 | is specified, then it defaults to the current branch. | |
276 | ||
b84869ef CMN |
277 | --unset-upstream:: |
278 | Remove the upstream information for <branchname>. If no branch | |
279 | is specified it defaults to the current branch. | |
280 | ||
b7200e83 JH |
281 | --edit-description:: |
282 | Open an editor and edit the text to explain what the branch is | |
561d2b79 PO |
283 | for, to be used by various other commands (e.g. `format-patch`, |
284 | `request-pull`, and `merge` (if enabled)). Multi-line explanations | |
285 | may be used. | |
b7200e83 | 286 | |
f36ed6db VR |
287 | --contains [<commit>]:: |
288 | Only list branches which contain the specified commit (HEAD | |
d0403508 | 289 | if not specified). Implies `--list`. |
9a7ea2b1 | 290 | |
ac3f5a34 ÆAB |
291 | --no-contains [<commit>]:: |
292 | Only list branches which don't contain the specified commit | |
293 | (HEAD if not specified). Implies `--list`. | |
294 | ||
58d2c961 JN |
295 | --merged [<commit>]:: |
296 | Only list branches whose tips are reachable from the | |
21bf9339 | 297 | specified commit (HEAD if not specified). Implies `--list`. |
9a7ea2b1 | 298 | |
58d2c961 JN |
299 | --no-merged [<commit>]:: |
300 | Only list branches whose tips are not reachable from the | |
21bf9339 | 301 | specified commit (HEAD if not specified). Implies `--list`. |
9a7ea2b1 | 302 | |
52a22d1e | 303 | <branchname>:: |
d4072c97 | 304 | The name of the branch to create or delete. |
2b1f4247 | 305 | The new branch name must pass all checks defined by |
5162e697 | 306 | linkgit:git-check-ref-format[1]. Some of these checks |
2b1f4247 | 307 | may restrict the characters allowed in a branch name. |
7fc9d69f | 308 | |
075dd8ee | 309 | <start-point>:: |
bb35f35e JN |
310 | The new branch head will point to this commit. It may be |
311 | given as a branch name, a commit-id, or a tag. If this | |
312 | option is omitted, the current HEAD will be used instead. | |
2eaf273d | 313 | |
c976d415 LH |
314 | <oldbranch>:: |
315 | The name of an existing branch to rename. | |
316 | ||
317 | <newbranch>:: | |
318 | The new name for an existing branch. The same restrictions as for | |
e5ac1217 | 319 | <branchname> apply. |
7fc9d69f | 320 | |
aedcb7dc KN |
321 | --sort=<key>:: |
322 | Sort based on the key given. Prefix `-` to sort in descending | |
323 | order of the value. You may use the --sort=<key> option | |
324 | multiple times, in which case the last key becomes the primary | |
325 | key. The keys supported are the same as those in `git | |
560ae1c1 | 326 | for-each-ref`. Sort order defaults to the value configured for the |
97509a34 | 327 | `branch.sort` variable if it exists, or to sorting based on the |
aedcb7dc KN |
328 | full refname (including `refs/...` prefix). This lists |
329 | detached HEAD (if present) first, then local branches and | |
560ae1c1 | 330 | finally remote-tracking branches. See linkgit:git-config[1]. |
aedcb7dc | 331 | |
1e2ccd3a | 332 | |
aa3bc55e KN |
333 | --points-at <object>:: |
334 | Only list branches of the given object. | |
1e2ccd3a | 335 | |
3d9e4ce3 | 336 | --format <format>:: |
e4933cee MG |
337 | A string that interpolates `%(fieldname)` from a branch ref being shown |
338 | and the object it points at. The format is the same as | |
3d9e4ce3 KN |
339 | that of linkgit:git-for-each-ref[1]. |
340 | ||
d74b541e MÅ |
341 | CONFIGURATION |
342 | ------------- | |
343 | `pager.branch` is only respected when listing branches, i.e., when | |
0ae19de7 | 344 | `--list` is used or implied. The default is to use a pager. |
d74b541e MÅ |
345 | See linkgit:git-config[1]. |
346 | ||
9274dea3 ÆAB |
347 | include::includes/cmd-config-section-rest.txt[] |
348 | ||
349 | include::config/branch.txt[] | |
350 | ||
76a8788c | 351 | EXAMPLES |
2eaf273d | 352 | -------- |
1e2ccd3a | 353 | |
e5ac1217 | 354 | Start development from a known tag:: |
1e2ccd3a JH |
355 | + |
356 | ------------ | |
357 | $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 | |
358 | $ cd my2.6 | |
2eaf273d | 359 | $ git branch my2.6.14 v2.6.14 <1> |
328c6cb8 | 360 | $ git switch my2.6.14 |
1e2ccd3a | 361 | ------------ |
2eaf273d SE |
362 | + |
363 | <1> This step and the next one could be combined into a single step with | |
ba170517 | 364 | "checkout -b my2.6.14 v2.6.14". |
1e2ccd3a | 365 | |
e5ac1217 | 366 | Delete an unneeded branch:: |
1e2ccd3a JH |
367 | + |
368 | ------------ | |
369 | $ git clone git://git.kernel.org/.../git.git my.git | |
370 | $ cd my.git | |
33b1f3d5 FM |
371 | $ git branch -d -r origin/todo origin/html origin/man <1> |
372 | $ git branch -D test <2> | |
2eaf273d SE |
373 | ------------ |
374 | + | |
e5ac1217 | 375 | <1> Delete the remote-tracking branches "todo", "html" and "man". The next |
ba170517 JNA |
376 | 'fetch' or 'pull' will create them again unless you configure them not to. |
377 | See linkgit:git-fetch[1]. | |
e5ac1217 | 378 | <2> Delete the "test" branch even if the "master" branch (or whichever branch |
ba170517 | 379 | is currently checked out) does not have all commits from the test branch. |
2eaf273d | 380 | |
1fde99cf PO |
381 | Listing branches from a specific remote:: |
382 | + | |
383 | ------------ | |
384 | $ git branch -r -l '<remote>/<pattern>' <1> | |
385 | $ git for-each-ref 'refs/remotes/<remote>/<pattern>' <2> | |
386 | ------------ | |
387 | + | |
388 | <1> Using `-a` would conflate <remote> with any local branches you happen to | |
389 | have been prefixed with the same <remote> pattern. | |
390 | <2> `for-each-ref` can take a wide range of options. See linkgit:git-for-each-ref[1] | |
391 | ||
392 | Patterns will normally need quoting. | |
2eaf273d | 393 | |
76a8788c | 394 | NOTES |
2eaf273d SE |
395 | ----- |
396 | ||
328c6cb8 NTND |
397 | If you are creating a branch that you want to switch to immediately, |
398 | it is easier to use the "git switch" command with its `-c` option to | |
399 | do the same thing with a single command. | |
2eaf273d | 400 | |
ac3f5a34 ÆAB |
401 | The options `--contains`, `--no-contains`, `--merged` and `--no-merged` |
402 | serve four related but different purposes: | |
9a7ea2b1 LH |
403 | |
404 | - `--contains <commit>` is used to find all branches which will need | |
405 | special attention if <commit> were to be rebased or amended, since those | |
406 | branches contain the specified <commit>. | |
407 | ||
ac3f5a34 ÆAB |
408 | - `--no-contains <commit>` is the inverse of that, i.e. branches that don't |
409 | contain the specified <commit>. | |
410 | ||
9a7ea2b1 LH |
411 | - `--merged` is used to find all branches which can be safely deleted, |
412 | since those branches are fully contained by HEAD. | |
413 | ||
414 | - `--no-merged` is used to find branches which are candidates for merging | |
415 | into HEAD, since those branches are not fully contained by HEAD. | |
1e2ccd3a | 416 | |
b59cdffd | 417 | include::ref-reachability-filters.txt[] |
415af72b | 418 | |
b85e6c5f NS |
419 | SEE ALSO |
420 | -------- | |
421 | linkgit:git-check-ref-format[1], | |
422 | linkgit:git-fetch[1], | |
bb35f35e JN |
423 | linkgit:git-remote[1], |
424 | link:user-manual.html#what-is-a-branch[``Understanding history: What is | |
425 | a branch?''] in the Git User's Manual. | |
b85e6c5f | 426 | |
7fc9d69f JH |
427 | GIT |
428 | --- | |
9e1f0a85 | 429 | Part of the linkgit:git[1] suite |