diff options
author | Massimiliano Culpo <massimiliano.culpo@gmail.com> | 2018-07-20 10:30:36 +0200 |
---|---|---|
committer | Todd Gamblin <tgamblin@llnl.gov> | 2018-07-24 11:27:17 -0700 |
commit | 35cef169740d8eb87a1cc76fcde85d207935d91a (patch) | |
tree | 6925bf9fc43c38acd5d5c14ea57ac72a8a2a8973 /lib/spack/docs/workflows.rst | |
parent | 7cbe1aedb7c0ecc32d2cee3e965ec71570ee09d9 (diff) | |
download | spack-35cef169740d8eb87a1cc76fcde85d207935d91a.tar.gz spack-35cef169740d8eb87a1cc76fcde85d207935d91a.tar.bz2 spack-35cef169740d8eb87a1cc76fcde85d207935d91a.tar.xz spack-35cef169740d8eb87a1cc76fcde85d207935d91a.zip |
Grouped all the module commands under `spack module`
As requested in the review all the commands meant to manage module
files have been grouped under the `spack module` command.
Unit tests have been refactored to match the new command structure.
Diffstat (limited to 'lib/spack/docs/workflows.rst')
-rw-r--r-- | lib/spack/docs/workflows.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/spack/docs/workflows.rst b/lib/spack/docs/workflows.rst index d3a60d9490..b3bdaf3291 100644 --- a/lib/spack/docs/workflows.rst +++ b/lib/spack/docs/workflows.rst @@ -276,11 +276,11 @@ have some drawbacks: 2. The ``spack spec`` and ``spack install`` commands use a sophisticated concretization algorithm that chooses the "best" among several options, taking into account ``packages.yaml`` file. - The ``spack load`` and ``spack tcl loads`` commands, on the + The ``spack load`` and ``spack module tcl loads`` commands, on the other hand, are not very smart: if the user-supplied spec matches - more than one installed package, then ``spack tcl loads`` will + more than one installed package, then ``spack module tcl loads`` will fail. This may change in the future. For now, the workaround is to - be more specific on any ``spack tcl loads`` lines that fail. + be more specific on any ``spack module tcl loads`` lines that fail. """""""""""""""""""""" @@ -290,7 +290,7 @@ Generated Load Scripts Another problem with using `spack load` is, it is slow; a typical user environment could take several seconds to load, and would not be appropriate to put into ``.bashrc`` directly. It is preferable to use -a series of ``spack tcl loads`` commands to pre-compute which +a series of ``spack module tcl loads`` commands to pre-compute which modules to load. These can be put in a script that is run whenever installed Spack packages change. For example: @@ -301,7 +301,7 @@ installed Spack packages change. For example: # Generate module load commands in ~/env/spackenv cat <<EOF | /bin/sh >$HOME/env/spackenv - FIND='spack tcl loads --prefix linux-SuSE11-x86_64/' + FIND='spack module tcl loads --prefix linux-SuSE11-x86_64/' \$FIND modele-utils \$FIND emacs @@ -346,14 +346,14 @@ Users may now put ``source ~/env/spackenv`` into ``.bashrc``. Some module systems put a prefix on the names of modules created by Spack. For example, that prefix is ``linux-SuSE11-x86_64/`` in the above case. If a prefix is not needed, you may omit the - ``--prefix`` flag from ``spack tcl loads``. + ``--prefix`` flag from ``spack module tcl loads``. """"""""""""""""""""""" Transitive Dependencies """"""""""""""""""""""" -In the script above, each ``spack tcl loads`` command generates a +In the script above, each ``spack module tcl loads`` command generates a *single* ``module load`` line. Transitive dependencies do not usually need to be loaded, only modules the user needs in ``$PATH``. This is because Spack builds binaries with RPATH. Spack's RPATH policy has @@ -394,13 +394,13 @@ Unfortunately, Spack's RPATH support does not work in all case. For example: In cases where RPATH support doesn't make things "just work," it can be necessary to load a module's dependencies as well as the module itself. This is done by adding the ``--dependencies`` flag to the -``spack tcl loads`` command. For example, the following line, +``spack module tcl loads`` command. For example, the following line, added to the script above, would be used to load SciPy, along with Numpy, core Python, BLAS/LAPACK and anything else needed: .. code-block:: sh - spack tcl loads --dependencies py-scipy + spack module tcl loads --dependencies py-scipy ^^^^^^^^^^^^^^ Dummy Packages @@ -630,7 +630,7 @@ environments: and extension packages. * Views and activated extensions maintain state that is semantically - equivalent to the information in a ``spack tcl loads`` script. + equivalent to the information in a ``spack module tcl loads`` script. Administrators might find things easier to maintain without the added "heavyweight" state of a view. |