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 | --no-color] [-r | -a]
  12            [-v [--abbrev=<length> | --no-abbrev]]
  13            [--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
  18 DESCRIPTION
  19 -----------
  20 With no arguments given a list of existing branches
  21 will be shown, the current branch will be highlighted with an asterisk.
  22 Option `-r` causes the remote-tracking branches to be listed,
  23 and option `-a` shows both.
  24 With `--contains <commit>`, shows only the branches that
  25 contains the named commit (in other words, the branches whose
  26 tip commits are descendant of the named commit).
  27
  28 In its second form, a new branch named <branchname> will be created.
  29 It will start out with a head equal to the one given as <start-point>.
  30 If no <start-point> is given, the branch will be created with a head
  31 equal to that of the currently checked out branch.
  32
  33 Note that this will create the new branch, but it will not switch the
  34 working tree to it; use "git checkout <newbranch>" to switch to the
  35 new branch.
  36
  37 When a local branch is started off a remote branch, git can setup the
  38 branch so that gitlink:git-pull[1] will appropriately merge from that
  39 remote branch.  If this behavior is desired, it is possible to make it
  40 the default using the global `branch.autosetupmerge` configuration
  41 flag.  Otherwise, it can be chosen per-branch using the `--track`
  42 and `--no-track` options.
  43
  44 With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
  45 If <oldbranch> had a corresponding reflog, it is renamed to match
  46 <newbranch>, and a reflog entry is created to remember the branch
  47 renaming. If <newbranch> exists, -M must be used to force the rename
  48 to happen.
  49
  50 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
  51 specify more than one branch for deletion.  If the branch currently
  52 has a reflog then the reflog will also be deleted. Use -r together with -d
  53 to delete remote-tracking branches.
  54
  55
  56 OPTIONS
  57 -------
  58 -d::
  59         Delete a branch. The branch must be fully merged.
  60
  61 -D::
  62         Delete a branch irrespective of its index status.
  63
  64 -l::
  65         Create the branch's reflog.  This activates recording of
  66         all changes made to the branch ref, enabling use of date
  67         based sha1 expressions such as "<branchname>@\{yesterday}".
  68
  69 -f::
  70         Force the creation of a new branch even if it means deleting
  71         a branch that already exists with the same name.
  72
  73 -m::
  74         Move/rename a branch and the corresponding reflog.
  75
  76 -M::
  77         Move/rename a branch even if the new branchname already exists.
  78
  79 --color::
  80         Color branches to highlight current, local, and remote branches.
  81
  82 --no-color::
  83         Turn off branch colors, even when the configuration file gives the
  84         default to color output.
  85
  86 -r::
  87         List or delete (if used with -d) the remote-tracking branches.
  88
  89 -a::
  90         List both remote-tracking branches and local branches.
  91
  92 -v, --verbose::
  93         Show sha1 and commit subject line for each head.
  94
  95 --abbrev=<length>::
  96         Alter minimum display length for sha1 in output listing,
  97         default value is 7.
  98
  99 --no-abbrev::
 100         Display the full sha1s in output listing rather than abbreviating them.
 101
 102 --track::
 103         Set up configuration so that git-pull will automatically
 104         retrieve data from the remote branch.  Use this if you always
 105         pull from the same remote branch into the new branch, or if you
 106         don't want to use "git pull <repository> <refspec>" explicitly.  Set the
 107         branch.autosetupmerge configuration variable to true if you
 108         want git-checkout and git-branch to always behave as if
 109         '--track' were given.
 110
 111 --no-track::
 112         When a branch is created off a remote branch,
 113         set up configuration so that git-pull will not retrieve data
 114         from the remote branch, ignoring the branch.autosetupmerge
 115         configuration variable.
 116
 117 <branchname>::
 118         The name of the branch to create or delete.
 119         The new branch name must pass all checks defined by
 120         gitlink:git-check-ref-format[1].  Some of these checks
 121         may restrict the characters allowed in a branch name.
 122
 123 <start-point>::
 124         The new branch will be created with a HEAD equal to this.  It may
 125         be given as a branch name, a commit-id, or a tag.  If this option
 126         is omitted, the current branch is assumed.
 127
 128 <oldbranch>::
 129         The name of an existing branch to rename.
 130
 131 <newbranch>::
 132         The new name for an existing branch. The same restrictions as for
 133         <branchname> applies.
 134
 135
 136 Examples
 137 --------
 138
 139 Start development off of a known tag::
 140 +
 141 ------------
 142 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 143 $ cd my2.6
 144 $ git branch my2.6.14 v2.6.14   <1>
 145 $ git checkout my2.6.14
 146 ------------
 147 +
 148 <1> This step and the next one could be combined into a single step with
 149 "checkout -b my2.6.14 v2.6.14".
 150
 151 Delete unneeded branch::
 152 +
 153 ------------
 154 $ git clone git://git.kernel.org/.../git.git my.git
 155 $ cd my.git
 156 $ git branch -d -r origin/todo origin/html origin/man   <1>
 157 $ git branch -D test                                    <2>
 158 ------------
 159 +
 160 <1> Delete remote-tracking branches "todo", "html", "man"
 161 <2> Delete "test" branch even if the "master" branch does not have all
 162 commits from test branch.
 163
 164
 165 Notes
 166 -----
 167
 168 If you are creating a branch that you want to immediately checkout, it's
 169 easier to use the git checkout command with its `-b` option to create
 170 a branch and check it out with a single command.
 171
 172
 173 Author
 174 ------
 175 Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
 176
 177 Documentation
 178 --------------
 179 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 180
 181 GIT
 182 ---
 183 Part of the gitlink:git[7] suite