summaryrefslogtreecommitdiff
path: root/share/spack/templates/modules/modulefile.lua
diff options
context:
space:
mode:
authorXavier Delaruelle <xavier.delaruelle@cea.fr>2023-03-27 10:48:25 +0200
committerGitHub <noreply@github.com>2023-03-27 10:48:25 +0200
commitea60220a84b0547abe886683fabbb44184cdfb63 (patch)
treef82f8f007bd3209f53bae9dadb878bb0a78611f6 /share/spack/templates/modules/modulefile.lua
parent84d67190a65d22a4ed615adcbd27534d1b60fc3a (diff)
downloadspack-ea60220a84b0547abe886683fabbb44184cdfb63.tar.gz
spack-ea60220a84b0547abe886683fabbb44184cdfb63.tar.bz2
spack-ea60220a84b0547abe886683fabbb44184cdfb63.tar.xz
spack-ea60220a84b0547abe886683fabbb44184cdfb63.zip
modules: enhance help message (#36410)
Update tcl and lmod modulefile template to provide more information on help message (name, version and target) like done on whatis for lmod modulefiles.
Diffstat (limited to 'share/spack/templates/modules/modulefile.lua')
-rw-r--r--share/spack/templates/modules/modulefile.lua4
1 files changed, 4 insertions, 0 deletions
diff --git a/share/spack/templates/modules/modulefile.lua b/share/spack/templates/modules/modulefile.lua
index 8a8329ecd1..42ef9e5fd1 100644
--- a/share/spack/templates/modules/modulefile.lua
+++ b/share/spack/templates/modules/modulefile.lua
@@ -15,7 +15,11 @@ whatis([[Short description : {{ short_description }}]])
whatis([[Configure options : {{ configure_options }}]])
{% endif %}
+help([[Name : {{ spec.name }}]])
+help([[Version: {{ spec.version }}]])
+help([[Target : {{ spec.target }}]])
{% if long_description %}
+help()
help([[{{ long_description| textwrap(72)| join() }}]])
{% endif %}
{% endblock %}