Browse Source

git-checkout.txt: document "git checkout <pathspec>" better

git checkout <pathspec> can be used to reset changes in the working tree.

Signed-off-by: Torsten Bögershausen <tboegi@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Torsten Bögershausen 10 years ago committed by Junio C Hamano
parent
commit
c4ac525c84
  1. 6
      Documentation/git-checkout.txt

6
Documentation/git-checkout.txt

@ -3,7 +3,7 @@ git-checkout(1) @@ -3,7 +3,7 @@ git-checkout(1)

NAME
----
git-checkout - Checkout a branch or paths to the working tree
git-checkout - Switch branches or restore working tree files

SYNOPSIS
--------
@ -89,6 +89,10 @@ Omitting <branch> detaches HEAD at the tip of the current branch. @@ -89,6 +89,10 @@ Omitting <branch> detaches HEAD at the tip of the current branch.
(i.e. commit, tag or tree) to update the index for the given
paths before updating the working tree.
+
'git checkout' with <paths> or `--patch` is used to restore modified or
deleted paths to their original contents from the index or replace paths
with the contents from a named <tree-ish> (most often a commit-ish).
+
The index may contain unmerged entries because of a previous failed merge.
By default, if you try to check out such an entry from the index, the
checkout operation will fail and nothing will be checked out.

Loading…
Cancel
Save