From 130c51518be97da87465d000e5ee10ef13786691 Mon Sep 17 00:00:00 2001
From: Achim Gsell <achim.gsell@psi.ch>
Date: Mon, 25 May 2020 10:32:10 +0200
Subject: [PATCH] get_release(): comment added

---
 Pmodules/modulecmd.bash.in | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Pmodules/modulecmd.bash.in b/Pmodules/modulecmd.bash.in
index 93e21d0..684759c 100644
--- a/Pmodules/modulecmd.bash.in
+++ b/Pmodules/modulecmd.bash.in
@@ -124,7 +124,12 @@ get_release() {
 		std::upvar $1 'stable'
 		return 0
 	fi
-
+        #
+        # In an overlay the name of the module-file is something like
+        #   dir/modulefiles/name/version
+        # the corresponding release file is
+        #   dir/modulefiles/name/.release-version
+        #
 	local -r releasefile="${modulefile%/*}/.release-${modulefile##*/}"
 	if [[ -r ${releasefile} ]]; then
 		# read releasefile, remove empty lines, spaces etc