#9440: document more environment variables
-------------------------------------+-------------------------------------
       Reporter:  jhpalmieri         |        Owner:  mvngu
           Type:  enhancement        |       Status:  needs_review
       Priority:  minor              |    Milestone:  sage-6.4
      Component:  documentation      |   Resolution:
       Keywords:                     |    Merged in:
        Authors:                     |    Reviewers:
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/jhpalmieri/9440-DOCBUILD         |  79280e197ff0507b3c2b29ed23fe7aefaedc9aae
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by jhpalmieri):

 Replying to [comment:11 kcrisman]:
 > Nice!  Though I misled you by the wiki formatting.  I don't know the
 status of these, and at least some definitely aren't documented.
 >
 > >  * Add {{{PARI_EXTRA_OPTS}}}, which is passed to PARI's
 {{{Configure}}} when building Sage / installing the PARI spkg.
 > Needed?

 Doesn't seem to be used, but some other variables are used in Pari's spkg-
 install file. I've documented those (just copying from spkg-install,
 basically).

 > >  * Add {{{CPPFLAGS}}}, {{{LDFLAGS}}}, {{{CXXFLAG64}}}?,
 {{{LDFLAG64}}}? {{{LD}}}?
 > Needed?

 I added a bit about them.

 > >  * Document that (e.g.) {{{export CFLAGS=""}}} has not the same effect
 as {{{unset CFLAGS}}}.
 > Needed?

 Same here.

 > >  * Add note on not putting a space between {{{-j}}} and {{{NUM}}} in
 the description of {{{MAKE}}}, because doing so has a "completely"
 different meaning...
 > Needed?

 I don't know, this isn't Sage specific. I think we can skip it.


 > >  * Add a note on / reference to {{{sage-env}}}.
 > Needed?

 Done.

 > > 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*}}}).
 > Needed?

 I noticed that the documented value for SAGE_TIMEOUT was wrong. Beyond
 that, I don't know what Leif meant by this. If he wants to expand on it at
 some point, he can open another ticket and clarify.

 > > 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.)
 > Needed?

 I don't think there are such variables anymore. There is a variable
 SAGE_TMP used while running Sage, but it's not user-customizable and it's
 not an environment variable. So I don't think we need to document it.

 > > {{{SHELL}}} might be relevant, too.
 > Needed?

 Why? Let's skip it. What does it have to do with Sage?

 > > The {{{*ITER*}}} variables for (parallel) doctesting are missing.
 > Needed?

 I added something about them.

--
Ticket URL: <http://trac.sagemath.org/ticket/9440#comment:14>
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 unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to