Skip to content

Commit d52c66d

Browse files
author
Matthias Koeppe
committed
src/doc/en/installation/source.rst: Updates on some envvars
1 parent f2e9684 commit d52c66d

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

src/doc/en/installation/source.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ Most users won't need to set any of these: the build process just works on many
650650
platforms.
651651
(Note though that setting :envvar:`MAKE`, as described below, can significantly
652652
speed up the process.)
653-
Building Sage involves building about 100 packages, each of which has its own
653+
Building Sage involves building many packages, each of which has its own
654654
compilation instructions.
655655

656656

@@ -677,11 +677,6 @@ Here are some of the more commonly used variables affecting the build process:
677677
and `Parallel building
678678
<https://www.gnu.org/software/make/manual/make.html#Parallel>`_.
679679

680-
.. warning::
681-
682-
Some users on single-core macOS machines have reported problems when
683-
building Sage with ``MAKE='make -jNUM'`` with ``NUM`` greater than one.
684-
685680
.. envvar:: V
686681

687682
If set to ``0``, silence the build. Instead of showing a detailed
@@ -754,14 +749,22 @@ Sage-specific environment variables controlling the build process
754749
connection. The git repository, however, does not contain the source
755750
code for third-party packages. Instead, it will be downloaded as
756751
needed (note: you can run ``make download`` to force downloading
757-
packages before building). Package downloads use the Sage mirror
758-
network, the nearest mirror will be determined automatically for
759-
you. This is influenced by the following environment variable:
752+
packages before building).
760753

761-
Try the specified mirror first, before falling back to the official
762-
Sage mirror list. Note that Sage will search the directory
754+
If :envvar:`SAGE_SERVER` is set, the specified Sage mirror is contacted
755+
first. Note that Sage will search the directory
763756
``SAGE_SERVER/spkg/upstream`` for upstream tarballs.
764757

758+
If downloading a file from there fails or :envvar:`SAGE_SERVER` is not set,
759+
files will be attempted to download from release assets of the
760+
Sage GitHub repository.
761+
762+
If that fails too, the Sage mirror network is contacted to determine
763+
the nearest mirrors.
764+
765+
This sequence of operations is defined by the files in the directory
766+
:file:`$SAGE_ROOT/.upstream.d`.
767+
765768
.. envvar:: SAGE_NUM_THREADS
766769

767770
If set to a number, then when rebuilding with ``sage -b`` or
@@ -1025,7 +1028,7 @@ Environment variables dealing with specific Sage packages
10251028
.. envvar:: OPENBLAS_CONFIGURE
10261029

10271030
Adds additional configuration flags for
1028-
the OpenBLAS package that gets added to the make command. (see :trac:`23272`)
1031+
the OpenBLAS package that gets added to the ``make`` command. (see :trac:`23272`)
10291032

10301033
.. envvar:: PARI_CONFIGURE
10311034

@@ -1054,13 +1057,13 @@ Environment variables dealing with doctesting
10541057

10551058
.. envvar:: SAGE_TIMEOUT
10561059

1057-
used for Sage's doctesting: the number of seconds
1060+
Used for Sage's doctesting: the number of seconds
10581061
to allow a doctest before timing it out.
10591062
If this isn't set, the default is 300 seconds (5 minutes).
10601063

10611064
.. envvar:: SAGE_TIMEOUT_LONG
10621065

1063-
used for Sage's doctesting: the number of
1066+
Used for Sage's doctesting: the number of
10641067
seconds to allow a doctest before timing it out, if tests are run using
10651068
``sage -t --long``.
10661069
If this isn't set, the default is 1800 seconds (30 minutes).

0 commit comments

Comments
 (0)