diff options
| author | Matthieu Moy <Matthieu.Moy@imag.fr> | 2009-08-18 23:38:40 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-09-01 22:03:11 -0700 |
| commit | 3c2eb80fe3f3c7efbb25e929df9f70d7c896a5ef (patch) | |
| tree | d530750f12ec624139b62d7bff3370877da3c7f5 /Documentation/git-stash.txt | |
| parent | 14c674e9dc52c4b93512b22748c01ca6ccdef7bd (diff) | |
| download | git-3c2eb80fe3f3c7efbb25e929df9f70d7c896a5ef.tar.gz | |
stash: simplify defaulting to "save" and reject unknown options
With the earlier DWIM patches, certain combination of options defaulted
to the "save" command correctly while certain equally valid combination
did not. For example, "git stash -k" were Ok but "git stash -q -k" did
not work.
This makes the logic of defaulting to "save" much simpler. If there are no
non-flag arguments, it is clear that there is no command word, and we
default to "save" subcommand. This rule prevents "git stash -q apply"
from quietly creating a stash with "apply" as the message.
This also teaches "git stash save" to reject an unknown option. This is
to keep a mistyped "git stash save --quite" from creating a stash with a
message "--quite", and this safety is more important with the new logic
to default to "save" with any option-looking argument without an explicit
comand word.
[jc: this is based on Matthieu's 3-patch series, and a follow-up
discussion, and he and Peff take all the credit; if I have introduced bugs
while reworking, they are mine.]
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-stash.txt')
| -rw-r--r-- | Documentation/git-stash.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 1c4ed412a1..30a249cbc5 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -14,7 +14,6 @@ SYNOPSIS 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>] 'git stash' branch <branchname> [<stash>] 'git stash' [save [--patch] [-k|--[no-]keep-index] [-q|--quiet] [<message>]] -'git stash' [-p|--patch|-k|--keep-index] 'git stash' clear 'git stash' create @@ -46,9 +45,11 @@ OPTIONS save [--patch] [--[no-]keep-index] [-q|--quiet] [<message>]:: Save your local modifications to a new 'stash', and run `git reset - --hard` to revert them. This is the default action when no - subcommand is given. The <message> part is optional and gives - the description along with the stashed state. + --hard` to revert them. The <message> part is optional and gives + the description along with the stashed state. For quickly making + a snapshot, you can omit _both_ "save" and <message>, but giving + only <message> does not trigger this action to prevent a misspelled + subcommand from making an unwanted stash. + If the `--keep-index` option is used, all changes already added to the index are left intact. |