Merge branch 'pb/prepare-commit-msg'
[gitweb.git] / Documentation / git-checkout.txt
index 4f2e847dc3fe44f503a578fc79496179c21ac11a..b4cfa044bbb969add6f434070a8666fc0c325d15 100644 (file)
@@ -8,7 +8,7 @@ git-checkout - Checkout and switch to a branch
 SYNOPSIS
 --------
 [verse]
-'git-checkout' [-q] [-f] [-b [--track | --no-track] <new_branch> [-l]] [-m] [<branch>]
+'git-checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>]
 'git-checkout' [<tree-ish>] <paths>...
 
 DESCRIPTION
@@ -35,7 +35,7 @@ working tree.
 OPTIONS
 -------
 -q::
-       Quiet, supress feedback messages.
+       Quiet, suppress feedback messages.
 
 -f::
        Proceed even if the index or the working tree differs
@@ -44,16 +44,19 @@ OPTIONS
 -b::
        Create a new branch named <new_branch> and start it at
        <branch>.  The new branch name must pass all checks defined
-       by gitlink:git-check-ref-format[1].  Some of these checks
+       by linkgit:git-check-ref-format[1].  Some of these checks
        may restrict the characters allowed in a branch name.
 
 --track::
        When -b is given and a branch is created off a remote branch,
        set up configuration so that git-pull will automatically
-       retrieve data from the remote branch.  Set the
-       branch.autosetupmerge configuration variable to true if you
+       retrieve data from the remote branch.  Use this if you always
+       pull from the same remote branch into the new branch, or if you
+       don't want to use "git pull <repository> <refspec>" explicitly.
+       This behavior is the default.  Set the
+       branch.autosetupmerge configuration variable to false if you
        want git-checkout and git-branch to always behave as if
-       '--track' were given.
+       '--no-track' were given.
 
 --no-track::
        When -b is given and a branch is created off a remote branch,
@@ -62,9 +65,9 @@ OPTIONS
        configuration variable.
 
 -l::
-       Create the new branch's ref log.  This activates recording of
-       all changes to made the branch ref, enabling use of date
-       based sha1 expressions such as "<branchname>@{yesterday}".
+       Create the new branch's reflog.  This activates recording of
+       all changes made to the branch ref, enabling use of date
+       based sha1 expressions such as "<branchname>@\{yesterday}".
 
 -m::
        If you have local modifications to one or more files that
@@ -214,5 +217,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[7] suite