zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modules: enhance help message (#36410)

Browse Source 
Update tcl and lmod modulefile template to provide more information on
help message (name, version and target) like done on whatis for lmod
modulefiles.
This commit is contained in:
Xavier Delaruelle
2023-03-27 10:48:25 +02:00
committed by GitHub
parent 84d67190a6
commit ea60220a84
4 changed files with 65 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
share/spack/templates/modules/modulefile.lua
View File

@@ -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 %}

10
share/spack/templates/modules/modulefile.tcl
View File

@@ -14,11 +14,15 @@
module-whatis "{{ short_description }}"
{% endif %}
{% if long_description %}
proc ModulesHelp { } {
{{ long_description| textwrap(72)| quote()| prepend_to_line('puts stderr ')| join() }}
}
puts stderr "Name : {{ spec.name }}"
puts stderr "Version: {{ spec.version }}"
puts stderr "Target : {{ spec.target }}"
{% if long_description %}
puts stderr ""
{{ long_description| textwrap(72)| quote()| prepend_to_line(' puts stderr ')| join() }}
{% endif %}
}
{% endblock %}
{% block autoloads %}