Ticket #11197: trac_11197-spkg-install-docs.patch

spkg/install

@@ -431 +431 @@
 ZNPOLY=`$newest zn_poly`
 export ZNPOLY
 
+builddocs() {
+    if [ "$SAGE_SPKG_INSTALL_DOCS" = "yes" ]; then
+        # In case we want to change the name of the script:
+        SPKG_INSTALL_SCRIPT=spkg-install-docs
+        INSTALL="$SAGE_ROOT/spkg/pipestatus"
+        . "$SAGE_ROOT/local/bin/sage-env"
+        if [ $? -ne 0 ]; then
+            echo >&2 "Error running sage-env"
+            exit 1
+        fi
+        echo "Building documentation for spkg files."
+        echo -ne "Searching for documentation..."
+        cd standard
+        for PKG in *.spkg
+        do
+            PKG=`echo "$PKG" | sed 's/\(.(*\).spkg/\1/'`
+            found=`tar jtf "$SAGE_ROOT/spkg/standard/$PKG.spkg" | grep $SPKG_INSTALL_SCRIPT`
+            # $installed_file is a placeholder file which should only
+            # exist if the docs for $PKG have been successfully built
+            # and installed.  If present, don't rebuild the docs.
+            installed_file="$SAGE_ROOT/spkg/installed/$PKG-docs"
+            if [ $? -eq 0 ] && [ -n "$found" ] && [ ! -f $installed_file ]; then
+                echo
+                echo "**************************************************"
+                echo "Building documentation for $PKG."
+                cd "$SAGE_ROOT/spkg/build/"
+                tar jxf "$SAGE_ROOT/spkg/standard/$PKG.spkg" 2>/dev/null
+                cd "$PKG" && "$INSTALL" ". $SPKG_INSTALL_SCRIPT 2>&1" "tee -a $SAGE_LOGS/$PKG-docs.log"
+                if [ $? -ne 0 ]; then
+                    echo "Warning: Error building documentation for $PKG."
+                    echo "Warning: Error building documentation for $PKG."  >> "$SAGE_LOGS/$PKG-docs.log"
+                else
+                    rm -rf "$SAGE_ROOT/spkg/build/$PKG/"
+                    echo "PACKAGE NAME: $PKG documentation" > "$installed_file"
+                    echo "INSTALL DATE: `date`" >> "$installed_file"
+                    echo "UNAME: `uname -a`" >> "$installed_file"
+                    if [ -f "$SAGE_ROOT"/VERSION.txt ]; then
+                        cat "$SAGE_ROOT"/VERSION.txt >> "$installed_file"
+                    fi
+                    echo "Successfully built and installed documentation for $PKG."
+                fi
+                echo "**************************************************"
+                echo -ne "Searching for documentation..."
+            else
+                echo -ne "."
+            fi
+        done
+        echo
+        echo
+    fi
+}
 
-# Skip the rest if nothing to do (i.e., to [re]build):
+# Skip everything (except building the spkg docs) 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
@@ -440 +492 @@
 # non-zero status which is not a problem.
 if make -q -f standard/deps $1; then
     echo "Nothing to (re)build / all up-to-date."
+    builddocs
     exit 0
 fi
 
-
 # Dump environment for debugging purposes:
 echo "*** ALL ENVIRONMENT VARIABLES BEFORE BUILD: ***"
 env
@@ -465 +517 @@
     exit 1
 fi
 
+builddocs
+
 cd "$SAGE_ROOT"
 
 # Rename makefile to Makefile (see #10156)