Ticket #9440 (new enhancement)

Opened 3 years ago

Last modified 3 years ago

document more environment variables

Reported by: jhpalmieri Owned by: mvngu
Priority: minor Milestone: sage-5.10
Component: documentation Keywords:
Cc: leif Work issues:
Report Upstream: N/A Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description

In ticket #8263, we missed these:

  • SAGE_DOC_JSMATH - should force docs to be built using jsMath
  • SAGE_DOCBUILD_OPTS - passed as an argument to sage --docbuild in the main Sage makefile.

Change History

comment:1 Changed 3 years ago by leif

  • Cc leif added

I'm quite sure there are more missing... ;-)

comment:2 Changed 3 years ago by leif

TODO:

  • Add PARI_EXTRA_OPTS, which is passed to PARI's Configure when building Sage / installing the PARI spkg.
  • Add CPPFLAGS, LDFLAGS, CXXFLAG64?, LDFLAG64? LD?
  • Document that (e.g.) export CFLAGS="" has not the same effect as unset CFLAGS.
  • Add note on not putting a space between -j and NUM in the description of MAKE, because doing so has a "completely" different meaning...
  • Add warning to (setting) SAGE_CHECK, since this currently breaks most builds. This will (or should) be fixed in future releases though; there's afaik a ticket adding more options to the value of this variable...
  • Add a note on / reference to sage-env.

Also, the description of some variables is incomplete, not current (in its use in all spkgs, e.g. SAGE_DEBUG), misleading, or even wrong (SAGE_TIMEOUT*).

I think the various variations of SAGE_T[E]MP[[_]DIR] are missing. (I wonder where e.g. TMP and TMPDIR are / may be used instead, or as a fall-back / default.)

SHELL might be relevant, too.

The *ITER* variables for (parallel) doctesting are missing.

I'm currently not sure if we have a similar section in the Developer's Guide, but some variables like SAGE_ROOT and SAGE_LOCAL should be documented (there?), too.

I'm still pretty sure even more variables are missing... ;-)

Note: See TracTickets for help on using tickets.