#16273: update README
-------------------------------------+-------------------------------------
Reporter: vbraun | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.2
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Volker Braun | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/vbraun/update_readme | d60e5d7a028727f0ca7f66504dc7bfe9e06c6978
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jhpalmieri):
Here are some suggested changes to the installation guide.
{{{
#!diff
diff --git a/src/doc/en/installation/source.rst
b/src/doc/en/installation/source.rst
index a848cc2..a7d2c2b 100644
--- a/src/doc/en/installation/source.rst
+++ b/src/doc/en/installation/source.rst
@@ -886,9 +886,10 @@ Here are some of the more commonly used variables
affecting the build process:
and uses more memory and disk space than using MathJax.
- :envvar:`SAGE_BUILD_DIR` - the default behavior is to build each spkg
in a
- subdirectory of :file:`$SAGE_ROOT/spkg/build/`; for example, build
+ subdirectory of :file:`$SAGE_ROOT/local/var/tmp/sage/build/`; for
+ example, build
:file:`atlas-3.8.3.p12.spkg` in the directory
- :file:`$SAGE_ROOT/spkg/build/atlas-3.8.3.p12/`.
+ :file:`$SAGE_ROOT/local/var/tmp/sage/build/atlas-3.8.3.p12/`.
If this variable is set, then build in
:file:`$SAGE_BUILD_DIR/atlas-3.8.3.p12/` instead.
If the directory :file:`$SAGE_BUILD_DIR` does not exist, it is created.
@@ -909,7 +910,8 @@ Here are some of the more commonly used variables
affecting the build process:
- :envvar:`SAGE_KEEP_BUILT_SPKGS` - the default behavior is to delete
each
build directory -- the appropriate subdirectory of
- :file:`$SAGE_ROOT/spkg/build` or :file:`$SAGE_BUILD_DIR` -- after each
spkg
+ :file:`$SAGE_ROOT/local/var/tmp/sage/build` or
+ :file:`$SAGE_BUILD_DIR` -- after each spkg
is successfully built, and to keep it if there were errors installing
the
spkg.
Set this variable to ``yes`` to keep the subdirectory regardless.
@@ -917,7 +919,8 @@ Here are some of the more commonly used variables
affecting the build process:
corresponding subdirectory, for example left over from a previous
build,
then the default behavior is to delete that old subdirectory.
If this variable is set to ``yes``, then the old subdirectory is moved
to
- :file:`$SAGE_ROOT/spkg/build/old/` (or :file:`$SAGE_BUILD_DIR/old`),
+ :file:`$SAGE_ROOT/local/var/tmp/sage/build/old/`
+ (or :file:`$SAGE_BUILD_DIR/old`),
overwriting any already existing file or directory with the same name.
.. note::
@@ -1106,13 +1109,13 @@ Sage uses the following environment variables when
it runs:
If you wish to set up your own server, then note that Sage will search
the
directories:
- - ``SAGE_SERVER/packages/standard/``,
- - ``SAGE_SERVER/packages/optional/``,
- - ``SAGE_SERVER/packages/experimental/``,
- - and ``SAGE_SERVER/packages/archive/``
+ - ``SAGE_SERVER/spkg/standard/``,
+ - ``SAGE_SERVER/spkg/optional/``,
+ - ``SAGE_SERVER/spkg/experimental/``,
+ - and ``SAGE_SERVER/spkg/archive/``
for packages.
- See the script :file:`$SAGE_ROOT/spkg/bin/sage-spkg` for the
implementation.
+ See the script :file:`$SAGE_ROOT/src/bin/sage-spkg` for the
implementation.
- :envvar:`SAGE_PATH` - a colon-separated list of directories which Sage
searches when trying to locate Python libraries.
@@ -1129,7 +1132,7 @@ Sage uses the following environment variables when
it runs:
set the :envvar:`DYLD_LIBRARY_PATH` variable.
- :envvar:`SAGE_CBLAS` - used in the file
- :file:`SAGE_ROOT/devel/sage/sage/misc/cython.py`.
+ :file:`SAGE_ROOT/src/sage/misc/cython.py`.
Set this to the base name of the BLAS library file on your system if
you want
to override the default setting.
That is, if the relevant file is called :file:`libcblas_new.so` or
@@ -1159,7 +1162,7 @@ Variables dealing with doctesting:
jar, set this to something non-empty and run the doctest suite.
See the documentation for the functions :func:`picklejar` and
:func:`unpickle_all` in
- :file:`$SAGE_ROOT/devel/sage/sage/structure/sage_object.pyx`, online
+ :file:`$SAGE_ROOT/src/sage/structure/sage_object.pyx`, online
`here (picklejar)
<http://sagemath.org/doc/reference/sage/structure/sage_object.html#sage.structure.sage_object.picklejar>`_
and `here (unpickle_all)
@@ -1287,4 +1290,4 @@ would be appropriate if you have a Core i3/5/7
processor with AVX support.
-**This page was last updated in October 2013 (Sage 5.12).**
+**This page was last updated in May 2014 (Sage 6.2).**
}}}
There are other parts which are probably outdated:
{{{
As of this writing (Sage 4.8), when building the standard Sage packages,
1.5 gigabytes of free space are required in this directory (or more if
``SAGE_KEEP_BUILT_SPKGS=yes`` -- see below); the exact amount of
required
space varies from platform to platform.
}}}
and
{{{
After a full build of Sage (as of version 4.8), these subdirectories
can
take up to 6 gigabytes of storage, in total, depending on the
platform
and the block size of the file system.
}}}
I don't know what these storage requirements should be now, but it's not
as important as the other changes being discussed here.
--
Ticket URL: <http://trac.sagemath.org/ticket/16273#comment:10>
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.
