Skip to content

Commit 997d79a

Browse files
committed
doc: desc. cmds/vars hooks in NEWS
1 parent c8e3bc3 commit 997d79a

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

.aspell.en.pws

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
personal_ws-1.1 en 854
1+
personal_ws-1.1 en 855
22
ABBRVLIST
33
ActiveTcl
44
Adrien
@@ -711,6 +711,7 @@ simd
711711
siteProcsToExposeToItrp
712712
siteconfig
713713
sitevalue
714+
sitevar
714715
sitevarvalue
715716
soFT
716717
soFt

NEWS.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,23 @@ Modules 5.2.0 (not yet released)
146146
:envvar:`__MODULES_LMREFRESH` environment variable.
147147
* Optimize :subcmd:`refresh` sub-command to only evaluate loaded modules that
148148
defines volatile environment changes (shell completion, alias or function).
149+
(fix issue #477)
150+
* Add :sitevar:`modulefile_extra_cmds` hook variable that could be defined in
151+
:file:`siteconfig.tcl` file to define specific commands in modulefile
152+
interpreter context. :sitevar:`modulefile_extra_cmds` is a list of command
153+
name and relative procedure pairs. (fix issue #286)
154+
* Add :sitevar:`modulefile_extra_vars` hook variable that could be defined in
155+
:file:`siteconfig.tcl` file to define specific variables in modulefile
156+
interpreter context. :sitevar:`modulefile_extra_vars` is a list of variable
157+
name and value pairs. (fix issue #286)
158+
* Add :sitevar:`modulerc_extra_cmds` hook variable that could be defined in
159+
:file:`siteconfig.tcl` file to define specific commands in modulerc
160+
interpreter context. :sitevar:`modulerc_extra_cmds` is a list of command
161+
name and relative procedure pairs. (fix issue #286)
162+
* Add :sitevar:`modulerc_extra_vars` hook variable that could be defined in
163+
:file:`siteconfig.tcl` file to define specific variables in modulerc
164+
interpreter context. :sitevar:`modulerc_extra_vars` is a list of variable
165+
name and value pairs. (fix issue #286)
149166

150167
.. _Nagelfar: http://nagelfar.sourceforge.net/
151168
.. _ShellCheck: https://www.shellcheck.net/

doc/source/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ def ghcommit_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
345345
return [title], []
346346

347347
# define new directive/role that can be used as .. subcmd::/:subcmd:,
348-
# .. mfcmd::/:mfcmd: and .. mfvar::/:mfvar:
348+
# .. mfcmd::/:mfcmd:, .. mfvar::/:mfvar: and .. sitevar::/:sitevar:
349349
def setup(app):
350350
app.add_object_type('subcmd', 'subcmd',
351351
objname='module sub-command',
@@ -359,6 +359,10 @@ def setup(app):
359359
objname='modulefile variable',
360360
indextemplate='pair: %s; modulefile variable',
361361
parse_node=parse_cmd_args_node)
362+
app.add_object_type(directivename='sitevar', rolename='sitevar',
363+
objname='siteconfig variable',
364+
indextemplate='pair: %s; siteconfig variable',
365+
parse_node=parse_cmd_args_node)
362366
app.add_object_type('instopt', 'instopt',
363367
objname='installation option',
364368
indextemplate='pair: %s; installation option',

0 commit comments

Comments
 (0)