Rename SAGE_SRC_ROOT -> SAGE_VPATH

build/bin/sage-spkg

@@ -286,7 +286,7 @@ elif [ -z "$PKG_HAS_PATH" ]; then
     # we try to find a package in upstream
     PKG_VER="${PKG_NAME#${PKG_BASE}}"
     PKG_VER="${PKG_VER#-}"
-    PKG_SCRIPTS="$SAGE_SRC_ROOT/build/pkgs/$PKG_BASE"
+    PKG_SCRIPTS="$SAGE_VPATH/build/pkgs/$PKG_BASE"
     LOCAL_PKG_VER=`cat $PKG_SCRIPTS/package-version.txt 2>/dev/null`
     if [ -n "$LOCAL_PKG_VER" ] && [ -z "$PKG_VER" -o "$PKG_VER" = "$LOCAL_PKG_VER" ]; then
         PKG_VER="$LOCAL_PKG_VER"
@@ -674,7 +674,7 @@ write_script_wrapper() {
 #!/usr/bin/env bash
 
 export SAGE_ROOT="$SAGE_ROOT"
-export SAGE_SRC_ROOT="$SAGE_SRC_ROOT"
+export SAGE_VPATH="$SAGE_VPATH"
 export SAGE_SRC="$SAGE_SRC"
 export SAGE_PKG_DIR="$pkgdir"
 
@@ -684,7 +684,7 @@ export PKG_VER="$PKG_VER"
 
 for lib in env dist-helpers; do
     lib="sage-\$lib"
-    source "\$SAGE_SRC_ROOT/src/bin/\$lib"
+    source "\$SAGE_VPATH/src/bin/\$lib"
     if [ \$? -ne 0 ]; then
         echo >&2 "Error: failed to source \$lib"
         echo >&2 "Is \$SAGE_ROOT the correct SAGE_ROOT?"
@@ -867,7 +867,7 @@ cat > "$PKG_NAME_INSTALLED" << __EOF__
     "package_version": "$PKG_VER",
     "install_date": "$(date)",
     "system_uname": "$(uname -a)",
-    "sage_version": "$(cat "${SAGE_SRC_ROOT}/VERSION.txt")",
+    "sage_version": "$(cat "${SAGE_VPATH}/VERSION.txt")",
     "test_result": "$TEST_SUITE_RESULT"
 }
 __EOF__

build/make/deps

@@ -172,7 +172,7 @@ sagelib: \
 ###############################################################################
 
 # Don't just use "install" since we don't want to change permissions
-$(SAGE_LOCAL)/bin/%: $(SAGE_SRC_ROOT)/src/bin/%
+$(SAGE_LOCAL)/bin/%: $(SAGE_SRC)/bin/%
 	$(AM_V_at)cp $< $@
 
 SCRIPTS += $(SAGE_LOCAL)/bin/sage-env-config
@@ -237,7 +237,7 @@ doc-pdf: $(DOC_DEPENDENCIES)
 doc-clean: doc-src-clean doc-output-clean
 
 doc-src-clean:
-	cd "$(SAGE_SRC_ROOT)/src/doc" && $(MAKE) -f $(SAGE_SRC)/doc/Makefile clean
+	cd "$(SAGE_VPATH)/src/doc" && $(MAKE) -f $(SAGE_SRC)/doc/Makefile clean
 
 doc-output-clean:
 	rm -rf "$(SAGE_SHARE)/doc/sage"

build/make/install

@@ -7,25 +7,25 @@
 # Assume current directory is SAGE_ROOT/build/make
 export SAGE_ROOT=`cd ../.. && pwd -P`
 
-# Determine SAGE_LOCAL and SAGE_SRC_ROOT
+# Determine SAGE_LOCAL and SAGE_VPATH
 . "$SAGE_ROOT"/src/bin/sage-env-config
 if [ $? -ne 0 ]; then
     echo "Error: Failed to read sage-env-config.  Did you run configure?"
     exit 1
 fi
 
-export SAGE_SRC="$SAGE_SRC_ROOT/src"
+export SAGE_SRC="$SAGE_VPATH/src"
 export SAGE_SHARE="$SAGE_LOCAL/share"
 export SAGE_EXTCODE="$SAGE_SHARE/sage/ext"
 export SAGE_LOGS="$SAGE_ROOT/logs/pkgs"
 export SAGE_SPKG_INST="$SAGE_LOCAL/var/lib/sage/installed"
-export SAGE_VERSION=`cat $SAGE_SRC_ROOT/VERSION.txt | sed 's+.*\ \(.*\),.*+\1+'`
+export SAGE_VERSION=`cat $SAGE_VPATH/VERSION.txt | sed 's+.*\ \(.*\),.*+\1+'`
 
 if [ -z "${SAGE_ORIG_PATH_SET}" ]; then
     SAGE_ORIG_PATH=$PATH && export SAGE_ORIG_PATH
     SAGE_ORIG_PATH_SET=True && export SAGE_ORIG_PATH_SET
 fi
-export PATH="$SAGE_SRC_ROOT/build/bin:$SAGE_SRC/bin:$SAGE_ROOT/src/bin:$SAGE_LOCAL/bin:$PATH"
+export PATH="$SAGE_VPATH/build/bin:$SAGE_SRC/bin:$SAGE_ROOT/src/bin:$SAGE_LOCAL/bin:$PATH"
 
 export PYTHONPATH="$SAGE_LOCAL"
 

build/sage_bootstrap/creator.py

@@ -18,15 +18,15 @@
 import logging
 log = logging.getLogger()
 
-from sage_bootstrap.env import SAGE_SRC_ROOT
+from sage_bootstrap.env import SAGE_VPATH
 
 
 
 class PackageCreator(object):
 
     def __init__(self, package_name):
         self.package_name = package_name
-        self.path = os.path.join(SAGE_SRC_ROOT, 'build', 'pkgs', package_name)
+        self.path = os.path.join(SAGE_VPATH, 'build', 'pkgs', package_name)
         try:
             os.mkdir(self.path)
         except OSError:

build/sage_bootstrap/env.py

@@ -6,7 +6,7 @@
 variables:
 
 * ``SAGE_ROOT``
-* ``SAGE_SRC_ROOT``
+* ``SAGE_VPATH``
 * ``SAGE_SRC``
 * ``SAGE_DISTFILES``
 """
@@ -32,16 +32,16 @@
         os.path.abspath(__file__))))
 
 try:
-    SAGE_SRC_ROOT = os.environ['SAGE_SRC_ROOT']
+    SAGE_VPATH = os.environ['SAGE_VPATH']
 except KeyError:
-    SAGE_SRC_ROOT = SAGE_ROOT
+    SAGE_VPATH = SAGE_ROOT
 
 SAGE_SRC = os.environ.get('SAGE_SRC',
-    os.path.join(SAGE_SRC_ROOT, 'src'))
+    os.path.join(SAGE_VPATH, 'src'))
 SAGE_DISTFILES = os.environ.get('SAGE_DISTFILES',
     os.path.join(SAGE_ROOT, 'upstream'))
 
-assert os.path.isfile(os.path.join(SAGE_SRC_ROOT, 'configure.ac')), SAGE_SRC_ROOT
+assert os.path.isfile(os.path.join(SAGE_VPATH, 'configure.ac')), SAGE_VPATH
 # Check that SAGE_ROOT is the root of either a configured build directory
 # or the root of an unconfigured non-VPATH source directory.
 assert (os.path.isfile(os.path.join(SAGE_ROOT, 'config.status'))

build/sage_bootstrap/package.py

@@ -19,7 +19,7 @@
 import logging
 log = logging.getLogger()
 
-from sage_bootstrap.env import SAGE_SRC_ROOT, SAGE_DISTFILES
+from sage_bootstrap.env import SAGE_VPATH, SAGE_DISTFILES
 
 
 
@@ -30,7 +30,7 @@ def __init__(self, package_name):
         Sage Package
 
         A package is defined by a subdirectory of
-        ``SAGE_SRC_ROOT/build/pkgs/``. The name of the package is the name
+        ``SAGE_VPATH/build/pkgs/``. The name of the package is the name
         of the subdirectory; The metadata of the package is contained
         in various files in the package directory. This class provides
         an abstraction to the metadata, you should never need to
@@ -55,7 +55,7 @@ def name(self):
         Return the package name
 
          A package is defined by a subdirectory of
-        ``SAGE_SRC_ROOT/build/pkgs/``. The name of the package is the name
+        ``SAGE_VPATH/build/pkgs/``. The name of the package is the name
         of the subdirectory.
 
         OUTPUT:
@@ -179,7 +179,7 @@ def all(cls):
         """
         Return all packages
         """
-        base = os.path.join(SAGE_SRC_ROOT, 'build', 'pkgs')
+        base = os.path.join(SAGE_VPATH, 'build', 'pkgs')
         for subdir in os.listdir(base):
             path = os.path.join(base, subdir) 
             if not os.path.isfile(os.path.join(path, "checksums.ini")):
@@ -191,7 +191,7 @@ def path(self):
         """
         Return the package directory
         """
-        return os.path.join(SAGE_SRC_ROOT, 'build', 'pkgs', self.name)
+        return os.path.join(SAGE_VPATH, 'build', 'pkgs', self.name)
 
     def _init_checksum(self):
         """

configure.ac

@@ -93,8 +93,8 @@ SAGE_LOCAL="$prefix"
 if test "$SAGE_LOCAL" = NONE; then
     SAGE_LOCAL=local
 fi
-SAGE_SRC_ROOT=`cd $srcdir && pwd -P`
-SAGE_SRC="$SAGE_SRC_ROOT/src"
+SAGE_VPATH=`cd $srcdir && pwd -P`
+SAGE_SRC="$SAGE_VPATH/src"
 SAGE_SPKG_INST="$SAGE_LOCAL/var/lib/sage/installed"
 
 #---------------------------------------------------------
@@ -653,7 +653,7 @@ exec 7>build/make/Makefile
 cat >&7 <<EOF
 #==============================================================================
 # This file has been automatically generated by
-#   $SAGE_SRC_ROOT/configure
+#   $SAGE_VPATH/configure
 # You should not edit it by hand
 #==============================================================================
 
@@ -736,9 +736,9 @@ AC_MSG_RESULT([])
 # Print version number of latest package $pkg
 newest_version() {
     PKG=$1
-    if test -f "$SAGE_SRC_ROOT/build/pkgs/$PKG/package-version.txt" ; then
+    if test -f "$SAGE_VPATH/build/pkgs/$PKG/package-version.txt" ; then
         AS_ECHO_N(["$PKG-"])
-        cat "$SAGE_SRC_ROOT/build/pkgs/$PKG/package-version.txt"
+        cat "$SAGE_VPATH/build/pkgs/$PKG/package-version.txt"
     else
         echo "$PKG"
     fi
@@ -766,7 +766,7 @@ newest_version() {
 changequote(<,>)
 filtered_packages_list() {
     # for each package in pkgs/
-    for DIR in $SAGE_SRC_ROOT/build/pkgs/*; do
+    for DIR in $SAGE_VPATH/build/pkgs/*; do
         test -d "$DIR" || continue
 
         PKG_TYPE_FILE="$DIR/type"
@@ -914,7 +914,7 @@ cat >&7 <<EOF
 
 EOF
 
-cat "$SAGE_SRC_ROOT/build/make/deps" >&7
+cat "$SAGE_VPATH/build/make/deps" >&7
 # Copy build/make/deps
 
 cat >&7 <<EOF
@@ -932,8 +932,8 @@ while read PKG_NAME PKG_VERSION PKG_VAR; do
         # filtered_packages_list signals an error (already reported there)
         exit 1 # this doesn't leave 'configure' (yet)
     fi
-    DEP_FILE="$SAGE_SRC_ROOT/build/pkgs/$PKG_NAME/dependencies"
-    TYPE=`cat "$SAGE_SRC_ROOT/build/pkgs/$PKG_NAME/type"`
+    DEP_FILE="$SAGE_VPATH/build/pkgs/$PKG_NAME/dependencies"
+    TYPE=`cat "$SAGE_VPATH/build/pkgs/$PKG_NAME/type"`
     if [ -f "$DEP_FILE" ]; then
         # DEPS is first line of $DEP_FILE with some modifications:
         # - start with a single space
@@ -967,14 +967,14 @@ while read PKG_NAME PKG_VERSION PKG_VAR; do
         echo >&7 "$PKG_NAME:$DEPS"
         echo >&7 "	\$(A""M_V_at)cd '$SAGE_ROOT' && \\"
         echo >&7 "	    source '$SAGE_ROOT/src/bin/sage-env' && \\"
-        echo >&7 "	    sage-logger -p '$SAGE_SRC_ROOT/build/pkgs/$PKG_NAME/spkg-install' \$(SAGE_LOGS)/$PKG_NAME.log"
+        echo >&7 "	    sage-logger -p '$SAGE_VPATH/build/pkgs/$PKG_NAME/spkg-install' \$(SAGE_LOGS)/$PKG_NAME.log"
         echo >&7
 
         # Just run the spkg-uninstall script if it exists
         echo >&7 "$PKG_NAME-clean:"
         echo >&7 "	-\$(A""M_V_at)cd '$SAGE_ROOT' && \\"
         echo >&7 "	    source '$SAGE_ROOT/src/bin/sage-env' && \\"
-        echo >&7 "	    '$SAGE_SRC_ROOT/build/pkgs/$PKG_NAME/spkg-uninstall'"
+        echo >&7 "	    '$SAGE_VPATH/build/pkgs/$PKG_NAME/spkg-uninstall'"
         echo >&7
     else
         # Normal Sage packages
@@ -1041,11 +1041,11 @@ AS_IF([test x$srcdir != x.],
     [AC_CONFIG_COMMANDS([vpath],
 	[
 	    SAGE_ROOT=${ac_abs_top_builddir}
-	    SAGE_SRC_ROOT=${ac_abs_top_srcdir}
+	    SAGE_VPATH=${ac_abs_top_srcdir}
 	    # Assume that $srcdir is readonly, so symlink existing upstream files into build directory upstream
 	    # If new packages are downloaded, they end up in the build directory upstream.
 	    mkdir -p upstream
-	    for a in $SAGE_SRC_ROOT/upstream/* ; do
+	    for a in $SAGE_VPATH/upstream/* ; do
 		if test -f "$a" -a ! -f "upstream/`basename $a`" ; then
 		    ln -s "$a" upstream/
 		fi
@@ -1054,10 +1054,10 @@ AS_IF([test x$srcdir != x.],
 #!/usr/bin/env bash
 SAGE_ROOT="$SAGE_ROOT"
 export SAGE_ROOT
-exec "$SAGE_SRC_ROOT/src/bin/sage" "\@S|@@"
+exec "$SAGE_VPATH/src/bin/sage" "\@S|@@"
 EOF
 	    chmod +x sage
-	    sed "s|^top_srcdir =.*|top_srcdir = $SAGE_SRC_ROOT|" $srcdir/Makefile > Makefile
+	    sed "s|^top_srcdir =.*|top_srcdir = $SAGE_VPATH|" $srcdir/Makefile > Makefile
 	])
     ])
 

src/Makefile.in

@@ -34,7 +34,7 @@ sage:
 	cd $(srcdir) && export                                    \
 	    SAGE_ROOT=/doesnotexist                               \
 	    SAGE_SRC=/doesnotexist                                \
-	    SAGE_SRC_ROOT=/doesnotexist                           \
+	    SAGE_VPATH=/doesnotexist                              \
 	    SAGE_DOC_SRC=/doesnotexist                            \
 	    SAGE_BUILD_DIR=/doesnotexist                          \
 	    SAGE_PKGS=$(abs_top_srcdir)/build/pkgs                \

src/bin/sage-env

@@ -186,8 +186,8 @@ export SAGE_ENV_SOURCED=$SAGE_ENV_VERSION
 
 export SAGE_ROOT="$NEW_SAGE_ROOT"
 
-if [ -z "$SAGE_SRC_ROOT" ]; then
-    export SAGE_SRC_ROOT="$SAGE_ROOT"
+if [ -z "$SAGE_VPATH" ]; then
+    export SAGE_VPATH="$SAGE_ROOT"
 fi
 
 # sage-env must know where the Sage's script files are.
@@ -199,7 +199,7 @@ if [ -z "$SAGE_SCRIPTS_DIR" ]; then
         SAGE_SRC_SCRIPTS_DIR="$SAGE_LOCAL/bin"
     elif [ -f "$SAGE_ROOT/src/bin/sage-env-config" ]; then
         SAGE_SCRIPTS_DIR="$SAGE_ROOT/src/bin"
-        SAGE_SRC_SCRIPTS_DIR="$SAGE_SRC_ROOT/src/bin"
+        SAGE_SRC_SCRIPTS_DIR="$SAGE_VPATH/src/bin"
     else
         echo >&2 "Error: You must set either the SAGE_LOCAL or SAGE_SCRIPTS_DIR environment variable to run this"
         return 1
@@ -274,7 +274,7 @@ export SAGE_SHARE="$SAGE_LOCAL/share"
 export SAGE_EXTCODE="$SAGE_SHARE/sage/ext"
 export SAGE_SPKG_INST="$SAGE_LOCAL/var/lib/sage/installed"
 export SAGE_LOGS="$SAGE_ROOT/logs/pkgs"
-export SAGE_SRC="$SAGE_SRC_ROOT/src"
+export SAGE_SRC="$SAGE_VPATH/src"
 export SAGE_DOC_SRC="$SAGE_SRC/doc"
 export SAGE_DOC="$SAGE_SHARE/doc/sage"
 

src/bin/sage-env-config.in

@@ -15,9 +15,9 @@
 #
 ##########################################################################
 
-# SAGE_SRC_ROOT is the root of the Sage distribution source tree.
+# SAGE_VPATH is the root of the Sage distribution source tree.
 # For non-VPATH builds, it is the same as SAGE_ROOT.
-export SAGE_SRC_ROOT="@abs_top_srcdir@"
+export SAGE_VPATH="@abs_top_srcdir@"
 
 # SAGE_LOCAL is the installation prefix and can be customized by using
 # ./configure --prefix

src/bin/sage-starts

@@ -14,7 +14,7 @@ echo "[`date +'%Y-%m-%d %H:%M:%S'`] `cat VERSION.txt 2>/dev/null`" | tee -a logs
 # sysadmin.  We use --nodotsage so we don't force a .sage directory
 # in the sysadmin's HOME directory.
 cmd='sage.all._write_started_file(); print "Yes, Sage starts."'
-"$SAGE_SRC_ROOT"/build/bin/sage-logger "./sage --nodotsage -c '$cmd'" logs/start.log
+"$SAGE_VPATH"/build/bin/sage-logger "./sage --nodotsage -c '$cmd'" logs/start.log
 
 if [ $? -ne 0 ]; then
     echo >&2 "Sage failed to start up."

src/doc/common/conf.py

@@ -1,10 +1,10 @@
 import sys, os, sphinx
-from sage.env import SAGE_DOC_SRC, SAGE_DOC, SAGE_SRC_ROOT, THEBE_DIR
+from sage.env import SAGE_DOC_SRC, SAGE_DOC, SAGE_VPATH, THEBE_DIR
 from datetime import date
 from six import iteritems
 
 # If your extensions are in another directory, add it here.
-sys.path.append(os.path.join(SAGE_SRC_ROOT, "src", "sage_setup", "docbuild", "ext"))
+sys.path.append(os.path.join(SAGE_VPATH, "src", "sage_setup", "docbuild", "ext"))
 
 # General configuration
 # ---------------------

src/sage/env.py

@@ -118,13 +118,13 @@ def _add_variable_or_fallback(key, fallback, force=False):
 
 # bunch of sage directories and files
 _add_variable_or_fallback('SAGE_ROOT',       None)
-_add_variable_or_fallback('SAGE_SRC_ROOT',   None)
+_add_variable_or_fallback('SAGE_VPATH',   None)
 _add_variable_or_fallback('SAGE_LOCAL',      None)
 _add_variable_or_fallback('SAGE_ETC',        opj('$SAGE_LOCAL', 'etc'))
 _add_variable_or_fallback('SAGE_INC',        opj('$SAGE_LOCAL', 'include'))
 _add_variable_or_fallback('SAGE_SHARE',      opj('$SAGE_LOCAL', 'share'))
 
-_add_variable_or_fallback('SAGE_SRC',        opj('$SAGE_SRC_ROOT', 'src'))
+_add_variable_or_fallback('SAGE_SRC',        opj('$SAGE_VPATH', 'src'))
 
 try:
     sitepackages_dirs = site.getsitepackages()
@@ -137,8 +137,8 @@ def _add_variable_or_fallback(key, fallback, force=False):
 
 _add_variable_or_fallback('SAGE_CYTHONIZED', opj('$SAGE_ROOT', 'src', 'build', 'cythonized'))
 
-# Used by sage/misc/package.py.  Should be SAGE_SRC_ROOT in VPATH.
-_add_variable_or_fallback('SAGE_PKGS', opj('$SAGE_SRC_ROOT', 'build', 'pkgs'))
+# Used by sage/misc/package.py.  Should be SAGE_VPATH in VPATH.
+_add_variable_or_fallback('SAGE_PKGS', opj('$SAGE_VPATH', 'build', 'pkgs'))
 
 
 _add_variable_or_fallback('SAGE_EXTCODE',    opj('$SAGE_SHARE', 'sage', 'ext'))
@@ -147,7 +147,7 @@ def _add_variable_or_fallback(key, fallback, force=False):
 _add_variable_or_fallback('SAGE_DOC_SRC',    opj('$SAGE_SRC', 'doc'))
 _add_variable_or_fallback('SAGE_DOC',        opj('$SAGE_SHARE', 'doc', 'sage'))
 _add_variable_or_fallback('DOT_SAGE',        opj(os.environ.get('HOME','$SAGE_ROOT'), '.sage'))
-_add_variable_or_fallback('SAGE_DOT_GIT',    opj('$SAGE_SRC_ROOT', '.git'))
+_add_variable_or_fallback('SAGE_DOT_GIT',    opj('$SAGE_VPATH', '.git'))
 _add_variable_or_fallback('SAGE_DISTFILES',  opj('$SAGE_ROOT', 'upstream'))
 
 # misc

src/sage/misc/package.py

@@ -337,7 +337,7 @@ def package_versions(package_type, local=False):
     are of the form ``'package': (installed, latest)``, where
     ``installed`` is the installed version (or ``None`` if not
     installed) and ``latest`` is the latest available version. If the
-    package has a directory in ``SAGE_SRC_ROOT/build/pkgs/``, then
+    package has a directory in ``SAGE_VPATH/build/pkgs/``, then
     ``latest`` is determined by the file ``package-version.txt`` in
     that directory.  If ``local`` is ``False``, then Sage's servers are
     queried for package information.