Ticket #3537: trac_3537-doc.patch

doc/en/developer/producing_spkgs.rst

@@ -169 +169 @@
   correctly. Also, running ``gap`` or ``Singular``, for example, will
   run the correct version.
 
-- The environment variable ``SAGE_ROOT`` points to the root directory
+- The environment variable :envvar:`SAGE_ROOT` points to the root directory
   of the Sage installation.
 
-- The environment variable ``SAGE_LOCAL`` points to the
+- The environment variable :envvar:`SAGE_LOCAL` points to the
   ``SAGE_ROOT/local`` directory of the Sage installation.
 
-- The environment variables ``LD_LIBRARY_PATH`` and
-  ``DYLD_LIBRARY_PATH`` both have ``SAGE_ROOT/local/lib`` at the
+- The environment variables :envvar:`LD_LIBRARY_PATH` and
+  :envvar:`DYLD_LIBRARY_PATH` both have ``SAGE_ROOT/local/lib`` at the
   front.
 
+- The script ``sage-env`` in the directory ``SAGE_ROOT/local/bin``
+  sets a number of other environment variables before any
+  package's ``spkg-install`` is run.  For example, it sets the variable
+  :envvar:`RM` to ``"rm"``, so if you want ``$RM`` to behave like ``rm
+  -f``, then you need to call ``$RM -f`` (this is done in singular's
+  ``spkg-install``, for example), or you need to redefine :envvar:`RM`
+  appropriately in ``spkg-install``.
+
+- The Sage Installation Guide also discusses the roles of some other
+  environment variables: see the chapter "Install from Source Code".
+
 The ``spkg-install`` script should copy your files to the appropriate
 place after doing any build that is necessary.  Here is a template::
 
@@ -243 +254 @@
 
 
 Note that the first line is ``/usr/bin/env bash``; this is important
-for portability.  Next, the script checks that ``SAGE_LOCAL`` is
+for portability.  Next, the script checks that :envvar:`SAGE_LOCAL` is
 defined to make sure that the Sage environment has been set.  After
 this, the script may simply run ``cd src`` and then call either
 ``python setup.py install`` or the autotools sequence