[PATCH RFC 7/7] doc: add section explaining hook configuration variables

Jacob Keller jacob.e.keller at intel.com
Wed Mar 19 15:46:47 PDT 2014

This patch adds a small section about hook configuration variables,
warning authors that they may use the cfgfile for storage, but also
indicating that future changes to aiaiai could break them.

Signed-off-by: Jacob Keller <jacob.e.keller at intel.com>
 doc/email/configuration.txt | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/doc/email/configuration.txt b/doc/email/configuration.txt
index 50d4e5785cb5..4c0f7f5adf02 100644
--- a/doc/email/configuration.txt
+++ b/doc/email/configuration.txt
@@ -203,7 +203,16 @@ to set them, in order to help customize aiaiai.
     aiaiai-email-test-patchset program. This can be used so that the hook can
     cancel validation if it determined the patch is bad for some reason.
-2.4.1 Dispatcher Hook
+2.4.1 Hook Configuration
+Hooks may set their own configuration fields inside of the configuration file.
+In order to avoid collisions it may be best to use separate block fields, or
+specialized names. It is expected that the hook will perform the neccessary get
+calls for this, and should not expect help from aiaiai internals. Be warned
+that future changes to aiaiai could add conflicting configuration options.
+2.5 Dispatcher Hook
 The dispatcher hook is called by aiaiai-email-dispatcher-helper, and receives

More information about the aiaiai mailing list