Add helpful comments. Disable ccache as default

[buildfarm-client.git] / build-farm.conf.template

diff --git a/build-farm.conf.template b/build-farm.conf.template
index ee056d98a01bc1d21d5cfd664c0b4edd5b3047e4..4ac7684e6b3cde276ce0db9c308f20a48965daa0 100644 (file)
--- a/build-farm.conf.template
+++ b/build-farm.conf.template
@@ -107,8 +107,10 @@ our %conf =(
     trigger_include => undef,
 
     # settings for mail notices - default to notifying nobody
     trigger_include => undef,
 
     # settings for mail notices - default to notifying nobody

+    # (putting the operator of the animal is a good idea)

     # these lists contain addresses to be notified
     # must be complete email addresses, as the email is sent from the server
     # these lists contain addresses to be notified
     # must be complete email addresses, as the email is sent from the server

+    # put single-quote (') around the address string

     mail_events =>{
         all => [], # unconditional
         fail => [], # if this build fails
     mail_events =>{
         all => [], # unconditional
         fail => [], # if this build fails


@@ -137,8 +139,8 @@ our %conf =(
     # previous definitions of variables.  Example:
     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
     makefile_set =>{
     # previous definitions of variables.  Example:
     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
     makefile_set =>{

-        # comment out if not using ccache
-        CC => 'ccache gcc',
+        # uncomment to use ccache
+        #CC => 'ccache gcc',

         # Required for some tests to pass
         AUTH_PLAINTEXT => 'yes',
         SUPPORT_MAILDIR => 'yes',
         # Required for some tests to pass
         AUTH_PLAINTEXT => 'yes',
         SUPPORT_MAILDIR => 'yes',