projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 215a7ad1 JH |
1 | git-branch(1) |
| 2 | ============= | |
| 7fc9d69f JH |
3 | |
| 4 | NAME | |
| 5 | ---- | |
| 2eaf273d | 6 | git-branch - List, create, or delete branches. |
| 7fc9d69f JH |
7 | |
| 8 | SYNOPSIS | |
| 9 | -------- | |
| dd181119 | 10 | [verse] |
| 2eaf273d SE |
11 | 'git-branch' [-r] |
| 12 | 'git-branch' [-f] <branchname> [<start-point>] | |
| 13 | 'git-branch' (-d | -D) <branchname>... | |
| 7fc9d69f JH |
14 | |
| 15 | DESCRIPTION | |
| 16 | ----------- | |
| 2eaf273d SE |
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. | |
| 7fc9d69f | 19 | |
| 2eaf273d SE |
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. | |
| dd181119 JL |
27 | |
| 28 | ||
| 7fc9d69f JH |
29 | OPTIONS |
| 30 | ------- | |
| d4072c97 AE |
31 | -d:: |
| 32 | Delete a branch. The branch must be fully merged. | |
| 33 | ||
| 34 | -D:: | |
| 35 | Delete a branch irrespective of its index status. | |
| 36 | ||
| 075dd8ee | 37 | -f:: |
| 2eaf273d SE |
38 | Force the creation of a new branch even if it means deleting |
| 39 | a branch that already exists with the same name. | |
| 40 | ||
| 41 | -r:: | |
| 42 | List only the "remote" branches. | |
| 075dd8ee | 43 | |
| 52a22d1e | 44 | <branchname>:: |
| d4072c97 | 45 | The name of the branch to create or delete. |
| 2b1f4247 SP |
46 | The new branch name must pass all checks defined by |
| 47 | gitlink:git-check-ref-format[1]. Some of these checks | |
| 48 | may restrict the characters allowed in a branch name. | |
| 7fc9d69f | 49 | |
| 075dd8ee | 50 | <start-point>:: |
| 2eaf273d SE |
51 | The new branch will be created with a HEAD equal to this. It may |
| 52 | be given as a branch name, a commit-id, or a tag. If this option | |
| 53 | is omitted, the current branch is assumed. | |
| 54 | ||
| 7fc9d69f | 55 | |
| 1e2ccd3a JH |
56 | |
| 57 | Examples | |
| 2eaf273d | 58 | -------- |
| 1e2ccd3a | 59 | |
| dd181119 | 60 | Start development off of a known tag:: |
| 1e2ccd3a JH |
61 | + |
| 62 | ------------ | |
| 63 | $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 | |
| 64 | $ cd my2.6 | |
| 2eaf273d | 65 | $ git branch my2.6.14 v2.6.14 <1> |
| 1e2ccd3a | 66 | $ git checkout my2.6.14 |
| 1e2ccd3a | 67 | ------------ |
| 2eaf273d SE |
68 | + |
| 69 | <1> This step and the next one could be combined into a single step with | |
| 70 | "checkout -b my2.6.14 v2.6.14". | |
| 1e2ccd3a JH |
71 | |
| 72 | Delete unneeded branch:: | |
| 73 | + | |
| 74 | ------------ | |
| 75 | $ git clone git://git.kernel.org/.../git.git my.git | |
| 76 | $ cd my.git | |
| 2eaf273d SE |
77 | $ git branch -D todo <1> |
| 78 | ------------ | |
| 79 | + | |
| 1e2ccd3a JH |
80 | <1> delete todo branch even if the "master" branch does not have all |
| 81 | commits from todo branch. | |
| 2eaf273d SE |
82 | |
| 83 | ||
| 84 | Notes | |
| 85 | ----- | |
| 86 | ||
| 87 | If you are creating a branch that you want to immediately checkout, it's | |
| 88 | easier to use the git checkout command with its `-b` option to create | |
| 89 | a branch and check it out with a single command. | |
| 90 | ||
| 1e2ccd3a | 91 | |
| 7fc9d69f JH |
92 | Author |
| 93 | ------ | |
| 94 | Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net> | |
| 95 | ||
| 96 | Documentation | |
| 97 | -------------- | |
| 98 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
| 99 | ||
| 100 | GIT | |
| 101 | --- | |
| a7154e91 | 102 | Part of the gitlink:git[7] suite |
| 7fc9d69f | 103 |