email.cfg: refine the configuration file example

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>

diff --git a/email/aiaiai-email.cfg b/email/aiaiai-email.cfg
index 257c02590011dbf494968f2e6339e03ec3f5f3f8..0ef1857524880f3e8d70fcdd0171e526bfe32388 100644 (file)
--- a/email/aiaiai-email.cfg
+++ b/email/aiaiai-email.cfg
@@ -4,11 +4,14 @@
 
 # Example configuration file for aiaiai-email-test-patchset
 
+# Mandatory section containing the global Aiaiai settings
 [global]
-       # The name and e-mail of the validator
-       # Projects are selected by adding "+prj_name" to the emailname, e.g.
-       # aiaiai+prj_kernel-3.2-tizen@aiaiai.ku
+       # The name the patch validator
        ownname = Aiaiai
+       # Projects are selected by adding "+prj_name" to the local part of the
+       # e-mail, "aiaiai+kernel-tizen@aiaiai.ku" would select the
+       # "kernel-tizen" project, which is definde in the "prj_kernel-tizen"
+       # section below in this file.
        ownmail = aiaiai@aiaiai.ku
        # Admin's e-mail and name
        adminname = Artem Bityutskiy
@@ -18,7 +21,8 @@
        # How many jobs aiaiai-test-patchset should use
        jobs = 14
 
-# Do not put dots at the end of the sentences
+# Mandatory section describing various patterns that Aiaiai will use in its
+# e-mail answers. Do not put dots at the end of the sentences.
 [email]
        # Every e-mail we send starts with the preamble
        preamble = /home/aiaiai/aiaiai-preamble.txt
@@ -27,11 +31,14 @@
        # When the thest succeeds, this phrase is put after the preamble
        built_preamble = I have tested your changes
 
+# An optional section describing the "kernel-3.0-androd" project. There may be
+# several projects. This project will be used for patches sent to
+# "aiaiai+kernel-3.0-android@aiaiai.ku".
 [prj_kernel-3.0-android]
        # Human-readable project name
-       name = 3.0-android
+       name = Android kernel
        # Project description
-       description = 3.0-based kernel for Android
+       description = The x86 Android kernel
        # Path to the project sources
        path = /home/aiaiai/git/linux-3.0-android
        # Configurations to test
@@ -48,9 +55,10 @@
        # unwanted keyword per line)
        unwanted_keywords = /home/aiaiai/unwanted-keywords.txt
 
-[prj_kernel-3.2-tizen]
-       name = 3.2-tizen
-       description = 3.2-based tizen kernel
+# A second project.
+[prj_kernel-tizen]
+       name = Tizen kernel
+       description = The x86 Tizen kernel
        path = /home/aiaiai/git/linux-3.2-tizen
        configs = tizen_defconfig,i386 i386_defconfig,i386
        branch = origin/tizen