#!/bin/sh
# ------------------------------------------------------------------------------
#
# git-qfinish.sh: Implement the Git-MQ "git qfinish" extension command.
#
# Move a specified sequence of applied Git-MQ patches out of Git-MQ control,
# delete the associated patch tags, and patch files, leaving the associated
# commit objects in place; the specified patch sequence must be contiguous,
# and must extend from the base of the patch stack.
#
# $Id$
#
# ------------------------------------------------------------------------------
#
mq_facility="git qfinish"
#
# I'd have liked to call this a "SYNOPSIS", (which is what it is), but git's
# git-sh-setup script requires the much less appropriate name "OPTIONS_SPEC",
# (which describes only a small subset of its actual content).
#
OPTIONS_SPEC="\
git qfinish <patch> ... [<patch-range> [<patch>]] ...
git qfinish <patch-range> ... [<patch> [<patch-range>]] ...
git qfinish --applied

Release a specified patch, sequence of patches, or all applied
patches from Git-MQ control, leaving each as a regular commit;
any explicitly specified patches must represent a contiguous
sequence at the base of the patch series stack.
--
a,applied!   release all currently applied patches"
#
# ------------------------------------------------------------------------------
#
# $Id$
#
# Written by Keith Marshall <keith@users.osdn.me>
# Copyright (C) 2018-2020, 2022, Keith Marshall
#
#
# This file is part of the Git-MQ program suite.
#
# The Git-MQ program suite is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public Licence
# as published by the Free Software Foundation, either version 3 of
# the Licence, or (at your option) any later version.
#
# The Git-MQ program suite is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty
# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public Licence for more details.
#
# You should have received a copy of the GNU General Public Licence
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# ------------------------------------------------------------------------------
#
# Although they may not always have any effect, all Git-MQ commands, like
# their hg counterparts, are expected to accept the global verbosity, and
# colour control options; ensure that they are declared:
#
OPTIONS_SPEC="$OPTIONS_SPEC
colour?*     generic output colour control -- may have no effect"
${OPTION_VERBOSE_DEFINED-false} || OPTIONS_SPEC="$OPTIONS_SPEC
v,verbose!*  generic verbosity selector -- may have no effect"

# For Git-MQ options, such as "--colour", we prefer a spelling convention
# which conforms to "World English" standards; however, git itself adopts
# "US English" convention.  Thus, we must also accommodate users who will
# specify "--color" instead of "--colour", without creating any ambiguity
# in the possible abbreviations; to achieve this, we check for "--color",
# among the command-line arguments, replacing it with "--colour", BEFORE
# we allow git to parse them.
#
for mq_argv
do case "$mq_argv" in
     --color*) mq_argv=`echo $mq_argv | sed 's/^--colo/&u/'` ;;
     --no-color) mq_argv="--no-colour" ;;
   esac
   ${mq_argv_init-true} && { set -- "$mq_argv"; mq_argv_init=false
   } || set -- "$@" "$mq_argv"
done

# Now, we may let git parse the command line, and set up its shell script
# processing environment, for use within a git working directory tree.
#
SUBDIRECTORY_OK=true . "`git --exec-path`/git-sh-setup" && require_work_tree

libexecdir=`dirname "$0"`
test `basename "$libexecdir"` = bin && libexecdir=`dirname "$libexecdir"`
libexecdir="$libexecdir/libexec/git-mq/${VERSION=1.0}"

mq_require(){ test -f "$1" || die "fatal: '$1' not found."; . "$1"; }
mq_require "$libexecdir/git-mq-setup.sh"

# Check if the "--applied" option has been specified; ignore any of
# the standard Git-MQ options, which may have been specified on the
# command line.
#
while git_mq_getopt "$@"
do test "$1" = "-a" && mq_applied_opt=all; shift
done

# Hand off further processing to the appropriate backend script; that
# is to "git-qfinish-all" when the "--applied" option is specified, or
# to "git-qfinish-named" otherwise.
#
mq_require git-qfinish-${mq_applied_opt-named} "$@"
#
# ------------------------------------------------------------------------------
# $RCSfile$: end of file
