change --enable-{nouveau,clouseau} to --with-

We've decided that CouchDB should not alter default.ini in the release
tarball if you enable either or both of the search add-ons. That activation
should be done by our packages or by the system administrator.

We change the configure flags from --enable to --with to indicate that these
components will only be built and included in the release artifact.

Author: rnewson

.devcontainer/devcontainer.json

@@ -23,7 +23,7 @@
     // Your code will live inside the volume created for the container under /workspace.
     "workspaceMount": "target=/workspaces/couchdb,type=volume",
     "workspaceFolder": "/workspaces/couchdb",
-    "postCreateCommand": "./configure --enable-nouveau --enable-clouseau && make",
+    "postCreateCommand": "./configure --with-nouveau --with-clouseau && make",
 
     "customizations": {
         "vscode": {

README-DEV.rst

@@ -154,7 +154,7 @@ Configure the source by running::
 
 If you intend to run the test suites with Clouseau::
 
-    ./configure --enable-clouseau
+    ./configure --with-clouseau
 
 If you don't want to build Fauxton or documentation specify
 ``--disable-fauxton`` and/or ``--disable-docs`` arguments for ``configure`` to

build-aux/Jenkinsfile.full

@@ -26,81 +26,81 @@ meta = [
   'centos8': [
     name: 'CentOS 8',
     spidermonkey_vsn: '60',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-centos:8-erlang-${ERLANG_VERSION}"
   ],
 
   'centos9': [
     name: 'CentOS 9',
     spidermonkey_vsn: '78',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-centos:9-erlang-${ERLANG_VERSION}"
   ],
 
   'focal': [
     name: 'Ubuntu 20.04',
     spidermonkey_vsn: '68',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-ubuntu:focal-erlang-${ERLANG_VERSION}"
   ],
 
   'jammy': [
     name: 'Ubuntu 22.04',
     spidermonkey_vsn: '91',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-ubuntu:jammy-erlang-${ERLANG_VERSION}"
   ],
 
   'bullseye-ppc64': [
     name: 'Debian 11 POWER',
     spidermonkey_vsn: '78',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-debian:bullseye-erlang-${ERLANG_VERSION}",
     node_label: 'ppc64le'
   ],
 
   'bullseye-s390x': [
     name: 'Debian 11 s390x',
     spidermonkey_vsn: '78',
-    enable_nouveau: true,
+    with_nouveau: true,
     image: "apache/couchdbci-debian:bullseye-erlang-${ERLANG_VERSION}",
     node_label: 's390x'
   ],
 
   'bullseye': [
     name: 'Debian 11',
     spidermonkey_vsn: '78',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-debian:bullseye-erlang-${ERLANG_VERSION}"
   ],
 
   'bookworm': [
     name: 'Debian 12',
     spidermonkey_vsn: '78',
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-debian:bookworm-erlang-${ERLANG_VERSION}"
   ],
 
   'bookworm-quickjs': [
     name: 'Debian 12 with QuickJS',
     disable_spidermonkey: true,
-    enable_nouveau: true,
-    enable_clouseau: true,
+    with_nouveau: true,
+    with_clouseau: true,
     image: "apache/couchdbci-debian:bookworm-erlang-${ERLANG_VERSION}"
   ],
 
   // Temp disable until worker is back
   // 'freebsd-x86_64': [
   //    name: 'FreeBSD x86_64',
   //    spidermonkey_vsn: '91',
-  //    enable_clouseau: false,
+  //    with_clouseau: false,
   //    gnu_make: 'gmake'
   // ],
 
@@ -109,15 +109,15 @@ meta = [
   'freebsd-arm64': [
      name: 'FreeBSD ARM64 QuickJS',
      disable_spidermonkey: true,
-     enable_clouseau: false,
+     with_clouseau: false,
      gnu_make: 'gmake'
   ],
 
  'macos': [
     name: 'macOS',
     spidermonkey_vsn: '91',
-    enable_nouveau: false,
-    enable_clouseau: true,
+    with_nouveau: false,
+    with_clouseau: true,
     gnu_make: 'make'
   ]
 ]
@@ -128,11 +128,11 @@ def String configure(config) {
   } else {
       result = "./configure --skip-deps --spidermonkey-version ${config.spidermonkey_vsn}"
   }
-  if (config.enable_nouveau) {
-    result += " --enable-nouveau"
+  if (config.with_nouveau) {
+    result += " --with-nouveau"
   }
-  if (config.enable_clouseau) {
-    result += " --enable-clouseau"
+  if (config.with_clouseau) {
+    result += " --with-clouseau"
   }
   return result
 }
@@ -319,7 +319,7 @@ pipeline {
       steps {
         timeout(time: 15, unit: "MINUTES") {
           sh (script: 'rm -rf apache-couchdb-*', label: 'Clean workspace of any previous release artifacts' )
-          sh "./configure --spidermonkey-version 78 --enable-nouveau"
+          sh "./configure --spidermonkey-version 78 --with-nouveau"
           sh 'make dist'
         }
       }

build-aux/Jenkinsfile.pr

@@ -20,7 +20,7 @@ mkdir build
 cd build
 tar -xf ${WORKSPACE}/apache-couchdb-*.tar.gz
 cd apache-couchdb-*
-./configure --enable-nouveau --enable-clouseau --js-engine=${JS_ENGINE}
+./configure --with-nouveau --with-clouseau --js-engine=${JS_ENGINE}
 make check || (make build-report && false)
 '''
 
@@ -218,7 +218,7 @@ pipeline {
       steps {
         sh '''
           rm -rf apache-couchdb-*
-          ./configure --spidermonkey-version 78 --enable-nouveau --enable-clouseau
+          ./configure --spidermonkey-version 78 --with-nouveau --with-clouseau
           make dist
           chmod -R a+w * .
         '''

configure

@@ -65,8 +65,8 @@ Options:
   -u | --user USER            set the username to run as (defaults to $COUCHDB_USER)
   --disable-fauxton           do not build Fauxton
   --disable-docs              do not build any documentation or manpages
-  --enable-nouveau            enable the new experimental search module
-  --enable-clouseau           enable the Clouseau search module
+  --with-nouveau              build the new experimental search module
+  --with-clouseau             build the Clouseau search module
   --erlang-md5                use erlang for md5 hash operations
   --dev                       alias for --disable-docs --disable-fauxton
   --spidermonkey-version VSN  specify the version of SpiderMonkey to use (defaults to $SM_VSN)
@@ -108,22 +108,22 @@ parse_opts() {
                 continue
                 ;;
 
-            --enable-nouveau)
+            --with-nouveau)
                 WITH_NOUVEAU="true"
                 shift
                 continue
                 ;;
 
-	    --enable-clouseau)
-		if [ "${ERLANG_VER}" -gt 25 ]; then
-		    echo "Warning: Clouseau is not working with OTP 26 or later at the moment, therefore it is not configured.  Continue in 5 seconds..."
-		    sleep 5
-		else
-		    WITH_CLOUSEAU=1
-		fi
-		shift
-		continue
-		;;
+	        --with-clouseau)
+		        if [ "${ERLANG_VER}" -gt 25 ]; then
+		            echo "Warning: Clouseau is not working with OTP 26 or later at the moment, therefore it is not configured.  Continue in 5 seconds..."
+		            sleep 5
+		        else
+		            WITH_CLOUSEAU=1
+		        fi
+		        shift
+		        continue
+		        ;;
 
             --erlang-md5)
                 ERLANG_MD5="true"
@@ -380,7 +380,6 @@ cat > rel/couchdb.config << EOF
 {prefix, "."}.
 {data_dir, "./data"}.
 {view_index_dir, "./data"}.
-{nouveau_enable, "$WITH_NOUVEAU"}.
 {nouveau_index_dir, "./data/nouveau"}.
 {nouveau_url, "http://127.0.0.1:5987"}.
 {nouveau_port, 5987}.

configure.ps1

@@ -8,8 +8,8 @@
   -DisableFauxton            request build process skip building Fauxton (default false)
   -DisableDocs               request build process skip building documentation (default false)
   -DisableSpiderMonkey       do not use SpiderMonkey as JS engine (default false)
-  -EnableNouveau             enable the new experiemtal search module (default false)
-  -EnableClouseau            enable the Clouseau search module (default false)
+  -WithNouveau               build the new experiemtal search module (default false)
+  -WithClouseau              build the Clouseau search module (default false)
   -SkipDeps                  do not update Erlang dependencies (default false)
   -CouchDBUser USER          set the username to run as (defaults to current user)
   -SpiderMonkeyVersion VSN   select the version of SpiderMonkey to use (default 91)
@@ -50,8 +50,8 @@ Param(
     [switch]$Test = $false,
     [switch]$DisableFauxton = $false, # do not build Fauxton
     [switch]$DisableDocs = $false, # do not build any documentation or manpages
-    [switch]$EnableNouveau = $false, # dont use new search module by default
-    [switch]$EnableClouseau = $false, # do not use Clouseau by default
+    [switch]$WithNouveau = $false, # dont use new search module by default
+    [switch]$WithClouseau = $false, # do not use Clouseau by default
     [switch]$SkipDeps = $false, # do not update erlang dependencies
     [switch]$DisableProper = $false, # a compilation pragma. proper is a kind of automated test suite
     [switch]$DisableSpiderMonkey = $false, # do not use SpiderMonkey as JS engine
@@ -145,8 +145,6 @@ $InstallDir="$LibDir\couchdb"
 $LogFile="$LogDir\couch.log"
 $BuildFauxton = [int](-not $DisableFauxton)
 $BuildDocs = [int](-not $DisableDocs)
-$WithNouveau = ($EnableNouveau).ToString().ToLower()
-$WithClouseau = $(If ($EnableClouseau) {1} else {0})
 $Hostname = [System.Net.Dns]::GetHostEntry([string]"localhost").HostName
 $WithProper = (-not $DisableProper).ToString().ToLower()
 $ErlangMD5 = ($EnableErlangMD5).ToString().ToLower()
@@ -182,7 +180,6 @@ $CouchDBConfig = @"
 {prefix, "."}.
 {data_dir, "./data"}.
 {view_index_dir, "./data"}.
-{nouveau_enable, "$WithNouveau"}.
 {nouveau_index_dir, "./data/nouveau"}.
 {nouveau_url, "http://127.0.0.1:5987"}.
 {nouveau_port, 5987}.
@@ -310,7 +307,7 @@ if ((Get-Command "erlfmt.cmd" -ErrorAction SilentlyContinue) -eq $null)
 
 $ClouseauDir = "$rootdir\clouseau"
 
-if ($EnableClouseau)
+if ($WithClouseau)
 {
 
     if (Test-Path $ClouseauDir) {

dev/run

@@ -603,9 +603,9 @@ log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %c [%p] %m%n
 @log("Start Clouseau node clouseau{idx}")
 def boot_clouseau(ctx, idx):
     configure_cmd = (
-        "&.\\configure.ps1 -EnableClouseau"
+        "&.\\configure.ps1 -WithClouseau"
         if platform.system() == "Windows"
-        else "./configure --enable-clouseau"
+        else "./configure --with-clouseau"
     )
     clouseau_dir = ctx["clouseau_dir"]
 

nouveau/README.md

@@ -43,7 +43,7 @@ I don't intend to add grouping support, it seems barely used. Would accept a tid
 
 ## Getting started
 
-Configure CouchDB with `--enable-nouveau`
+Configure CouchDB with `--with-nouveau`
 
 Build Nouveau with;