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