提交: be7793e838712eb18693a0e742b14d765702edaa - git-mq (git)

Mercurial Queues Emulation for Git

Commit MetaInfo

• 修訂: be7793e838712eb18693a0e742b14d765702edaa (tree)
• 時間: 2019-06-17 07:39:04
• 作者: Keith Marshall <keith@user...>
• Commiter: Keith Marshall

Log Message

Avoid "--message" vs. "--file" option conflicts.

* git-qnew.shar (mq_collect_msgopt, mq_validate_option): Remove;
these are superseded by a new, reusable API module.

* mq-message-opts.sh: New file; it reimplements...
(mq_collect_msgopt): ...this message option collector API.
* git-qnew.shar git-qrefresh.shar git-qfold.shar: Use it.
* Makefile.in (install-libexec-scripts): Add it.

Change Summary

• modified: Makefile.in
• modified: git-qfold.shar
• modified: git-qnew.shar
• modified: git-qrefresh.shar
• add: mq-message-opts.sh

差異

--- a/Makefile.in
+++ b/Makefile.in
@@ -168,6 +168,7 @@ install-libexec-scripts: git-qpush-backend.sh git-qpop-backend.sh
 install-libexec-scripts: git-qfinish-named.sh git-qfinish-all.sh
 install-libexec-scripts: git-qgoto-init.sh git-rev-import.sh
 
+install-libexec-scripts: mq-message-opts.sh
 install-libexec-scripts: mq-series-index.sh mq-series-list.sh
 install-libexec-scripts: mq-series-list-colour.sh mq-select-list.awk
 install-libexec-scripts: mq-select-activate.sh mq-select-backend.sh

--- a/git-qfold.shar
+++ b/git-qfold.shar
@@ -47,7 +47,7 @@ mq_facility="git qfold"
 # (which describes only a small subset of its actual content).
 #
 OPTIONS_SPEC="\
-git qfold [-e] [-m <text>] [-l <file>] [-k] <patch> ...
+git qfold [-e] [[[-m <text>] ...] | [-F <file>]] [-k] <patch> ...
 
 Merge the content of specified unapplied patches into the current
 topmost patch; the merged patches are then removed from the series,
@@ -80,8 +80,9 @@ mq_commit_opts="--amend"
 while git_mq_getopt "$@"
   do case $1 in
        -e) mq_collect mq_commit_opts --edit ;;
-       -m) mq_msgopt=true; mq_collect mq_commit_opts "-m '$2'"; shift ;;
-       -[Fl]) mq_msgopt=true; mq_collect mq_commit_opts "-F '$2'"; shift ;;
+       -F) mq_collect_valid_msgopt --file "$2"; shift ;;
+       -l) mq_collect_valid_msgopt --logfile "$2"; shift ;;
+       -m) mq_collect_valid_msgopt --message "$2"; shift ;;
        -k) mq_remove_opt=false ;;
      esac; shift
   done
@@ -146,7 +147,10 @@ mq_tmpfile mq_errlog '`mktemp` || $fatal "cannot open error message cache"'
 # cache file in which we may assemble a cumulative message, extracted
 # from the original and folded patch headers.
 #
-${mq_msgopt-false} && mq_fold_count=count || {
+test ${mq_msgopt+set} && {
+  mq_fold_count=count
+  mq_collect mq_commit_opts "$mq_msgopt"
+} || {
   mq_tmpfile mq_msg_file '`mktemp` || $fatal "cannot open log message cache"'
   mq_collect mq_commit_opts "--file='$mq_msg_file'"
   git qheader > "$mq_msg_file"

--- a/git-qnew.shar
+++ b/git-qnew.shar
@@ -67,26 +67,18 @@ ETX
 . ./git-mq-setup.shar
 
 cat <<\ETX
-# Establish helper functions, to assist in parsing of command-specific
-# options specified on the command line; the first rejects any conflict,
-# such as "--file" vs. "--message"...
-#
-mq_validate_option() {
-  test "x$1" = "x${2-$1}" || $fatal "option '$1' conflicts with '$2'"
-}
-# ...while the second collects commit message fragments, if any, which
-# are specified with the "--message" option.
-#
-mq_collect_msgopt() {
-  mq_validate_option $1 $mq_msgopt
-  mq_msgopt=${mq_msgopt+"$mq_msgopt "}"$1 '$2'"
-}
-
 # Regardless of any options specified by the user, we must be prepared
 # to commit an empty patch.
 #
 mq_commit_opts="--allow-empty"
 
+# The commit message definition options, "--message", "--logfile", or
+# "--file", require a special validating interpreter, to ensure that no
+# invalid combination is specified; this collects any valid sequence of
+# such options into the "mq_msgopt" shell variable.
+#
+mq_require mq-message-opts
+
 # Process any options which the user may have specified on the command
 # line; shift them out of the way, leaving only non-option arguments.
 #
@@ -94,8 +86,9 @@ while git_mq_getopt "$@"
   do case $1 in
        -e) mq_collect mq_commit_opts "--edit" ;;
        -a) mq_commit_all=true; mq_collect mq_commit_opts --all ;;
-       -[Fl]) mq_collect_msgopt --file "$2"; shift ;;
-       -m) mq_collect_msgopt --message "$2"; shift ;;
+       -F) mq_collect_valid_msgopt --file "$2"; shift ;;
+       -l) mq_collect_valid_msgopt --logfile "$2"; shift ;;
+       -m) mq_collect_valid_msgopt --message "$2"; shift ;;
        -d) mq_commit_date="--date='$2'"; shift ;;
        -D) mq_commit_date="--date='`date '+%s %z'`'" ;;
        -u) mq_commit_user="--author='$2'"; shift ;;
@@ -226,7 +219,7 @@ test $# -gt 0 && {
 # commit options set; if no log message specified, substitute a
 # suitable default.
 #
-test ${mq_msgopt+set} && mq_commit_opts="$mq_commit_opts $mq_msgopt" ||
+test ${mq_msgopt+set} && mq_collect mq_commit_opts "$mq_msgopt" ||
   mq_collect mq_commit_opts "--message '[Git-MQ]: $mq_patchname'"
 
 # Delegate the commit, and subsequent patch generation, to the patch

--- a/git-qrefresh.shar
+++ b/git-qrefresh.shar
@@ -46,7 +46,7 @@ mq_facility="git qrefresh"
 # (which describes only a small subset of its actual content).
 #
 OPTIONS_SPEC="\
-git qrefresh [-e] [-m <text>] [-F <file>] [-s] [-a | <path> ...]
+git qrefresh [-e] [[[-m <text>] ...] | [-F <file>]] [-s] [-a | <path> ...]
 
 Update the current topmost patch, to incorporate staged changes, and
 optionally unstaged working tree changes, to tracked and/or specified
@@ -76,6 +76,13 @@ cat <<\ETX
 #
 mq_commit_opts="--amend"
 
+# The commit message definition options, "--message", "--logfile", or
+# "--file", require a special validating interpreter, to ensure that no
+# invalid combination is specified; this collects any valid sequence of
+# such options into the "mq_msgopt" shell variable.
+#
+mq_require mq-message-opts
+
 # Collect any other options, which have been specified on the command
 # line, into the "mq_commit_opts" shell variable, so that we may pass
 # them on to the "git commit" command.
@@ -84,8 +91,9 @@ while git_mq_getopt "$@"
   do case $1 in
        -e) mq_collect mq_commit_opts --edit ;;
        -a) mq_refresh_all=true; mq_collect mq_commit_opts --all ;;
-       -m) mq_msgopt=true; mq_collect mq_commit_opts "-m '$2'"; shift ;;
-       -[Fl]) mq_msgopt=true; mq_collect mq_commit_opts "-F '$2'"; shift ;;
+       -F) mq_collect_valid_msgopt --file "$2"; shift ;;
+       -l) mq_collect_valid_msgopt --logfile "$2"; shift ;;
+       -m) mq_collect_valid_msgopt --message "$2"; shift ;;
        -U) mq_commit_user="--reset-author" ;;
        -u) mq_commit_user="--author='$2'"; shift ;;
        -D) mq_commit_date="--date='`date '+%s %z'`'" ;;
@@ -110,7 +118,8 @@ mq_patchfile="$mq_patchdir/$mq_patchname"
 # if none was given via a command line option, then arrange to reuse
 # whatever message was provided for the original patch.
 #
-${mq_msgopt-false} || mq_collect mq_commit_opts "-C qtip"
+test ${mq_msgopt+set} && mq_collect mq_commit_opts "$mq_msgopt" ||
+  mq_collect mq_commit_opts "-C qtip"
 
 # We prefer to capture the updated patch into a temporary file,
 # before finally updating the actual patch.

--- /dev/null
+++ b/mq-message-opts.sh
@@ -0,0 +1,57 @@
+# mq-message-opts.sh
+# ------------------------------------------------------------------------------
+#
+# Supplementary shell script fragment; it implements helper functions to
+# collect and validate the commit log message options, which may be passed
+# to the handlers for the "qnew", "qrefresh", and "qfold" subcommands.
+#
+# ------------------------------------------------------------------------------
+#
+# $Id$
+#
+# Written by Keith Marshall <[e-mail]>
+# Copyright (C) 2019, MinGW.org Project
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ------------------------------------------------------------------------------
+#
+# Recognizing that neither Mercurial nor Git allow the combination of the
+# "--message" option with the "--logfile" option (in Mercurial's case), or
+# the "--file" option (in Git's case); we provide the following helper to
+# trap any violation of this constraint, and abort the command early.
+#
+  mq_reject_opt_conflict() {
+    local reason_for_rejection="fatal: cannot combine options '$1' and '$2'"
+    test "x$3" = "x${4-$3}" || mq_abort 2 "$reason_for_rejection"
+  }
+# Now, we may implement the primary API entry for this module; we accept
+# "--file" and "--logfile" options as aliases, and map both to the former,
+# while collecting it, or any other option without modification, together
+# with a mandatory argument, into the "mq_msgopt" shell variable.
+#
+  mq_collect_valid_msgopt() {
+    local collect_option="--file"
+    test "x$1" = "x--logfile" || collect_option="$1"
+    mq_reject_opt_conflict "${mq_msgsrc=$1}" "$1" "$collect_option" $mq_msgopt
+    mq_collect mq_msgopt "$collect_option '$2'"
+  }
+#
+# ------------------------------------------------------------------------------
+# $RCSfile$: end of file