Documentation: mention 'git stash pop --index' option explicitly
authorSZEDER Gábor <szeder@ira.uka.de>
Mon, 8 Jun 2009 22:57:06 +0000 (00:57 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 9 Jun 2009 07:18:24 +0000 (00:18 -0700)
commitf39d6ee2aad735641dce90f7e021e6b6862963c6
tree32083082c7c8ae2c890294924ea2a9055e8c6bce
parent4e2715fb9878235cb696f765695eef38078b0b7a
Documentation: mention 'git stash pop --index' option explicitly

'git stash pop' supports the '--index' option since its initial
implementation (bd56ff54, git-stash: add new 'pop' subcommand,
2008-02-22), but its documentation does not mention it explicitly.
Moreover, both the usage shown by 'git stash -h' and the synopsis
section in the man page imply that 'git stash pop' does not have an
'--index' option.

First, this patch corrects the usage and the synopsis section.

Second, the patch moves the description of the '--index' option to the
'git stash pop' section in the documentation, and refers to it from
the 'git stash apply' section.  This way it follows the intentions of
commit d1836637 (Documentation: teach stash/pop workflow instead of
stash/apply, 2009-05-28), as all 'git stash pop'-related documentation
will be in one place without references to 'git stash apply'.

Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-stash.txt
git-stash.sh