summaryrefslogtreecommitdiff
path: root/HACKING.md
diff options
context:
space:
mode:
authorLuke Shumaker <LukeShu@sbcglobal.net>2014-06-16 22:40:57 -0400
committerLuke Shumaker <LukeShu@sbcglobal.net>2014-06-16 22:40:57 -0400
commit3d9850b56c77b51edcdb2697c74ba2d1761109dc (patch)
treee5fe03bcbf6cd4d72f7c31a3129156e6784c4325 /HACKING.md
parent52cc0c3ff27d4c48d3461d9fd898367aa4a92631 (diff)
parent813bfa255a1e46f05e08dcb587b8f417b995b2d4 (diff)
Merge branch 'master' into lukeshu/xbs
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/HACKING.md b/HACKING.md
index 2e5937b..ebe595b 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -51,13 +51,13 @@ lines that should not wrap, `echo` to print blank lines, `prose` to
print paragraphs, `bullet` to print bullet points, and `flag` to print
option flags. The text should follow this general format:
- print |Usage: ${program} [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL
- print |One line description of program, no period
+ print "Usage: %s [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL" "${program_name}"
+ print "One line description of program, no period"
echo
- prose |More details. This is a paragraph.
+ prose "More details. This is a paragraph."
echo
- print |Options:
- flag | -h Show this message
+ print "Options:"
+ flag "-h" "Show this message"
In the "Usage:" line, use printf `%s` and the value `"${0##*/}"` to
determine the program name at runtime.