Skip to content

Commit

Permalink
stash: complain about unknown flags
Browse files Browse the repository at this point in the history
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 <vincent.legoll@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jeff King authored and Junio C Hamano committed May 20, 2015
1 parent fdf96a2 commit d6cc2df
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion git-stash.sh
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ list_stash () {
}

show_stash () {
ALLOW_UNKNOWN_FLAGS=t
assert_stash_like "$@"

git diff ${FLAGS:---stat} $b_commit $w_commit
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions t/t3903-stash.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 &&
Expand Down

0 comments on commit d6cc2df

Please sign in to comment.