about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorJonathan "Duke" Leto <jonathan@leto.net>2011-04-29 20:12:49 -0700
committerJonathan "Duke" Leto <jonathan@leto.net>2011-04-29 20:12:49 -0700
commit090319d830ad8ef4b842254e0b8fb9dfc07f5eda (patch)
treec797abfdf77f66ffda8457413a114692c247c349 /README.md
parentMake the command-line arg of the builder --config to match jitterbug_db (diff)
downloadjitterbug-090319d830ad8ef4b842254e0b8fb9dfc07f5eda.tar.gz
Add more docs about the config file
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4ea55af..0bd2385 100644
--- a/README.md
+++ b/README.md
@@ -89,3 +89,12 @@ can be a life saver to minimize bandwidth and the time to build + test a
 commit.  If this is a true value, repos will be cached in the "build" directory
 specified above.
 
+The rest of the options in this section are related to email
+notifications. The keys "on_failure" and "on_pass" list the
+name of a Perl class that handles emails. You probably won't
+need to change this.
+
+The config key "on_failure_subject_prefix" can be used to
+tweak the subject lines of emails that Jitterbug sends. By
+default, they will begin with "[jitterbug] FAIL". Similarly,
+there is a "on_pass_subject_prefix" which defaults to "[jitterbug] PASS".