add tests for git diff --submodule
[git.git] / Documentation / git-branch.txt
blobaad71dc59a7c385be4f24ee9b981cd998fdd186f
1 git-branch(1)
2 =============
4 NAME
5 ----
6 git-branch - List, create, or delete branches
8 SYNOPSIS
9 --------
10 [verse]
11 'git branch' [--color | --no-color] [-r | -a]
12         [-v [--abbrev=<length> | --no-abbrev]]
13         [(--merged | --no-merged | --contains) [<commit>]]
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>...
18 DESCRIPTION
19 -----------
21 With no arguments, existing branches are listed and the current branch will
22 be highlighted with an asterisk.  Option `-r` causes the remote-tracking
23 branches to be listed, and option `-a` shows both.
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
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
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).
33 In the command's second form, a new branch named <branchname> will be created.
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.
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.
42 When a local branch is started off a remote branch, git sets up the
43 branch so that 'git-pull' will appropriately merge from
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.
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.
54 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
55 specify more than one branch for deletion.  If the branch currently
56 has a reflog then the reflog will also be deleted.
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
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.
65 OPTIONS
66 -------
67 -d::
68         Delete a branch. The branch must be fully merged in HEAD.
70 -D::
71         Delete a branch irrespective of its merged status.
73 -l::
74         Create the branch's reflog.  This activates recording of
75         all changes made to the branch ref, enabling use of date
76         based sha1 expressions such as "<branchname>@\{yesterday}".
78 -f::
79 --force::
80         Reset <branchname> to <startpoint> if <branchname> exists
81         already. Without `-f` 'git-branch' refuses to change an existing branch.
83 -m::
84         Move/rename a branch and the corresponding reflog.
86 -M::
87         Move/rename a branch even if the new branch name already exists.
89 --color::
90         Color branches to highlight current, local, and remote branches.
92 --no-color::
93         Turn off branch colors, even when the configuration file gives the
94         default to color output.
96 -r::
97         List or delete (if used with -d) the remote-tracking branches.
99 -a::
100         List both remote-tracking branches and local branches.
102 -v::
103 --verbose::
104         Show sha1 and commit subject line for each head, along with
105         relationship to upstream branch (if any). If given twice, print
106         the name of the upstream branch, as well.
108 --abbrev=<length>::
109         Alter the sha1's minimum display length in the output listing.
110         The default value is 7.
112 --no-abbrev::
113         Display the full sha1s in the output listing rather than abbreviating them.
115 -t::
116 --track::
117         When creating a new branch, set up configuration to mark the
118         start-point branch as "upstream" from the new branch. This
119         configuration will tell git to show the relationship between the
120         two branches in `git status` and `git branch -v`. Furthermore,
121         it directs `git pull` without arguments to pull from the
122         upstream when the new branch is checked out.
124 This behavior is the default when the start point is a remote branch.
125 Set the branch.autosetupmerge configuration variable to `false` if you
126 want `git checkout` and `git branch` to always behave as if '--no-track'
127 were given. Set it to `always` if you want this behavior when the
128 start-point is either a local or remote branch.
130 --no-track::
131         Do not set up "upstream" configuration, even if the
132         branch.autosetupmerge configuration variable is true.
134 --contains <commit>::
135         Only list branches which contain the specified commit.
137 --merged::
138         Only list branches which are fully contained by HEAD.
140 --no-merged::
141         Do not list branches which are fully contained by HEAD.
143 <branchname>::
144         The name of the branch to create or delete.
145         The new branch name must pass all checks defined by
146         linkgit:git-check-ref-format[1].  Some of these checks
147         may restrict the characters allowed in a branch name.
149 <start-point>::
150         The new branch will be created with a HEAD equal to this.  It may
151         be given as a branch name, a commit-id, or a tag.  If this option
152         is omitted, the current branch is assumed.
154 <oldbranch>::
155         The name of an existing branch to rename.
157 <newbranch>::
158         The new name for an existing branch. The same restrictions as for
159         <branchname> apply.
162 Examples
163 --------
165 Start development from a known tag::
167 ------------
168 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
169 $ cd my2.6
170 $ git branch my2.6.14 v2.6.14   <1>
171 $ git checkout my2.6.14
172 ------------
174 <1> This step and the next one could be combined into a single step with
175 "checkout -b my2.6.14 v2.6.14".
177 Delete an unneeded branch::
179 ------------
180 $ git clone git://git.kernel.org/.../git.git my.git
181 $ cd my.git
182 $ git branch -d -r origin/todo origin/html origin/man   <1>
183 $ git branch -D test                                    <2>
184 ------------
186 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
187 'fetch' or 'pull' will create them again unless you configure them not to.
188 See linkgit:git-fetch[1].
189 <2> Delete the "test" branch even if the "master" branch (or whichever branch
190 is currently checked out) does not have all commits from the test branch.
193 Notes
194 -----
196 If you are creating a branch that you want to checkout immediately, it is
197 easier to use the git checkout command with its `-b` option to create
198 a branch and check it out with a single command.
200 The options `--contains`, `--merged` and `--no-merged` serve three related
201 but different purposes:
203 - `--contains <commit>` is used to find all branches which will need
204   special attention if <commit> were to be rebased or amended, since those
205   branches contain the specified <commit>.
207 - `--merged` is used to find all branches which can be safely deleted,
208   since those branches are fully contained by HEAD.
210 - `--no-merged` is used to find branches which are candidates for merging
211   into HEAD, since those branches are not fully contained by HEAD.
213 SEE ALSO
214 --------
215 linkgit:git-check-ref-format[1],
216 linkgit:git-fetch[1],
217 linkgit:git-remote[1].
219 Author
220 ------
221 Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com>
223 Documentation
224 --------------
225 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
229 Part of the linkgit:git[1] suite