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] [--show-current]
  12         [-v [--abbrev=<n> | --no-abbrev]]
  13         [--column[=<options>] | --no-column] [--sort=<key>]
  14         [--merged [<commit>]] [--no-merged [<commit>]]
  15         [--contains [<commit>]] [--no-contains [<commit>]]
  16         [--points-at <object>] [--format=<format>]
  17         [(-r | --remotes) | (-a | --all)]
  18         [--list] [<pattern>...]
  19 'git branch' [--track | --no-track] [-f] <branchname> [<start-point>]
  20 'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
  21 'git branch' --unset-upstream [<branchname>]
  22 'git branch' (-m | -M) [<oldbranch>] <newbranch>
  23 'git branch' (-c | -C) [<oldbranch>] <newbranch>
  24 'git branch' (-d | -D) [-r] <branchname>...
  25 'git branch' --edit-description [<branchname>]
  26
  27 DESCRIPTION
  28 -----------
  29
  30 If `--list` is given, or if there are no non-option arguments, existing
  31 branches are listed; the current branch will be highlighted in green and
  32 marked with an asterisk.  Any branches checked out in linked worktrees will
  33 be highlighted in cyan and marked with a plus sign. Option `-r` causes the
  34 remote-tracking branches to be listed,
  35 and option `-a` shows both local and remote branches.
  36
  37 If a `<pattern>`
  38 is given, it is used as a shell wildcard to restrict the output to
  39 matching branches. If multiple patterns are given, a branch is shown if
  40 it matches any of the patterns.
  41
  42 Note that when providing a
  43 `<pattern>`, you must use `--list`; otherwise the command may be interpreted
  44 as branch creation.
  45
  46 With `--contains`, shows only the branches that contain the named commit
  47 (in other words, the branches whose tip commits are descendants of the
  48 named commit), `--no-contains` inverts it. With `--merged`, only branches
  49 merged into the named commit (i.e. the branches whose tip commits are
  50 reachable from the named commit) will be listed.  With `--no-merged` only
  51 branches not merged into the named commit will be listed.  If the <commit>
  52 argument is missing it defaults to `HEAD` (i.e. the tip of the current
  53 branch).
  54
  55 The command's second form creates a new branch head named <branchname>
  56 which points to the current `HEAD`, or <start-point> if given. As a
  57 special case, for <start-point>, you may use `"A...B"` as a shortcut for
  58 the merge base of `A` and `B` if there is exactly one merge base. You
  59 can leave out at most one of `A` and `B`, in which case it defaults to
  60 `HEAD`.
  61
  62 Note that this will create the new branch, but it will not switch the
  63 working tree to it; use "git switch <newbranch>" to switch to the
  64 new branch.
  65
  66 When a local branch is started off a remote-tracking branch, Git sets up the
  67 branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
  68 configuration entries) so that 'git pull' will appropriately merge from
  69 the remote-tracking branch. This behavior may be changed via the global
  70 `branch.autoSetupMerge` configuration flag. That setting can be
  71 overridden by using the `--track` and `--no-track` options, and
  72 changed later using `git branch --set-upstream-to`.
  73
  74 With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
  75 If <oldbranch> had a corresponding reflog, it is renamed to match
  76 <newbranch>, and a reflog entry is created to remember the branch
  77 renaming. If <newbranch> exists, -M must be used to force the rename
  78 to happen.
  79
  80 The `-c` and `-C` options have the exact same semantics as `-m` and
  81 `-M`, except instead of the branch being renamed, it will be copied to a
  82 new name, along with its config and reflog.
  83
  84 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
  85 specify more than one branch for deletion.  If the branch currently
  86 has a reflog then the reflog will also be deleted.
  87
  88 Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
  89 only makes sense to delete remote-tracking branches if they no longer exist
  90 in the remote repository or if 'git fetch' was configured not to fetch
  91 them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
  92 way to clean up all obsolete remote-tracking branches.
  93
  94
  95 OPTIONS
  96 -------
  97 -d::
  98 --delete::
  99         Delete a branch. The branch must be fully merged in its
 100         upstream branch, or in `HEAD` if no upstream was set with
 101         `--track` or `--set-upstream-to`.
 102
 103 -D::
 104         Shortcut for `--delete --force`.
 105
 106 --create-reflog::
 107         Create the branch's reflog.  This activates recording of
 108         all changes made to the branch ref, enabling use of date
 109         based sha1 expressions such as "<branchname>@\{yesterday}".
 110         Note that in non-bare repositories, reflogs are usually
 111         enabled by default by the `core.logAllRefUpdates` config option.
 112         The negated form `--no-create-reflog` only overrides an earlier
 113         `--create-reflog`, but currently does not negate the setting of
 114         `core.logAllRefUpdates`.
 115
 116 -f::
 117 --force::
 118         Reset <branchname> to <startpoint>, even if <branchname> exists
 119         already. Without `-f`, 'git branch' refuses to change an existing branch.
 120         In combination with `-d` (or `--delete`), allow deleting the
 121         branch irrespective of its merged status, or whether it even
 122         points to a valid commit. In combination with
 123         `-m` (or `--move`), allow renaming the branch even if the new
 124         branch name already exists, the same applies for `-c` (or `--copy`).
 125
 126 -m::
 127 --move::
 128         Move/rename a branch and the corresponding reflog.
 129
 130 -M::
 131         Shortcut for `--move --force`.
 132
 133 -c::
 134 --copy::
 135         Copy a branch and the corresponding reflog.
 136
 137 -C::
 138         Shortcut for `--copy --force`.
 139
 140 --color[=<when>]::
 141         Color branches to highlight current, local, and
 142         remote-tracking branches.
 143         The value must be always (the default), never, or auto.
 144
 145 --no-color::
 146         Turn off branch colors, even when the configuration file gives the
 147         default to color output.
 148         Same as `--color=never`.
 149
 150 -i::
 151 --ignore-case::
 152         Sorting and filtering branches are case insensitive.
 153
 154 --column[=<options>]::
 155 --no-column::
 156         Display branch listing in columns. See configuration variable
 157         `column.branch` for option syntax. `--column` and `--no-column`
 158         without options are equivalent to 'always' and 'never' respectively.
 159 +
 160 This option is only applicable in non-verbose mode.
 161
 162 -r::
 163 --remotes::
 164         List or delete (if used with -d) the remote-tracking branches.
 165         Combine with `--list` to match the optional pattern(s).
 166
 167 -a::
 168 --all::
 169         List both remote-tracking branches and local branches.
 170         Combine with `--list` to match optional pattern(s).
 171
 172 -l::
 173 --list::
 174         List branches.  With optional `<pattern>...`, e.g. `git
 175         branch --list 'maint-*'`, list only the branches that match
 176         the pattern(s).
 177
 178 --show-current::
 179         Print the name of the current branch. In detached HEAD state,
 180         nothing is printed.
 181
 182 -v::
 183 -vv::
 184 --verbose::
 185         When in list mode,
 186         show sha1 and commit subject line for each head, along with
 187         relationship to upstream branch (if any). If given twice, print
 188         the path of the linked worktree (if any) and the name of the upstream
 189         branch, as well (see also `git remote show <remote>`).  Note that the
 190         current worktree's HEAD will not have its path printed (it will always
 191         be your current directory).
 192
 193 -q::
 194 --quiet::
 195         Be more quiet when creating or deleting a branch, suppressing
 196         non-error messages.
 197
 198 --abbrev=<n>::
 199         In the verbose listing that show the commit object name,
 200         show the shortest prefix that is at least '<n>' hexdigits
 201         long that uniquely refers the object.
 202         The default value is 7 and can be overridden by the `core.abbrev`
 203         config option.
 204
 205 --no-abbrev::
 206         Display the full sha1s in the output listing rather than abbreviating them.
 207
 208 -t::
 209 --track::
 210         When creating a new branch, set up `branch.<name>.remote` and
 211         `branch.<name>.merge` configuration entries to mark the
 212         start-point branch as "upstream" from the new branch. This
 213         configuration will tell git to show the relationship between the
 214         two branches in `git status` and `git branch -v`. Furthermore,
 215         it directs `git pull` without arguments to pull from the
 216         upstream when the new branch is checked out.
 217 +
 218 This behavior is the default when the start point is a remote-tracking branch.
 219 Set the branch.autoSetupMerge configuration variable to `false` if you
 220 want `git switch`, `git checkout` and `git branch` to always behave as if `--no-track`
 221 were given. Set it to `always` if you want this behavior when the
 222 start-point is either a local or remote-tracking branch.
 223
 224 --no-track::
 225         Do not set up "upstream" configuration, even if the
 226         branch.autoSetupMerge configuration variable is true.
 227
 228 --set-upstream::
 229         As this option had confusing syntax, it is no longer supported.
 230         Please use `--track` or `--set-upstream-to` instead.
 231
 232 -u <upstream>::
 233 --set-upstream-to=<upstream>::
 234         Set up <branchname>'s tracking information so <upstream> is
 235         considered <branchname>'s upstream branch. If no <branchname>
 236         is specified, then it defaults to the current branch.
 237
 238 --unset-upstream::
 239         Remove the upstream information for <branchname>. If no branch
 240         is specified it defaults to the current branch.
 241
 242 --edit-description::
 243         Open an editor and edit the text to explain what the branch is
 244         for, to be used by various other commands (e.g. `format-patch`,
 245         `request-pull`, and `merge` (if enabled)). Multi-line explanations
 246         may be used.
 247
 248 --contains [<commit>]::
 249         Only list branches which contain the specified commit (HEAD
 250         if not specified). Implies `--list`.
 251
 252 --no-contains [<commit>]::
 253         Only list branches which don't contain the specified commit
 254         (HEAD if not specified). Implies `--list`.
 255
 256 --merged [<commit>]::
 257         Only list branches whose tips are reachable from the
 258         specified commit (HEAD if not specified). Implies `--list`.
 259
 260 --no-merged [<commit>]::
 261         Only list branches whose tips are not reachable from the
 262         specified commit (HEAD if not specified). Implies `--list`.
 263
 264 <branchname>::
 265         The name of the branch to create or delete.
 266         The new branch name must pass all checks defined by
 267         linkgit:git-check-ref-format[1].  Some of these checks
 268         may restrict the characters allowed in a branch name.
 269
 270 <start-point>::
 271         The new branch head will point to this commit.  It may be
 272         given as a branch name, a commit-id, or a tag.  If this
 273         option is omitted, the current HEAD will be used instead.
 274
 275 <oldbranch>::
 276         The name of an existing branch to rename.
 277
 278 <newbranch>::
 279         The new name for an existing branch. The same restrictions as for
 280         <branchname> apply.
 281
 282 --sort=<key>::
 283         Sort based on the key given. Prefix `-` to sort in descending
 284         order of the value. You may use the --sort=<key> option
 285         multiple times, in which case the last key becomes the primary
 286         key. The keys supported are the same as those in `git
 287         for-each-ref`. Sort order defaults to the value configured for the
 288         `branch.sort` variable if exists, or to sorting based on the
 289         full refname (including `refs/...` prefix). This lists
 290         detached HEAD (if present) first, then local branches and
 291         finally remote-tracking branches. See linkgit:git-config[1].
 292
 293
 294 --points-at <object>::
 295         Only list branches of the given object.
 296
 297 --format <format>::
 298         A string that interpolates `%(fieldname)` from a branch ref being shown
 299         and the object it points at.  The format is the same as
 300         that of linkgit:git-for-each-ref[1].
 301
 302 CONFIGURATION
 303 -------------
 304 `pager.branch` is only respected when listing branches, i.e., when
 305 `--list` is used or implied. The default is to use a pager.
 306 See linkgit:git-config[1].
 307
 308 EXAMPLES
 309 --------
 310
 311 Start development from a known tag::
 312 +
 313 ------------
 314 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 315 $ cd my2.6
 316 $ git branch my2.6.14 v2.6.14   <1>
 317 $ git switch my2.6.14
 318 ------------
 319 +
 320 <1> This step and the next one could be combined into a single step with
 321     "checkout -b my2.6.14 v2.6.14".
 322
 323 Delete an unneeded branch::
 324 +
 325 ------------
 326 $ git clone git://git.kernel.org/.../git.git my.git
 327 $ cd my.git
 328 $ git branch -d -r origin/todo origin/html origin/man   <1>
 329 $ git branch -D test                                    <2>
 330 ------------
 331 +
 332 <1> Delete the remote-tracking branches "todo", "html" and "man". The next
 333     'fetch' or 'pull' will create them again unless you configure them not to.
 334     See linkgit:git-fetch[1].
 335 <2> Delete the "test" branch even if the "master" branch (or whichever branch
 336     is currently checked out) does not have all commits from the test branch.
 337
 338 Listing branches from a specific remote::
 339 +
 340 ------------
 341 $ git branch -r -l '<remote>/<pattern>'                 <1>
 342 $ git for-each-ref 'refs/remotes/<remote>/<pattern>'    <2>
 343 ------------
 344 +
 345 <1> Using `-a` would conflate <remote> with any local branches you happen to
 346     have been prefixed with the same <remote> pattern.
 347 <2> `for-each-ref` can take a wide range of options. See linkgit:git-for-each-ref[1]
 348
 349 Patterns will normally need quoting.
 350
 351 NOTES
 352 -----
 353
 354 If you are creating a branch that you want to switch to immediately,
 355 it is easier to use the "git switch" command with its `-c` option to
 356 do the same thing with a single command.
 357
 358 The options `--contains`, `--no-contains`, `--merged` and `--no-merged`
 359 serve four related but different purposes:
 360
 361 - `--contains <commit>` is used to find all branches which will need
 362   special attention if <commit> were to be rebased or amended, since those
 363   branches contain the specified <commit>.
 364
 365 - `--no-contains <commit>` is the inverse of that, i.e. branches that don't
 366   contain the specified <commit>.
 367
 368 - `--merged` is used to find all branches which can be safely deleted,
 369   since those branches are fully contained by HEAD.
 370
 371 - `--no-merged` is used to find branches which are candidates for merging
 372   into HEAD, since those branches are not fully contained by HEAD.
 373
 374 include::ref-reachability-filters.txt[]
 375
 376 SEE ALSO
 377 --------
 378 linkgit:git-check-ref-format[1],
 379 linkgit:git-fetch[1],
 380 linkgit:git-remote[1],
 381 link:user-manual.html#what-is-a-branch[``Understanding history: What is
 382 a branch?''] in the Git User's Manual.
 383
 384 GIT
 385 ---
 386 Part of the linkgit:git[1] suite