diff options
| author | SZEDER Gábor <szeder@ira.uka.de> | 2009-06-09 00:57:06 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-06-09 00:18:24 -0700 |
| commit | f39d6ee2aad735641dce90f7e021e6b6862963c6 (patch) | |
| tree | 32083082c7c8ae2c890294924ea2a9055e8c6bce /git-stash.sh | |
| parent | 4e2715fb9878235cb696f765695eef38078b0b7a (diff) | |
| download | git-f39d6ee2aad735641dce90f7e021e6b6862963c6.tar.gz | |
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>
Diffstat (limited to 'git-stash.sh')
| -rwxr-xr-x | git-stash.sh | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/git-stash.sh b/git-stash.sh index b9ace99704..e6a5867209 100755 --- a/git-stash.sh +++ b/git-stash.sh @@ -3,8 +3,8 @@ dashless=$(basename "$0" | sed -e 's/-/ /') USAGE="list [<options>] - or: $dashless (show | drop | pop ) [<stash>] - or: $dashless apply [--index] [<stash>] + or: $dashless ( show | drop ) [<stash>] + or: $dashless ( pop | apply ) [--index] [<stash>] or: $dashless branch <branchname> [<stash>] or: $dashless [save [--keep-index] [<message>]] or: $dashless clear" |