IMPORTANT: software configuration optimized and better modularized

Summary: after merging this commit into your project, it should be
re-configured since the location of software installation files like
'LOCAL.conf' or the LaTeX macros of the software environment have
changed. But it should not affect the analysis phase of your project.

Until this commit, it was not possible to run a pre-built Maneage'd project
(in a container) on a newly cloned Maneage'd project source. This was
because the containers should be read-only, but during the various checks
of the configuration (to verify that we are using the same software
environment in the container and the source), we were writing/testing many
things in the build directory, and 'LOCAL.conf' which was actually in the
source directory!

Furthermore, the '.local' and '.build' were built at configure time, making
it hard to run the same container from a newly cloned Maneage'd project. To
make things harder for the scenario above, the 'configure.sh' script would
pause on every message and didn't have a quiet mode (making it practically
impossible to run './project configure' before './project make' on every
container run).

With this commit, all these issues have been addressed and it is now
possible to simply get a built container, clone a Maneage'd project and run
the analysis (using the built environment of the container that is verified
on every run). The respective changes/additions are described below:

 - The high-level container scripts ('apptainer.sh' and 'docker.sh', along
   with their READMEs) have been moved to the 'reproduce/software/shell'
   directory and the old 'reproduce/software/containers' directory has been
   deleted. This is because we have classified the software files by their
   language/format and the container scripts are scripts in the end.

 - The './project' script:

    - Now has two extra options: '--quiet' and '--no-pause'. Both are
      directly passed to the 'configure.sh' script. They will respectively
      disable any informative printed message or any pause after that
      message (if it is printed).

    - The '--build-dir' option is now also relevant for './project make':
      when it is given, it will re-create the two '.build' and '.local'
      symbolic links at the top source directory in all scenarios
      ('configure', 'make' or 'shell'). This will allow both the
      configuration, analysis and shell phases to safely assume they exist
      and match the user's desire at run-time.

    - The build/analysis directory's sub-directories that need to be built
      before 'top-make.mk' are now built in a separate function to help in
      readability.

 - The 'configure.sh' script:

    - For developers: a new 'check_elapsed' variable has been defined that
      will enable the newly added 'elapsed_time_from_prev_step'
      function. This function should be used from now on at the end of
      every major step to help find bottlenecks.

 - The targets of the software in 'pre-make-build.sh' now also have the
   version of the software in their file name. Until now, they didn't have
   the version, so there was no way to detect if the software has been
   updated or not in the source. For Lzip and Make (that also get built
   after GCC), the ones in this script have a '-pre-make' suffix also.

 - 'Local.conf.in' now has descriptions for every variable.

 - The '-std=gnu17' option is now used instead of '-std=c17' for basic
   software that cannot be built without specifying the C standard in GCC
   15.1 (described in previous commit: 2881fc0a6205). See [1] for more
   details; in summary: '-std=gnu17' is also supported on macOS's Clang and
   has some features that 'pkg-config' needs

 - Generally: some longer code lines have been broken or indentation
   decreased to fit the 75 character line length. This has not reduced
   readability however. For example the long 'echo' commands are now
   replaced by multiple 'printf's, or the indentation is still clearly
   visible.

The seeds of the work on this commit started by a branch containing three
commits by Giacomo Lorenzetti (133 insertions, 100 deletions). Upon merging
with the main 'maneage' branch, they were generalized and re-organized to
become this commit.

The following issues have also been addressed with this commit:

 - The LaTeX calls (during the building of 'paper.pdf') do not contain
   Maneage'd dynamic libraries. This is because we don't build the LaTeX
   binaries from source, an TeXLive manager uses the host environment.

 - The 'docker.sh' script:

    - Adds the '--project-name' option: its internal variable existed, but
      the option for the user to define it at run-time was not.

    - Ported to macOS: it does not check being a member of the 'docker'
      group, and finds the number of threads using macOS-specific tools.

 - The 'apptainer.sh' script:

    - Now installs 'wget' in the base container also (necessary when the
      user doesn't have the tarballs).

[1] https://savannah.nongnu.org/bugs/?67068#comment2

1 files changed, 24 insertions, 33 deletions

diff --git a/reproduce/software/shell/pre-make-build.sh b/reproduce/software/shell/pre-make-build.sh
index 28b7385..172bdb6 100755
--- a/reproduce/software/shell/pre-make-build.sh
+++ b/reproduce/software/shell/pre-make-build.sh
@@ -135,16 +135,6 @@ download_tarball() {
     else mv "$ucname" "$maneagetar"
     fi
   fi
-
-  # If the tarball is newer than the (possibly existing) program (the
-  # version has changed), then delete the program. When the LaTeX name is
-  # not given here, the software is re-built later (close to the end of
-  # 'basic.mk') and the name is properly placed there.
-  if [ -f "$ibidir/$progname" ]; then
-      if [ "$maneagetar" -nt "$ibidir/$progname" ]; then
-          rm "$ibidir/$progname"
-      fi
-  fi
 }
 
 
@@ -159,6 +149,9 @@ build_program() {
     # Options
     configoptions=$1
 
+    # Inform the user.
+    echo; echo "Pre-make building of $progname"; echo
+
     # Go into the temporary building directory.
     cd "$tmpblddir"
     unpackdir="$progname"-"$version"
@@ -183,7 +176,8 @@ build_program() {
 
     # build the project, either with Make and either without it.
     if [ x$progname = xlzip ]; then
-        ./configure --build --check --installdir="$instdir/bin" $configoptions
+        ./configure --build --check --installdir="$instdir/bin" \
+                    $configoptions
     else
         # All others accept the configure script.
         ./configure --prefix="$instdir" $configoptions
@@ -196,7 +190,10 @@ build_program() {
             case $on_mac_os in
                 yes) sed -e's/\%1u/\%d/'  src/flock.c > src/flock-new.c;;
                 no)  sed -e's/\%1u/\%ld/' src/flock.c > src/flock-new.c;;
-                *)   echo "pre-make-build.sh: '$on_mac_os' unrecognized value for on_mac_os";;
+                *)
+                    printf "pre-make-build.sh: '$on_mac_os' "
+                    printf "unrecognized value for on_mac_os"
+                    exit 1;;
             esac
             mv src/flock-new.c src/flock.c
         fi
@@ -218,9 +215,9 @@ build_program() {
     cd "$topdir"
     rm -rf "$tmpblddir/$unpackdir"
     if [ x"$progname_tex" = x ]; then
-        echo "" > "$ibidir/$progname"
+        echo "" > "$texfile"
     else
-        echo "$progname_tex $version" > "$ibidir/$progname"
+        echo "$progname_tex $version" > "$texfile"
     fi
   fi
 }
@@ -238,12 +235,12 @@ build_program() {
 # (without compression it is just ~400Kb). So we use its '.tar' file and
 # won't rely on the host's compression tools at all.
 progname="lzip"
-progname_tex="" # Lzip re-built after GCC (empty string to avoid repetition)
+progname_tex="" # Lzip is re-built after GCC (empty to avoid repetition)
 url=$(awk '/^'$progname'-url/{print $3}' $urlfile)
 version=$(awk '/^'$progname'-version/{print $3}' "$versionsfile")
 tarball=$progname-$version.tar
-download_tarball
-build_program
+texfile="$ibidir/$progname-$version-pre-make"
+if ! [ -f $texfile ]; then download_tarball; build_program; fi
 
 
 
@@ -268,8 +265,11 @@ progname_tex="" # Make re-built after GCC (empty string to avoid repetition)
 url=$(awk '/^'$progname'-url/{print $3}' $urlfile)
 version=$(awk '/^'$progname'-version/{print $3}' $versionsfile)
 tarball=$progname-$version.tar.lz
-download_tarball
-build_program "--disable-dependency-tracking --without-guile"
+texfile="$ibidir/$progname-$version-pre-make"
+if ! [ -f $texfile ]; then
+    download_tarball
+    build_program "--disable-dependency-tracking --without-guile"
+fi
 
 
 
@@ -286,13 +286,11 @@ progname_tex="Dash"
 url=$(awk '/^'$progname'-url/{print $3}' $urlfile)
 version=$(awk '/^'$progname'-version/{print $3}' $versionsfile)
 tarball=$progname-$version.tar.lz
-download_tarball
-build_program
+texfile="$ibidir/$progname-$version"
+if ! [ -f $texfile ]; then download_tarball; build_program; fi
 
 # If the 'sh' symbolic link isn't set yet, set it to point to Dash.
-if [ -f $bindir/sh ]; then just_a_place_holder=1
-else ln -sf $bindir/dash $bindir/sh;
-fi
+if ! [ -f $bindir/sh ]; then ln -sf $bindir/dash $bindir/sh; fi
 
 
 
@@ -315,12 +313,5 @@ progname_tex="Discoteq flock"
 url=$(awk '/^'$progname'-url/{print $3}' $urlfile)
 version=$(awk '/^'$progname'-version/{print $3}' $versionsfile)
 tarball=$progname-$version.tar.lz
-download_tarball
-build_program
-
-
-
-
-
-# Finish this script successfully
-exit 0
+texfile="$ibidir/$progname-$version"
+if ! [ -f $texfile ]; then download_tarball; build_program; fi