summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorMark W. Krentel <krentel@rice.edu>2018-10-16 17:34:22 -0500
committerPeter Scheibel <scheibel1@llnl.gov>2018-10-16 15:34:22 -0700
commite5e8d89ad9ad0c851e91d6b26e08e068112bf66a (patch)
treea90da98cd9028850f47a11e813a6ff06d3ed08ee /lib
parent1597d6762902ba6ddc4af0255cb82f87c2ae616f (diff)
downloadspack-e5e8d89ad9ad0c851e91d6b26e08e068112bf66a.tar.gz
spack-e5e8d89ad9ad0c851e91d6b26e08e068112bf66a.tar.bz2
spack-e5e8d89ad9ad0c851e91d6b26e08e068112bf66a.tar.xz
spack-e5e8d89ad9ad0c851e91d6b26e08e068112bf66a.zip
docs: add note about compilers with modules (#9520)
compilers.yaml can track a module that is needed for a compiler, but Spack does not fill this in automatically. This adds a note to the documentation informing the user how to do this.
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/getting_started.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst
index 97b9a3a235..7fb1ad648c 100644
--- a/lib/spack/docs/getting_started.rst
+++ b/lib/spack/docs/getting_started.rst
@@ -202,6 +202,13 @@ installed, but you know that new compilers have been added to your
This loads the environment module for gcc-4.9.0 to add it to
``PATH``, and then it adds the compiler to Spack.
+.. note::
+
+ By default, spack does not fill in the ``modules:`` field in the
+ ``compilers.yaml`` file. If you are using a compiler from a
+ module, then you should add this field manually.
+ See the section on :ref:`compilers-requiring-modules`.
+
.. _cmd-spack-compiler-info:
^^^^^^^^^^^^^^^^^^^^^^^
@@ -320,6 +327,7 @@ by adding the following to your ``packages.yaml`` file:
all:
compiler: [gcc@4.9.3]
+.. _compilers-requiring-modules:
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Compilers Requiring Modules