undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: mention 'git stash pop --index' option explicitly

Browse Source 
'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>
This commit is contained in:
SZEDER Gábor 2009-06-09 00:57:06 +02:00 committed by Junio C Hamano
parent 4e2715fb98
commit f39d6ee2aa
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/git-stash.txt
View File

@ -9,8 +9,8 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git stash' list [<options>] 'git stash' list [<options>]
'git stash' (show | drop | pop ) [<stash>] 'git stash' ( show | drop ) [<stash>]
'git stash' apply [--index] [<stash>] 'git stash' ( pop | apply ) [--index] [<stash>]
'git stash' branch <branchname> [<stash>] 'git stash' branch <branchname> [<stash>]
'git stash' [save [--keep-index] [<message>]] 'git stash' [save [--keep-index] [<message>]]
'git stash' clear 'git stash' clear
@ -86,16 +86,16 @@ Applying the state can fail with conflicts; in this case, it is not
removed from the stash list. You need to resolve the conflicts by hand removed from the stash list. You need to resolve the conflicts by hand
and call `git stash drop` manually afterwards. and call `git stash drop` manually afterwards.
+ +
When no `<stash>` is given, `stash@\{0}` is assumed. See also `apply`.
apply [--index] [<stash>]::
Like `pop`, but do not remove the state from the stash list.
+
If the `--index` option is used, then tries to reinstate not only the working If the `--index` option is used, then tries to reinstate not only the working
tree's changes, but also the index's ones. However, this can fail, when you tree's changes, but also the index's ones. However, this can fail, when you
have conflicts (which are stored in the index, where you therefore can no have conflicts (which are stored in the index, where you therefore can no
longer apply the changes as they were originally). longer apply the changes as they were originally).
+
When no `<stash>` is given, `stash@\{0}` is assumed.
apply [--index] [<stash>]::
Like `pop`, but do not remove the state from the stash list.
branch <branchname> [<stash>]:: branch <branchname> [<stash>]::

4
git-stash.sh
View File

@ -3,8 +3,8 @@
dashless=$(basename "$0" | sed -e 's/-/ /') dashless=$(basename "$0" | sed -e 's/-/ /')
USAGE="list [<options>] USAGE="list [<options>]
or: $dashless (show | drop | pop ) [<stash>] or: $dashless ( show | drop ) [<stash>]
or: $dashless apply [--index] [<stash>] or: $dashless ( pop | apply ) [--index] [<stash>]
or: $dashless branch <branchname> [<stash>] or: $dashless branch <branchname> [<stash>]
or: $dashless [save [--keep-index] [<message>]] or: $dashless [save [--keep-index] [<message>]]
or: $dashless clear" or: $dashless clear"