Ticket #4949: trac_4949-installation.v3.patch

File trac_4949-installation.v3.patch, 3.8 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 36a2047ea652bf32549f2eca2a46e4c987bb7b91
    # Parent  6d795baa5da32038b26348f4bcba7e45cb648f98
    installation guide: document SAGE_BUILD_DIR and SAGE_KEEP_BUILT_SPKGS
    
    
    diff --git a/doc/en/installation/source.rst b/doc/en/installation/source.rst
    a b process: 
    632632  spkgs might also assume that certain programs are available on the
    633633  system (for example, ``latex`` or ``pdflatex``).
    634634
     635- :envvar:`SAGE_BUILD_DIR` - the default behavior is to build each
     636  spkg in a subdirectory of :file:`$SAGE_ROOT/spkg/build/`; for
     637  example, build :file:`atlas-3.8.3.p12.spkg` in the directory
     638  :file:`$SAGE_ROOT/spkg/build/atlas-3.8.3.p12/`.  If this variable is
     639  set, build in :file:`$SAGE_BUILD_DIR/atlas-3.8.3.p12/`
     640  instead.  If the directory :file:`$SAGE_BUILD_DIR` does not
     641  exist, it is created.  As of this writing (Sage 4.8), when building
     642  the standard Sage packages, this may require 1.5 gigabytes of free
     643  space in this directory (or more if :envvar:`SAGE_KEEP_BUILT_SPKGS`
     644  is "yes" -- see below); the exact amount of required space varies
     645  from platform to platform.  For example, the block size of the file
     646  system will affect the amount of space used, since some spkgs
     647  contain many small files.
     648
     649  .. warning::
     650
     651    The variable :envvar:`SAGE_BUILD_DIR` must be set to the full
     652    path name of either an existing directory for which the user has write
     653    permissions, or to the full path name of a nonexistent directory
     654    which the user has permission to create.  The path name must
     655    contain no spaces.
     656
     657- :envvar:`SAGE_KEEP_BUILT_SPKGS` - the default behavior is to delete
     658  each build directory -- the appropriate subdirectory of
     659  :file:`$SAGE_ROOT/spkg/build` or :file:`$SAGE_BUILD_DIR` --
     660  after each spkg is successfully built.  The subdirectory is not
     661  deleted if there were errors installing the spkg.  Set this variable
     662  to "yes" to keep the subdirectory regardless.  Furthermore, if you
     663  install an spkg for which there is already a corresponding
     664  subdirectory, for example left over from a previous build, then the
     665  default behavior is to delete that old subdirectory.  If this
     666  variable is set to "yes", then the old subdirectory is moved to
     667  :file:`$SAGE_ROOT/spkg/build/old/` (or
     668  :file:`$SAGE_BUILD_DIR/old`), overwriting any already
     669  existing file or directory with the same name.
     670
     671  .. note::
     672
     673     After a full build of Sage (as of version 4.8), these
     674     subdirectories can take up to 6 gigabytes of storage, in total,
     675     depending on the platform and the block size of the file system.
     676     If you always set this variable to "yes", it can take even more
     677     space: rebuilding every spkg would use double the amount of
     678     space, and any upgrades to spkgs would create still more
     679     directories, using still more space.
     680
     681  .. note::
     682
     683     In an existing Sage installation, running ``sage -i -s new.spkg``
     684     or ``sage -f -s new.spkg`` installs the spkg ``new.spkg`` and
     685     keeps the corresponding build directory; thus setting
     686     :envvar:`SAGE_KEEP_BUILT_SPKGS` to "yes" mimics this behavior
     687     when building Sage from scratch or when installing individual
     688     spkgs.  So you can set this variable to "yes" instead of using
     689     the ``-s`` flag for ``sage -i`` or ``sage -f``.
     690
    635691- :envvar:`SAGE_FAT_BINARY` - to prepare a binary distribution that
    636692  will run on the widest range of target machines, set this variable
    637693  to "yes" before building Sage::
    Special Notes 
    9471003  :ref:`installation in a multiuser environment
    9481004  <sagetex_installation_multiuser>`.
    9491005
    950   **This page was last updated in November 2011**
     1006  **This page was last updated in February 2012**