From c3e82b1c7b6c358719f3d1dd5cf4871cde3446a7 Mon Sep 17 00:00:00 2001
From: Raul Infante-Sainz <infantesainz@gmail.com>
Date: Fri, 19 Mar 2021 17:52:08 +0000
Subject: Configuration: --debug option available in this phase also

Until now, each time there was a problem in the configuration of Maneage'd
projects and debugging was necessary, we had to take the following changes:

 - Run the configuration on a single thread ('-j1') to see the building of
   only the problematic software.

 - Disable the Zenodo check manually by commenting those parts of
   'reproduce/software/shell/configure.sh'. Because the internet connection
   wastes a few seconds and is thus very annoying during repeated runs!

 - Manually remove the '-k' option that was passed to Make (when building
   the software). With the '-k', Make keeps going with the execution of
   other targets if something crashes and this usually causes confusions
   during the debugging.

Doing the manual changes within the code was both very annoying and prone
to errors (forgetting to correct it!).

With this commit, the existing '--debug' option has been generalized to the
software configuration phase of Maneage also. Until now, it was only
available in the analysis phase (and would directly be passed to the 'make'
command that would run the analysis). When this option is used, and the
project is in the software configuration phase, the Zenodo check won't be
done, it will use one single thread ('-j1'), and it will stop the execution
as soon as an error occurs (Make is not run with '-k').
---
 reproduce/software/shell/configure.sh | 48 ++++++++++++++++++++++++++---------
 1 file changed, 36 insertions(+), 12 deletions(-)

(limited to 'reproduce/software/shell')

diff --git a/reproduce/software/shell/configure.sh b/reproduce/software/shell/configure.sh
index 812f3d3..8ae74d2 100755
--- a/reproduce/software/shell/configure.sh
+++ b/reproduce/software/shell/configure.sh
@@ -3,6 +3,7 @@
 # Necessary preparations/configurations for the reproducible project.
 #
 # Copyright (C) 2018-2021 Mohammad Akhlaghi <mohammad@akhlaghi.org>
+# Copyright (C) 2021      Raul Infante-Sainz <infantesainz@gmail.com>
 #
 # This script is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -1458,18 +1459,19 @@ fi
 # which will download the DOI-resolved webpage, and extract the Zenodo-URL
 # of the most recent version from there (using the 'coreutils' tarball as
 # an example, the directory part of the URL for all the other software are
-# the same).
+# the same). This is not done if the option `--debug' is used.
+zenodourl=""
 user_backup_urls=""
 zenodocheck=.build/software/zenodo-check.html
-if $downloader $zenodocheck https://doi.org/10.5281/zenodo.3883409; then
-    zenodourl=$(sed -n -e'/coreutils/p' $zenodocheck \
-                    | sed -n -e'/http/p' \
-                    | tr ' ' '\n' \
-                    | grep http \
-                    | sed -e 's/href="//' -e 's|/coreutils| |' \
-                    | awk 'NR==1{print $1}')
-else
-    zenodourl=""
+if [ x$debug = x ]; then
+  if $downloader $zenodocheck https://doi.org/10.5281/zenodo.3883409; then
+      zenodourl=$(sed -n -e'/coreutils/p' $zenodocheck \
+                      | sed -n -e'/http/p' \
+                      | tr ' ' '\n' \
+                      | grep http \
+                      | sed -e 's/href="//' -e 's|/coreutils| |' \
+                      | awk 'NR==1{print $1}')
+  fi
 fi
 rm -f $zenodocheck
 
@@ -1497,6 +1499,28 @@ user_backup_urls="$user_backup_urls $zenodourl"
 
 
 
+# Corrections for debugging mode
+# ------------------------------
+#
+# If the user wants to debug the software configuration, they are usually
+# focused on the building of the single problematic software. Therefore,
+# the default multi-threaded execution of Make with the '--keep-going'
+# option are very annoying and can even hide important warnings. Recall
+# that with '--keep-going', Make will continue building other targets, even
+# if one target fails. When the user runs './project configure --debug',
+# the 'debug' variable will not be empty and this mode will be activated.
+if [ x$debug = x ]; then
+  keepgoing="--keep-going"
+else
+  jobs=1
+  numthreads=1
+  keepgoing=""
+fi
+
+
+
+
+
 # Build other basic tools our own GNU Make
 # ----------------------------------------
 #
@@ -1504,7 +1528,7 @@ user_backup_urls="$user_backup_urls $zenodourl"
 # Bash, Make, or AWK. In this step, we'll install such low-level basic
 # tools, but we have to be very portable (and use minimal features in all).
 echo; echo "Building necessary software (if necessary)..."
-.local/bin/make -k -f reproduce/software/make/basic.mk \
+.local/bin/make $keepgoing -f reproduce/software/make/basic.mk \
      user_backup_urls="$user_backup_urls" \
      sys_library_path=$sys_library_path \
      rpath_command=$rpath_command \
@@ -1532,7 +1556,7 @@ else
     numthreads=$jobs
 fi
 .local/bin/env -i HOME=$bdir \
-     .local/bin/make -k -f reproduce/software/make/high-level.mk \
+     .local/bin/make $keepgoing -f reproduce/software/make/high-level.mk \
           user_backup_urls="$user_backup_urls" \
           sys_library_path=$sys_library_path \
           rpath_command=$rpath_command \
-- 
cgit v1.2.1