GIT 1.4.4.3
[git/git.git] / 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' [-r]
12 'git-branch' [-l] [-f] <branchname> [<start-point>]
13 'git-branch' (-d | -D) <branchname>...
14
15 DESCRIPTION
16 -----------
17 With no arguments given (or just `-r`) a list of available branches
18 will be shown, the current branch will be highlighted with an asterisk.
19
20 In its second form, a new branch named <branchname> will be created.
21 It will start out with a head equal to the one given as <start-point>.
22 If no <start-point> is given, the branch will be created with a head
23 equal to that of the currently checked out branch.
24
25 With a `-d` or `-D` option, `<branchname>` will be deleted. You may
26 specify more than one branch for deletion. If the branch currently
27 has a ref log then the ref log will also be deleted.
28
29
30 OPTIONS
31 -------
32 -d::
33 Delete a branch. The branch must be fully merged.
34
35 -D::
36 Delete a branch irrespective of its index status.
37
38 -l::
39 Create the branch's ref log. This activates recording of
40 all changes to made the branch ref, enabling use of date
41 based sha1 expressions such as "<branchname>@{yesterday}".
42
43 -f::
44 Force the creation of a new branch even if it means deleting
45 a branch that already exists with the same name.
46
47 -r::
48 List only the "remote" branches.
49
50 <branchname>::
51 The name of the branch to create or delete.
52 The new branch name must pass all checks defined by
53 gitlink:git-check-ref-format[1]. Some of these checks
54 may restrict the characters allowed in a branch name.
55
56 <start-point>::
57 The new branch will be created with a HEAD equal to this. It may
58 be given as a branch name, a commit-id, or a tag. If this option
59 is omitted, the current branch is assumed.
60
61
62
63 Examples
64 --------
65
66 Start development off of a known tag::
67 +
68 ------------
69 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
70 $ cd my2.6
71 $ git branch my2.6.14 v2.6.14 <1>
72 $ git checkout my2.6.14
73 ------------
74 +
75 <1> This step and the next one could be combined into a single step with
76 "checkout -b my2.6.14 v2.6.14".
77
78 Delete unneeded branch::
79 +
80 ------------
81 $ git clone git://git.kernel.org/.../git.git my.git
82 $ cd my.git
83 $ git branch -D todo <1>
84 ------------
85 +
86 <1> delete todo branch even if the "master" branch does not have all
87 commits from todo branch.
88
89
90 Notes
91 -----
92
93 If you are creating a branch that you want to immediately checkout, it's
94 easier to use the git checkout command with its `-b` option to create
95 a branch and check it out with a single command.
96
97
98 Author
99 ------
100 Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
101
102 Documentation
103 --------------
104 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
105
106 GIT
107 ---
108 Part of the gitlink:git[7] suite
109