user-manual: use pithier example commit
[gitweb.git] / Documentation / git-branch.txt
index e872fc89fc17caefc844bd5129f74040bada5cb9..8dc5171f5e685ab18d466751710f44e8aba104b7 100644 (file)
@@ -3,13 +3,14 @@ git-branch(1)
 
 NAME
 ----
-git-branch - List, create, or delete branches.
+git-branch - List, create, or delete branches
 
 SYNOPSIS
 --------
 [verse]
-'git-branch' [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]]
-'git-branch' [-l] [-f] <branchname> [<start-point>]
+'git-branch' [--color | --no-color] [-r | -a]
+          [-v [--abbrev=<length> | --no-abbrev]]
+'git-branch' [--track | --no-track] [-l] [-f] <branchname> [<start-point>]
 'git-branch' (-m | -M) [<oldbranch>] <newbranch>
 'git-branch' (-d | -D) [-r] <branchname>...
 
@@ -25,6 +26,13 @@ It will start out with a head equal to the one given as <start-point>.
 If no <start-point> is given, the branch will be created with a head
 equal to that of the currently checked out branch.
 
+When a local branch is started off a remote branch, git can setup the
+branch so that gitlink:git-pull[1] will appropriately merge from that
+remote branch.  If this behavior is desired, it is possible to make it
+the default using the global `branch.autosetupmerge` configuration
+flag.  Otherwise, it can be chosen per-branch using the `--track`
+and `--no-track` options.
+
 With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
 If <oldbranch> had a corresponding reflog, it is renamed to match
 <newbranch>, and a reflog entry is created to remember the branch
@@ -74,12 +82,15 @@ OPTIONS
        List both remote-tracking branches and local branches.
 
 -v::
-       Show sha1 and commit subjectline for each head.
+       Show sha1 and commit subject line for each head.
 
 --abbrev=<length>::
        Alter minimum display length for sha1 in output listing,
        default value is 7.
 
+--no-abbrev::
+       Display the full sha1s in output listing rather than abbreviating them.
+
 <branchname>::
        The name of the branch to create or delete.
        The new branch name must pass all checks defined by
@@ -125,7 +136,7 @@ $ git branch -D test               <2>
 +
 <1> delete remote-tracking branches "todo", "html", "man"
 <2> delete "test" branch even if the "master" branch does not have all
-commits from todo branch.
+commits from test branch.
 
 
 Notes