From 2d29fd14314b500d6fc11ff334cbcab56705e26c Mon Sep 17 00:00:00 2001
From: Jeremy Harris <jgh@exim.org>
Date: Fri, 8 Dec 2023 14:44:55 +0000
Subject: [PATCH] more notes on configuration

---
 build-farm.conf.template | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/build-farm.conf.template b/build-farm.conf.template
index 6a55237..0358811 100644
--- 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,
@@ -116,6 +123,7 @@ our %conf =(
         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
@@ -146,6 +154,9 @@ our %conf =(
         AUTH_PLAINTEXT => 'yes',
         SUPPORT_MAILDIR => 'yes',
         # Other examples. Could use makefile_regex instead.
+	#
+	#USE_GDBM = yes
+	#DBMLIB = -lgdbm
         #
 	WITH_CONTENT_SCAN => 'yes',
         #DISABLE_TLS => 'yes',
@@ -173,8 +184,9 @@ our %conf =(
     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
     makefile_add =>{
         # Show all warnings and errors
-	# Some platforms need the c99 setting enabled
-        CFLAGS => '-std=c99 -Wall -Wno-parentheses -Wno-dangling-else -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',
-- 
2.30.2