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         [--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' (-m | -M) [<oldbranch>] <newbranch>
  17 'git branch' (-d | -D) [-r] <branchname>...
  18 'git branch' --edit-description [<branchname>]
  19
  20 DESCRIPTION
  21 -----------
  22
  23 With no arguments, existing branches are listed and the current branch will
  24 be highlighted with an asterisk.  Option `-r` causes the remote-tracking
  25 branches to be listed, and option `-a` shows both. This list mode is also
  26 activated by the `--list` option (see below).
  27 <pattern> restricts the output to matching branches, the pattern is a shell
  28 wildcard (i.e., matched using fnmatch(3)).
  29 Multiple patterns may be given; if any of them matches, the branch is shown.
  30
  31 With `--contains`, shows only the branches that contain the named commit
  32 (in other words, the branches whose tip commits are descendants of the
  33 named commit).  With `--merged`, only branches merged into the named
  34 commit (i.e. the branches whose tip commits are reachable from the named
  35 commit) will be listed.  With `--no-merged` only branches not merged into
  36 the named commit will be listed.  If the <commit> argument is missing it
  37 defaults to 'HEAD' (i.e. the tip of the current branch).
  38
  39 The command's second form creates a new branch head named <branchname>
  40 which points to the current 'HEAD', or <start-point> if given.
  41
  42 Note that this will create the new branch, but it will not switch the
  43 working tree to it; use "git checkout <newbranch>" to switch to the
  44 new branch.
  45
  46 When a local branch is started off a remote-tracking branch, git sets up the
  47 branch so that 'git pull' will appropriately merge from
  48 the remote-tracking branch. This behavior may be changed via the global
  49 `branch.autosetupmerge` configuration flag. That setting can be
  50 overridden by using the `--track` and `--no-track` options, and
  51 changed later using `git branch --set-upstream`.
  52
  53 With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
  54 If <oldbranch> had a corresponding reflog, it is renamed to match
  55 <newbranch>, and a reflog entry is created to remember the branch
  56 renaming. If <newbranch> exists, -M must be used to force the rename
  57 to happen.
  58
  59 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
  60 specify more than one branch for deletion.  If the branch currently
  61 has a reflog then the reflog will also be deleted.
  62
  63 Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
  64 only makes sense to delete remote-tracking branches if they no longer exist
  65 in the remote repository or if 'git fetch' was configured not to fetch
  66 them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
  67 way to clean up all obsolete remote-tracking branches.
  68
  69
  70 OPTIONS
  71 -------
  72 -d::
  73 --delete::
  74         Delete a branch. The branch must be fully merged in its
  75         upstream branch, or in `HEAD` if no upstream was set with
  76         `--track` or `--set-upstream`.
  77
  78 -D::
  79         Delete a branch irrespective of its merged status.
  80
  81 -l::
  82 --create-reflog::
  83         Create the branch's reflog.  This activates recording of
  84         all changes made to the branch ref, enabling use of date
  85         based sha1 expressions such as "<branchname>@\{yesterday}".
  86         Note that in non-bare repositories, reflogs are usually
  87         enabled by default by the `core.logallrefupdates` config option.
  88
  89 -f::
  90 --force::
  91         Reset <branchname> to <startpoint> if <branchname> exists
  92         already. Without `-f` 'git branch' refuses to change an existing branch.
  93
  94 -m::
  95 --move::
  96         Move/rename a branch and the corresponding reflog.
  97
  98 -M::
  99         Move/rename a branch even if the new branch name already exists.
 100
 101 --color[=<when>]::
 102         Color branches to highlight current, local, and
 103         remote-tracking branches.
 104         The value must be always (the default), never, or auto.
 105
 106 --no-color::
 107         Turn off branch colors, even when the configuration file gives the
 108         default to color output.
 109         Same as `--color=never`.
 110
 111 --column[=<options>]::
 112 --no-column::
 113         Display branch listing in columns. See configuration variable
 114         column.branch for option syntax.`--column` and `--no-column`
 115         without options are equivalent to 'always' and 'never' respectively.
 116 +
 117 This option is only applicable in non-verbose mode.
 118
 119 -r::
 120 --remotes::
 121         List or delete (if used with -d) the remote-tracking branches.
 122
 123 -a::
 124 --all::
 125         List both remote-tracking branches and local branches.
 126
 127 --list::
 128         Activate the list mode. `git branch <pattern>` would try to create a branch,
 129         use `git branch --list <pattern>` to list matching branches.
 130
 131 -v::
 132 --verbose::
 133         When in list mode,
 134         show sha1 and commit subject line for each head, along with
 135         relationship to upstream branch (if any). If given twice, print
 136         the name of the upstream branch, as well.
 137
 138 -q::
 139 --quiet::
 140         Be more quiet when creating or deleting a branch, suppressing
 141         non-error messages.
 142
 143 --abbrev=<length>::
 144         Alter the sha1's minimum display length in the output listing.
 145         The default value is 7 and can be overridden by the `core.abbrev`
 146         config option.
 147
 148 --no-abbrev::
 149         Display the full sha1s in the output listing rather than abbreviating them.
 150
 151 -t::
 152 --track::
 153         When creating a new branch, set up configuration to mark the
 154         start-point branch as "upstream" from the new branch. This
 155         configuration will tell git to show the relationship between the
 156         two branches in `git status` and `git branch -v`. Furthermore,
 157         it directs `git pull` without arguments to pull from the
 158         upstream when the new branch is checked out.
 159 +
 160 This behavior is the default when the start point is a remote-tracking branch.
 161 Set the branch.autosetupmerge configuration variable to `false` if you
 162 want `git checkout` and `git branch` to always behave as if '--no-track'
 163 were given. Set it to `always` if you want this behavior when the
 164 start-point is either a local or remote-tracking branch.
 165
 166 --no-track::
 167         Do not set up "upstream" configuration, even if the
 168         branch.autosetupmerge configuration variable is true.
 169
 170 --set-upstream::
 171         If specified branch does not exist yet or if `--force` has been
 172         given, acts exactly like `--track`. Otherwise sets up configuration
 173         like `--track` would when creating the branch, except that where
 174         branch points to is not changed.
 175
 176 --edit-description::
 177         Open an editor and edit the text to explain what the branch is
 178         for, to be used by various other commands (e.g. `request-pull`).
 179
 180 --contains [<commit>]::
 181         Only list branches which contain the specified commit (HEAD
 182         if not specified).
 183
 184 --merged [<commit>]::
 185         Only list branches whose tips are reachable from the
 186         specified commit (HEAD if not specified).
 187
 188 --no-merged [<commit>]::
 189         Only list branches whose tips are not reachable from the
 190         specified commit (HEAD if not specified).
 191
 192 <branchname>::
 193         The name of the branch to create or delete.
 194         The new branch name must pass all checks defined by
 195         linkgit:git-check-ref-format[1].  Some of these checks
 196         may restrict the characters allowed in a branch name.
 197
 198 <start-point>::
 199         The new branch head will point to this commit.  It may be
 200         given as a branch name, a commit-id, or a tag.  If this
 201         option is omitted, the current HEAD will be used instead.
 202
 203 <oldbranch>::
 204         The name of an existing branch to rename.
 205
 206 <newbranch>::
 207         The new name for an existing branch. The same restrictions as for
 208         <branchname> apply.
 209
 210
 211 Examples
 212 --------
 213
 214 Start development from a known tag::
 215 +
 216 ------------
 217 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 218 $ cd my2.6
 219 $ git branch my2.6.14 v2.6.14   <1>
 220 $ git checkout my2.6.14
 221 ------------
 222 +
 223 <1> This step and the next one could be combined into a single step with
 224 "checkout -b my2.6.14 v2.6.14".
 225
 226 Delete an unneeded branch::
 227 +
 228 ------------
 229 $ git clone git://git.kernel.org/.../git.git my.git
 230 $ cd my.git
 231 $ git branch -d -r origin/todo origin/html origin/man   <1>
 232 $ git branch -D test                                    <2>
 233 ------------
 234 +
 235 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
 236 'fetch' or 'pull' will create them again unless you configure them not to.
 237 See linkgit:git-fetch[1].
 238 <2> Delete the "test" branch even if the "master" branch (or whichever branch
 239 is currently checked out) does not have all commits from the test branch.
 240
 241
 242 Notes
 243 -----
 244
 245 If you are creating a branch that you want to checkout immediately, it is
 246 easier to use the git checkout command with its `-b` option to create
 247 a branch and check it out with a single command.
 248
 249 The options `--contains`, `--merged` and `--no-merged` serve three related
 250 but different purposes:
 251
 252 - `--contains <commit>` is used to find all branches which will need
 253   special attention if <commit> were to be rebased or amended, since those
 254   branches contain the specified <commit>.
 255
 256 - `--merged` is used to find all branches which can be safely deleted,
 257   since those branches are fully contained by HEAD.
 258
 259 - `--no-merged` is used to find branches which are candidates for merging
 260   into HEAD, since those branches are not fully contained by HEAD.
 261
 262 SEE ALSO
 263 --------
 264 linkgit:git-check-ref-format[1],
 265 linkgit:git-fetch[1],
 266 linkgit:git-remote[1],
 267 link:user-manual.html#what-is-a-branch[``Understanding history: What is
 268 a branch?''] in the Git User's Manual.
 269
 270 GIT
 271 ---
 272 Part of the linkgit:git[1] suite