Merge pull request #203 from yeldiRium/usage-basename

Show basename of script in usage text

Author: matejak

AUTHORS

@@ -5,3 +5,4 @@ Kevin Stravers <kevin@stravers.net>
 Matěj Týč <matej.tyc@gmail.com>
 Nicola Lunghi <nick83ola@gmail.com>
 Stephen Gallagher <sgallagh@redhat.com>
+Hannes Leutloff <hannes.leutloff@yeldirium.de>

bin/argbash

@@ -86,7 +86,7 @@ _arg_debug=
 print_help()
 {
 	printf '%s\n' "Argbash is an argument parser generator for Bash."
-	printf 'Usage: %s [-o|--output <arg>] [-i|--(no-)in-place] [-t|--type <type>] [--(no-)library] [--strip <content>] [--(no-)check-typos] [-c|--(no-)commented] [-I|--search <arg>] [--debug <arg>] [-h|--help] [-v|--version] <input>\n' "$0"
+	printf 'Usage: %s [-o|--output <arg>] [-i|--(no-)in-place] [-t|--type <type>] [--(no-)library] [--strip <content>] [--(no-)check-typos] [-c|--(no-)commented] [-I|--search <arg>] [--debug <arg>] [-h|--help] [-v|--version] <input>\n' "$(basename "$0")"
 	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)"

bin/argbash-1to2

@@ -42,7 +42,7 @@ _arg_output=""
 print_help()
 {
 	printf '%s\n' "Convert a template for argbash>=1,<2 to argbash>=2,<3"
-	printf 'Usage: %s [-o|--output <arg>] [-v|--version] [-h|--help] <input-1> [<input-2>] ... [<input-n>] ...\n' "$0"
+	printf 'Usage: %s [-o|--output <arg>] [-v|--version] [-h|--help] <input-1> [<input-2>] ... [<input-n>] ...\n' "$(basename "$0")"
 	printf '\t%s\n' "<input>: The input file to transform"
 	printf '\t%s\n' "-o, --output: Name of the output file (pass '-' for stdout and empty string for the same as input file) (default: '""')"
 	printf '\t%s\n' "-v, --version: Prints version"

bin/argbash-init

@@ -66,7 +66,7 @@ _arg_mode="default"
 print_help()
 {
 	printf '%s\n' "Make a template for scripts."
-	printf 'Usage: %s [-s|--separate] [--(no-)hints] [--pos <arg>] [--opt <arg>] [--opt-bool <arg>] [-m|--mode <MODE>] [-v|--version] [-h|--help] [<output>]\n' "$0"
+	printf 'Usage: %s [-s|--separate] [--(no-)hints] [--pos <arg>] [--opt <arg>] [--opt-bool <arg>] [-m|--mode <MODE>] [-v|--version] [-h|--help] [<output>]\n' "$(basename "$0")"
 	printf '\t%s\n' "<output>: Name of the output template (default: '-')"
 	printf '\t%s\n' "-s, --separate: Separate the parsing logic (specify two times for complete separation)"
 	printf '\t%s\n' "--hints, --no-hints: Whether to write hints to the script template (off by default)"

src/stuff.m4

@@ -417,7 +417,7 @@ m4_define([_MAKE_HELP], [MAKE_FUNCTION(
 		[dnl If we have optionals, display them like [--opt1 arg] [--(no-)opt2] ... according to their type. @<:@ becomes square bracket at the end of processing
 ],
 		[_MAKE_HELP_SYNOPSIS([$1])],
-		[\n' "@S|@0"_ENDL_()],
+		[\n' "$(basename "@S|@0")"_ENDL_()],
 		[_IF_HAVE_POSITIONAL_ARGS([_MAKE_HELP_FUNCTION_POSITIONAL_PART])],
 		[dnl If we have 0 optional args, don't do anything (FOR loop would assert, 0 < 1)
 ],

tests/regressiontests/Makefile

@@ -266,6 +266,7 @@ basic: $(TESTDIR)/basic.sh
 	grep -q "local _key$$" $<
 	$< -h | grep -q 'P percent: %'
 	$< -h | grep -q 'O percent: %'
+	$< -h | grep -q 'Usage: $(notdir $<) '
 	! $< -h | grep -qe '\[--\]'
 	test -z "$(SHELLCHECK)" || $(SHELLCHECK) "$(TESTDIR)/basic.sh"
 basic-dash: $(TESTDIR)/basic-dash.sh
@@ -275,6 +276,7 @@ basic-dash: $(TESTDIR)/basic-dash.sh
 	$< LOO -b | grep -q BOOL=off,
 	$< -h | grep -q 'P percent: %'
 	$< -h | grep -q 'O percent: %'
+	$< -h | grep -q 'Usage: $(notdir $<) '
 	$< -h | grep -qe '\[--\]'
 	test -z "$(SHELLCHECK)" || $(SHELLCHECK) "$(TESTDIR)/basic-dash.sh"
 test-void: $(TESTDIR)/test-void.sh

tests/regressiontests/make/tests/tests-base.m4

@@ -9,6 +9,7 @@ ADD_TEST_BASH([basic], [[
 	grep -q "local _key$$" $<
 	$< -h | grep -q 'P percent: %'
 	$< -h | grep -q 'O percent: %'
+	$< -h | grep -q 'Usage: $(notdir $<) '
 	! $< -h | grep -qe '\[--\]'
 ]])
 
@@ -20,6 +21,7 @@ ADD_TEST_DASH([basic], [[
 	$< LOO -b | grep -q BOOL=off,
 	$< -h | grep -q 'P percent: %'
 	$< -h | grep -q 'O percent: %'
+	$< -h | grep -q 'Usage: $(notdir $<) '
 	$< -h | grep -qe '\[--\]'
 ]])