From: Miklos Vajna <vmiklos@frugalware.org>
Date: Sun, 30 Sep 2007 22:30:27 +0000 (+0200)
Subject: git stash: document apply's --index switch
X-Git-Tag: v1.5.3.4~16
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=0bdcac5666170547dc7882cc1d39b0481206074b;p=git.git

git stash: document apply's --index switch

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 05f40cff6..5723bb06f 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -63,7 +63,7 @@ show [<stash>]::
 	it will accept any format known to `git-diff` (e.g., `git-stash show
 	-p stash@\{1}` to view the second most recent stash in patch form).
 
-apply [<stash>]::
+apply [--index] [<stash>]::
 
 	Restore the changes recorded in the stash on top of the current
 	working tree state.  When no `<stash>` is given, applies the latest
@@ -71,6 +71,11 @@ apply [<stash>]::
 +
 This operation can fail with conflicts; you need to resolve them
 by hand in the working tree.
++
+If the `--index` option is used, then tries to reinstate not only the working
+tree's changes, but also the index's ones. However, this can fail, when you
+have conflicts (which are stored in the index, where you therefore can no
+longer apply the changes as they were originally).
 
 clear::
 	Remove all the stashed states. Note that those states will then