Add example branch-specific config code

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

diff --git a/build-farm.conf.template b/build-farm.conf.template
index 819c7591ec65220be4e7dcce24e906c709dcc8d1..1ad3e7c9123c2d2fbd99cc9a1dc94b3f83c4a22c 100644 (file)
--- a/build-farm.conf.template
+++ b/build-farm.conf.template
@@ -17,6 +17,9 @@ use warnings;
 
 my $branch = $::branch;
 
+# 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";
 
@@ -41,15 +44,15 @@ our %conf =(
     tar_log_cmd => undef,
     # If running multiple animals, an explicit common directory for
     # the lockfile so that runs do not conflict. Otherwise, leave unset.
-    global_lock_dir => $ENV{HOME},
+    global_lock_dir => $basedir,
     # this directory must exist before anything will work
-    build_root => "$ENV{HOME}/buildfarm",
+    build_root => "$basedir/buildfarm",
     # set true to do vpath builds
     use_vpath => undef,
 
     keep_error_builds => 0,
     # Linux style, use "*.core" for BSD
-    core_file_glob => "core*",
+    core_file_glob => 'core*',
 
     # Note about HTTPS: HTTPS support is experimental. For a
     # limited time you may try to use HTTP, in case HTTPS doesn't
@@ -62,8 +65,8 @@ our %conf =(
     upgrade_target => 'https://buildfarm.exim.org/cgi-bin/upgrade.pl',
 
     # Your host alias and password in the BuildFarm
-    animal => "alias_assigned_by_build_team",
-    secret => "secret_assigned_by_build_team",
+    animal => 'alias_assigned_by_build_team',
+    secret => 'secret_assigned_by_build_team',
 
     # allow automatic updates of the buildfarm client code.
     # Leave it *unset* to get the default behaviour, set it
@@ -104,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
@@ -119,7 +124,7 @@ our %conf =(
     build_env =>{
         # use a dedicated cache for the build farm. this should give us
         # very high hit rates and slightly faster cache searching.
-        CCACHE_DIR => "$ENV{HOME}/buildfarm/ccache/$branch",
+        CCACHE_DIR => "$basedir/buildfarm/ccache/$branch",
 
         ### set this if you need a proxy setting for the
         # outbound web transaction that reports the results
@@ -134,13 +139,14 @@ 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',
         # Other examples. Could use makefile_regex instead.
         #
+       WITH_CONTENT_SCAN => 'yes',
         #SUPPORT_TLS => 'yes',
         #  Enable the proper libs here or see in makefile_regex
         #  for use of pkg-config
@@ -155,8 +161,8 @@ our %conf =(
         #LOOKUP_PGSQL => 'yes',
         #SUPPORT_PROXY => 'yes',
         #SUPPORT_SOCKS => 'yes',
-        #EXPERIMENTAL_SPF => 'yes',
-        #EXPERIMENTAL_DANE => 'yes',
+        #SUPPORT_SPF => 'yes',
+        #SUPPORT_DANE => 'yes',
     },
     # Settings to add to Local/Makefile. These will add to variables that
     # are already defined earlier in the Makefile.  Example:
@@ -167,7 +173,7 @@ our %conf =(
         # Or enable debugging flags
         #CFLAGS => '-g -Wall',
         #LFLAGS => '-g',
-        # If set EXPERIMENTAL_SPF above, add it to the linker:
+        # If set SUPPORT_SPF above, add it to the linker:
         #LDFLAGS => '-lspf2',
     },
 
@@ -183,7 +189,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.
@@ -191,7 +196,7 @@ our %conf =(
     # the group of the exim user as a secondary group. Example:
     # user=>farm, group=>farm, secondary_groups=>exim
     # user=>exim, group=>exim
-    master_exim_user => "exim",
+    master_exim_user => 'exim',
 
     # Range of tests to run if enable make_test in optional steps.
     # Start with just a couple while getting the aminal set up,
@@ -234,4 +239,10 @@ if ($branch eq 'global')
 #
 ##################################
 
+# Eg:
+#if ($branch eq 'exim-4.90+fixes')
+#{
+#      $conf{makefile_set}{SUPPORT_DANE} = '';
+#}
+
 1;