diff options
Diffstat (limited to 'lib/spack/docs/module_file_support.rst')
| -rw-r--r-- | lib/spack/docs/module_file_support.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst index 14925c8590..721b18d5fc 100644 --- a/lib/spack/docs/module_file_support.rst +++ b/lib/spack/docs/module_file_support.rst @@ -394,6 +394,32 @@ that are already in the LMod hierarchy. For hierarchies that are deeper than three layers ``lmod spider`` may have some issues. See `this discussion on the LMod project <https://github.com/TACC/Lmod/issues/114>`_. +.. _customize-env-modifications: + +""""""""""""""""""""""""""""""""""" +Customize environment modifications +""""""""""""""""""""""""""""""""""" + +You can control which prefixes in a Spack package are added to environment +variables with the ``prefix_inspections`` section; this section maps relative +prefixes to the list of environment variables which should be updated with +those prefixes. + +.. code-block:: yaml + + modules: + prefix_inspections: + bin: + - PATH + lib: + - LIBRARY_PATH + '': + - CMAKE_PREFIX_PATH + +In this case, for a Spack package ``foo`` installed to ``/spack/prefix/foo``, +the generated module file for ``foo`` would update ``PATH`` to contain +``/spack/prefix/foo/bin``. + """""""""""""""""""""""""""""""""""" Filter out environment modifications """""""""""""""""""""""""""""""""""" |