X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-branch.txt;h=71ecd858aad06b88cd459af15751fd2b604c3271;hb=a3cc31fb059410d6b96786045947bafc2f32ce60;hp=a7121a4c632da21a6e00f5f53d136969ac8b9804;hpb=1301c6eb412e7c5511b952a12e42c70ad56f028b;p=git.git diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index a7121a4c..71ecd858 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -3,27 +3,67 @@ git-branch(1) NAME ---- -git-branch - Create a new branch. +git-branch - Create a new branch, or remove an old one SYNOPSIS -------- -'git-branch' [ [start-point]] +[verse] +'git-branch' [[-f] []] +'git-branch' (-d | -D) DESCRIPTION ----------- If no argument is provided, show available branches and mark current branch with star. Otherwise, create a new branch of name . - If a starting point is also specified, that will be where the branch is created, otherwise it will be created at the current HEAD. +With a `-d` or `-D` option, `` will be deleted. + + OPTIONS ------- +-d:: + Delete a branch. The branch must be fully merged. + +-D:: + Delete a branch irrespective of its index status. + +-f:: + Force a reset of to (or current head). + :: - The name of the branch to create. + The name of the branch to create or delete. + +:: + Where to create the branch; defaults to HEAD. This + option has no meaning with -d and -D. + + +Examples +~~~~~~~~ + +Start development off of a known tag:: ++ +------------ +$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 +$ cd my2.6 +$ git branch my2.6.14 v2.6.14 <1> +$ git checkout my2.6.14 + +<1> These two steps are the same as "checkout -b my2.6.14 v2.6.14". +------------ + +Delete unneeded branch:: ++ +------------ +$ git clone git://git.kernel.org/.../git.git my.git +$ cd my.git +$ git branch -D todo <1> -start-point:: - Where to create the branch; defaults to HEAD. +<1> delete todo branch even if the "master" branch does not have all +commits from todo branch. +------------ Author ------