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