From 91984f8d551650b5ed79b9428c1098a10e922e4e Mon Sep 17 00:00:00 2001
From: Trygve Laugstøl <trygvis@inamo.no>
Date: Mon, 28 Oct 2013 21:21:34 +0100
Subject: o Working a bit on the style guide.

---
 STYLE-GUIDE.txt | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 STYLE-GUIDE.txt

(limited to 'STYLE-GUIDE.txt')

diff --git a/STYLE-GUIDE.txt b/STYLE-GUIDE.txt
new file mode 100644
index 0000000..1f0a9cf
--- /dev/null
+++ b/STYLE-GUIDE.txt
@@ -0,0 +1,89 @@
+Bash Style Guide
+================
+
+Basic
+-----
+
+* Indent: two spaces. Spaces >> tabs.
+
+Creating `usage()` and `help()`
+-------------------------------
+
+The general semantics
+---------------------
+
+When the user requests help through `-h` or no arguments,
+`show_help()` should be used. This will output the info on stdout
+because the user explicitly requested so. If the user gives some form
+of invalid argument or there is any other error the usage should go to
+stderr because the user might be using pipes.
+
+How app.sh does it
+------------------
+
+Each command should implement `usage_text`. The command should call
+`show_help()` and `usage()` as appropriate. These functions are
+defined in `lib/common` and will both call `usage_app()` to get the
+usage info. `usage()` will send the info to stderr.
+
+* `show_help()` will exit with 0, while `usage()` will exit with code 1.
+
+Formatting of usage output
+--------------------------
+
+* Enclose required arguments in angle brackets: `-v <version>`
+* Enclose optional arguments in square brackets: `[-h hook]`
+
+----------------------------------------------------------------------
+usage_text() {
+  echo "usage: $0 -v <version> [-h hook]"
+}
+----------------------------------------------------------------------
+
+Executing Commands
+==================
+
+* http://unix.stackexchange.com/q/23026
+
+Parsing options
+===============
+
+Applications should always check for extra options or define how
+they're handled.
+
+By always shifting out processed arguments `$@` will be an array with
+the remaining arguments. If only command options are allowed they can
+be shifted in one go with the expression `shift $(($OPTIND - 1))`.
+
+----------------------------------------------------------------------
+while getopts "f:" opt
+do
+  case $opt in
+    f)
+      file="$OPTARG"
+      shift 2;
+      ;;
+    *)
+      usage "Unknown argument: $OPTARG"
+      ;;
+  esac
+done
+
+shift $(($OPTIND - 1))
+----------------------------------------------------------------------
+
+After all arguments have been processed, check for extra arguments:
+
+----------------------------------------------------------------------
+if [[ $# != 0 ]]
+then
+  usage "Extra arguments"
+fi
+----------------------------------------------------------------------
+
+Resources
+---------
+
+* Parameter expansion: <http://wiki.bash-hackers.org/syntax/pe>
+
+// vim: set ft=asciidoc:
-- 
cgit v1.2.3