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 <allan@archlinux.org>
Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Allan McRae 2011-06-09 21:08:40 +10:00 committed by Dan McGee
parent 4272b37d3d
commit 53f4e43191
1 changed files with 15 additions and 0 deletions

15
scripts/library/README Normal file
View File

@ -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 "$@"