summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorGeorge Hartzell <hartzell@alerce.com>2018-07-06 10:06:53 -0700
committerAdam J. Stewart <ajstewart426@gmail.com>2018-07-06 12:06:53 -0500
commit7f814971a5b594a0a99699b261fc8824ab92e560 (patch)
tree5f19260cdb710d084f37bdfc5c75ac28faf36682 /lib
parentcf140b5f4c0ffd1d000fa66de739193051c12f34 (diff)
downloadspack-7f814971a5b594a0a99699b261fc8824ab92e560.tar.gz
spack-7f814971a5b594a0a99699b261fc8824ab92e560.tar.bz2
spack-7f814971a5b594a0a99699b261fc8824ab92e560.tar.xz
spack-7f814971a5b594a0a99699b261fc8824ab92e560.zip
Clear up a bit of modules/dotkit confusion (#8650)
`use` is an overloaded word between dotkit, modules and spack. Add additional words to make the distinction clear in the docs.
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/module_file_support.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst
index d7ef18f290..471ef3aca5 100644
--- a/lib/spack/docs/module_file_support.rst
+++ b/lib/spack/docs/module_file_support.rst
@@ -113,8 +113,10 @@ Modules Dotkit
========================= ==========================
And you can use the same shortened names you use everywhere else in
-Spack. For example, this will add the ``mpich`` package built with
-``gcc`` to your path:
+Spack.
+
+For example, if you are using dotkit, this will add the ``mpich``
+package built with ``gcc`` to your path:
.. code-block:: console
@@ -122,16 +124,16 @@ Spack. For example, this will add the ``mpich`` package built with
# ... wait for install ...
- $ spack use mpich %gcc@4.4.7
+ $ spack use mpich %gcc@4.4.7 # dotkit
Prepending: mpich@3.0.4%gcc@4.4.7 (ok)
$ which mpicc
~/spack/opt/linux-debian7-x86_64/gcc@4.4.7/mpich@3.0.4/bin/mpicc
-Or, similarly with modules, you could type:
+Or, similarly if you are using modules, you could type:
.. code-block:: console
- $ spack load mpich %gcc@4.4.7
+ $ spack load mpich %gcc@4.4.7 # modules
These commands will add appropriate directories to your ``PATH``,
``MANPATH``, ``CPATH``, and ``LD_LIBRARY_PATH``. When you no longer