Ticket #4949: trac_4949-installation.patch

File trac_4949-installation.patch, 3.5 KB (added by jhpalmieri, 8 years ago)

sage repo: update installation guide

  • doc/en/installation/source.rst

    # HG changeset patch
    # User J. H. Palmieri <palmieri@math.washington.edu>
    # Date 1281132114 25200
    # Node ID 731a9b2ad8f1464a8649a43f4e2bcd4c02990e65
    # Parent  a00f3e5308bff0538de0d9a420074109bf0712e8
    #4949: update installation guide with new environment variables
    
    diff --git a/doc/en/installation/source.rst b/doc/en/installation/source.rst
    a b process: 
    611611  spkgs might also assume that certain programs are available on the
    612612  system (for example, ``latex`` or ``pdflatex``).
    613613
     614- :envvar:`SAGE_BUILD_TMPDIR` - the default behavior is to build each
     615  spkg in a subdirectory of :file:`$SAGE_ROOT/spkg/build/`; for
     616  example, build :file:`atlas-3.8.3.p12.spkg` in the directory
     617  :file:`$SAGE_ROOT/spkg/build/atlas-3.8.3.p12/`.  If this variable is
     618  set to an existing directory, build in
     619  :file:`$SAGE_BUILD_TMPDIR/build/atlas-3.8.3.p12/` instead.  As of
     620  this writing (Sage 4.7.1), when building the standard Sage packages,
     621  this may require 1.5 gigabytes of free space in this directory
     622  (or more if :envvar:`SAGE_KEEP_BUILT_SPKGS` is "yes" -- see below);
     623  the exact amount of required space varies from platform to
     624  platform.  For example, the block size of the file system will
     625  affect the amount of space used, since some spkgs contain many small
     626  files.
     627
     628  .. warning::
     629
     630    The variable :envvar:`SAGE_BUILD_TMPDIR` must be set to the full
     631    path name of an existing directory for which the user has write
     632    permissions, and its path name must contain no spaces.
     633
     634- :envvar:`SAGE_KEEP_BUILT_SPKGS` - the default behavior is to delete
     635  each build directory -- the appropriate subdirectory of
     636  :file:`$SAGE_ROOT/spkg/build` or :file:`$SAGE_BUILD_TMPDIR/build` --
     637  after each spkg is successfully built.  The subdirectory is not
     638  deleted if there were errors installing the spkg.  Set this variable
     639  to "yes" to keep the subdirectory regardless.  Furthermore, if you
     640  install an spkg for which there is already a corresponding
     641  subdirectory, for example left over from a previous build, then the
     642  default behavior is to delete that old subdirectory.  If this
     643  variable is set to "yes", then the old subdirectory is moved to
     644  :file:`$SAGE_ROOT/spkg/build/old/` (or
     645  :file:`$SAGE_BUILD_TMPDIR/build/old`), overwriting any already
     646  existing directory with the same name.
     647
     648  .. note::
     649
     650     After a full build of Sage (as of version 4.7.1), these
     651     subdirectories can take up to 6 gigabytes of storage, in total,
     652     depending on the platform and the block size of the file system.
     653     If you always set this variable to "yes", it can take even more
     654     space: rebuilding every spkg would use double the amount of
     655     space, and any upgrades to spkgs would create still more
     656     directories, using still more space.
     657
     658  .. note::
     659
     660     In an existing Sage installation, running ``sage -i -s new.spkg``
     661     or ``sage -f -s new.spkg`` installs the spkg ``new.spkg`` and
     662     keeps the corresponding build directory; thus setting
     663     :envvar:`SAGE_KEEP_BUILT_SPKGS` to "yes" mimics this behavior
     664     when building Sage from scratch or when installing individual
     665     spkgs.  So you can set this variable to "yes" instead of using
     666     the ``-s`` flag for ``sage -i`` or ``sage -f``.
     667
    614668- :envvar:`SAGE_FAT_BINARY` - to prepare a binary distribution that
    615669  will run on the widest range of target machines, set this variable
    616670  to "yes" before building Sage::