PATCH] Documentation: Tweak use case in "git stash save --keep-index"
- From
- Eric Raible <raible@gmail.com>
- Date
- Jul 8, 2008, 05:18 UTC
- Message-ID
- <279b37b20807072218o19dabd97y2c4edc62fb980ca4@mail.gmail.com>
The documentation suggests using "git stash apply" in the --keep-index workflow even though doing so will lead to clutter in the stash. And given that the changes are about to be committed anyway "git stash pop" is more sensible.
Additionally the text preceeding the example claims that it works for "two or more commits", but the example itself is really tailored for just two. Expanding it just a little makes it clear how the procedure generalizes to N commits.
Signed-off-by: Eric Raible <raible@gmail.com> --- Note that this is relative to Junio's pu branch (v1.5.6.2-397-g20210bb)
Documentation/git-stash.txt | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index df26901..bf241da 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -201,9 +201,10 @@ $ git add --patch foo $ git stash save --keep-index $ build && run tests $ git commit -m 'First part' -$ git stash apply +$ git stash pop +... repeat above five steps until one commit remains ... $ build && run tests -$ git commit -a -m 'Second part' +$ git commit foo -m 'Remaining parts' ---------------------------------------------------------------- SEE ALSO
-- 1.5.6.1.1073.g489ff.dirty