From ea60220a84b0547abe886683fabbb44184cdfb63 Mon Sep 17 00:00:00 2001
From: Xavier Delaruelle <xavier.delaruelle@cea.fr>
Date: Mon, 27 Mar 2023 10:48:25 +0200
Subject: 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.
---
 share/spack/templates/modules/modulefile.lua |  4 ++++
 share/spack/templates/modules/modulefile.tcl | 10 +++++++---
 2 files changed, 11 insertions(+), 3 deletions(-)

(limited to 'share')

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 %}
diff --git a/share/spack/templates/modules/modulefile.tcl b/share/spack/templates/modules/modulefile.tcl
index 5ea976fbdd..935d1df72d 100644
--- a/share/spack/templates/modules/modulefile.tcl
+++ b/share/spack/templates/modules/modulefile.tcl
@@ -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 %}
-- 
cgit v1.2.3-60-g2f50