Documentation/git-branch.txt

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