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 eb131523d62ddab3238889c74b87d20f20814469..4ac7684e6b3cde276ce0db9c308f20a48965daa0 100644 (file)
--- a/build-farm.conf.template
+++ b/build-farm.conf.template
@@ -17,8 +17,8 @@ use warnings;
 
 my $branch = $::branch;
 
-# This could be changed to use the startdard layout but in a different place
-my $basedir = $ENV{HOME};
+# This could be changed to use the standard layout but in a different place
+my $basedir = "$ENV{HOME}";
 
 # This template assumes that the user running the buildfarm process is "farm"
 my $farm_user_name = getpwuid($<) // die "$0: can't get user name from uid $<: $!\n";
@@ -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',
@@ -186,7 +188,6 @@ our %conf =(
         # May be outdated, please check a current EDITME for
         # for options.
         #q(s/^# (EXPERIMENTAL_CERTNAMES.*)/$1/),
-        #q(s/^# (EXPERIMENTAL_DNSSEC.*)/$1/),
     ],
 
     # The user compiled as the master exim username.