Skip to content

Add module-help support for Tcl modules #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

Add module-help support for Tcl modules #785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/source/051_tcl_modulefiles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,11 @@ standard TCL language.

**unuse** *path* :
remove *path* to MODULEPATH


**module-help** *string* :
What is printed out when the help command is called. Note that
the *help string* can be multi-lined.

**module-info** *string* :
This command returns different things depending what *string* is:

Expand Down
28 changes: 25 additions & 3 deletions rt/tclmodules/err.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
step 1
lua ProjectDIR/src/lmod.in.lua shell --regression_testing --version
===========================
Modules based on Lua: Version 8.7.59 2025-03-06 13:51 -07:00
Modules based on Lua: Version 8.7.65 2025-08-05 10:24 -06:00
by Robert McLay [email protected]
===========================
step 2
Expand Down Expand Up @@ -33,8 +33,9 @@ step 6
lua ProjectDIR/src/lmod.in.lua shell --regression_testing avail
===========================
ProjectDIR/rt/tclmodules/mf
a/1.0 getenv/1.0 hide/2.0 (D) showMe/1.0
earlyLateOutput/2.0 (L) hide/1.0 outputMode/1.0
a/1.0 help/1.0 hide/2.0 (D)
earlyLateOutput/2.0 (L) help/2.0 (D) outputMode/1.0
getenv/1.0 hide/1.0 showMe/1.0
Where:
D: Default Module
L: Module is loaded
Expand All @@ -56,6 +57,7 @@ The following is a list of the modules and extensions currently available:
a: a/1.0
earlyLateOutput: earlyLateOutput/2.0
getenv: getenv/1.0
help: help/1.0, help/2.0
hide: hide/1.0, hide/2.0
outputMode: outputMode/1.0
showMe: showMe/1.0
Expand All @@ -69,3 +71,23 @@ must specify the version if there is more than one version:
step 9
cat myMode.log
===========================
===========================
step 10
lua ProjectDIR/src/lmod.in.lua shell --regression_testing load help/1.0
===========================
===========================
step 11
lua ProjectDIR/src/lmod.in.lua shell --regression_testing help help/1.0
===========================
Module Specific Help for "help/1.0"
first help line
with newline
second help line
===========================
step 12
lua ProjectDIR/src/lmod.in.lua shell --regression_testing help help/2.0
===========================
Module Specific Help for "help/2.0"
first help line
with newline
second help line
4 changes: 4 additions & 0 deletions rt/tclmodules/mf/help/1.0
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#%Module
module-help {first help line
with newline}
module-help {second help line}
6 changes: 6 additions & 0 deletions rt/tclmodules/mf/help/2.0
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#%Module
proc ModulesHelp {} {
puts stderr {second help line}
}
module-help {first help line
with newline}
28 changes: 28 additions & 0 deletions rt/tclmodules/out.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,31 @@ step 9
cat myMode.log
===========================
myMode: spider
===========================
step 10
lua ProjectDIR/src/lmod.in.lua shell --regression_testing load help/1.0
===========================
LOADEDMODULES=earlyLateOutput/2.0:getenv/1.0:help/1.0;
export LOADEDMODULES;
MODULEPATH=ProjectDIR/rt/tclmodules/mf;
export MODULEPATH;
_LMFILES_=ProjectDIR/rt/tclmodules/mf/earlyLateOutput/2.0:ProjectDIR/rt/tclmodules/mf/getenv/1.0:ProjectDIR/rt/tclmodules/mf/help/1.0;
export _LMFILES_;
_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={earlyLateOutput={fn="ProjectDIR/rt/tclmodules/mf/earlyLateOutput/2.0",fullName="earlyLateOutput/2.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="earlyLateOutput",wV="000000002.*zfinal",},getenv={fn="ProjectDIR/rt/tclmodules/mf/getenv/1.0",fullName="getenv/1.0",loadOrder=2,propT={},stackDepth=0,status="active",userName="getenv",wV="000000001.*zfinal",},help={fn="ProjectDIR/rt/tclmodules/mf/help/1.0",fullName="help/1.0",loadOrder=3,propT={},stackDepth=0,status="active",userName="help/1.0",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/tclmodules/mf",},systemBaseMPATH="ProjectDIR/rt/tclmodules/mf",}';
export _ModuleTable_;
===========================
step 11
lua ProjectDIR/src/lmod.in.lua shell --regression_testing help help/1.0
===========================
MODULEPATH=ProjectDIR/rt/tclmodules/mf;
export MODULEPATH;
_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={earlyLateOutput={fn="ProjectDIR/rt/tclmodules/mf/earlyLateOutput/2.0",fullName="earlyLateOutput/2.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="earlyLateOutput",wV="000000002.*zfinal",},getenv={fn="ProjectDIR/rt/tclmodules/mf/getenv/1.0",fullName="getenv/1.0",loadOrder=2,propT={},stackDepth=0,status="active",userName="getenv",wV="000000001.*zfinal",},help={fn="ProjectDIR/rt/tclmodules/mf/help/1.0",fullName="help/1.0",loadOrder=3,propT={},stackDepth=0,status="active",userName="help/1.0",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/tclmodules/mf",},systemBaseMPATH="ProjectDIR/rt/tclmodules/mf",}';
export _ModuleTable_;
===========================
step 12
lua ProjectDIR/src/lmod.in.lua shell --regression_testing help help/2.0
===========================
MODULEPATH=ProjectDIR/rt/tclmodules/mf;
export MODULEPATH;
_ModuleTable_='_ModuleTable_={MTversion=3,depthT={},family={},mT={earlyLateOutput={fn="ProjectDIR/rt/tclmodules/mf/earlyLateOutput/2.0",fullName="earlyLateOutput/2.0",loadOrder=1,propT={},stackDepth=0,status="active",userName="earlyLateOutput",wV="000000002.*zfinal",},getenv={fn="ProjectDIR/rt/tclmodules/mf/getenv/1.0",fullName="getenv/1.0",loadOrder=2,propT={},stackDepth=0,status="active",userName="getenv",wV="000000001.*zfinal",},help={fn="ProjectDIR/rt/tclmodules/mf/help/1.0",fullName="help/1.0",loadOrder=3,propT={},stackDepth=0,status="active",userName="help/1.0",wV="000000001.*zfinal",},},mpathA={"ProjectDIR/rt/tclmodules/mf",},systemBaseMPATH="ProjectDIR/rt/tclmodules/mf",}';
export _ModuleTable_;
3 changes: 3 additions & 0 deletions rt/tclmodules/tclmodules.tdesc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ testdescript = {
runLmod load getenv # 7
runLmod spider # 8
runBase cat myMode.log # 9
runLmod load help/1.0 # 10
runLmod help help/1.0 # 11
runLmod help help/2.0 # 12

HOME=$ORIG_HOME
cat _stdout.[0-9][0-9][0-9] > _stdout.orig
Expand Down
7 changes: 7 additions & 0 deletions src/tcl2lua.tcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,12 @@ proc getModCmdOpts { &answerA &extraArgs args } {
set resultA(mode) $modeStr
}

proc module-help {args} {
global g_outputA
set msg [join $args]
lappend g_outputA "help(\[===\[$msg\]===\])\n"
}

proc module-info {what {more {}}} {
global g_fullName g_usrName g_shellName g_shellType
set mode [currentMode]
Expand Down Expand Up @@ -1077,6 +1083,7 @@ proc execute-modulefile {modfile } {
interp alias $child is-loaded {} is-loaded
interp alias $child is-avail {} is-avail
interp alias $child module {} module
interp alias $child module-help {} module-help
interp alias $child module-info {} module-info
interp alias $child module-whatis {} module-whatis
interp alias $child myPuts {} myPuts
Expand Down
Loading