Merge git://git.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-branch.txt
1 git-branch(1)
2 =============
3
4 NAME
5 ----
6 git-branch - Create a new branch, or remove an old one.
7
8 SYNOPSIS
9 --------
10 'git-branch' [(-d | -D) <branchname>] | [[-f] <branchname> [<start-point>]]
11
12 DESCRIPTION
13 -----------
14 If no argument is provided, show available branches and mark current
15 branch with star. Otherwise, create a new branch of name <branchname>.
16
17 If a starting point is also specified, that will be where the branch is
18 created, otherwise it will be created at the current HEAD.
19
20 OPTIONS
21 -------
22 -d::
23 Delete a branch. The branch must be fully merged.
24
25 -D::
26 Delete a branch irrespective of its index status.
27
28 -f::
29 Force a reset of <branchname> to <start-point> (or current head).
30
31 <branchname>::
32 The name of the branch to create or delete.
33
34 <start-point>::
35 Where to create the branch; defaults to HEAD. This
36 option has no meaning with -d and -D.
37
38
39 Examples
40 ~~~~~~~~
41
42 Start development off of a know tag::
43 +
44 ------------
45 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
46 $ cd my2.6
47 $ git branch my2.6.14 v2.6.14 <1>
48 $ git checkout my2.6.14
49
50 <1> These two steps are the same as "checkout -b my2.6.14 v2.6.14".
51 ------------
52
53 Delete unneeded branch::
54 +
55 ------------
56 $ git clone git://git.kernel.org/.../git.git my.git
57 $ cd my.git
58 $ git branch -D todo <1>
59
60 <1> delete todo branch even if the "master" branch does not have all
61 commits from todo branch.
62 ------------
63
64 Author
65 ------
66 Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
67
68 Documentation
69 --------------
70 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
71
72 GIT
73 ---
74 Part of the gitlink:git[7] suite
75