Documentation: tweak use case in "git stash save --keep-index"
authorEric Raible <raible@gmail.com>
Tue, 8 Jul 2008 07:40:56 +0000 (00:40 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 8 Jul 2008 20:59:08 +0000 (13:59 -0700)
commitcaf1899699b2255111a3db335553e31f3718c1c9
treecb34743507a334a887fcf30f99e373a7abb46654
parent7bedebcaad351108a8f6eab6a031f2be2c06b613
Documentation: tweak use case in "git stash save --keep-index"

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.

Finally the example is annotated with some commentary to
explain things on a line-by-line basis.
Documentation/git-stash.txt