Rename empty to excise/excised

Author: matejak

bin/argbash

@@ -17,7 +17,7 @@
 # ARG_OPTIONAL_REPEATED([search],[I],[Directories to search for the wrapped scripts (directory of the template will be added to the end of the list)],["."])
 # ARG_OPTIONAL_SINGLE([debug],[],[(developer option) Tell autom4te to trace a macro])
 # ARG_TYPE_GROUP_SET([content],[content],[strip],[none,user-content,all])
-# ARG_TYPE_GROUP_SET([type],[type],[type],[bash-script,posix-script,manpage,manpage-defs,completion,docopt,empty])
+# ARG_TYPE_GROUP_SET([type],[type],[type],[bash-script,posix-script,manpage,manpage-defs,completion,docopt,excised])
 # ARG_DEFAULTS_POS([])
 # ARG_HELP([Argbash is an argument parser generator for Bash.])
 # ARG_VERSION_AUTO([_ARGBASH_VERSION])
@@ -52,12 +52,12 @@ content()
 
 type()
 {
-	local _allowed=("bash-script" "posix-script" "manpage" "manpage-defs" "completion" "docopt" "empty") _seeking="$1"
+	local _allowed=("bash-script" "posix-script" "manpage" "manpage-defs" "completion" "docopt" "excised") _seeking="$1"
 	for element in "${_allowed[@]}"
 	do
 		test "$element" = "$_seeking" && echo "$element" && return 0
 	done
-	die "Value '$_seeking' (of argument '$2') doesn't match the list of allowed values: 'bash-script', 'posix-script', 'manpage', 'manpage-defs', 'completion', 'docopt' and 'empty'" 4
+	die "Value '$_seeking' (of argument '$2') doesn't match the list of allowed values: 'bash-script', 'posix-script', 'manpage', 'manpage-defs', 'completion', 'docopt' and 'excised'" 4
 }
 
 
@@ -90,7 +90,7 @@ print_help()
 	printf '\t%s\n' "<input>: The input template file (pass '-' for stdin)"
 	printf '\t%s\n' "-o, --output: Name of the output file (pass '-' for stdout) (default: '-')"
 	printf '\t%s\n' "-i, --in-place, --no-in-place: Update a bash script in-place (off by default)"
-	printf '\t%s\n' "-t, --type: Output type to generate. Can be one of: 'bash-script', 'posix-script', 'manpage', 'manpage-defs', 'completion', 'docopt' and 'empty' (default: 'bash-script')"
+	printf '\t%s\n' "-t, --type: Output type to generate. Can be one of: 'bash-script', 'posix-script', 'manpage', 'manpage-defs', 'completion', 'docopt' and 'excised' (default: 'bash-script')"
 	printf '\t%s\n' "--library, --no-library: Whether the input file if the pure parsing library (off by default)"
 	printf '\t%s\n' "--strip: Determines what to have in the output. Can be one of: 'none', 'user-content' and 'all' (default: 'none')"
 	printf '\t%s\n' "--check-typos, --no-check-typos: Whether to check for possible argbash macro typos (on by default)"

doc/usage.rst

@@ -248,7 +248,7 @@ Bash completion                 completion                      all
 docopt help message             docopt                          all
 manpage template                manpage                         all
 manpage template definitions    manpage-defs                    all
-No generated code               empty                           all
+No generated code               excised                         all
 ============================    =======================         ==========================
 
 
@@ -353,13 +353,14 @@ So given a argbash-powered script or m4 file, your manpage workflow will typical
   $ man ./my-script.1
 
 
-.. _empty_output:
+.. _excise_output:
 
-Empty output
-++++++++++++
+Output without generated code
++++++++++++++++++++++++++++++
 
 Argbash can also generte output that doesn't contain parsing code --- only user code and the Argbash template.
-There are following examples when the empty output makes sense when dealing with Argbash-powered scripts:
+If the input contained parsing code, that one gets *excised*.
+There are following examples when the excised output makes sense when dealing with Argbash-powered scripts:
 
 - Space saving for e.g. copy-pasting:
   Don't involve generated code earlier than you need to, as it does make the script larger, and that can be an annoyance.

resources/Makefile

@@ -19,7 +19,7 @@ M4_SRC += \
 	../src/output-bash-script.m4 \
 	../src/output-completion.m4 \
 	../src/output-docopt.m4 \
-	../src/output-empty.m4 \
+	../src/output-excised.m4 \
 	../src/output-manpage.m4 \
 	../src/output-manpage-defs.m4 \
 	../src/output-posix-script.m4 \

src/argbash.m4

@@ -17,7 +17,7 @@
 # ARG_OPTIONAL_REPEATED([search], I, [Directories to search for the wrapped scripts (directory of the template will be added to the end of the list)], ["."])
 # ARG_OPTIONAL_SINGLE([debug],, [(developer option) Tell autom4te to trace a macro])
 # ARG_TYPE_GROUP_SET([content], [content], [strip], [none,user-content,all])
-# ARG_TYPE_GROUP_SET([type], [type], [type], [bash-script,posix-script,manpage,manpage-defs,completion,docopt,empty])
+# ARG_TYPE_GROUP_SET([type], [type], [type], [bash-script,posix-script,manpage,manpage-defs,completion,docopt,excised])
 # ARG_DEFAULTS_POS()
 # ARG_HELP([Argbash is an argument parser generator for Bash.])
 # ARG_VERSION_AUTO([_ARGBASH_VERSION])

src/output-empty.m4 renamed to src/output-excised.m4

@@ -15,8 +15,8 @@ ARGBASH_INIT_EXEC ?= $(ARGBASH_INIT)
 	$(word 2,$^) --type posix-script -o $@ $<
 	sed -i "s|#!/bin/bash|#!$(shell which dash)|" $@
 
-%-empty.m4: %.sh $(ARGBASH_BIN)
-	$(word 2,$^) --type empty -o $@ $<
+%-excised.m4: %.sh $(ARGBASH_BIN)
+	$(word 2,$^) --type excised -o $@ $<
 
 %.sh: %.m4 $(ARGBASH_BIN)
 	$(word 2,$^) $< -o $@
@@ -120,7 +120,7 @@ TESTS += \
 
 
 TESTS += \
-	test-ls_like-empty \
+	test-ls_like-excised \
 	$(NUL)
 
 
@@ -189,7 +189,7 @@ SCRIPTS += \
 	$(TESTDIR)/test-getopt-equals.sh \
 	$(TESTDIR)/basic.txt \
 	$(TESTDIR)/test-onlyopt.txt \
-	$(TESTDIR)/test-ls_like-empty.m4 \
+	$(TESTDIR)/test-ls_like-excised.m4 \
 	$(NUL)
 
 ifneq "$(shell which dash 2> /dev/null)" ""
@@ -598,7 +598,7 @@ test-onlyopt-docopt: $(TESTDIR)/test-onlyopt.txt
 	grep -q "\[--opt-repeated OPT-REPEATED\]\.\.\." $<
 	grep -q "\[--incrx\]\.\.\." $<
 
-test-ls_like-empty: $(TESTDIR)/test-ls_like-empty.m4
+test-ls_like-excised: $(TESTDIR)/test-ls_like-excised.m4
 	diff -q $(TESTDIR)/test-ls_like.m4 $<
 
 test-delim-space: $(TESTDIR)/test-delim-space.sh

tests/regressiontests/Makefile

@@ -11,7 +11,7 @@ m4_define([include_test], [m4_do(
 
 m4_include([tests/tests-base.m4])
 m4_include([tests/tests-docopt.m4])
-m4_include([tests/tests-empty.m4])
+m4_include([tests/tests-excise.m4])
 m4_include([tests/tests-delimiters.m4])
 m4_include([tests/tests-init.m4])
 m4_include([tests/tests-env.m4])
@@ -37,8 +37,8 @@ ARGBASH_INIT_EXEC ?= $(ARGBASH_INIT)
 	$(word 2,$^) --type posix-script -o $@ $<
 	[sed -i "s|#!/bin/bash|#!]$(shell which dash)|" $@
 
-%-empty.m4: %.sh $(ARGBASH_BIN)
-	$(word 2,$^) --type empty -o $@ $<
+%-excised.m4: %.sh $(ARGBASH_BIN)
+	$(word 2,$^) --type excised -o $@ $<
 
 %.sh: %.m4 $(ARGBASH_BIN)
 	$(word 2,$^) $< -o $@
@@ -70,7 +70,7 @@ TESTS += \
 
 TESTS += \
 	m4_join([ \
-	], m4_set_list([EMPTY_OUTPUT_TESTS])) \
+	], m4_set_list([EXCISE_OUTPUT_TESTS])) \
 	$(NUL)
 
 
@@ -81,7 +81,7 @@ TESTS_GEN += \
 
 SCRIPTS += \
 	m4_join([ \
-	], m4_set_list([_TEST_BASH_SCRIPTS]),m4_set_list([_TEST_DOCOPT_SCRIPTS]),m4_set_list([_TEST_EMPTY_OUTPUT_SCRIPTS])) \
+	], m4_set_list([_TEST_BASH_SCRIPTS]),m4_set_list([_TEST_DOCOPT_SCRIPTS]),m4_set_list([_TEST_EXCISE_OUTPUT_SCRIPTS])) \
 	$(NUL)
 
 ifneq "$(shell which dash 2> /dev/null)" ""

tests/regressiontests/make/Makefile.m4

@@ -68,12 +68,12 @@ dnl $2: The test body (see also: TEST_BODY)
 dnl
 dnl Remarks:
 dnl No leading/trailing newlines, around the test body as it already has those.
-m4_define([ADD_EMPTY_OUTPUT_TEST], [m4_do(
+m4_define([ADD_EXCISE_OUTPUT_TEST], [m4_do(
 	[m4_pushdef([_original_source], [$(TESTDIR)/$1.m4])],
-	[m4_pushdef([_artifact], [$(TESTDIR)/$1-empty.m4])],
-	[m4_pushdef([_testname], [[$1-empty]])],
-	[m4_set_add([EMPTY_OUTPUT_TESTS], _testname)],
-	[m4_set_add([_TEST_EMPTY_OUTPUT_SCRIPTS], m4_quote(_artifact))],
+	[m4_pushdef([_artifact], [$(TESTDIR)/$1-excised.m4])],
+	[m4_pushdef([_testname], [[$1-excised]])],
+	[m4_set_add([EXCISE_OUTPUT_TESTS], _testname)],
+	[m4_set_add([_TEST_EXCISE_OUTPUT_SCRIPTS], m4_quote(_artifact))],
 	[m4_divert_text([STDOUT3], [m4_do(
 		[_testname: _artifact],
 		[

tests/regressiontests/make/make.m4

@@ -0,0 +1,2 @@
+ADD_EXCISE_OUTPUT_TEST([test-ls_like], [])
+