From f65a1155e1aa30864c4c8bb49d1e5445f1ab9b67 Mon Sep 17 00:00:00 2001 From: George Hartzell Date: Tue, 12 Feb 2019 13:02:13 -0800 Subject: Enhancement to module autoload documentation (#10310) * Note that `none` is the default for lmod autoload Save a bit of confusion by *explicitly* pointing out that `none` is the default value for autoload in the lmod module file generator. * Add a tip re building software externally Add a tip about using `autoload: all` when building packages outside of the tree that use artifacts (e.g. libraries, includes) within the tree. --- lib/spack/docs/module_file_support.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst index e644b3625f..32e03f546f 100644 --- a/lib/spack/docs/module_file_support.rst +++ b/lib/spack/docs/module_file_support.rst @@ -618,7 +618,21 @@ activated using ``spack activate``: The configuration file above will produce module files that will load their direct dependencies if the package installed depends on ``python``. The allowed values for the ``autoload`` statement are either ``none``, -``direct`` or ``all``. +``direct`` or ``all``. The default is ``none``. + +.. tip:: + Building external software + Setting ``autoload`` to ``direct`` for all packages can be useful + when building software outside of a Spack installation that depends on + artifacts in that installation. E.g. (adjust ``lmod`` vs ``tcl`` + as appropriate): + + .. code-block:: yaml + + modules: + lmod: + all: + autoload: 'direct' .. note:: TCL prerequisites -- cgit v1.2.3-60-g2f50