From d6cc2df5c80dc4f52a56679baa5e32539eb028b1 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Wed, 20 May 2015 14:01:32 -0400 Subject: stash: complain about unknown flags The option parser for git-stash stuffs unknown flags into the $FLAGS variable, where they can be accessed by the individual commands. However, most commands do not even look at these extra flags, leading to unexpected results like this: $ git stash drop --help Dropped refs/stash@{0} (e6cf6d80faf92bb7828f7b60c47fc61c03bd30a1) We should notice the extra flags and bail. Rather than annotate each command to reject a non-empty $FLAGS variable, we can notice that "stash show" is the only command that actually _wants_ arbitrary flags. So we switch the default mode to reject unknown flags, and let stash_show() opt into the feature. Reported-by: Vincent Legoll Signed-off-by: Jeff King Signed-off-by: Junio C Hamano diff --git a/git-stash.sh b/git-stash.sh index d4cf818..f540127 100755 --- a/git-stash.sh +++ b/git-stash.sh @@ -301,6 +301,7 @@ list_stash () { } show_stash () { + ALLOW_UNKNOWN_FLAGS=t assert_stash_like "$@" git diff ${FLAGS:---stat} $b_commit $w_commit @@ -332,13 +333,14 @@ show_stash () { # # GIT_QUIET is set to t if -q is specified # INDEX_OPTION is set to --index if --index is specified. -# FLAGS is set to the remaining flags +# FLAGS is set to the remaining flags (if allowed) # # dies if: # * too many revisions specified # * no revision is specified and there is no stash stack # * a revision is specified which cannot be resolve to a SHA1 # * a non-existent stash reference is specified +# * unknown flags were set and ALLOW_UNKNOWN_FLAGS is not "t" # parse_flags_and_rev() @@ -372,6 +374,8 @@ parse_flags_and_rev() INDEX_OPTION=--index ;; -*) + test "$ALLOW_UNKNOWN_FLAGS" = t || + die "$(eval_gettext "unknown option: \$opt")" FLAGS="${FLAGS}${FLAGS:+ }$opt" ;; esac diff --git a/t/t3903-stash.sh b/t/t3903-stash.sh index 1e29962..3846789 100755 --- a/t/t3903-stash.sh +++ b/t/t3903-stash.sh @@ -93,6 +93,10 @@ test_expect_success 'unstashing in a subdirectory' ' ) ' +test_expect_success 'stash drop complains of extra options' ' + test_must_fail git stash drop --foo +' + test_expect_success 'drop top stash' ' git reset --hard && git stash list > stashlist1 && -- cgit v0.10.2-6-g49f6 From 5ba28313f29bcc2e8571c4b325646fecfbe238df Mon Sep 17 00:00:00 2001 From: Jeff King Date: Wed, 20 May 2015 14:17:46 -0400 Subject: stash: recognize "--help" for subcommands If you run "git stash --help", you get the help for stash (this magic is done by the git wrapper itself). But if you run "git stash drop --help", you get an error. We cannot show help specific to "stash drop", of course, but we can at least give the user the normal stash manpage. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano diff --git a/git-stash.sh b/git-stash.sh index f540127..23bd1d3 100755 --- a/git-stash.sh +++ b/git-stash.sh @@ -219,6 +219,9 @@ save_stash () { -a|--all) untracked=all ;; + --help) + show_help + ;; --) shift break @@ -307,6 +310,11 @@ show_stash () { git diff ${FLAGS:---stat} $b_commit $w_commit } +show_help () { + exec git help stash + exit 1 +} + # # Parses the remaining options looking for flags and # at most one revision defaulting to ${ref_stash}@{0} @@ -373,6 +381,9 @@ parse_flags_and_rev() --index) INDEX_OPTION=--index ;; + --help) + show_help + ;; -*) test "$ALLOW_UNKNOWN_FLAGS" = t || die "$(eval_gettext "unknown option: \$opt")" -- cgit v0.10.2-6-g49f6