diff options
author | Massimiliano Culpo <massimiliano.culpo@gmail.com> | 2018-04-11 22:53:09 +0200 |
---|---|---|
committer | Todd Gamblin <tgamblin@llnl.gov> | 2018-07-24 11:27:17 -0700 |
commit | e81c0c3e2c1a45c77d91fbffb2911b9dc3511272 (patch) | |
tree | 51ee97d89be1a0fdf1464bdbd8b21922a3b6db5a /lib/spack/docs/module_file_support.rst | |
parent | 6ab57571c20ed50889f4960cdec97b00ba999793 (diff) | |
download | spack-e81c0c3e2c1a45c77d91fbffb2911b9dc3511272.tar.gz spack-e81c0c3e2c1a45c77d91fbffb2911b9dc3511272.tar.bz2 spack-e81c0c3e2c1a45c77d91fbffb2911b9dc3511272.tar.xz spack-e81c0c3e2c1a45c77d91fbffb2911b9dc3511272.zip |
Updated references to `spack module` in the documentation.
Diffstat (limited to 'lib/spack/docs/module_file_support.rst')
-rw-r--r-- | lib/spack/docs/module_file_support.rst | 51 |
1 files changed, 21 insertions, 30 deletions
diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst index 2351f935b5..67e041e061 100644 --- a/lib/spack/docs/module_file_support.rst +++ b/lib/spack/docs/module_file_support.rst @@ -181,7 +181,7 @@ To identify just the one built with the Intel compiler. .. _cmd-spack-module-loads: ^^^^^^^^^^^^^^^^^^^^^^ -``spack module loads`` +``spack tcl loads`` ^^^^^^^^^^^^^^^^^^^^^^ In some cases, it is desirable to load not just a module, but also all @@ -195,21 +195,13 @@ Scripts to load modules recursively may be made with the command: .. code-block:: console - $ spack module loads --dependencies <spec> + $ spack tcl loads --dependencies <spec> An equivalent alternative using `process substitution <http://tldp.org/LDP/abs/html/process-sub.html>`_ is: .. code-block :: console - $ source <( spack module loads --dependencies <spec> ) - -.. warning:: - - The ``spack load`` command does not currently accept the - ``--dependencies`` flag. Use ``spack module loads`` instead, for - now. - -.. See #1662 + $ source <( spack tcl loads --dependencies <spec> ) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -219,12 +211,12 @@ Module Commands for Shell Scripts Although Spack is flexible, the ``module`` command is much faster. This could become an issue when emitting a series of ``spack load`` commands inside a shell script. By adding the ``--shell`` flag, -``spack module find`` may also be used to generate code that can be +``spack tcl find`` may also be used to generate code that can be cut-and-pasted into a shell script. For example: .. code-block:: console - $ spack module loads --dependencies py-numpy git + $ spack tcl loads --dependencies py-numpy git # bzip2@1.0.6%gcc@4.9.3=linux-x86_64 module load bzip2-1.0.6-gcc-4.9.3-ktnrhkrmbbtlvnagfatrarzjojmkvzsx # ncurses@6.0%gcc@4.9.3=linux-x86_64 @@ -264,9 +256,9 @@ Module Prefixes ^^^^^^^^^^^^^^^ On some systems, modules are automatically prefixed with a certain -string; ``spack module loads`` needs to know about that prefix when it +string; ``spack tcl loads`` needs to know about that prefix when it issues ``module load`` commands. Add the ``--prefix`` option to your -``spack module loads`` commands if this is necessary. +``spack tcl loads`` commands if this is necessary. For example, consider the following on one system: @@ -275,11 +267,11 @@ For example, consider the following on one system: $ module avail linux-SuSE11-x86_64/antlr-2.7.7-gcc-5.3.0-bdpl46y - $ spack module loads antlr # WRONG! + $ spack tcl loads antlr # WRONG! # antlr@2.7.7%gcc@5.3.0~csharp+cxx~java~python arch=linux-SuSE11-x86_64 module load antlr-2.7.7-gcc-5.3.0-bdpl46y - $ spack module loads --prefix linux-SuSE11-x86_64/ antlr + $ spack tcl loads --prefix linux-SuSE11-x86_64/ antlr # antlr@2.7.7%gcc@5.3.0~csharp+cxx~java~python arch=linux-SuSE11-x86_64 module load linux-SuSE11-x86_64/antlr-2.7.7-gcc-5.3.0-bdpl46y @@ -631,37 +623,36 @@ The allowed values for the ``autoload`` statement are either ``none``, Maintaining Module Files ------------------------ -Spack not only provides great flexibility in the generation of module files -and in the customization of both their layout and content, but also ships with -a tool to ease the burden of their maintenance in production environments. -This tool is the ``spack module`` command: +Each type of module file has a command with the same name associated +with it. The actions these commands permit are usually associated +with the maintenance of a production environment. Here's, for instance, +a sample of the features of the ``spack tcl`` command: .. command-output:: spack tcl --help .. _cmd-spack-module-refresh: -^^^^^^^^^^^^^^^^^^^^^^^^ -``spack module refresh`` -^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Refresh the set of modules +^^^^^^^^^^^^^^^^^^^^^^^^^^ -The command that regenerates module files to update their content or -their layout is ``module refresh``: +The subcommand that regenerates module files to update their content or +their layout is ``refresh``: .. command-output:: spack tcl refresh --help A set of packages can be selected using anonymous specs for the optional -``constraint`` positional argument. The argument ``--module-type`` identifies -the type of module files to refresh. Optionally the entire tree can be deleted +``constraint`` positional argument. Optionally the entire tree can be deleted before regeneration if the change in layout is radical. .. _cmd-spack-module-rm: ^^^^^^^^^^^^^^^^^^^ -``spack module rm`` +Delete module files ^^^^^^^^^^^^^^^^^^^ If instead what you need is just to delete a few module files, then the right -command is ``module rm``: +subcommand is ``rm``: .. command-output:: spack tcl rm --help |