Skip to content

Commit

Permalink
git-checkout.txt: document "git checkout <pathspec>" better
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Torsten Bögershausen authored and Junio C Hamano committed Jun 17, 2015
1 parent f09bd21 commit c4ac525
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion Documentation/git-checkout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit c4ac525

Please sign in to comment.