1git-branch(1) 2============= 3 4NAME 5---- 6git-branch - List, create, or delete branches 7 8SYNOPSIS 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>... 17 18DESCRIPTION 19----------- 20 21With no arguments, existing branches are listed and the current branch will 22be highlighted with an asterisk. Option `-r` causes the remote-tracking 23branches to be listed, and option `-a` shows both. 24 25With `--contains`, shows only the branches that contain the named commit 26(in other words, the branches whose tip commits are descendants of the 27named commit). With `--merged`, only branches merged into the named 28commit (i.e. the branches whose tip commits are reachable from the named 29commit) will be listed. With `--no-merged` only branches not merged into 30the named commit will be listed. If the <commit> argument is missing it 31defaults to 'HEAD' (i.e. the tip of the current branch). 32 33In the command's second form, a new branch named <branchname> will be created. 34It will start out with a head equal to the one given as <start-point>. 35If no <start-point> is given, the branch will be created with a head 36equal to that of the currently checked out branch. 37 38Note that this will create the new branch, but it will not switch the 39working tree to it; use "git checkout <newbranch>" to switch to the 40new branch. 41 42When a local branch is started off a remote branch, git sets up the 43branch so that 'git-pull' will appropriately merge from 44the remote branch. This behavior may be changed via the global 45`branch.autosetupmerge` configuration flag. That setting can be 46overridden by using the `--track` and `--no-track` options. 47 48With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>. 49If <oldbranch> had a corresponding reflog, it is renamed to match 50<newbranch>, and a reflog entry is created to remember the branch 51renaming. If <newbranch> exists, -M must be used to force the rename 52to happen. 53 54With a `-d` or `-D` option, `<branchname>` will be deleted. You may 55specify more than one branch for deletion. If the branch currently 56has a reflog then the reflog will also be deleted. 57 58Use -r together with -d to delete remote-tracking branches. Note, that it 59only makes sense to delete remote-tracking branches if they no longer exist 60in the remote repository or if 'git-fetch' was configured not to fetch 61them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a 62way to clean up all obsolete remote-tracking branches. 63 64 65OPTIONS 66------- 67-d:: 68 Delete a branch. The branch must be fully merged in HEAD. 69 70-D:: 71 Delete a branch irrespective of its merged status. 72 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}". 77 78-f:: 79--force:: 80 Reset <branchname> to <startpoint> if <branchname> exists 81 already. Without `-f` 'git-branch' refuses to change an existing branch. 82 83-m:: 84 Move/rename a branch and the corresponding reflog. 85 86-M:: 87 Move/rename a branch even if the new branch name already exists. 88 89--color:: 90 Color branches to highlight current, local, and remote branches. 91 92--no-color:: 93 Turn off branch colors, even when the configuration file gives the 94 default to color output. 95 96-r:: 97 List or delete (if used with -d) the remote-tracking branches. 98 99-a:: 100 List both remote-tracking branches and local branches. 101 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. 107 108--abbrev=<length>:: 109 Alter the sha1's minimum display length in the output listing. 110 The default value is 7. 111 112--no-abbrev:: 113 Display the full sha1s in the output listing rather than abbreviating them. 114 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. 123+ 124This behavior is the default when the start point is a remote branch. 125Set the branch.autosetupmerge configuration variable to `false` if you 126want `git checkout` and `git branch` to always behave as if '--no-track' 127were given. Set it to `always` if you want this behavior when the 128start-point is either a local or remote branch. 129 130--no-track:: 131 Do not set up "upstream" configuration, even if the 132 branch.autosetupmerge configuration variable is true. 133 134--contains <commit>:: 135 Only list branches which contain the specified commit. 136 137--merged [<commit>]:: 138 Only list branches whose tips are reachable from the 139 specified commit (HEAD if not specified). 140 141--no-merged [<commit>]:: 142 Only list branches whose tips are not reachable from the 143 specified commit (HEAD if not specified). 144 145<branchname>:: 146 The name of the branch to create or delete. 147 The new branch name must pass all checks defined by 148 linkgit:git-check-ref-format[1]. Some of these checks 149 may restrict the characters allowed in a branch name. 150 151<start-point>:: 152 The new branch will be created with a HEAD equal to this. It may 153 be given as a branch name, a commit-id, or a tag. If this option 154 is omitted, the current branch is assumed. 155 156<oldbranch>:: 157 The name of an existing branch to rename. 158 159<newbranch>:: 160 The new name for an existing branch. The same restrictions as for 161 <branchname> apply. 162 163 164Examples 165-------- 166 167Start development from a known tag:: 168+ 169------------ 170$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 171$ cd my2.6 172$ git branch my2.6.14 v2.6.14 <1> 173$ git checkout my2.6.14 174------------ 175+ 176<1> This step and the next one could be combined into a single step with 177"checkout -b my2.6.14 v2.6.14". 178 179Delete an unneeded branch:: 180+ 181------------ 182$ git clone git://git.kernel.org/.../git.git my.git 183$ cd my.git 184$ git branch -d -r origin/todo origin/html origin/man <1> 185$ git branch -D test <2> 186------------ 187+ 188<1> Delete the remote-tracking branches "todo", "html" and "man". The next 189'fetch' or 'pull' will create them again unless you configure them not to. 190See linkgit:git-fetch[1]. 191<2> Delete the "test" branch even if the "master" branch (or whichever branch 192is currently checked out) does not have all commits from the test branch. 193 194 195Notes 196----- 197 198If you are creating a branch that you want to checkout immediately, it is 199easier to use the git checkout command with its `-b` option to create 200a branch and check it out with a single command. 201 202The options `--contains`, `--merged` and `--no-merged` serve three related 203but different purposes: 204 205- `--contains <commit>` is used to find all branches which will need 206 special attention if <commit> were to be rebased or amended, since those 207 branches contain the specified <commit>. 208 209- `--merged` is used to find all branches which can be safely deleted, 210 since those branches are fully contained by HEAD. 211 212- `--no-merged` is used to find branches which are candidates for merging 213 into HEAD, since those branches are not fully contained by HEAD. 214 215SEE ALSO 216-------- 217linkgit:git-check-ref-format[1], 218linkgit:git-fetch[1], 219linkgit:git-remote[1]. 220 221Author 222------ 223Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com> 224 225Documentation 226-------------- 227Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. 228 229GIT 230--- 231Part of the linkgit:git[1] suite