From: Jeremy Harris <jgh@wizmail.org>
Date: Wed, 16 Aug 2017 14:08:43 +0000 (+0100)
Subject: Add helpful comments.  Disable ccache as default
X-Git-Url: https://git.exim.org/buildfarm-client.git/commitdiff_plain/dee5f00a9a60fd2114457eec3b2ad4d55d4a03ea

Add helpful comments.  Disable ccache as default
---

diff --git a/build-farm.conf.template b/build-farm.conf.template
index ee056d9..4ac7684 100644
--- 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
+    # (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
+    # put single-quote (') around the address string
     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 =>{
-        # 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',