Ticket #11321: trac_11321-reviewer_part1-document_patches_and_further_clean-up.spkg.patch

SPKG.txt

@@ -23 +23 @@
 
 == Dependencies ==
 
- * MPIR
+ * GMP/MPIR
  * MPFR
  * PARI
+ * GNU patch (shipped with Sage)
 
 == Special Update/Build Instructions ==
 
-There is some garbage in the upstream sources:
-src/include/.Lexplicit_formula.h.swp
-src/include/.Lvalue.h.swp
-src/include/._.DS_Store
-src/include/.DS_Store
-src/include/Lexplicit_formula.h.swap.crap
-src/include/Lvalue.h.bak
-src/src/.Makefile.old.swp
-src/src/._.DS_Store
-src/src/.DS_Store
-src/src/.Lcommandline.ggo.swp
-src/src/libLfunction.a
+ * There is some garbage in the upstream sources:
+     src/include/.Lexplicit_formula.h.swp
+     src/include/.Lvalue.h.swp
+     src/include/._.DS_Store
+     src/include/.DS_Store
+     src/include/Lexplicit_formula.h.swap.crap
+     src/include/Lvalue.h.bak
+     src/src/Makefile.old
+     src/src/.Makefile.old.swp
+     src/src/._.DS_Store
+     src/src/.DS_Store
+     src/src/.Lcommandline.ggo.swp
+     src/src/libLfunction.a
+ * Make sure the patches still apply cleanly.
+ * TODO / FIXME:
+   The (upstream) Makefile uses $(CC) to compile C++ (also using $(CCFLAGS)),
+   which it defines to 'g++', and hardcodes 'g++' when linking the shared
+   library. (It should use $(CXX) instead, which might *default* to 'g++'.)
+
+=== Patches ===
+
+ * Lcommon.h.patch:
+   Uncomment the definition of lcalc_to_double(const long double& x).
+   (Necessary for GCC >= 4.6.0, cf. #10892.)
+   Comment from there:
+     The reason is the following code horror from src/src/include/Lcommon.h:
+     [...]
+     But somebody who is familiar with the codebase should really rewrite lcalc
+     to not redefine the double() cast, thats just fragile and will sooner or
+     later again fail inside some system headers.
+ * Makefile.patch:
+   We change a lot there, since Lcalc doesn't have a 'configure' script,
+   and hence the Makefile is supposed to be edited to customize Lcalc (build
+   options, locations of headers and libraries etc.).
+   Besides that, we
+   - put CXXFLAGS into Lcalc's "CCFLAGS" used for compiling C++,
+   - remove some stuff involving LDFLAGS1 and LDFLAGS2, setting just LDFLAGS,
+   - use $(MAKE) instead of 'make' in the crude build receipts,
+   - use CXXFLAG64 when linking the shared library.
+ * pari-2.4.4.patch: 
+   Use allocatemem() instead of allocatemoremem() which the new PARI no
+   longer supports. (The former isn't supported by older versions of PARI
+   though; cf. #11321.)
+ * time.h.patch:
+   Include also <time.h> in Lcommandline_numbertheory.h (at least required
+   on Cygwin, cf. #9845).
+   This should get reported upstream.
 
 == Changelog ==
 

spkg-install

@@ -1 +1 @@
 #!/usr/bin/env bash
 
-if [ -z "$SAGE_LOCAL" ] ; then 
-  echo >&2 "SAGE_LOCAL undefined ... exiting"; 
-  echo >&2 "Maybe run 'sage -sh'?" 
-  exit 1 
+if [ -z "$SAGE_LOCAL" ]; then 
+    echo >&2 "Error: SAGE_LOCAL undefined ... exiting"
+    echo >&2 "Maybe run 'sage -sh'?" 
+    exit 1 
 fi
 
 # Add a sensible default optimisation flag. Change if necessary.
 OPTIMIZATION_FLAGS="-O3"
 
-# Most packages do not need all these set
-# But it is better to do them all each time, rather than ommit
-# a flag by mistake.
+# Most packages do not need all these set, but it is better to do them all
+# each time, rather than omit a flag by mistake:
 
-CFLAGS="$CFLAGS $OPTIMIZATION_FLAGS "
-CXXFLAGS="$CXXFLAGS $OPTIMIZATION_FLAGS "
-FCFLAGS="$FCFLAGS $OPTIMIZATION_FLAGS "
-F77FLAGS="$F77FLAGS $OPTIMIZATION_FLAGS "
-CPPFLAGS="$CPPFLAGS -I$SAGE_LOCAL/include"
-LDFLAGS="$LDFLAGS -L$SAGE_LOCAL/lib"
+CFLAGS="$OPTIMIZATION_FLAGS $CFLAGS"
+CXXFLAGS="$OPTIMIZATION_FLAGS $CXXFLAGS"
+FCFLAGS="$OPTIMIZATION_FLAGS $FCFLAGS"
+F77FLAGS="$OPTIMIZATION_FLAGS $F77FLAGS"
+CPPFLAGS="-I$SAGE_LOCAL/include $CPPFLAGS"
+LDFLAGS="-L$SAGE_LOCAL/lib $LDFLAGS"
 
 
-# Compile for 64-bit if SAGE64 is set to 'yes' 
-if [ "x$SAGE64" = xyes ]  ; then
-   echo >&2 "Building a 64-bit version of lcalc"
+# Compile for 64-bit if SAGE64 is set to 'yes':
+if [ "x$SAGE64" = xyes ]; then
+    echo >&2 "Building a 64-bit version of lcalc"
 
-   # Both Sun and GNU compilers use -m64 to build 64-bit code,
-   # but compilers from IBM (on AIX), and HP (on HP-UX) 
-   # do not. So allow the environment
-   # variables CFLAG64 and CXXFLAG64 to set the flag to whatever
-   # option the C and C++ compilers want for 64-bit code. If not default to -m64. 
+    # Both Sun and GNU compilers use -m64 to build 64-bit code, but compilers
+    # from IBM (on AIX), and HP (on HP-UX) do not. So allow the environment
+    # variables CFLAG64 and CXXFLAG64 to set the flag to whatever option the
+    # C and C++ compilers want for 64-bit code. If not set, default to -m64.
 
-   if [ -z "$CFLAG64" ] ; then
-      CFLAG64=-m64
-   fi 
+    if [ -z "$CFLAG64" ]; then
+        CFLAG64=-m64
+    fi 
+    if [ -z "$CXXFLAG64" ]; then
+        CXXFLAG64="$CFLAG64" # default to that of the C compiler
+    fi 
+    export CFLAG64
+    export CXXFLAG64
 
-   if [ -z "$CXXFLAG64" ] ; then
-      CXXFLAG64=-m64
-   fi 
-   export CFLAG64
-   export CXXFLAG64
-
-   CFLAGS="$CFLAGS $CFLAG64 "
-   CXXFLAGS="$CXXFLAGS $CXXFLAG64 "
-   FCFLAGS="$FCFLAGS $CXXFLAG64 "
-   F77FLAGS="$F77FLAGS $CXXFLAG64 "
-   # Some packages may need LDFLAGS and/or ABI set here. 
-   # LDFLAGS="$LDFLAGS -m64 "
-   # ABI=64
-   # Normally one would just add this to CXXFLAGS, but since the Makefile
-   # does not import CXXFLAGS properly, and it would take a major change to 
-   # sort out the Makefile properly, the variable can just be added here, 
-   # and ${CXXFLAG64} added at the right point in the Makefile for 64-bit builds. 
+    CFLAGS="$CFLAGS $CFLAG64"
+    CXXFLAGS="$CXXFLAGS $CXXFLAG64"
+    FCFLAGS="$FCFLAGS $CXXFLAG64" # XXX Does this make sense?
+    F77FLAGS="$F77FLAGS $CXXFLAG64"
+    # Some packages may need LDFLAGS and/or ABI set here.
+    # LDFLAGS="$LDFLAGS $CFLAG64" # XXX Perhaps should use some LDFLAG64.
+    # ABI=64
+    # Normally one would just add this to CXXFLAGS, but since the Makefile
+    # does not import CXXFLAGS properly, and it would take a major change to
+    # sort out the Makefile properly, the variable can just be added here,
+    # and ${CXXFLAG64} added at the right point in the Makefile for 64-bit
+    # builds.
+    # (The last sentence apparently refers to CXXFLAG64 only. -leif)
 fi
 
 # If SAGE_DEBUG is set to 'yes', add debugging information.  Since both
 # the Sun and GNU compilers accept -g to give debugging information,
 # there is no need to do anything specific to one compiler or the other.
 
-if [ "x$SAGE_DEBUG" = xyes ] ; then
-    echo >&2 "Code will be built with debugging information present. Unset 'SAGE_DEBUG'"
+if [ "x$SAGE_DEBUG" = xyes ]; then
+    echo >&2 "Code will be built with debugging information present." \
+             "Unset 'SAGE_DEBUG'"
     echo >&2 "or set it to 'no' if you don't want that."
 
-    CFLAGS="$CFLAGS -g "
-    CXXFLAGS="$CXXFLAGS -g "
-    FCFLAGS="$FCFLAGS -g "
-    F77FLAGS="$F77FLAGS -g "
+    CFLAGS="$CFLAGS -g"
+    CXXFLAGS="$CXXFLAGS -g"
+    FCFLAGS="$FCFLAGS -g"
+    F77FLAGS="$F77FLAGS -g"
 else
-    echo >&2 "No debugging information will be used during the build of this package."
-    echo >&2 "Set 'SAGE_DEBUG' to 'yes' if you want debugging information present (-g added)."
+    echo >&2 "No debugging information will be used during the build of" \
+             "this package."
+    echo >&2 "Set 'SAGE_DEBUG' to 'yes' if you want debugging information" \
+             "present (-g added)."
 fi
 
 # Add appropriate flag(s) to show all warnings.
-# This test of a compiler is not perfect by any means, but
-# is better than nothing.
+# This test of a compiler is not perfect by any means, but is better than
+# nothing:
 
-if $CC -flags > /dev/null 2>&1 ; then
-   SUN_COMPILER=1
-   # The Sun compilers are fussy, and adding extra
-   # warnings will just show too many.
+if $CC -flags >/dev/null 2>&1; then
+    SUN_COMPILER=1
+    # The Sun compilers are fussy, and adding extra
+    # warnings will just show too many.
 else
-   # Assume gcc if not the Sun C compiler.
-   # Add -Wall to show all warnings. 
-   CFLAGS="$CFLAGS -Wall "
-   CXXFLAGS="$CXXFLAGS -Wall "
-   FCFLAGS="$FCFLAGS -Wall "
-   F77FLAGS="$F77FLAGS -Wall "
-   GNU_COMPILER=1
+    # Assume gcc if not the Sun C compiler.
+    GNU_COMPILER=1
+    # Add -Wall to show all warnings.
+    CFLAGS="-Wall $CFLAGS"
+    CXXFLAGS="-Wall $CXXFLAGS"
+    FCFLAGS="-Wall $FCFLAGS"
+    F77FLAGS="-Wall $F77FLAGS"
 fi
 
-# Determine if the C++ compiler is the Sun or GNU compiler
-# Just to check we are not mising GNU and non-GNU. 
-if $CXX -flags > /dev/null 2>&1 ; then
-   SUN_COMPILER=1
+# Determine if the C++ compiler is the Sun or GNU compiler,
+# just to check we are not mixing GNU and non-GNU:
+if $CXX -flags >/dev/null 2>&1; then
+    SUN_COMPILER=1
 else
-   GNU_COMPILER=1
+    # Assume gcc/g++ if not the Sun C++ compiler.
+    GNU_COMPILER=1
 fi
 
-# Determine if the Fortran compiler is the Sun or GNU compiler
-if [ -z "$SAGE_FORTRAN" ] ; then
-   echo >&2 "No Fortran compiler has been defined. This is not normally a problem."
+# Determine if the Fortran compiler is the Sun or GNU compiler:
+if [ -z "$SAGE_FORTRAN" ]; then
+    echo >&2 "No Fortran compiler has been defined." \
+             "This is not normally a problem."
 else
-   if $SAGE_FORTRAN -flags > /dev/null 2>&1 ;  then
-      SUN_COMPILER=1
-   else
-      GNU_COMPILER=1
-   fi
+    if $SAGE_FORTRAN -flags >/dev/null 2>&1; then
+        SUN_COMPILER=1
+    else
+        GNU_COMPILER=1
+    fi
 fi
 
-
-# Check if SAGE_FORTRAN_LIB is defined, that the file actually exists. 
-# SAGE_FORTRAN_LIB does not always need to be defined, but if it is defined, then
-# the file should exist. 
-if [ -n "$SAGE_FORTRAN_LIB" ] &&  [ ! -r "$SAGE_FORTRAN_LIB" ]; then
-    echo >&2 "SAGE_FORTRAN_LIB is defined as $SAGE_FORTRAN_LIB,"
-    echo >&2 "but that file does not exist."
+# Check if SAGE_FORTRAN_LIB is defined, that the file actually exists.
+# SAGE_FORTRAN_LIB does not always need to be defined, but if it is defined,
+# then the file should exist.
+if [ -n "$SAGE_FORTRAN_LIB" ] && [ ! -r "$SAGE_FORTRAN_LIB" ]; then
+    echo >&2 "Error: SAGE_FORTRAN_LIB is defined as '$SAGE_FORTRAN_LIB',"
+    echo >&2 "but that file does not exist (or isn't readable)."
     exit 1
 fi
 
 # Checks that the user is not mixing the Sun and GNU compilers. This problem
 # has been seen on code built with the aid of SCons, but in general could
 # happen with any code if the user has specified a C compiler but not a C++ one.
-# This problem is even more likely to occur with the Fortran compiler - I've done
-# it myself when building Sage!
-
-if [ "x$SUN_COMPILER" = "x1" ] && [ "x$GNU_COMPILER" = "x1" ] ; then
-    echo >&2 "You are mixing the Sun and GNU C/C++/Fortran compilers"
+# This problem is even more likely to occur with the Fortran compiler - I've
+# done it myself when building Sage!
+if [ "x$SUN_COMPILER" = "x1" ] && [ "x$GNU_COMPILER" = "x1" ]; then
+    echo >&2 "Error: You are mixing the Sun and GNU C/C++/Fortran compilers."
     echo >&2 "Such a combination will lead to problems."
-    echo >&2 "Check CC, CXX & SAGE_FORTRAN carefully."
+    echo >&2 "Check the environment variables CC, CXX & SAGE_FORTRAN" \
+             "carefully."
     echo >&2 "Exiting ..."
     exit 1
 fi
 
-# These are all used by GNU to specify compilers. 
+echo "The following environment variables will be exported:"
+
+# These are all used by GNU to specify compilers:
 echo "Using CC=$CC"
 echo "Using CXX=$CXX"
 echo "Using FC=$FC"
 echo "Using F77=$F77"
 
-# Used by Sage in connection with Fortran
+# Usually, one would add LD here, too.
+echo "Using MAKE=$MAKE"
+
+# Used by Sage in connection with Fortran:
 echo "Using SAGE_FORTRAN=$SAGE_FORTRAN"
 echo "Using SAGE_FORTRAN_LIB=$SAGE_FORTRAN_LIB"
 
-# Flags which may be set. 
-echo "The following environment variables will be exported"
+# Flags which may be set:
 echo "Using CFLAG64=$CFLAG64"
 echo "Using CXXFLAG64=$CXXFLAG64"
 echo "Using CFLAGS=$CFLAGS"
@@ -153 +160 @@
 echo "Using CPPFLAGS=$CPPFLAGS"
 echo "Using LDFLAGS=$LDFLAGS"
 echo "Using ABI=$ABI"
-echo "configure scripts and/or makefiles might override these later"
+echo "'configure' scripts and/or makefiles might override these later."
 echo " "
 
-# export everything. Probably not necessary in most cases. 
+# Export everything. Probably not necessary in most cases.
 export CFLAGS
 export CXXFLAGS
 export FCFLAGS
@@ -164 +171 @@
 export CPPFLAGS
 export LDFLAGS
 export ABI
+# (Variables like CC, CXX etc. have already been exported by 'sage-env'.)
 
-# End of pretty general spkg-install file. 
-# Now do the specific things needed for this package (lcalc)
+# End of pretty general spkg-install file.
+# Now do the specific things needed for this package (lcalc).
 
 success() {
     if [ $? -ne 0 ]; then
-        echo >&2 "Error building lcalc '$1'"
+        echo >&2 "Error building the Lcalc package: '$1'"
         exit 1
     fi
 }
@@ -179 +187 @@
 
 cd src
 
-# Apply Sage specific patches
+# Apply Sage-specific patches: (See SPKG.txt for details on the patches.)
+echo >&2 "Patching the upstream source code for Sage..."
 for patch in ../patches/*.patch; do
     patch -p1 <"$patch"
-    success "patch $patch failed"
+    success "patch $patch failed to apply"
 done
 
+# There's currently no 'configure' script for Lcalc; we (also) configure
+# it by patching the Makefile. This may change in a later release of Lcalc.
 
-cd src   # Now we are in src/src
+cd src   # Now we are in src/src.
 
-# Build everything
+# Build everything:
+echo >&2 "Now building lcalc, example programs and the shared library..."
 $MAKE
 success 'make'
 
-echo >&2 "Now copying over lcalc binary"
+echo >&2 "Now copying over lcalc binary..."
 cp lcalc "$SAGE_LOCAL"/bin
 success 'copying binary'
 
-echo >&2 "Now copying over lcalc library"
+echo >&2 "Now copying over lcalc library..."
 
-#Remove next few lines  when OSX 10.4 is no longer supported
-#10.4 does not seem to compile with .so extension in the library files
+# Remove next few lines when MacOS X 10.4 (Darwin 8) is no longer supported.
+# 10.4 does not seem to compile with .so extension in the library files.
 if [ "$UNAME" = "Darwin" ]; then
     if [ `sysctl -n kern.osrelease | cut -d . -f 1` -lt 9 ]; then
         cp libLfunction.so "$SAGE_LOCAL"/lib/libLfunction.dylib 
         success "copying libLfunction.dylib"
     fi
-fi #End of Mac OS X 10.4 specific instructions
+fi # End of MacOS X 10.4 specific instructions
 
 
 if [ "$UNAME" = "CYGWIN" ]; then
@@ -215 +227 @@
 fi
 success "copying libLfunction.so"
 
-echo >&2 "Now copying over lcalc library header files"
+echo >&2 "Now copying over lcalc library header files..."
 rm -fr "$SAGE_LOCAL"/include/lcalc
 mkdir -p "$SAGE_LOCAL"/include/lcalc
 cp ../include/* "$SAGE_LOCAL"/include/lcalc
-success 'install'
+success 'copying header files'