summaryrefslogtreecommitdiff
path: root/scripts/library/README
diff options
context:
space:
mode:
authorAllan McRae <allan@archlinux.org>2011-06-09 21:08:40 +1000
committerDan McGee <dan@archlinux.org>2011-06-15 09:19:10 -0500
commit53f4e431918fdfd4e2433c387da1c89c697613bf (patch)
tree79f3f11e6b782d769db39348b54ac497f62eeb86 /scripts/library/README
parent4272b37d3d9f112b9f089dafc2e7538c4c24f7b2 (diff)
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>
Diffstat (limited to 'scripts/library/README')
-rw-r--r--scripts/library/README15
1 files changed, 15 insertions, 0 deletions
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 "$@"