Documentation/branch: document -d --force and -m --force
[git.git] / Documentation / git-branch.txt
1 git-branch(1)
2 =============
5 ----
6 git-branch - List, create, or delete branches
9 --------
10 [verse]
11 'git branch' [--color[=<when>] | --no-color] [-r | -a]
12         [--list] [-v [--abbrev=<length> | --no-abbrev]]
13         [--column[=<options>] | --no-column]
14         [(--merged | --no-merged | --contains) [<commit>]] [<pattern>...]
15 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
16 'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
17 'git branch' --unset-upstream [<branchname>]
18 'git branch' (-m | -M) [<oldbranch>] <newbranch>
19 'git branch' (-d | -D) [-r] <branchname>...
20 'git branch' --edit-description [<branchname>]
23 -----------
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.
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
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
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).
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.
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.
50 When a local branch is started off a remote-tracking branch, Git sets up the
51 branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
52 configuration entries) so that 'git pull' will appropriately merge from
53 the remote-tracking branch. This behavior may be changed via the global
54 `branch.autosetupmerge` configuration flag. That setting can be
55 overridden by using the `--track` and `--no-track` options, and
56 changed later using `git branch --set-upstream-to`.
58 With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
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.
64 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
65 specify more than one branch for deletion.  If the branch currently
66 has a reflog then the reflog will also be deleted.
68 Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
69 only makes sense to delete remote-tracking branches if they no longer exist
70 in the remote repository or if 'git fetch' was configured not to fetch
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.
76 -------
77 -d::
78 --delete::
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`.
83 -D::
84         Delete a branch irrespective of its merged status.
86 -l::
87 --create-reflog::
88         Create the branch's reflog.  This activates recording of
89         all changes made to the branch ref, enabling use of date
90         based sha1 expressions such as "<branchname>@\{yesterday}".
91         Note that in non-bare repositories, reflogs are usually
92         enabled by default by the `core.logallrefupdates` config option.
94 -f::
95 --force::
96         Reset <branchname> to <startpoint> if <branchname> exists
97         already. Without `-f` 'git branch' refuses to change an existing branch.
98         In combination with `-d` (or `--delete`), allow deleting the
99         branch irrespective of its merged status. In combination with
100         `-m` (or `--move`), allow renaming the branch even if the new
101         branch name already exists.
103 -m::
104 --move::
105         Move/rename a branch and the corresponding reflog.
107 -M::
108         Move/rename a branch even if the new branch name already exists.
110 --color[=<when>]::
111         Color branches to highlight current, local, and
112         remote-tracking branches.
113         The value must be always (the default), never, or auto.
115 --no-color::
116         Turn off branch colors, even when the configuration file gives the
117         default to color output.
118         Same as `--color=never`.
120 --column[=<options>]::
121 --no-column::
122         Display branch listing in columns. See configuration variable
123         column.branch for option syntax.`--column` and `--no-column`
124         without options are equivalent to 'always' and 'never' respectively.
126 This option is only applicable in non-verbose mode.
128 -r::
129 --remotes::
130         List or delete (if used with -d) the remote-tracking branches.
132 -a::
133 --all::
134         List both remote-tracking branches and local branches.
136 --list::
137         Activate the list mode. `git branch <pattern>` would try to create a branch,
138         use `git branch --list <pattern>` to list matching branches.
140 -v::
141 -vv::
142 --verbose::
143         When in list mode,
144         show sha1 and commit subject line for each head, along with
145         relationship to upstream branch (if any). If given twice, print
146         the name of the upstream branch, as well (see also `git remote
147         show <remote>`).
149 -q::
150 --quiet::
151         Be more quiet when creating or deleting a branch, suppressing
152         non-error messages.
154 --abbrev=<length>::
155         Alter the sha1's minimum display length in the output listing.
156         The default value is 7 and can be overridden by the `core.abbrev`
157         config option.
159 --no-abbrev::
160         Display the full sha1s in the output listing rather than abbreviating them.
162 -t::
163 --track::
164         When creating a new branch, set up `branch.<name>.remote` and
165         `branch.<name>.merge` configuration entries to mark the
166         start-point branch as "upstream" from the new branch. This
167         configuration will tell git to show the relationship between the
168         two branches in `git status` and `git branch -v`. Furthermore,
169         it directs `git pull` without arguments to pull from the
170         upstream when the new branch is checked out.
172 This behavior is the default when the start point is a remote-tracking branch.
173 Set the branch.autosetupmerge configuration variable to `false` if you
174 want `git checkout` and `git branch` to always behave as if '--no-track'
175 were given. Set it to `always` if you want this behavior when the
176 start-point is either a local or remote-tracking branch.
178 --no-track::
179         Do not set up "upstream" configuration, even if the
180         branch.autosetupmerge configuration variable is true.
182 --set-upstream::
183         If specified branch does not exist yet or if `--force` has been
184         given, acts exactly like `--track`. Otherwise sets up configuration
185         like `--track` would when creating the branch, except that where
186         branch points to is not changed.
188 -u <upstream>::
189 --set-upstream-to=<upstream>::
190         Set up <branchname>'s tracking information so <upstream> is
191         considered <branchname>'s upstream branch. If no <branchname>
192         is specified, then it defaults to the current branch.
194 --unset-upstream::
195         Remove the upstream information for <branchname>. If no branch
196         is specified it defaults to the current branch.
198 --edit-description::
199         Open an editor and edit the text to explain what the branch is
200         for, to be used by various other commands (e.g. `request-pull`).
202 --contains [<commit>]::
203         Only list branches which contain the specified commit (HEAD
204         if not specified). Implies `--list`.
206 --merged [<commit>]::
207         Only list branches whose tips are reachable from the
208         specified commit (HEAD if not specified). Implies `--list`.
210 --no-merged [<commit>]::
211         Only list branches whose tips are not reachable from the
212         specified commit (HEAD if not specified). Implies `--list`.
214 <branchname>::
215         The name of the branch to create or delete.
216         The new branch name must pass all checks defined by
217         linkgit:git-check-ref-format[1].  Some of these checks
218         may restrict the characters allowed in a branch name.
220 <start-point>::
221         The new branch head will point to this commit.  It may be
222         given as a branch name, a commit-id, or a tag.  If this
223         option is omitted, the current HEAD will be used instead.
225 <oldbranch>::
226         The name of an existing branch to rename.
228 <newbranch>::
229         The new name for an existing branch. The same restrictions as for
230         <branchname> apply.
233 Examples
234 --------
236 Start development from a known tag::
238 ------------
239 $ git clone git:// my2.6
240 $ cd my2.6
241 $ git branch my2.6.14 v2.6.14   <1>
242 $ git checkout my2.6.14
243 ------------
245 <1> This step and the next one could be combined into a single step with
246 "checkout -b my2.6.14 v2.6.14".
248 Delete an unneeded branch::
250 ------------
251 $ git clone git:// my.git
252 $ cd my.git
253 $ git branch -d -r origin/todo origin/html origin/man   <1>
254 $ git branch -D test                                    <2>
255 ------------
257 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
258 'fetch' or 'pull' will create them again unless you configure them not to.
259 See linkgit:git-fetch[1].
260 <2> Delete the "test" branch even if the "master" branch (or whichever branch
261 is currently checked out) does not have all commits from the test branch.
264 Notes
265 -----
267 If you are creating a branch that you want to checkout immediately, it is
268 easier to use the git checkout command with its `-b` option to create
269 a branch and check it out with a single command.
271 The options `--contains`, `--merged` and `--no-merged` serve three related
272 but different purposes:
274 - `--contains <commit>` is used to find all branches which will need
275   special attention if <commit> were to be rebased or amended, since those
276   branches contain the specified <commit>.
278 - `--merged` is used to find all branches which can be safely deleted,
279   since those branches are fully contained by HEAD.
281 - `--no-merged` is used to find branches which are candidates for merging
282   into HEAD, since those branches are not fully contained by HEAD.
285 --------
286 linkgit:git-check-ref-format[1],
287 linkgit:git-fetch[1],
288 linkgit:git-remote[1],
289 link:user-manual.html#what-is-a-branch[``Understanding history: What is
290 a branch?''] in the Git User's Manual.
294 Part of the linkgit:git[1] suite