zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor changes to Basic Settings docs for SC18 (#9809)

Browse Source 
Grammar/spelling issues
This commit is contained in:
Adam J. Stewart 2018-11-11 23:10:05 -06:00 committed by Peter Scheibel
parent dfd0e96508
commit c227e1f02e
2 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
etc/spack/defaults/config.yaml
View File

@ -24,7 +24,7 @@ config:
- $spack/share/spack/templates - $spack/share/spack/templates
# default directory layout # Default directory layout
install_path_scheme: "${ARCHITECTURE}/${COMPILERNAME}-${COMPILERVER}/${PACKAGE}-${VERSION}-${HASH}" install_path_scheme: "${ARCHITECTURE}/${COMPILERNAME}-${COMPILERVER}/${PACKAGE}-${VERSION}-${HASH}"
@ -52,7 +52,7 @@ config:
- $spack/var/spack/stage - $spack/var/spack/stage
# Cache directory already downloaded source tarballs and archived # Cache directory for already downloaded source tarballs and archived
# repositories. This can be purged with `spack clean --downloads`. # repositories. This can be purged with `spack clean --downloads`.
source_cache: $spack/var/spack/cache source_cache: $spack/var/spack/cache
@ -100,15 +100,17 @@ config:
# build_jobs: 4 # build_jobs: 4
# If set to true, spack will use ccache to cache c compiles. # If set to true, Spack will use ccache to cache C compiles.
ccache: false ccache: false
# How long to wait to lock the Spack installation database. This lock is used # How long to wait to lock the Spack installation database. This lock is used
# when spack needs to manage its own package metadata and all operations are # when Spack needs to manage its own package metadata and all operations are
# expected to complete within the default time limit. The timeout should # expected to complete within the default time limit. The timeout should
# therefore generally be left untouched. # therefore generally be left untouched.
db_lock_timeout: 120 db_lock_timeout: 120
# How long to wait when attempting to modify a package (e.g. to install it). # How long to wait when attempting to modify a package (e.g. to install it).
# This value should typically be 'null' (never time out) unless the Spack # This value should typically be 'null' (never time out) unless the Spack
# instance only ever has a single user at a time, and only if the user # instance only ever has a single user at a time, and only if the user

26
lib/spack/docs/config_yaml.rst
View File

@ -5,9 +5,9 @@
.. _config-yaml: .. _config-yaml:
==================================== ==============
Basic settings in ``config.yaml`` Basic Settings
==================================== ==============
Spack's basic configuration options are set in ``config.yaml``. You can Spack's basic configuration options are set in ``config.yaml``. You can
see the default settings by looking at see the default settings by looking at
@ -84,8 +84,8 @@ See :ref:`modules` for details.
-------------------- --------------------
Spack is designed to run out of a user home directory, and on many Spack is designed to run out of a user home directory, and on many
systems the home directory is a (slow) network filesystem. On most systems, systems the home directory is a (slow) network file system. On most systems,
building in a temporary filesystem results in faster builds than building building in a temporary file system results in faster builds than building
in the home directory. Usually, there is also more space available in in the home directory. Usually, there is also more space available in
the temporary location than in the home directory. So, Spack tries to the temporary location than in the home directory. So, Spack tries to
create build stages in temporary space. create build stages in temporary space.
@ -162,7 +162,7 @@ attacks. Use at your own risk.
When set to ``true``, concurrent instances of Spack will use locks to When set to ``true``, concurrent instances of Spack will use locks to
avoid modifying the install tree, database file, etc. If false, Spack avoid modifying the install tree, database file, etc. If false, Spack
will disable all locking, but you must **not** run concurrent instances will disable all locking, but you must **not** run concurrent instances
of Spack. For filesystems that don't support locking, you should set of Spack. For file systems that don't support locking, you should set
this to ``false`` and run one Spack at a time, but otherwise we recommend this to ``false`` and run one Spack at a time, but otherwise we recommend
enabling locks. enabling locks.
@ -202,16 +202,16 @@ To build all software in serial, set ``build_jobs`` to 1.
-------------------- --------------------
When set to ``true`` Spack will use ccache to cache compiles. This is When set to ``true`` Spack will use ccache to cache compiles. This is
useful specifically un two cases: (1) Use with ``spack setup``, (2) useful specifically in two cases: (1) when using ``spack setup``, and (2)
Build the same package with many different variants. The default is when building the same package with many different variants. The default is
``false``. ``false``.
When enabled Spack will look inside your ``PATH`` for a ``ccache`` When enabled, Spack will look inside your ``PATH`` for a ``ccache``
executable and stop if it is not found. Some systems come with executable and stop if it is not found. Some systems come with
``ccache``, but it can also be installed using ``spack install ``ccache``, but it can also be installed using ``spack install
ccache``. ``ccache`` comes with reasonable defaults for cache size ccache``. ``ccache`` comes with reasonable defaults for cache size
and location. (See the *Configuration settings* secion of ``man and location. (See the *Configuration settings* section of ``man
ccache`` to learn more about the default settings and how change ccache`` to learn more about the default settings and how to change
them.) Please note that we currently disable ccache's ``hash_dir`` them). Please note that we currently disable ccache's ``hash_dir``
feature to avoid an issue with the stage directory (see feature to avoid an issue with the stage directory (see
https://github.com/LLNL/spack/pull/3761#issuecomment-294352232 ). https://github.com/LLNL/spack/pull/3761#issuecomment-294352232).