From a510d51a78f14fbb8416037a587ce1bfc6016d24 Mon Sep 17 00:00:00 2001
From: Marc Schink <dev@zapb.de>
Date: Wed, 26 Jun 2024 15:50:45 +0200
Subject: [PATCH] bootstrap: Do not set up Git submodules by default

Building OpenOCD with jimtcl and libjaylink Git submodules is deprecated
and will be removed in the upcoming releases. The remaining 'git2cl'
submodule is only required during the OpenOCD release process.

Only set up Git submodules when the 'with-submodules' argument is used,
for example during the OpenOCD release process or for the transition
period until all submodules are replaced by external dependencies.

We keep the existing 'nosubmodule' argument in order to not break
automatic testing with Jenkins.

Change-Id: Ia4fd765e3a2d6b2c40b084a1ffdf919d5f4f35bb
Signed-off-by: Marc Schink <dev@zapb.de>
Reviewed-on: https://review.openocd.org/c/openocd/+/8381
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-by: R. Diez <rdiez-2006@rd10.de>
---
 bootstrap | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/bootstrap b/bootstrap
index 9dfdc41ac..0ee26d4ed 100755
--- a/bootstrap
+++ b/bootstrap
@@ -15,19 +15,21 @@ else
     exit 1
 fi
 
-SKIP_SUBMODULE=0
+WITH_SUBMODULES=0
 
 case "$#" in
     0) ;;
-    1) if [ "$1" = "nosubmodule" ]; then
-           SKIP_SUBMODULE=1
-       else
+    1) if [ "$1" = "with-submodules" ]; then
+           WITH_SUBMODULES=1
+       elif [ "$1" = "nosubmodule" ]; then
+           WITH_SUBMODULES=0
+       elif [ -n "$1" ]; then
            echo "$0: Illegal argument $1" >&2
-           echo "USAGE: $0 [nosubmodule]" >&2
+           echo "USAGE: $0 [with-submodules]" >&2
            exit 1
        fi;;
    *)  echo "$0: Wrong number of command-line arguments." >&2
-       echo "USAGE: $0 [nosubmodule]" >&2
+       echo "USAGE: $0 [with-submodules]" >&2
        exit 1;;
 esac
 
@@ -42,12 +44,12 @@ autoheader --warnings=all
 automake --warnings=all --gnu --add-missing --copy
 )
 
-if [ "$SKIP_SUBMODULE" -ne 0 ]; then
-    echo "Skipping submodule setup"
-else
+if [ "$WITH_SUBMODULES" -ne 0 ]; then
     echo "Setting up submodules"
     git submodule sync
     git submodule update --init
+else
+    echo "Skipping submodule setup"
 fi
 
 if [ -x src/jtag/drivers/libjaylink/autogen.sh ]; then