Ticket #10176: trac_10176-further_improve_spkg_install-spkg.patch

setup.py

@@ -5 +5 @@
 import os, sys, time
 from setuptools import setup
 
+
+import distutils.log
+
+if os.environ.get("SAGE_SETUPTOOLS_DEBUG","no")=="yes":
+    distutils.log.set_threshold(distutils.log.DEBUG)
+
+
 def all_files(dir, lstrip):
     """
     Return list of all filenames in the given directory, with lstrip
@@ -21 +28 @@
     
 
 code = setup(name = 'sagenb',
-      version     = '0.8.7.p1',  # the spkg-dist script assumes single quotes here
+      version     = '0.8.7.p2',  # the spkg-dist script assumes single quotes here
       description = 'The Sage Notebook',
       license     = 'GNU Public License (GPL) v2+',
       author      = 'William Stein et al.',

spkg-dist

@@ -77 +77 @@
 
 os.chdir(os.path.pardir)
 
+# Write the whole file from a single raw Python string:
+# (The #! has to be on the first line of the script.)
 spkg_install_fd.write(
 r"""#!/usr/bin/env bash
 
@@ -92 +94 @@
 cd sagenb
 python setup.py install
 if [ $? -ne 0 ]; then
-    echo "Error running setup.py install"
+    echo "Error running 'setup.py install'."
     exit 1
 fi
 
-mkdir -p "$SAGE_ROOT/devel"
+mkdir -p "$SAGE_ROOT/devel" # Create if it doesn't already exist
 
-echo "Copying SageNB package to '$SAGE_ROOT/devel/sagenb-main'."
+echo "Copying SageNB package to '$SAGE_ROOT/devel/sagenb-main'..."
+
 if [ -d "$SAGE_ROOT/devel/sagenb-main" ]; then
-    echo "Moving old SageNB package to '$SAGE_ROOT/devel/sagenb-main-old'."
+    echo "Moving old SageNB package to '$SAGE_ROOT/devel/sagenb-main-old'..."
     rm -rf "$SAGE_ROOT/devel/sagenb-main-old"
     mv "$SAGE_ROOT/devel/sagenb-main" "$SAGE_ROOT/devel/sagenb-main-old"
+    if [ $? -ne 0 ]; then
+        echo "Error moving the old 'sagenb-main' branch."
+        exit 1
+    fi
 fi
 
-# Rather than copying, we now use 'mv' above, so nothing to delete here:
-# rm -rf "$SAGE_ROOT/devel/sagenb" # Should point to sagenb-main if it exists
+rm -f "$SAGE_ROOT/devel/sagenb" # Delete just the link itself (if it exists)
 
-cd ..
-cp -pr sagenb "$SAGE_ROOT/devel/sagenb-main"
+cd .. # Back to sagenb-x.y.z/src/
+cp -pr sagenb "$SAGE_ROOT/devel/sagenb-main" # Creates new sagenb-main dir
+if [ $? -ne 0 ]; then
+    echo "Error copying the new SageNB package."
+    exit 1
+fi
 
 cd "$SAGE_ROOT/devel"
-ln -snf sagenb-main sagenb
+ln -s sagenb-main sagenb # Create new symbolic link (deleted above)
+if [ $? -ne 0 ]; then
+    echo "Error creating symbolic link to '$SAGE_ROOT/devel/sagenb-main'."
+    exit 1
+fi
 
 # We use relative paths for relocatability.
 cd "$SAGE_ROOT/devel/sagenb"
 python setup.py develop --egg-path ../../../../devel/sagenb
 if [ $? -ne 0 ]; then
-    echo "Error running setup.py develop"
+    echo "Error running 'setup.py develop'."
     exit 1
 fi
 
@@ -127 +141 @@
 # doesn't understand "-q" (which *is* POSIX):
 if ! grep sagenb easy-install.pth >/dev/null; then
     # Ugly work-around, we haven't found the real cause yet (see #10176):
-    echo 'No sagenb path found in easy-install.pth!'
-    echo "Adding relative sagenb path to easy-install.pth"
+    echo "No sagenb path found in 'easy-install.pth'"'!'
+    echo "Adding relative sagenb path to 'easy-install.pth'..."
     sed -e '$ i \../../../../devel/sagenb' easy-install.pth > easy-install.pth.$$
     if [ $? -ne 0 ]; then
-        echo "Error adding relative sagenb path to easy-install.pth"
+        echo "Error adding relative sagenb path to 'easy-install.pth'."
         exit 1
     fi
 else
-    echo "Making sagenb path in easy-install.pth relative"
+    echo "Making sagenb path in 'easy-install.pth' relative..."
     sed 's/^.*sagenb.*$/..\/..\/..\/..\/devel\/sagenb/' easy-install.pth > easy-install.pth.$$
     if [ $? -ne 0 ]; then
-        echo "Error patching easy-install.pth to have relative path to SageNB"
+        echo "Error patching 'easy-install.pth' to have relative path to SageNB."
         exit 1
     fi
 fi
-if true; then # DEBUG (cf. #10176)
+if true; then # Aids debugging (cf. #10176)
     echo "Old path: \"`grep sagenb easy-install.pth`\""
     echo "New path: \"`grep sagenb easy-install.pth.$$`\""
 fi
 # The following fails only on wrong file permissions etc.:
 mv -f easy-install.pth.$$ easy-install.pth
 if [ $? -ne 0 ]; then
-    echo "Error overwriting original easy-install.pth"
+    echo "Error overwriting original 'easy-install.pth'."
     exit 1
 fi
 """)