From 60d4f23ecb9efd3b8904ef40712906e63008c48a Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 26 Aug 2014 23:18:58 +0200 Subject: [PATCH] gsu: Improve documentation of _gsu_get_command_regex(). Although this function is private, it is central to the subcommand part of gsu and should thus be properly documented. The new text is more precise about the meaning of the regular expression that is used to identify subcommands. --- misc/gsu/subcommand | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/misc/gsu/subcommand b/misc/gsu/subcommand index f1685aa..a04b8de 100644 --- a/misc/gsu/subcommand +++ b/misc/gsu/subcommand @@ -11,8 +11,16 @@ _gsu_usage() gsu_short_msg "# Usage: $_gsu_self command [options]" } -# Each line matching this is recognized as a subcommand. The name of the may be -# given as $1. In any case the subcommand is the first subexpression. +# Return an extended regular expression to match against $0. +# +# When called without argument, the expression matches all lines which define a +# subcommand. +# +# If an argument is given, the returned expression matches only the subcommand +# passed as $1. This is useful to tell if a string is a valid subcommand. +# +# Regardless of whether an argument is given, the returned expression contains +# exactly one parenthesized subexpression for matching the command name. _gsu_get_command_regex() { local cmd="${1:-[-a-zA-Z_0-9]+}" -- 2.39.2