more notes on configuration

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

diff --git a/build-farm.conf.template b/build-farm.conf.template
index ee056d98a01bc1d21d5cfd664c0b4edd5b3047e4..03588112d4a2056e773e504c053cea7b8c6f9194 100644 (file)
--- a/build-farm.conf.template
+++ b/build-farm.conf.template
@@ -17,7 +17,8 @@ use warnings;
 
 my $branch = $::branch;
 
-# This could be changed to use the standard layout but in a different place
+# This could be changed to use the standard layout but in a different place.
+# Appending /buildfarm is common.
 my $basedir = "$ENV{HOME}";
 
 # This template assumes that the user running the buildfarm process is "farm"
@@ -26,7 +27,12 @@ my $farm_user_name = getpwuid($<) // die "$0: can't get user name from uid $<: $
 our %conf =(
     scm => 'git',
     # default is github mirror of Exim
-    # Only used for the initial clone (?)
+    # Only used for the initial clone (?).
+    # If running multiple animals on a single system,
+    # consider pointing to a local mirror (git clone --mirror)
+    # and separately updating that using cron (git -C /mirrordir fetch).
+    # If running multiple VMs for animals, consider pointing
+    # to a mirror on the hypervisor.
     scmrepo => 'https://github.com/Exim/exim.git',
     # webref for diffs on server - use default for community
     scm_url => undef,
@@ -45,7 +51,8 @@ our %conf =(
     # If running multiple animals, an explicit common directory for
     # the lockfile so that runs do not conflict. Otherwise, leave unset.
     global_lock_dir => $basedir,
-    # this directory must exist before anything will work
+    # If running multiple animals, the root must differ for each.
+    # This directory must exist before anything will work.
     build_root => "$basedir/buildfarm",
     # set true to do vpath builds
     use_vpath => undef,
@@ -107,13 +114,16 @@ 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
         change => [], # if this build causes a state change
         green => [], # if this build causes a state change to/from OK
+        # green => ['me@example.com'],
     },
 
     # env settings to apply within build/report process
@@ -137,19 +147,27 @@ 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',
+       HAVE_IPV6 => 'yes',
         # Required for some tests to pass
         AUTH_PLAINTEXT => 'yes',
         SUPPORT_MAILDIR => 'yes',
         # Other examples. Could use makefile_regex instead.
+       #
+       #USE_GDBM = yes
+       #DBMLIB = -lgdbm
         #
-        #SUPPORT_TLS => 'yes',
+       WITH_CONTENT_SCAN => 'yes',
+        #DISABLE_TLS => 'yes',
         #  Enable the proper libs here or see in makefile_regex
         #  for use of pkg-config
-        #USE_GNUTLS => 'yes'
+        #USE_OPENSSL => 'yes',
+        #USE_GNUTLS => 'yes',
         #TLS_LIBS => '-lssl -lcrypto',
         #
+       # Many testcases need dsearch
+        LOOKUP_DSEARCH => 'yes',
         #LOOKUP_LDAP => 'yes',
         #LOOKUP_INCLUDE => '-I/usr/include/mysql -I/usr/include/postgresql'
         #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
@@ -158,19 +176,21 @@ 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:
     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
     makefile_add =>{
         # Show all warnings and errors
-        CFLAGS => '-Wall -Werror=format-security',
+       # Some platforms need the c99 setting enabled; some hate it
+        #CFLAGS => '-std=c99 -Wall -Wno-parentheses -Werror=format-security',
+        CFLAGS => '-Wall -Wno-parentheses -Wno-dangling-else -Werror=format-security',
         # 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',
     },
 
@@ -217,6 +237,12 @@ our %conf =(
         qw()
     ],
 
+    # Configuration tuning for test suite ./configure
+    test_configure_env => {},
+    test_configure_args => [],
+    # Configuration tuning for test suite run
+    # eg. test_run_args = '-FLAVOUR openssl_1_1_1',
+    test_run_args => '',       
 );
 
 if ($branch eq 'global')
@@ -236,4 +262,10 @@ if ($branch eq 'global')
 #
 ##################################
 
+# Eg:
+#if ($branch eq 'exim-4.90+fixes')
+#{
+#      $conf{makefile_set}{SUPPORT_DANE} = '';
+#}
+
 1;