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