Re: [PATCH 1/2] Documentation: mention 'git stash pop --index' option explicitly

[Brandon Casey <casey@nrlssc.navy.mil>]

Sorry, I didn't read this first patch of yours before I submitted my
own patch to do basically the same thing.  I wasn't trying to trump
you.

-brandon


SZEDER Gábor wrote:
> '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 any
> options besides the stash to pop.
> 
> First, this patch corrects the usage and the synopsis section by listing
> the '--index' option for the 'pop' subcommand explicitly.
> 
> 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>
> ---
>  Documentation/git-stash.txt |   15 ++++++++-------
>  git-stash.sh                |    3 ++-
>  2 files changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index 1cc24cc..de90550 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -9,7 +9,8 @@ SYNOPSIS
>  --------
>  [verse]
>  'git stash' list [<options>]
> -'git stash' (show | drop | pop ) [<stash>]
> +'git stash' (show | drop ) [<stash>]
> +'git stash' pop [--index] [<stash>]
>  'git stash' apply [--index] [<stash>]
>  'git stash' branch <branchname> [<stash>]
>  'git stash' [save [--keep-index] [<message>]]
> @@ -86,16 +87,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
>  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
>  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
>  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>]::
>  
> diff --git a/git-stash.sh b/git-stash.sh
> index b9ace99..94f1d3a 100755
> --- a/git-stash.sh
> +++ b/git-stash.sh
> @@ -3,7 +3,8 @@
>  
>  dashless=$(basename "$0" | sed -e 's/-/ /')
>  USAGE="list [<options>]
> -   or: $dashless (show | drop | pop ) [<stash>]
> +   or: $dashless (show | drop ) [<stash>]
> +   or: $dashless pop [--index] [<stash>]
>     or: $dashless apply [--index] [<stash>]
>     or: $dashless branch <branchname> [<stash>]
>     or: $dashless [save [--keep-index] [<message>]]