summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorCameron Smith <cwsmith@users.noreply.github.com>2018-04-13 14:53:26 -0400
committerTodd Gamblin <tgamblin@llnl.gov>2018-04-13 11:53:26 -0700
commite6d3ab84059cf878a1621fd450b062c46cae785c (patch)
tree61897b5c1c446738774ac484594e26a761a7987c /lib
parentb9c8cdcbe3ac6009c005c4b9eeeb63c4461144bd (diff)
downloadspack-e6d3ab84059cf878a1621fd450b062c46cae785c.tar.gz
spack-e6d3ab84059cf878a1621fd450b062c46cae785c.tar.bz2
spack-e6d3ab84059cf878a1621fd450b062c46cae785c.tar.xz
spack-e6d3ab84059cf878a1621fd450b062c46cae785c.zip
cray: add comment about module use in packages.yaml (#7751)
This advises users to prefer `modules:` entries in `packages.yaml` on Cray.
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/getting_started.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst
index 48999ad152..407c1774b8 100644
--- a/lib/spack/docs/getting_started.rst
+++ b/lib/spack/docs/getting_started.rst
@@ -1203,7 +1203,14 @@ Here's an example of an external configuration for cray modules:
This tells Spack that for whatever package that depends on mpi, load the
cray-mpich module into the environment. You can then be able to use whatever
environment variables, libraries, etc, that are brought into the environment
-via module load.
+via module load.
+
+.. note::
+
+ For Cray-provided packages, it is best to use ``modules:`` instead of ``paths:``
+ in ``packages.yaml``, because the Cray Programming Environment heavily relies on
+ modules (e.g., loading the ``cray-mpich`` module adds MPI libraries to the
+ compiler wrapper link line).
You can set the default compiler that Spack can use for each compiler type.
If you want to use the Cray defaults, then set them under ``all:`` in packages.yaml.