Documentation update
authorGreg Brockman <gdb@mit.edu>
Tue, 24 Aug 2010 04:34:17 +0000 (00:34 -0400)
committerGreg Brockman <gdb@mit.edu>
Tue, 24 Aug 2010 05:48:50 +0000 (01:48 -0400)
build-hooks/post-build

index 277f8f2..1851cd7 100755 (executable)
@@ -16,12 +16,13 @@ To configure zephyr, add something like the following to your invirt config:
 build:
  hooks:
   post_build:
-   zephyr: &post_build_zepyhr
+   zephyr: &post_build_zephyr
     class: myclass [required]
     instance: myinstance [optional]
     zsig: myzsig [optional]
   failed_build:
    zephyr: *post_build_zephyr
+  ...
 
 == mail ==
 
@@ -36,10 +37,18 @@ build:
     subject: My Subject [optional]
   failed_build:
    mail: *post_build_mail
-
-post_build values will be used when this script is invoked as
-post-build, while failed_build values will be used when it is invoked
-as failed-build.
+  ...
+
+The script chooses which configuration option to use based off the
+name it is called with.  This name also determines which command-line
+arguments the script takes, as well as how they are formatted.  When
+called as:
+
+post-build: uses post_build option
+failed-build: uses failed_build option
+post-submit: uses post_submit option
+failed-submit: uses failed_submit option
+post-add-repo: uses post_add_repo option
 """
 
 import optparse