Ticket #11959: trac_11959-root.v2.patch

.hgignore

@@ -24 +24 @@
 Makefile.old
 VERSION.txt
 ^spkg-install$
+spkg/parallel_make.cfg

Makefile

@@ -43 +43 @@
 #       test -x $@ # or make it executable if it exists; sanity check only anyway
 
 build: $(PIPE)
-        cd spkg && "../$(PIPE)" "./install all 2>&1" "tee -a ../install.log"
+        cd spkg && \
+        "../$(PIPE)" \
+                "env SAGE_PARALLEL_SPKG_BUILD='$(SAGE_PARALLEL_SPKG_BUILD)' ./install all 2>&1" \
+                "tee -a ../install.log"
+
+build-serial: SAGE_PARALLEL_SPKG_BUILD = no
+build-serial: build
 
 # You can choose to have the built HTML version of the documentation link to
 # the PDF version. To do so, you need to build both the HTML and PDF versions.
@@ -155 +161 @@
         cd $(DESTDIR)/bin/; ./sage -c
 
 
-.PHONY: all build doc doc-html doc-html-jsmath doc-pdf \
+.PHONY: all build build-serial doc doc-html doc-html-jsmath doc-pdf \
         doc-clean clean distclean \
         test check testoptional testlong ptest ptestall ptestlong \
         install testall ptestoptional

README.txt

@@ -168 +168 @@
    installed when you install the programs listed above.
 
 3. Extract the Sage source tarball and cd into a directory with no
-   spaces in it. If you have a machine with 4 processors, say, type the
-   following to configure the build script to perform a parallel
+   spaces in it. If you have a machine with 4 processors, say, type
+   the following to configure the build script to perform a parallel
    compilation of Sage using 4 jobs:
 
        export MAKE="make -j4"
 
-   By default the above will only parallelize a small part of the build
-   process. To make the spkg build part of the installation process
-   parallel do:
+   (With 4 processors, you might also consider "-j5" or "-j6" --
+   building with more jobs than CPU cores can speed things up.)
+   You might in addition pass a "-l" flag to "make": this
+   sets a load limit, so for example if you execute
 
-       export SAGE_PARALLEL_SPKG_BUILD="yes"
+       export MAKE="make -j4 -l5.5"
 
-   The amount of processors used for the building of the spkg's is
-   determined by what you assigned to MAKE. So the above is useless if 
-   you did export MAKE="make -j1".
+   then "make" won't start more than one job at a time if the system
+   load average is above 5.5.  See
+   http://www.gnu.org/software/make/manual/make.html#Options-Summary
+   and http://www.gnu.org/software/make/manual/make.html#Parallel.
 
    If you want to run the test suite for each individual spkg as it is
    installed, type:
@@ -244 +246 @@
     plotting functionality benefits from it.
 
 
+PROBLEMS
+--------
+
+If you have problems building Sage, check the Sage Installation Guide,
+and also note the following.  Each separate component of Sage is
+contained in an spkg; these are stored in spkg/standard/.  As each one
+is built, a build log is stored in spkg/logs/, so you can browse these
+to find error messages.  If an spkg fails to build, the whole build
+process will stop soon after, so check the most recent log files
+first, or run
+
+   grep -li "An error" spkg/logs/*
+
+from the top-level Sage directory to find log files with error
+messages in them.  Send (a small part of) the relevant log file to the
+sage-devel mailing list, making sure to include at least some of the
+error messages; probably someone there will have some helpful
+suggestions.
+
+
 SUPPORTED COMPILERS
 -------------------
 

spkg/install

@@ -428 +428 @@
 ZNPOLY=`$newest zn_poly`
 export ZNPOLY
 
+# If the user (or the Makefile) has set SAGE_PARALLEL_SPKG_BUILD=no,
+# then turn off parallel building by writing .NOTPARALLEL to
+# spkg/standard/parallel_make.cfg.  Otherwise clear that file.
+if [[ ${SAGE_PARALLEL_SPKG_BUILD:-yes} = no ]]; then
+    # Disable just building multiple packages at the same time; individual
+    # spkgs still get built in parallel if they support it and '--jobs'
+    # in $MAKE is greater than one (and at all specified):
+    echo ".NOTPARALLEL:" > "$SAGE_ROOT"/spkg/parallel_make.cfg
+else
+    # Create an (almost) empty file, s.t. including it from spkg/standard/deps
+    # doesn't raise an error, thereby also invalidating any previous setting:
+    echo > "$SAGE_ROOT"/spkg/parallel_make.cfg
+fi
 
 # Skip the rest if nothing to do (i.e., to [re]build):
-# Note that we should use $MAKE here, but we currently don't use
-# it further below either unless SAGE_PARALLEL_SPKG_BUILD=yes, which
-# I consider a "bug". -- Leif Leonhardy
-# If "make" doesn't understand the -q option, it should exit with a
-# non-zero status which is not a problem.
-if make -q -f standard/deps $1; then
+# If "make" doesn't understand the -q option (although we require 
+# GNU make, which supports it), it should exit with a non-zero status 
+# which is not a problem. 
+if ${MAKE:-make} -q -f standard/deps $1; then
     echo "Nothing to (re)build / all up-to-date."
     exit 0
 fi
 
-
 # Dump environment for debugging purposes:
 echo "*** ALL ENVIRONMENT VARIABLES BEFORE BUILD: ***"
-env
+env | sort
 echo "***********************************************"
 
-
 ###############################################################################
 # NOW do the actual build:
 ###############################################################################
-if [ "$SAGE_PARALLEL_SPKG_BUILD" = "yes" ] && [ -n "$MAKE" ]; then
-    time $MAKE -f standard/deps $1
-else
-    time make -f standard/deps $1
-fi
+time ${MAKE:-make} -f standard/deps $1
 
-# added by Burcin Erocal, see trac #6295.
+# Added by Burcin Erocal, see trac #6295:
 if [ $? -ne 0 ]; then
-    echo "Error building Sage."
+    echo >&2 "Error building Sage."
     exit 1
 fi
 
 cd "$SAGE_ROOT"
 
-# Rename makefile to Makefile (see #10156)
+# Rename makefile to Makefile (see #10156):
 if [ -f makefile ]; then
     mv makefile Makefile
     if [ $? -ne 0 ]; then
@@ -473 +478 @@
     fi
 fi
 
-# build succeeded
-if [ "$1" = "all" ]; then
-    echo "To install gap, gp, singular, etc., scripts"
-    echo "in a standard bin directory, start sage and"
-    echo "type something like"
-    echo "   sage: install_scripts('/usr/local/bin')"
-    echo "at the Sage command prompt."
-    echo ""
-    echo "To build the documentation, run"
-    echo "   make doc"
-    echo ""
-fi
-
+# Build succeeded.
 echo "Sage build/upgrade complete!"
 
+if [ "$1" = "all" ]; then
+    echo
+    echo "To install small scripts to directly run Sage's versions of GAP,"
+    echo "the PARI/GP interpreter, Maxima, or Singular etc. (by typing e.g."
+    echo "just 'gap' or 'gp') into a standard 'bin' directory, start Sage"
+    echo "by typing 'sage' (or './sage') and enter something like"
+    echo
+    echo "    install_scripts('/usr/local/bin')"
+    echo
+    echo "at the Sage command prompt ('sage:')."
+    echo
+    echo "If you issued 'make', 'make all', or a similar command, then the"
+    echo "HTML version of the documentation will be built right now."
+    echo "Otherwise, if you want to (re)build the HTML documentation,"
+    echo "run 'make doc'.  To build the PDF version, run 'make doc-pdf'."
+    echo
+fi

spkg/standard/deps

@@ -9 +9 @@
 INSTALL = $(SAGE_ROOT)/spkg/pipestatus
 
 ###############################################################################
+# The file parallel_make.cfg is either empty (build in parallel) or
+# contains ".NOTPARALLEL:" (build serially).  This file is written
+# by spkg/install.  This setting has no effect on sub-makes -- it
+# only determines whether more than one spkg may be built at a time.
+###############################################################################
+include $(SAGE_ROOT)/spkg/parallel_make.cfg
+
+###############################################################################
 # The base system; required in order to run sage-spkg
 ###############################################################################
 BASE = $(INST)/$(PREREQ) $(INST)/$(DIR) $(INST)/$(SAGE_BZIP2)