Merge branch 'maint'

[git.git] / Documentation / git-checkout.txt

diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index e4ffde4fdd78f4fe476951c9eeabebf143647eb3..ea26da8e21030883e3655dcbc28ad06a4e3816f5 100644 (file)
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -8,7 +8,7 @@ git-checkout - Checkout and switch to a branch
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-checkout' [-q] [-f] [-b <new_branch> [-l]] [-m] [<branch>]
+'git-checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>]

 'git-checkout' [<tree-ish>] <paths>...
 
 DESCRIPTION
 'git-checkout' [<tree-ish>] <paths>...
 
 DESCRIPTION


@@ -18,13 +18,14 @@ When <paths> are not given, this command switches branches by
 updating the index and working tree to reflect the specified
 branch, <branch>, and updating HEAD to be <branch> or, if
 specified, <new_branch>.  Using -b will cause <new_branch> to
 updating the index and working tree to reflect the specified
 branch, <branch>, and updating HEAD to be <branch> or, if
 specified, <new_branch>.  Using -b will cause <new_branch> to

-be created.
+be created; in this case you can use the --track or --no-track
+options, which will be passed to `git branch`.

 
 When <paths> are given, this command does *not* switch
 branches.  It updates the named paths in the working tree from
 
 When <paths> are given, this command does *not* switch
 branches.  It updates the named paths in the working tree from

-the index file (i.e. it runs `git-checkout-index -f -u`), or a
-named commit.  In
-this case, `-f` and `-b` options are meaningless and giving
+the index file (i.e. it runs `git-checkout-index -f -u`), or
+from a named commit.  In
+this case, the `-f` and `-b` options are meaningless and giving

 either of them results in an error.  <tree-ish> argument can be
 used to specify a specific tree-ish (i.e. commit, tag or tree)
 to update the index for the given paths before updating the
 either of them results in an error.  <tree-ish> argument can be
 used to specify a specific tree-ish (i.e. commit, tag or tree)
 to update the index for the given paths before updating the


@@ -37,7 +38,8 @@ OPTIONS
        Quiet, supress feedback messages.
 
 -f::
        Quiet, supress feedback messages.
 
 -f::

-       Force a re-read of everything.
+       Proceed even if the index or the working tree differs
+       from HEAD.  This is used to throw away local changes.

 
 -b::
        Create a new branch named <new_branch> and start it at
 
 -b::
        Create a new branch named <new_branch> and start it at


@@ -45,6 +47,20 @@ OPTIONS
        by gitlink:git-check-ref-format[1].  Some of these checks
        may restrict the characters allowed in a branch name.
 
        by gitlink: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
+       want git-checkout and git-branch to always behave as if
+       '--track' were given.
+
+--no-track::
+       When -b is given and a branch is created off a remote branch,
+       set up configuration so that git-pull will not retrieve data
+       from the remote branch, ignoring the branch.autosetupmerge
+       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
 -l::
        Create the new branch's ref log.  This activates recording of
        all changes to made the branch ref, enabling use of date


@@ -61,7 +77,8 @@ OPTIONS
 +
 When a merge conflict happens, the index entries for conflicting
 paths are left unmerged, and you need to resolve the conflicts
 +
 When a merge conflict happens, the index entries for conflicting
 paths are left unmerged, and you need to resolve the conflicts

-and mark the resolved paths with `git update-index`.
+and mark the resolved paths with `git add` (or `git rm` if the merge
+should result in deletion of the path).

 
 <new_branch>::
        Name for the new branch.
 
 <new_branch>::
        Name for the new branch.


@@ -179,11 +196,11 @@ fatal: merge program failed
 At this point, `git diff` shows the changes cleanly merged as in
 the previous example, as well as the changes in the conflicted
 files.  Edit and resolve the conflict and mark it resolved with
 At this point, `git diff` shows the changes cleanly merged as in
 the previous example, as well as the changes in the conflicted
 files.  Edit and resolve the conflict and mark it resolved with

-`git update-index` as usual:
+`git add` as usual:

 +
 ------------
 $ edit frotz
 +
 ------------
 $ edit frotz

-$ git update-index frotz
+$ git add frotz

 ------------
 
 
 ------------
 
 


@@ -198,4 +215,3 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 GIT
 ---
 Part of the gitlink:git[7] suite
 GIT
 ---
 Part of the gitlink:git[7] suite

-