diff options
author | Trygve Laugstøl <trygvis@inamo.no> | 2013-10-28 21:21:34 +0100 |
---|---|---|
committer | Trygve Laugstøl <trygvis@inamo.no> | 2013-10-28 21:21:34 +0100 |
commit | 91984f8d551650b5ed79b9428c1098a10e922e4e (patch) | |
tree | 3e2a457eeeca84e1717c7280ddda8c15923dcff2 /STYLE-GUIDE.md | |
parent | f47f556cd49582d34122802c120ce00cf4da2e5a (diff) | |
download | app.sh-91984f8d551650b5ed79b9428c1098a10e922e4e.tar.gz app.sh-91984f8d551650b5ed79b9428c1098a10e922e4e.tar.bz2 app.sh-91984f8d551650b5ed79b9428c1098a10e922e4e.tar.xz app.sh-91984f8d551650b5ed79b9428c1098a10e922e4e.zip |
o Working a bit on the style guide.
Diffstat (limited to 'STYLE-GUIDE.md')
-rw-r--r-- | STYLE-GUIDE.md | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md deleted file mode 100644 index 207b988..0000000 --- a/STYLE-GUIDE.md +++ /dev/null @@ -1,57 +0,0 @@ -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. - -Resources ---------- - -* Parameter expansion: <http://wiki.bash-hackers.org/syntax/pe> - -<!-- vim: set ft=markdown: --> |