[PATCH] git-stash.txt: update synopsis, pop description
- From
Brandon Casey <casey@nrlssc.navy.mil>
- Date
- Jun 8, 2009, 16:56 UTC
- Message-ID
- <bJxDhbQFsPIm1ZUO8mSkwwlB-otpEtzhr6sRzDVsNjTkeMld-7T4NskTGr48iYOe3w8KU1kPuDA@cipher.nrlssc.navy.mil>
From: Brandon Casey <drafnel@gmail.com>
Internally, the 'pop' subcommand of git-stash calls the 'apply' subcommand. Hence, 'pop' accepts the same options as 'apply'. Make this clear by placing 'apply' and 'pop' next to each other in the synopsis, and state it explicitly in the description of 'pop'.
Signed-off-by: Brandon Casey <drafnel@gmail.com> --- Documentation/git-stash.txt | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 1cc24cc..7dda416 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'git stash' list [<options>] -'git stash' (show | drop | pop ) [<stash>] -'git stash' apply [--index] [<stash>] +'git stash' (show | drop) [<stash>] +'git stash' (apply | pop) [--index] [<stash>] 'git stash' branch <branchname> [<stash>] 'git stash' [save [--keep-index] [<message>]] 'git stash' clear @@ -80,7 +80,7 @@ pop [<stash>]:: Remove a single stashed state from the stash list and apply it on top of the current working tree state, i.e., do the inverse operation of `git stash save`. The working directory must - match the index. + match the index. `pop` accepts the same options as `apply`. + 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
-- 1.6.3.1.24.g152f4