[PATCH] doc: emphasize stash "--keep-index" stashes staged content
- Date: Wed, 11 Oct 2017 04:46:30 -0400 (EDT)
- From: "Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx>
- Subject: [PATCH] doc: emphasize stash "--keep-index" stashes staged content
It's not immediately obvious from the man page that the "--keep-index"
option still adds the staged content to the stash, so make that
Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 00f95fee1..037144037 100644
@@ -68,8 +68,8 @@ entries and working tree files are then rolled back to the state in
HEAD only for these files, too, leaving files that do not match the
-If the `--keep-index` option is used, all changes already added to the
-index are left intact.
+If the `--keep-index` option is used, all changes already staged in the
+index are left intact in the index, while still being added to the stash.
If the `--include-untracked` option is used, all untracked files are also
stashed and then cleaned up with `git clean`, leaving the working directory
Robert P. J. Day Ottawa, Ontario, CANADA