From 53f4e431918fdfd4e2433c387da1c89c697613bf Mon Sep 17 00:00:00 2001 From: Allan McRae Date: Thu, 9 Jun 2011 21:08:40 +1000 Subject: scripts/library: add README file Add a README file to briefly document the code snippets in the scripts library folder. Signed-off-by: Allan McRae Signed-off-by: Dan McGee --- scripts/library/README | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 scripts/library/README (limited to 'scripts/library') diff --git a/scripts/library/README b/scripts/library/README new file mode 100644 index 00000000..1e9c962b --- /dev/null +++ b/scripts/library/README @@ -0,0 +1,15 @@ +This folder contains code snippets that can be reused by multiple +scripts. A brief description of each file follows. + +output_format.sh: +Provides basic output formatting functions with levels 'msg', 'msg2', +'warning' and 'error'. The 'msg' amd 'msg2' functions print to stdout +and can be silenced by defining 'QUIET'. The 'warning' and 'error' +functions print to stderr with the appropriate prefix added to the +message. + +parse_options.sh: +A getopt replacement to avoids portability issues, in particular the +lack of long option name support in the default getopt provided by some +platforms. +Usage: parse_option $SHORT_OPTS $LONG_OPTS "$@" -- cgit v1.2.3-24-g4f1b