[PATCH] doc: emphasize stash "--keep-index" stashes staged content
- From
Robert P. J. Day <rpjday@crashcourse.ca>
- Date
- Oct 11, 2017, 08:46 UTC
- Message-ID
- <alpine.LFD.2.21.1710110443360.11205@localhost.localdomain>
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 abundantly clear.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
---
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 00f95fee1..037144037 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -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 pathspec intact. + -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
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================