#8263: Document ALL environment variables used by Sage
-----------------------------+----------------------------------------------
   Reporter:  drkirkby       |       Owner:  drkirkby    
       Type:  defect         |      Status:  needs_review
   Priority:  major          |   Milestone:  sage-4.5    
  Component:  documentation  |    Keywords:              
     Author:                 |    Upstream:  N/A         
   Reviewer:                 |      Merged:              
Work_issues:                 |  
-----------------------------+----------------------------------------------

Comment(by drkirkby):

 Thanks John. A couple of minor changes I would suggest. I don't have an
 install of Sage handy, so are not going to apply a review patch.

  * Line 202. The comment "you need to check this" can be removed. What you
 have is correct.
  * Line 495 - commmonly -> commonly
  * Line 500 - invididual -> individual
  * Line 576 says "SAGE_ATLAS_LIB - if you have an installation of ATLAS on
 your system and you want Sage to use it instead of buliding and installing
 its own version of Sage, set this variable to be the parent directory of
 your ATLAS installation:"
    * 'buliding' needs changing to 'building'
    * I believe you mean for Sage to install its own version of ATLAS
 rather than its own version of Sage.
  * Line 591. This bug fix was integrated into Solaris 10 update 8 (10/09),
 so only affects Solaris 10 update 7 (5/09) or earlier. So I think it might
 be better to change it to.

 {{{
 `INCLUDE_MPFR_PATCH` - This is used to add a patch to MPFR to bypass a bug
 in the  memset function affecting sun4v machines with versions of Solaris
 earlier than than Solaris 10 update 8 (10/09). Earlier versions of Solaris
 10 can be patched by applying Sun patch 142542-01.

 Recognized values are:

 INCLUDE_MPFR_PATCH=0 - never include the patch - useful if you know all
 sun4v machines Sage will be used on are running Solaris 10 update 8 or
 later, or have been patched with Sun patch 142542-01.
 }}}
  * Line 644. It would be useful to state what directory packages are
 expected to be in. The default server is http://www.sagemath.org/ but the
 packages do not sit in the top level. They seem to be in sub-directories
 below http://www.sagemath.org/packages/ So I suspect if someone sets up
 their own server they will need to create a directory 'packages'. What
 happens beyond that I'm not 100% sure - it looks like
 http://www.sagemath.org/packages/optional/
 http://www.sagemath.org/packages/experimental/ and
 http://www.sagemath.org/packages/spkg/standard/ are all searched for. One
 would need to check the source code to find out exactly what happens here.
 (Unless you know the details, it might be easier to put a comment like
 "please ask for advice on sage-devel if wishing to set up your own
 server").

 Apart from those very minor things, that looks a huge improvement.

 Dave

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8263#comment:19>
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.

Reply via email to