#8263: Document ALL environment variables used by Sage
-----------------------------+----------------------------------------------
Reporter: drkirkby | Owner: mvngu
Type: defect | Status: new
Priority: major | Milestone: sage-4.4
Component: documentation | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Description changed by mvngu:
Old description:
> Few if any environment variables are documented fully. #8262 is supposed
> to do this for MAKE_CHECK, but I'm aware of some others which need
> documenting.
>
> * SAGE_PORT (Allows one to build on any rare (unsupported) platform,
> like AIX, FreeBSD, HP-UX, Solaris on x86 hardware etc.
> * SAGE_USE_OLD_GCC (Allows use of gcc 3.4.x)
> * CFLAG64 (Flag to build 64-bit binary, defaults to -m64)
> * SAGE_ATLAS_LIB (I've not much idea, but found it when looking)
> * INCLUDE_MPFR_PATCH - (Adds a patch to MPFR to bypass a bug in the
> Solaris memset on sun4v machines. Note, if Sun patch 142542-01 is
> installed on sun4v machines, this is not needed, as that fixes the bug.
> Values are:
> * INCLUDE_MPFR_PATCH=0 will never include the patch - useful if you
> know any sun4v machines MPFR will be used on, are patched.
> * INCLUDE_MPFR_PATCH=1 will include, so binary will work on a sun4v
> machine, even if created on an older sun4u machine.
> * If unset, will include patch on sun4v machines only.
> * SAGE_FAT_BINARY
> * Some VALGRIND variable - perhaps SAGE_VALGRIND.
>
> From sage-doctest -- these are the times, specified in seconds, used by
> sage -t, sage -t -long, and sage -t -valgrind (and other similar tools),
> to determine when a doctest times out:
>
> * SAGE_TIMEOUT, default 360 seconds (6 minutes)
> * SAGE_TIMEOUT_LONG, default 1800 seconds (30 minutes)
> * SAGE_TIMEOUT_VALGRIND, default 1024 * 1024 seconds
>
> There are probably others too. Some like CC, are fairly obvious, but in
> many cases do not work, so in some ways, they might be best either
> undocumented, or documented with a warning that not all packages accept
> them.
>
> Some, like SAGE_PORT and SAGE_USE_OLD_GCC are sort of self-documenting,
> as the build of Sage will quickly terminate if these need to be set, and
> how to set them is fully explained.
>
> Perhaps others can update this list with others.
New description:
Few if any environment variables are documented fully. #8262 is supposed
to do this for MAKE_CHECK, but I'm aware of some others which need
documenting.
* SAGE_PORT (Allows one to build on any rare (unsupported) platform, like
AIX, FreeBSD, HP-UX, Solaris on x86 hardware etc.
* SAGE_USE_OLD_GCC (Allows use of gcc 3.4.x)
* CFLAG64 (Flag to build 64-bit binary, defaults to -m64)
* SAGE_ATLAS_LIB (I've not much idea, but found it when looking)
* INCLUDE_MPFR_PATCH - (Adds a patch to MPFR to bypass a bug in the
Solaris memset on sun4v machines. Note, if Sun patch 142542-01 is
installed on sun4v machines, this is not needed, as that fixes the bug.
Values are:
* INCLUDE_MPFR_PATCH=0 will never include the patch - useful if you
know any sun4v machines MPFR will be used on, are patched.
* INCLUDE_MPFR_PATCH=1 will include, so binary will work on a sun4v
machine, even if created on an older sun4u machine.
* If unset, will include patch on sun4v machines only.
* SAGE_FAT_BINARY
* Some VALGRIND variable - perhaps SAGE_VALGRIND.
From sage-doctest -- these are the times, specified in seconds, used by
sage -t, sage -t -long, and sage -t -valgrind (and other similar tools),
to determine when a doctest times out:
* SAGE_DOCTEST_ALLOW_TABS --- introduced by #8680
* SAGE_TIMEOUT, default 360 seconds (6 minutes)
* SAGE_TIMEOUT_LONG, default 1800 seconds (30 minutes)
* SAGE_TIMEOUT_VALGRIND, default 1024 * 1024 seconds
There are probably others too. Some like CC, are fairly obvious, but in
many cases do not work, so in some ways, they might be best either
undocumented, or documented with a warning that not all packages accept
them.
Some, like SAGE_PORT and SAGE_USE_OLD_GCC are sort of self-documenting, as
the build of Sage will quickly terminate if these need to be set, and how
to set them is fully explained.
Perhaps others can update this list with others.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8263#comment:3>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
