[PATCH v2] git-checkout.txt: Document "git checkout <pathspec>" better
DORMANTno replies
From: Torsten Bögershausen <hidden>
Date: 2016-06-15 23:05:20
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
git checkout <pathspec> can be used to reset changes in the working tree. Signed-off-by: Torsten Bögershausen <redacted> --- Version 2: Try to summarize the suggestions from the mailing list Documentation/git-checkout.txt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index d263a56..39ad36f 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt@@ -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 changes SYNOPSIS --------
@@ -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.
--
2.2.0.rc1.790.ge19fcd2