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