]>
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] |
b773fc34 | 11 | 'git branch' [--color | --no-color] [-r | -a] |
049716b3 JH |
12 | [-v [--abbrev=<length> | --no-abbrev]] |
13 | [(--merged | --no-merged | --contains) [<commit>]] | |
b1889c36 JN |
14 | 'git branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>] |
15 | 'git branch' (-m | -M) [<oldbranch>] <newbranch> | |
16 | 'git branch' (-d | -D) [-r] <branchname>... | |
7fc9d69f JH |
17 | |
18 | DESCRIPTION | |
19 | ----------- | |
049716b3 | 20 | |
e5ac1217 | 21 | With no arguments, existing branches are listed and the current branch will |
049716b3 JH |
22 | be highlighted with an asterisk. Option `-r` causes the remote-tracking |
23 | branches to be listed, and option `-a` shows both. | |
24 | ||
e5ac1217 DM |
25 | With `--contains`, shows only the branches that contain the named commit |
26 | (in other words, the branches whose tip commits are descendants of the | |
049716b3 JH |
27 | named commit). With `--merged`, only branches merged into the named |
28 | commit (i.e. the branches whose tip commits are reachable from the named | |
29 | commit) will be listed. With `--no-merged` only branches not merged into | |
e5ac1217 DM |
30 | the named commit will be listed. If the <commit> argument is missing it |
31 | defaults to 'HEAD' (i.e. the tip of the current branch). | |
7fc9d69f | 32 | |
e5ac1217 | 33 | In the command's second form, a new branch named <branchname> will be created. |
2eaf273d SE |
34 | It will start out with a head equal to the one given as <start-point>. |
35 | If no <start-point> is given, the branch will be created with a head | |
36 | equal to that of the currently checked out branch. | |
37 | ||
46749204 FMQ |
38 | Note that this will create the new branch, but it will not switch the |
39 | working tree to it; use "git checkout <newbranch>" to switch to the | |
40 | new branch. | |
41 | ||
572fc81d | 42 | When a local branch is started off a remote branch, git sets up the |
ba020ef5 | 43 | branch so that 'git-pull' will appropriately merge from |
572fc81d JS |
44 | the remote branch. This behavior may be changed via the global |
45 | `branch.autosetupmerge` configuration flag. That setting can be | |
46 | overridden by using the `--track` and `--no-track` options. | |
0746d19a | 47 | |
c976d415 LH |
48 | With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>. |
49 | If <oldbranch> had a corresponding reflog, it is renamed to match | |
50 | <newbranch>, and a reflog entry is created to remember the branch | |
51 | renaming. If <newbranch> exists, -M must be used to force the rename | |
52 | to happen. | |
53 | ||
2eaf273d | 54 | With a `-d` or `-D` option, `<branchname>` will be deleted. You may |
3a4b3f26 | 55 | specify more than one branch for deletion. If the branch currently |
1e72a40d JH |
56 | has a reflog then the reflog will also be deleted. |
57 | ||
58 | Use -r together with -d to delete remote-tracking branches. Note, that it | |
59 | only makes sense to delete remote-tracking branches if they no longer exist | |
e5ac1217 DM |
60 | in the remote repository or if 'git-fetch' was configured not to fetch |
61 | them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a | |
62 | way to clean up all obsolete remote-tracking branches. | |
dd181119 JL |
63 | |
64 | ||
7fc9d69f JH |
65 | OPTIONS |
66 | ------- | |
d4072c97 | 67 | -d:: |
1e72a40d | 68 | Delete a branch. The branch must be fully merged in HEAD. |
d4072c97 AE |
69 | |
70 | -D:: | |
1e72a40d | 71 | Delete a branch irrespective of its merged status. |
d4072c97 | 72 | |
3a4b3f26 | 73 | -l:: |
792d2370 JK |
74 | Create the branch's reflog. This activates recording of |
75 | all changes made to the branch ref, enabling use of date | |
967506bb | 76 | based sha1 expressions such as "<branchname>@\{yesterday}". |
3a4b3f26 | 77 | |
075dd8ee | 78 | -f:: |
fcfdf797 MG |
79 | Reset <branchname> to <startpoint> if <branchname> exists |
80 | already. Without `-f` 'git-branch' refuses to change an existing branch. | |
2eaf273d | 81 | |
c976d415 LH |
82 | -m:: |
83 | Move/rename a branch and the corresponding reflog. | |
84 | ||
85 | -M:: | |
e5ac1217 | 86 | Move/rename a branch even if the new branch name already exists. |
c976d415 | 87 | |
f3673988 BG |
88 | --color:: |
89 | Color branches to highlight current, local, and remote branches. | |
90 | ||
91 | --no-color:: | |
92 | Turn off branch colors, even when the configuration file gives the | |
93 | default to color output. | |
94 | ||
2eaf273d | 95 | -r:: |
7dda22e3 | 96 | List or delete (if used with -d) the remote-tracking branches. |
bfcc9214 AP |
97 | |
98 | -a:: | |
99 | List both remote-tracking branches and local branches. | |
075dd8ee | 100 | |
3240240f SB |
101 | -v:: |
102 | --verbose:: | |
2d8a7f0b JK |
103 | Show sha1 and commit subject line for each head, along with |
104 | relationship to upstream branch (if any). If given twice, print | |
105 | the name of the upstream branch, as well. | |
75e6e213 LH |
106 | |
107 | --abbrev=<length>:: | |
e5ac1217 DM |
108 | Alter the sha1's minimum display length in the output listing. |
109 | The default value is 7. | |
75e6e213 | 110 | |
5e00f6fa | 111 | --no-abbrev:: |
e5ac1217 | 112 | Display the full sha1s in the output listing rather than abbreviating them. |
5e00f6fa | 113 | |
84d176ce | 114 | --track:: |
e5ac1217 | 115 | When creating a new branch, set up the configuration so that 'git-pull' |
572fc81d JS |
116 | will automatically retrieve data from the start point, which must be |
117 | a branch. Use this if you always pull from the same upstream branch | |
e5ac1217 | 118 | into the new branch, and if you do not want to use "git pull |
572fc81d JS |
119 | <repository> <refspec>" explicitly. This behavior is the default |
120 | when the start point is a remote branch. Set the | |
121 | branch.autosetupmerge configuration variable to `false` if you want | |
ba020ef5 | 122 | 'git-checkout' and 'git-branch' to always behave as if '--no-track' were |
572fc81d JS |
123 | given. Set it to `always` if you want this behavior when the |
124 | start-point is either a local or remote branch. | |
84d176ce FMQ |
125 | |
126 | --no-track:: | |
70e96647 JK |
127 | Do not set up tracking configuration, even if the |
128 | branch.autosetupmerge configuration variable is true. | |
84d176ce | 129 | |
9a7ea2b1 LH |
130 | --contains <commit>:: |
131 | Only list branches which contain the specified commit. | |
132 | ||
133 | --merged:: | |
134 | Only list branches which are fully contained by HEAD. | |
135 | ||
136 | --no-merged:: | |
137 | Do not list branches which are fully contained by HEAD. | |
138 | ||
52a22d1e | 139 | <branchname>:: |
d4072c97 | 140 | The name of the branch to create or delete. |
2b1f4247 | 141 | The new branch name must pass all checks defined by |
5162e697 | 142 | linkgit:git-check-ref-format[1]. Some of these checks |
2b1f4247 | 143 | may restrict the characters allowed in a branch name. |
7fc9d69f | 144 | |
075dd8ee | 145 | <start-point>:: |
2eaf273d SE |
146 | The new branch will be created with a HEAD equal to this. It may |
147 | be given as a branch name, a commit-id, or a tag. If this option | |
148 | is omitted, the current branch is assumed. | |
149 | ||
c976d415 LH |
150 | <oldbranch>:: |
151 | The name of an existing branch to rename. | |
152 | ||
153 | <newbranch>:: | |
154 | The new name for an existing branch. The same restrictions as for | |
e5ac1217 | 155 | <branchname> apply. |
7fc9d69f | 156 | |
1e2ccd3a JH |
157 | |
158 | Examples | |
2eaf273d | 159 | -------- |
1e2ccd3a | 160 | |
e5ac1217 | 161 | Start development from a known tag:: |
1e2ccd3a JH |
162 | + |
163 | ------------ | |
164 | $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 | |
165 | $ cd my2.6 | |
2eaf273d | 166 | $ git branch my2.6.14 v2.6.14 <1> |
1e2ccd3a | 167 | $ git checkout my2.6.14 |
1e2ccd3a | 168 | ------------ |
2eaf273d SE |
169 | + |
170 | <1> This step and the next one could be combined into a single step with | |
171 | "checkout -b my2.6.14 v2.6.14". | |
1e2ccd3a | 172 | |
e5ac1217 | 173 | Delete an unneeded branch:: |
1e2ccd3a JH |
174 | + |
175 | ------------ | |
176 | $ git clone git://git.kernel.org/.../git.git my.git | |
177 | $ cd my.git | |
33b1f3d5 FM |
178 | $ git branch -d -r origin/todo origin/html origin/man <1> |
179 | $ git branch -D test <2> | |
2eaf273d SE |
180 | ------------ |
181 | + | |
e5ac1217 DM |
182 | <1> Delete the remote-tracking branches "todo", "html" and "man". The next |
183 | 'fetch' or 'pull' will create them again unless you configure them not to. | |
184 | See linkgit:git-fetch[1]. | |
185 | <2> Delete the "test" branch even if the "master" branch (or whichever branch | |
186 | is currently checked out) does not have all commits from the test branch. | |
2eaf273d SE |
187 | |
188 | ||
189 | Notes | |
190 | ----- | |
191 | ||
e5ac1217 | 192 | If you are creating a branch that you want to checkout immediately, it is |
2eaf273d SE |
193 | easier to use the git checkout command with its `-b` option to create |
194 | a branch and check it out with a single command. | |
195 | ||
e5ac1217 | 196 | The options `--contains`, `--merged` and `--no-merged` serve three related |
9a7ea2b1 LH |
197 | but different purposes: |
198 | ||
199 | - `--contains <commit>` is used to find all branches which will need | |
200 | special attention if <commit> were to be rebased or amended, since those | |
201 | branches contain the specified <commit>. | |
202 | ||
203 | - `--merged` is used to find all branches which can be safely deleted, | |
204 | since those branches are fully contained by HEAD. | |
205 | ||
206 | - `--no-merged` is used to find branches which are candidates for merging | |
207 | into HEAD, since those branches are not fully contained by HEAD. | |
1e2ccd3a | 208 | |
7fc9d69f JH |
209 | Author |
210 | ------ | |
59eb68aa | 211 | Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com> |
7fc9d69f JH |
212 | |
213 | Documentation | |
214 | -------------- | |
215 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
216 | ||
217 | GIT | |
218 | --- | |
9e1f0a85 | 219 | Part of the linkgit:git[1] suite |