Trac #30533: Add quiet mode for bootstrap

This ticket is to add a -q flag to bootstrap so that it will print out less. URL: https://trac.sagemath.org/30533 Reported by: slelievre Ticket author(s): Michael Orlitzky Reviewer(s): Matthias Koeppe
sagemath · Sep 21, 2020 · 3d4a8d2 · 3d4a8d2
2 parents 8700f75 + 9c39bc8
commit 3d4a8d2
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 21 deletions.
diff --git a/bootstrap b/bootstrap
@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/sh
 
 ########################################################################
 # Regenerate auto-generated files (e.g. configure)
@@ -17,6 +17,9 @@
 # will download http://host/path/configure-$CONFVERSION.tar.gz to
 # upstream/configure-$CONFVERSION.tar.gz. This is used by the buildbot
 # to download tarballs that are not published.
+#
+# The -q (quiet) flag hides all "informational" output.
+#
 ########################################################################
 
 # Set SAGE_ROOT to the path to this file and then cd into it
@@ -66,7 +69,9 @@ install_config_rpath() {
         return 179
     fi
 
-    echo "bootstrap:$LINENO: installing 'config/config.rpath'"
+    if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+	echo "bootstrap:$LINENO: installing 'config/config.rpath'"
+    fi
     cp "$config_rpath" config/
 }
 
@@ -97,10 +102,24 @@ SAGE_SPKG_CONFIGURE_$(echo ${pkgname} | tr '[a-z]' '[A-Z]')"
     done
     echo "$spkg_configures" >> m4/sage_spkg_configures.m4
 
-    SAGE_ROOT="$SAGE_ROOT" src/doc/bootstrap && \
+    # Default to no filter if "-q" was not passed.
+    QUIET_SED_FILTER=""
+    if [ "${BOOTSTRAP_QUIET}" = "yes" ]; then
+	# Otherwise, this filters the expected output from automake.
+	QUIET_SED_FILTER='/configure\.ac:[0-9][0-9]*: installing /d'
+    fi
+
+    # The insanity with automake's descriptors is intended to filter
+    # ONLY stderr, and to re-output the results back to stderr leaving
+    # stdout alone. Basically we swap the two descriptors using a
+    # third, filter, and then swap them back.
+    BOOTSTRAP_QUIET="${BOOTSTRAP_QUIET}" \
+    SAGE_ROOT="$SAGE_ROOT" \
+    src/doc/bootstrap && \
     install_config_rpath && \
     aclocal -I m4 && \
-    automake --add-missing --copy build/make/Makefile-auto && \
+    automake --add-missing --copy build/make/Makefile-auto 3>&1 1>&2 2>&3 \
+        | sed "${QUIET_SED_FILTER}" 3>&1 1>&2 2>&3 && \
     autoconf
 
     st=$?
@@ -110,7 +129,7 @@ SAGE_SPKG_CONFIGURE_$(echo ${pkgname} | tr '[a-z]' '[A-Z]')"
         179|16|63|127)  # install_config_rpath failed|no m4 for pkg-config|autotools not installed|or version too old
             if [ $DOWNLOAD = yes ]; then
                 echo >&2 "Bootstrap failed, downloading required files instead."
-                bootstrap-download || exit $?
+                bootstrap_download || exit $?
             else
                 if [ $st -eq 127 ]; then
                     verb="install"
@@ -129,8 +148,11 @@ SAGE_SPKG_CONFIGURE_$(echo ${pkgname} | tr '[a-z]' '[A-Z]')"
 }
 
 # Bootstrap by downloading the auto-generated files
-bootstrap-download () {
-    sage-download-file configure-$CONFVERSION.tar.gz
+bootstrap_download () {
+    SAGE_DL_LOGLEVEL=""
+    [ "${BOOTSTRAP_QUIET}" = "yes" ] && SAGE_DL_LOGLEVEL="--log=WARNING"
+    sage-download-file ${SAGE_DL_LOGLEVEL} configure-$CONFVERSION.tar.gz
+
     if [ $? -ne 0 ]; then
         echo >&2 "Error: downloading configure-$CONFVERSION.tar.gz failed"
         exit 1
@@ -156,22 +178,46 @@ save () {
 
     NEWCONFVERSION=`git rev-parse HEAD`
     NEWCONFBALL="upstream/configure-$NEWCONFVERSION.tar.gz"
-    
+
     # Create configure tarball
-    echo "Creating $NEWCONFBALL..."
+    if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+	echo "Creating $NEWCONFBALL..."
+    fi
     mkdir -p upstream
-    tar zcf "$NEWCONFBALL" configure config/* build/make/Makefile-auto.in src/doc/en/installation/*.txt src/doc/en/reference/spkg/*.rst src/doc/en/reference/repl/*.txt
-
+    tar zcf "$NEWCONFBALL" \
+	configure \
+	config/* \
+	build/make/Makefile-auto.in \
+	src/doc/en/installation/*.txt \
+	src/doc/en/reference/spkg/*.rst \
+	src/doc/en/reference/repl/*.txt
+
     # Update version
     echo "$NEWCONFVERSION" >$PKG/package-version.txt
-    
+
     # Compute checksum
-    ./sage --package fix-checksum configure
+    if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+	./sage --package fix-checksum configure
+    else
+	# Hide the "Updating checksum..." message
+	./sage --package fix-checksum configure > /dev/null
+    fi
 }
 
 
 usage () {
-    echo >&2 "Usage: $0 [-d|-D|-s] [-u <URL>] [-h]"
+    echo >&2 "Usage: $0 [-d|-D|-s] [-u <URL>] [-h] [-q]"
+    echo >&2 ""
+    echo >&2 "Options:"
+    echo >&2 "  -d         fall back to downloading (released versions only)"
+    echo >&2 "             or using a pre-generated configure script"
+    echo >&2 "  -D         download and use a pre-generated configure script"
+    echo >&2 "             (released versions only); overrides -d"
+    echo >&2 "  -s         save the generated configure script under upstream/"
+    echo >&2 "             for later use with -d or -D"
+    echo >&2 "  -u <URL>   like -D, but downloads from the specified base URL"
+    echo >&2 "  -h         display this help and exit"
+    echo >&2 "  -q         hide informational output (be quiet)"
 }
 
 
@@ -180,14 +226,16 @@ SAVE=no
 DOWNLOAD=no
 ALWAYSDOWNLOAD=no
 CONFTARBALL_URL=""
-while getopts "Ddshu:" OPTION
+BOOTSTRAP_QUIET=no
+while getopts "Ddsu:hq" OPTION
 do
      case "$OPTION" in
          D) ALWAYSDOWNLOAD=yes; DOWNLOAD=yes;;
          d) DOWNLOAD=yes;;
          s) SAVE=yes;;
          u) CONFTARBALL_URL="$OPTARG"; ALWAYSDOWNLOAD=yes; DOWNLOAD=yes;;
          h) usage; exit 0;;
+         q) BOOTSTRAP_QUIET=yes;;
          ?) usage; exit 2;;
      esac
 done
@@ -200,7 +248,12 @@ if [ $DOWNLOAD$SAVE = yesyes ]; then
 fi
 
 # Start cleanly (it's not a problem if this fails)
-$MAKE bootstrap-clean 2>/dev/null
+# POSIX supports two separate incompatible formats for the MAKEFLAGS
+# variable, so instead of guessing, we simply define our own variable
+# to optionally pass an "-s" (silent) flag to Make.
+MAKE_SILENT=""
+[ "${BOOTSTRAP_QUIET}" = "yes" ] && MAKE_SILENT="-s"
+$MAKE ${MAKE_SILENT} bootstrap-clean 2>/dev/null
 mkdir config 2>/dev/null
 
 # If Sage has not been built yet, this will fail due to a missing
@@ -212,14 +265,16 @@ source src/bin/sage-env 2>/dev/null
 if [ $ALWAYSDOWNLOAD = yes ]; then
     if [ -n "$CONFTARBALL_URL" ]; then
         URL="$CONFTARBALL_URL"/configure-$CONFVERSION.tar.gz
-        sage-download-file "$URL" upstream/configure-$CONFVERSION.tar.gz
+        SAGE_DL_LOGLEVEL=""
+        [ "${BOOTSTRAP_QUIET}" = "yes" ] && SAGE_DL_LOGLEVEL="--log=WARNING"
+        sage-download-file ${SAGE_DL_LOGLEVEL} "$URL" upstream/configure-$CONFVERSION.tar.gz
         if [ $? -ne 0 ]; then
             echo >&2 "Error: downloading configure-$CONFVERSION.tar.gz from $CONFTARBALL_URL failed"
             exit 1
         fi
         echo >&2 "Downloaded configure-$CONFVERSION.tar.gz from $CONFTARBALL_URL "
     else
-        bootstrap-download || exit $?
+        bootstrap_download || exit $?
     fi
 else
     bootstrap

diff --git a/src/doc/bootstrap b/src/doc/bootstrap
@@ -5,6 +5,9 @@
 #
 # This script is run by SAGE_ROOT/bootstrap as part of the bootstrapping phase
 # (before configure, before creating source distributions).
+#
+# The BOOTSTRAP_QUIET variable is set by the top-level
+# bootstrap script and controls how verbose we are.
 ########################################################################
 
 set -e
@@ -49,14 +52,18 @@ for SYSTEM in arch debian fedora cygwin homebrew; do
             fi
         fi
     done
-    echo >&2 $0:$LINENO: installing "$OUTPUT_DIR"/$SYSTEM.txt and "$OUTPUT_DIR"/$SYSTEM-optional.txt
+    if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+	echo >&2 $0:$LINENO: installing "$OUTPUT_DIR"/$SYSTEM.txt and "$OUTPUT_DIR"/$SYSTEM-optional.txt
+    fi
     echo "$(sage-print-system-package-command $SYSTEM --prompt --sudo install $(echo $(echo $SYSTEM_PACKAGES | xargs -n 1 echo | sort)))" > "$OUTPUT_DIR"/$SYSTEM.txt
     echo "$(sage-print-system-package-command $SYSTEM --prompt --sudo install $(echo $(echo $OPTIONAL_SYSTEM_PACKAGES | xargs -n 1 echo | sort)))" > "$OUTPUT_DIR"/$SYSTEM-optional.txt
 done
 
 OUTPUT_DIR="src/doc/en/reference/spkg"
 mkdir -p "$OUTPUT_DIR"
-echo >&2 $0:$LINENO: installing "$OUTPUT_DIR"/"*.rst"
+if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+    echo >&2 $0:$LINENO: installing "$OUTPUT_DIR"/"*.rst"
+fi
 OUTPUT_INDEX="$OUTPUT_DIR"/index.rst
 cat > "$OUTPUT_INDEX" <<EOF
 
@@ -86,5 +93,7 @@ EOF
 OUTPUT_DIR="src/doc/en/reference/repl"
 mkdir -p "$OUTPUT_DIR"
 OUTPUT="$OUTPUT_DIR/options.txt"
-echo >&2 $0:$LINENO: installing "$OUTPUT"
+if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
+    echo >&2 $0:$LINENO: installing "$OUTPUT"
+fi
 ./sage -advanced > "$OUTPUT"