Debian Codegraph @

doc/build/NEWS.txt

raw
1 Release notes
2 *************
3
4 This file describes changes in recent versions of Modules. It
5 primarily documents those changes that are of interest to users and
6 admins.
7
8
9 Modules 5.7.0 (2026-09-21)
10 ==========================
11
12 * Script: improve **mrel** to always ask a Fedora Kerberos ticket.
13
14 * Use CMake "EVAL CODE" to forward arguments passed to "module" CMake
15 function. (fix issue #419 with contribution from Benoit Dumas)
16
17 * Doc: update email address in Code of conduct to report bad behavior
18 to maintainers.
19
20 * Move *modules-interest* mailing-list to HPSF.
21
22 * Script: add tests on **mb** utility to track performance of load,
23 list and purge sub-commands with large number (>100) of modules.
24
25 * Script: fix procedure call timing of Tcllib profiler module within
26 **mlprof** to avoid mixing timers from calls made at different
27 interpretation level.
28
29 * Parse loaded environment in early execution stage and always fail if
30 an inconsistency is detected.
31
32 * Improve performances of loaded module comparison used when checking
33 conflict and requirement dependencies. (fix issue #603)
34
35 * Fix environment variable synchronization issue between modulefile
36 evaluation interpreters: supersede the "append" Tcl command rather
37 sync interpreters for each environment variable change. A
38 substantial performance improvement is observed when loading or
39 unloading many modulefiles. (fix issue #603)
40
41 * Script: add "--with-lmod" option to **mb** command to compare
42 current Modules version against an installed version of Lmod.
43
44 * Update the "sh-to-mod" mechanism to correctly parse shell alias on
45 Dash shell version 0.5.13.
46
47 * Update the "sh-to-mod" mechanism to correctly parse path-like
48 environment variable on Fish shell version 4.3.
49
50 * When fetching user's groups, in case a group name cannot be resolved
51 use this group gid number as name instead of raising an error. (fix
52 issue #604)
53
54 * Introduce "path_entry_reorder" configuration option that change
55 order of entry in a path-like environment variable when it is added
56 again. This new configuration option is disabled by default. This
57 option can be changed at installation time with "--enable-path-
58 entry-reorder". When "path_entry_reorder" is changed with "config"
59 sub-command, it sets the "MODULES_PATH_ENTRY_REORDER" environment
60 variable. (fix issue #595 with contribution from Achim Gsell)
61
62 * Install: reorder the options in the "configure" script help message
63 alphabetically.
64
65 * Doc: add manual page for modulecmd command.
66
67 * Make "getenv" modulefile command available from module rc file
68 evaluation context. (fix issue #588)
69
70 * Install: add installation option "--disable-compressed-changelog" to
71 cope with packaging process handling documentation file compression
72 at their level. (fix issue #592)
73
74 * Add "-p" option as an abbreviated form for "--paginate". (fix issue
75 #593)
76
77 * Add "-P" option as an abbreviated form for "--no-pager". (fix issue
78 #606)
79
80 * Doc: add Organize TSC meeting guide.
81
82 * Add the "paginate" configuration option to control whether or not
83 output message should be piped into defined pager by default. This
84 option can be changed at installation time with "--enable-paginate".
85 When "paginate" is changed with "config" sub-command, it sets the
86 "MODULES_PAGINATE" environment variable. (fix issue #594)
87
88 * Doc: add Plan next release content guide
89
90 * Introduce the "non_exportable_tags" configuration option that lists
91 tags that should not be exported to modules once loaded. When
92 "non_exportable_tags" is changed with "config" sub-command, it sets
93 the "MODULES_NON_EXPORTABLE_TAGS" environment variable. (fix issue
94 #608)
95
96 * Improve the performance of the module’s column output by removing
97 the costly optimization that attempts to fit more columns within the
98 available screen width. (fix issue #622)
99
100 * Fix superseding definition of "source" Tcl command when
101 "source_cache" configuration option is enabled to support
102 "-encoding" option. (fix issue #627)
103
104 * Correctly parse the module specifications passed as argument on
105 "depends-on", mfcmd:*always-load* and "prereq-all" modulefile
106 commands. It especially fixes module specification containing the
107 definition of variants. (fixes issue #626)
108
109 * Report the full *via* path for modules on "avail" and "spider" sub-
110 commands rather the last part of this via information. JSON output
111 is updated to report the "via" key as an array rather as a string.
112 (fix issue #586)
113
114 * Introduce the "info_extension" configuration option to consider that
115 module extensions have a pure informational purpose and no module
116 alias is associated to them. Extensions defined with "provide"
117 modulefile command are not affected by this mechanism. When
118 "info_extension" is changed with "config" sub-command, it sets the
119 "MODULES_INFO_EXTENSION" environment variable. (fix issue #585)
120
121 * Doc: add Linked environment variables design notes.
122
123 * Add the "linked_envvars" configuration option to apply the same
124 value update commands to all linked environment variables. When
125 "linked_envvars" is changed with "config" sub-command, it sets the
126 "MODULES_LINKED_ENVVARS" environment variable. (fix issue #609)
127
128 * Doc: add Initialize environment variables design notes.
129
130 * Add the "init_envvars" configuration option to define initial values
131 to assign to environment variables before they are modified for the
132 first time. This option can be changed at installation time with "--
133 with-init-envvars". When "init_envvars" is changed with "config"
134 sub-command, it sets the "MODULES_INIT_ENVVARS" environment
135 variable. (fix issue #572)
136
137 * Enable lexical binding in Emacs addon file. (contribution from Peter
138 Oliver)
139
140 * Script: update **mt** utility to analyze test suite log file when
141 test suite run is aborted.
142
143 * Correctly match loaded modules specified as requirement with a
144 trailing "/" character after module name. (fix issue #640)
145
146 * Also consider "-" in addition to "." as a version number separator
147 character when selecting a module with the "extended_default"
148 mechanism. (fix issue #619)
149
150 * Rename Modules initialization script for Python "env_modules.py" to
151 make it a proper Python module name.
152
153 * Rename the Python initialization script to "env_modules.py" so that
154 it uses a valid Python module name. Generates a "python.py" symlink
155 onto "env_modules.py" to preserve compatibility. (contribution from
156 Byron Boulton)
157
158 * Install: introduce the "--enable-set-pythonpath" installation option
159 to prepend Modules "init" directory to the "PYTHONPATH" environment
160 variable during Modules initialization. This option is enabled by
161 default and make it easier to import the "env_modules" Python
162 module. (fix issue #483 with contribution from Byron Boulton)
163
164 * Install: add the "--enable-append-pythonpath" installation option,
165 which causes "--enable-set-pythonpath" to append the Modules "init"
166 directory to "PYTHONPATH" instead of prepending it. (contribution
167 from Byron Boulton)
168
169 * Doc: clarify shell script, executed by "source-sh" modulefile
170 command or "sh-to-mod" sub-command, does not get access to shell
171 aliases, functions or completions settings only available in
172 interactive sessions or defined in profile files. (fix issue #646)
173
174 * Report a global known error when Modules Tcl extension library
175 cannot be loaded. (fix issue #644)
176
177 * Add "domainname" configuration option to define the command to run
178 to fetch domain name. It can be changed at installation time with "
179 --with-domainname" and "--with-domainname-opts" options. When
180 "domainname" is changed with "config" sub-command, it sets the
181 "MODULES_DOMAINNAME" environment variable. (fix issue #645)
182
183 * Update the "source-sh" modulefile command and "sh-to-mod" sub-
184 command mechanism to produce a more consistent value for a path-like
185 environment variable change that requires both a prepended and an
186 appended part expressed with a different delimiter character: a
187 "setenv" command is now generated instead in this situation.
188
189 * Update the "source-sh" modulefile command and "sh-to-mod" sub-
190 command mechanism to no longer de-duplicate a path entry found
191 several times in the entries it prepends or in the entries it
192 appends, and to add the "--duplicates" option on a generated
193 "prepend-path" or "append-path" command when one of the path entries
194 it adds is already found in the variable value prior script
195 evaluation, is found several times in the entries it adds or is
196 found in both the entries it prepends and the entries it appends, so
197 this entry is not silently absorbed by these commands' default de-
198 duplication behavior nor relocated by the "path_entry_reorder"
199 configuration option.
200
201 * Resolve an exact "name/version" specification without validating
202 every sibling modulefile found in its directory, by walking versions
203 from the dictionary-highest to the dictionary-lowest and stopping as
204 soon as the implicit "default" and "latest" symbolic versions are
205 settled. A substantial performance improvement is observed when
206 loading an existing modulefile out of a directory holding hundreds
207 or thousands of sibling versions. (fix issue #561)
208
209 * Doc: add Module find and resolution process design notes.
210
211 * Doc: add Testsuite structure guide describing the DejaGnu testsuite
212 structure.
213
214 * Doc: document and cross-reference Commit message conventions in
215 Contributing.
216
217 * Doc: document Code comments conventions in Contributing.
218
219 * Doc: add Continuous integration guide describing continuous
220 integration usage.
221
222 * Install: rename the shipped "COPYING.GPLv2" license file to
223 "COPYING", the name convention recognized by packaging tools.
224
225 * Doc: fix favicon rendering with a black background instead of white
226 on viewers that ignore transparency, by setting its transparent
227 pixels to a white matte color instead of black.
228
229 * Doc: document Windows Terminal profile setup as an alternative way
230 to initialize Modules on Windows without an install script. (fix
231 issue #634)
232
233 * Install: use "reg add" instead of "setx /M" to persist the system-
234 wide "PATH" environment variable in "INSTALL.bat" and
235 "UNINSTALL.bat", as "setx" silently truncates the value it writes to
236 1024 characters, which could corrupt the system "PATH" when
237 installing from a shell with an already long inherited "PATH" (e.g.
238 a Visual Studio Developer Prompt). (fix issue #654)
239
240 * Doc: add Hook API design notes.
241
242 * Add the "add-hook" siteconfig command to register a procedure on one
243 of 4 stable hook events ("before-modulefile-eval", "after-
244 modulefile-eval", "before-modulerc-eval", "after-modulerc-eval"), so
245 sites no longer need to rely on "trace" or procedure renaming, which
246 bind to internal implementation details, to run code before or after
247 a modulefile or modulerc evaluation. (fix issue #607)
248
249 * Doc: add Add new hook event guide describing how to contribute a new
250 hook event.
251
252 * Doc: add Sync remote application directories on first load cookbook
253 recipe.
254
255 * Testsuite: add *completion* testsuite to validate shell Tab
256 completion of this project. This testsuite can be invoked with "make
257 testcompletion" or "script/mt comp". It drives a real bash, zsh,
258 fish or tcsh session through Expect to press the Tab key against the
259 built shell completion script and check the resulting candidate
260 list.
261
262 * Init: fix numerous inconsistencies between "module help"'s usage
263 message and the option flags and positional arguments each sub-
264 command actually accepts, and between that usage message and what
265 bash, fish, tcsh and zsh Tab completion offer for each sub-command.
266 Guarded against regressing with a new ground-truth check in the
267 *completion* testsuite that compares "module"/"ml" Tab completion
268 against the sub-commands, switches, options and argument kinds
269 parsed straight out of "module help".
270
271 * Init: no longer offer the legacy "initadd", "initclear", "initlist",
272 "initprepend" and "initrm" sub-commands as Tab completion candidates
273 (bash, fish, tcsh, zsh), since "module help" does not document them.
274
275 * Testsuite: add *cookbook* testsuite to validate the recipes
276 documented under Cookbook. This testsuite can be invoked with "make
277 testcookbook" or "script/mt cook". It builds a sandboxed fixture
278 from the exact files a recipe ships under "doc/example/", then runs
279 the commands demonstrated in the recipe's "Usage example"
280 documentation in order and checks that similar output is obtained.
281 Currently covers the Sync remote application directories on first
282 load recipe.
283
284 * Doc: add Ignore files in modulepath design notes.
285
286 * Add "modulepath-ignore" modulefile command to define, from rc files,
287 gitignore-style patterns describing modulepath content to ignore
288 when searching for modulefiles. Ignored files and directories are
289 handled as if they do not exist: they are not checked, not walked
290 down, not reported and not recorded in modulepath cache file. Add
291 "modulepath_ignore" configuration option and "--no-modulepath-
292 ignore" command line switch to control whether pattern definitions
293 are applied. (fix issue #562)
294
295 * Install: add the "--with-pythondir" installation option to define
296 the directory where to install the "env_modules" Python module. It
297 enables for instance to install "env_modules.py" with the other
298 Python modules available on the system. When this option is set, "--
299 enable-set-pythonpath" adds this directory to "PYTHONPATH" instead
300 of the Modules "init" directory. (fix issue #643)
301
302 * Introduce "ignore_cache_subcmds" configuration option that defines a
303 list of module sub-commands on which module cache files are ignored.
304 It is useful when cache files are large: a sub-command targeting
305 specific modules (like "load") may find them faster by walking
306 through modulepath directories than by evaluating whole cache files.
307 When "ignore_cache_subcmds" is changed with "config" sub-command, it
308 sets the "MODULES_IGNORE_CACHE_SUBCMDS" environment variable. (fix
309 issue #563)
310
311 * Protect the creation of the Tcl sub-interpreters used to evaluate
312 modulercs and modulefiles with the quarantine mechanism. Environment
313 variables listed in the "run_quarantine" configuration option are
314 unset or set to the value of their corresponding
315 "MODULES_RUNENV_<VAR>" variable during this creation step, then
316 restored to their original value. (fix issue #623)
317
318 * Doc: adopt the Linux kernel policy on AI coding assistants in
319 Contributing: AI agents must never add their own "Signed-off-by:"
320 trailer and their involvement must be disclosed with an "Assisted-
321 by:" trailer.
322
323 * Doc: add the Lesser known features document that explains a
324 selection of useful but lesser known features through practical
325 examples and common use cases.
326
327 * Init: fix command injection in Bash completion when module names
328 contain shell meta-characters. Completion candidates were passed to
329 "compgen -W" which evaluates command substitution syntax. (fix
330 CVE-2026-85013 found by AISLE in partnership with Red Hat)
331
332 * Accept abbreviated upper bounds in version ranges such as "@3.20:3"
333 to select versions starting at "3.20" within major version "3". (fix
334 issue #698)
335
336 * Fix resolution of relative path entries in "MODULEPATH" when a
337 module is loaded during a modulefile evaluation. Such entry was
338 resolved against the directory of the evaluating modulefile rather
339 than against the current working directory. A relative *directory*
340 argument of the "is-used" modulefile command or of the "unuse" sub-
341 command is also resolved against the current working directory to
342 recognize such entry whatever its form.
343
344 * Keep non-sticky requirements of sticky modules loaded during a
345 "purge" and explicitly report why their unload is skipped according
346 to the "sticky_purge" configuration. (fix issue #582)
347
348 * Fix internal error raised by "switch" sub-command when the unload of
349 the switched-off module fails after some of its dependent modules
350 were unloaded for reload, and switch sequence continues as
351 "switch_unload" is not set in "abort_on_error". Dependent modules
352 restored by the failed unload are not reloaded anymore.
353
354
355 Modules 5.6.2 (2026-09-07)
356 ==========================
357
358 * Init: fix command injection in Bash completion when module names
359 contain shell meta-characters. Completion candidates were passed to
360 "compgen -W" which evaluates command substitution syntax. (fix
361 CVE-2026-85013 found by AISLE in partnership with Red Hat)
362
363
364 Modules 5.6.1 (2025-11-25)
365 ==========================
366
367 * Script: improve **mrel** to better support Koji states and not rely
368 on sudo privileges to test a new release.
369
370 * Script: adapt utilities to only use **curl** rather also requiring
371 **wget**.
372
373 * Doc: Modules Technical Charter has been approved on September 4,
374 2025.
375
376 * Doc: add Adding Environment Modules support to EESSI design notes.
377
378 * Doc: update modulefile man page to describe the "report" modulefile
379 command, which is supported since version 4.0.
380
381 * Doc: use Furo Sphinx theme for the documentation published on Read
382 The Docs.
383
384 * Doc: describe how to call modulefile command from a hook procedure
385 in module man page. (fix issue #590)
386
387 * Doc: add warning in Installing Modules on Windows to mention **ml**
388 command name conflict with *MSVC x86 toolchain* "ml.exe". (fix issue
389 #589)
390
391 * Doc: add Maintainer guide.
392
393 * Doc: website is now located at https://envmodules.io.
394
395 * Doc: precise that no automatic path resolution is performed on
396 "prepend-path", "append-path" or "remove-path" modulefile commands.
397 (fix issue #597)
398
399 * Doc: add way to build latexpdf documentation.
400
401 * Ensure that a module having the same name than a loaded module from
402 another modulepath does not inherit its tags. (fix issue #599)
403
404 * Drop tags stored in memory that applies to a module when unloading
405 it. It ensures that tags applied to the module when reloaded from a
406 different modulepath are not inherited.
407
408 * Always apply *abort on error* behavior in case a Dependent Reload
409 sticky (and "--force" is not set) or super-sticky module fails to
410 reload. (fix issue #601)
411
412 * When loading a module, check already loaded modules and their
413 aliases exactly matching specification before looking at available
414 modules and their aliases. (fix issue #602)
415
416
417 Modules 5.6.0 (2025-07-31)
418 ==========================
419
420 * Rename "contrib" directory as "share" in sources to use clearer name
421 for architecture and configuration independent files.
422
423 * Set a Security policy for the project.
424
425 * Add red, white and black SVG logo files of Modules project.
426
427 * Doc: improve Links, Community sections in documentation index and
428 README
429
430 * Doc: improve Authors and Acknowledgments sections in README
431
432 * Doc: add Create new Modules release guide
433
434 * Update repository URL to https://github.com/envmodules/modules.
435
436 * Install: update "configure" script to allow running it from a
437 current working directory different than where this file is stored.
438 (fix issue #558)
439
440 * Doc: create *Developer HowTos* section on documentation website to
441 group development how-to guides.
442
443 * Doc: add Acknowledgments page in the documentation.
444
445 * Doc: describe Modules Governance.
446
447 * Doc: add Modules Technical Charter.
448
449 * Escape square brackets ("[]") used in values within produced shell
450 code as these characters may have special meaning on some shells
451 (like *csh*). (fix issue #565)
452
453 * Doc: advertise the Modules chat room ("#modules:matrix.org") to
454 discuss with the community.
455
456 * Doc: describe the Developer Certificate of Origin (DCO) process now
457 applied on contributions.
458
459 * Doc: add Add a new maintainer guide
460
461 * Fix interpreter variable reset between multiple modulefile or
462 modulerc evaluations when variable initial value is an invalid list.
463 (fix issue #570)
464
465 * Fix "source-sh" and "sh-to-mod" shell translation when used with new
466 *fish* shell version (4.0).
467
468 * Doc: add Mode select: irreversible module actions design notes.
469
470 * Introduce "use" extra specifier to search for "MODULEPATH" changes
471 performed with "module use", "append-path" or "prepend-path"
472 modulefile commands on "avail", "whatis" and "paths" sub-commands.
473
474 * Add "--dumpname" option to report name of current Environment
475 Modules implementation. Here it returns "Modules". This option is
476 also available on Lmod starting version 8.7.50.
477
478 * Add the "depends-on-any" modulefile command, alias over the "prereq"
479 command for compatibility with Lmod Tcl modulefiles.
480
481 * Add "depends-on-any" extra specifier to query modulefile requirement
482 definitions. The extra specifier aliases "prereq", "prereq-any" or
483 "require" may also be used to query this modulefile command.
484
485 * Introduce the "spider" sub-command that lists available modules
486 found in enabled modulepaths and recursively found in modulepaths
487 enabled by available modules. After a first step aimed at collecting
488 all modulepaths, "spider" proceeds and reports like "avail" sub-
489 command. The same set of options are supported.
490
491 * Introduce the "spider_output" and "spider_terse_output"
492 configuration options to define the content to report in addition to
493 the available module names respectively for "spider" sub-command
494 regular and terse output modes. Excepted value for these
495 configuration options is a colon separated list of elements to
496 report. Default value is
497 "modulepath:alias:dirwsym:sym:tag:variantifspec:key" for
498 "spider_output" and "modulepath:alias:dirwsym:sym:tag:variantifspec"
499 for "spider_terse_output". These values can be changed at
500 installation time respectively with the "--with-spider-output" and "
501 --with-spider-terse-output" options. These values can then be
502 superseded by using the "config" sub-command which sets the
503 "MODULES_SPIDER_OUTPUT" and "MODULES_SPIDER_TERSE_OUTPUT"
504 environment variables.
505
506 * Introduce the ability to control whether "spider" command search
507 results should recursively include or not modulefiles from
508 directories matching search query by use of the "--indepth" and "--
509 no-indepth" command-line switches or "spider_indepth" configuration
510 option (that sets "MODULES_SPIDER_INDEPTH" environment variable
511 through "config" command). Default value (enabled) may also be
512 changed at installation time with "--disable-spider-indepth" option.
513
514 * Doc: add spider sub-command design notes.
515
516 * The "lint" sub-command now also lint any readable modulecache files
517 when no modulefile specification is passed as argument or if
518 ".modulecache" file location is specifically passed as argument.
519
520 * Add the "hidden" element in the allowed value list of the
521 "avail_output", "avail_terse_output", "list_output",
522 "list_terse_output", "spider_output" and "spider_terse_output"
523 configuration options. When set, it is equivalent to use "--all"
524 option: hidden modules are shown.
525
526 * Produce a single output for multi pattern "avail" search rather than
527 a separate output for each submitted pattern.
528
529 * Produce a single output for multi pattern "whatis" search rather
530 than a separate output for each submitted pattern.
531
532 * Doc: clarify that character used in version specification like *,*
533 and *:* cannot be used as variant shortcut.
534
535 * Introduce "__MODULES_LMUSE" environment variable to keep track of
536 the loaded modules that enable modulepaths.
537
538 * Apply modulepath label defined with "modulepath-label" also on
539 output of "whatis" and "search" sub-commands.
540
541 * Report *via* information for each module entry on JSON output of
542 "avail" and "spider" sub-commands. *Via* information is the name of
543 the loaded or interpreted module that enables the modulepath in
544 which reported modules are stored.
545
546 * Add the "via" element in the allowed value list of the
547 "avail_output" and "spider_output" configuration options. When set,
548 if a modulepath is enabled by a module, this module name is reported
549 next to the modulepath name. "via" element is not available for
550 terse output mode. "via" is set by default in "spider_output"
551 configuration option.
552
553 * Add "modules_release" internal state. It will help to know the
554 current version of Modules within "siteconfig.tcl" script.
555
556 * Introduce "module-help" modulefile command which defines help text
557 to print when modulefile is evaluated in "help" mode.
558
559 * Update "add-property" modulefile command to use its *value* argument
560 to define tag on currently loading module.
561
562 * Doc: add module-warn modulefile command design notes.
563
564 * Add "module-warn" modulerc and modulefile command which prints a
565 warning message when designated modulefile is evaluated. This
566 command accepts options to emit the warning only for specific users,
567 groups or times.
568
569 * Introduce the "warning" informational module tag on modulefiles
570 targeted by "module-warn" command. Update default "tag_abbrev"
571 configuration option to add an abbreviation for the new tag ("W")
572 and default light and dark color palettes.
573
574 * Change light and dark color palettes for "nearly-forbidden" tag (red
575 text with yellow background), to make it look closer to "forbidden"
576 tag (red background) and distinguish it from new "warning" tag
577 (black text and yellow background).
578
579 * No raise of *nearly-forbidden* warning when affected modulefile is
580 evaluated in "refresh" mode.
581
582 * Issue the *nearly-forbidden* warning at the end of the affected
583 modulefile evaluation, ensuring it is always reported at the same
584 stage regardless of where it is defined.
585
586 * Change underlying shell code to set environment variable on *sh*,
587 *bash*, *ksh*, *zsh* and *fish* shells: enclose value within single
588 quotes rather escaping each special characters.
589
590 * "setenv" modulefile command now supports environment variable value
591 containing newline character. Exception is made for *csh* and *tcsh*
592 shells where newline characters are chopped from value. (fix issue
593 #557)
594
595 * Sort modules in JSON output as done on regular output.
596
597 * "cachebuild" command now sets the minimal Modules version specified
598 in the cache file magic cookie header to the oldest Modules version
599 compatible with this cache file, rather than the version that
600 generated the cache file. Freshly generated cache files are
601 compatible with Modules 5.3 and above.
602
603 * Doc: improve Enable Modules in shells guidelines.
604
605 * Doc: add Handle man pages search path cookbook recipe.
606
607 * Doc: add Other module implementations document.
608
609 * Add "update" sub-command, an alias of "reload"
610
611 * Add "disable" sub-command, an alias of "saverm"
612
613 * Add "describe" sub-command, an alias of "saveshow"
614
615 * Add "--show_hidden" option, an alias of "--all"
616
617 * Add "haveDynamicMPATH" modulefile command
618
619 * Fix "use.own" example modulefile to report when creating local
620 modulefiles directory. (fix issue #576)
621
622 * Doc: add manual page for envml command. (fix issue #190)
623
624 * Introduce Emacs addon files to highlight the modulefile syntax.
625 Installation of these files, which is enabled by default, is
626 controlled by the "--enable-emacs-addons" and "--emacsdatadir"
627 configure options. (contribution from Laurent Besson)
628
629 * Add "require_via" configuration option that controls whether or not
630 a requirement is considered between a module stored in a modulepath
631 and the loaded module that enables this modulepath. With Automated
632 module handling mechanisms enabled, modules stored in a modulepath
633 are unloaded or reloaded when the module enabling this modulepath is
634 changed. "require_via" is disabled by default but everyone willing
635 to hierarchically organize their modulefiles is encouraged to enable
636 this new option. This option can be changed at installation time
637 with "--enable-require-via". When "require_via" is changed with
638 "config" sub-command, it sets the "MODULES_REQUIRE_VIA" environment
639 variable.
640
641 * Install: installation option "--enable-new-features" is updated to
642 include "--enable-require-via".
643
644 * Doc: add Require via design notes.
645
646 * Skip reload of a *Dependent Reload* module if it is not found after
647 a change in enabled modulepaths. Reload of a not found module is
648 attempted only if it is tagged *super-sticky* or *sticky* and force
649 mode is disabled. Skipped module is considered *Dependent Unload*
650 module.
651
652 * Script: update **mb** tool to skip test for Modules version below
653 5.5 if Tcl 9 is selected.
654
655 * Introduce the "provide" modulefile command that defines module alias
656 over currently evaluating module. This helps convey that the module
657 offers additional functionality or components. (fix issue #539)
658
659 * Change "extensions" modulefile command to be an alias over the
660 "provide" command.
661
662 * Add the "provided-alias" element in the allowed value list of the
663 "avail_output", "avail_terse_output", "spider_output" and
664 "spider_terse_output" configuration options. When set, module
665 aliases are included into the output and the *extra match search*
666 mechanism is activated to scan modulefiles to get the module aliases
667 they define.
668
669 * Doc: add provide modulefile command design notes.
670
671 * Introduce "provide" and "provided-alias" extra specifiers to search
672 modules on "avail", "spider", "whatis" and "paths" sub-commands.
673 "provided-alias" extra specifier is an alias onto "provide" and
674 "family" extra specifiers.
675
676
677 Modules 5.5.0 (2024-11-11)
678 ==========================
679
680 * Init: update "cmd" shell initialization script to correctly define
681 "MODULESHOME" when installation pathname contains dot character.
682 (fix issue #525 with contribution from V-clone)
683
684 * Init: add completion for **ml** command on Tcsh shell. (fix issue
685 #416 with contribution from Laurent Besson)
686
687 * Init: fix completion of "mod-to-sh"'s options on Bash and Tcsh
688 shells.
689
690 * Fix modulepath file search when libtclenvmodules is disabled and
691 modulepath contains glob characters.
692
693 * Lib: correct libtclenvmodules to retrieve all user groups on Darwin
694 systems when user is member of more than 16 groups.
695
696 * Script: output testsuite run progress on **mt** development utility.
697
698 * Resolve switched-on module prior testing stickiness preservation.
699
700 * Contrib: fix versions modulefiles generated when "--enable-
701 versioning" installation option is set. Use "--not-req" option on
702 "module unload" commands to avoid declaring a conflict toward these
703 modules to unload. (fix issue #531)
704
705 * Add "hide-modulefile" and "hide-version" modulerc commands to
706 support modulerc files written for Lmod.
707
708 * Update "autoinit" sub-command to define **mogui** shell function or
709 alias if *mogui-cmd* command is found in "PATH".
710
711 * Add the "hide_auto_loaded" configuration option to tag automatically
712 loaded modules "hidden-loaded". These modules will not appear on
713 "list" sub-command output unless "--all" option is set. Option is
714 disabled by default and when set, it defines the
715 "MODULES_HIDE_AUTO_LOADED" environment variable.
716
717 * Introduce the "--modulepath" option to the "always-load", "depends-
718 on", "prereq", "prereq-all" and "prereq-any" modulefile commands.
719 When this option is set, required module should be located in a path
720 listed in the specified list or in an enabled modulepath matching
721 one path of the list. This information is recorded in loaded
722 environment in "__MODULES_LMPREREQPATH" variable.
723
724 * Add "lsb-release" modulefile command to get certain Linux Standard
725 Base (LSB) information. It accepts to following sub-commands: "id",
726 "codename" and "release".
727
728 * Add information logging capabilities controlled by two new
729 configuration options: "logger" which defines the command to use to
730 sent information to the log system and "logged_events" which
731 controls the information sent to logs.
732
733 * "logger" configuration option relies on the **logger** command by
734 default. It can be changed at installation time with "--with-logger"
735 and "--with-logger-opts" options. When "logger" is changed with
736 "config" sub-command, it sets the "MODULES_LOGGER" environment
737 variable. "logger" can be declared as a locked configuration option
738 in "locked_configs".
739
740 * "logged_events" configuration option is a list of event names
741 separated by colon character. It is empty by default, thus nothing
742 is logged by default. Allowed event names are "requested_cmd" (log
743 module commands directly executed by users), "requested_eval"
744 (modulefile evaluations directly asked by users) and "auto_eval"
745 (modulefile evaluations automatically triggered). Option value can
746 be changed at installation time with "--with-logged-events" option.
747 When "logged_events" is changed with "config" sub-command, it sets
748 the "MODULES_LOGGED_EVENTS" environment variable. "logged_events"
749 can be declared as a locked configuration option in
750 "locked_configs".
751
752 * Add "log" channel to the "puts" modulefile command. String message
753 passed to "puts log" is sent to the "logger" command.
754
755 * Doc: update Log module command cookbook recipe with integrated
756 logging feature.
757
758 * Install: update "configure" script to ignore all "--with-*" options
759 if no value is associated to them.
760
761 * Install: update "configure" script to set option to an empty string
762 if specified with "--without-*" argument. Exception is made for "--
763 without-icase" which sets option to the "never" value.
764
765 * Introduce "not:" prefix for extra specifier and variant criteria on
766 module search context. This prefix allows to negate search criteria
767 on Extra match search mechanism.
768
769 * Adopt stricter naming rule for variant names. Only characters within
770 the "A-Za-z0-9_-" range are allowed. Also, a variant name cannot
771 start with "-" (minus) character and the overall name cannot just be
772 a number.
773
774 * Allow "+" and "~" characters to be part of module name or version
775 specification as long as the string following them is not a valid
776 variant name (e.g., "foo/1.2+8"). (fix issue #527)
777
778 * In case of an issue external to Modules, do not mention at the end
779 of the error stack trace the web link to report this issue. (fix
780 issue #546)
781
782 * When a modulefile performs a "module unload" command that fails due
783 to dependent modules loaded, stop unload evaluation right after this
784 failed command unless "--force" option is used.
785
786 * Exclude sticky modules from the useless requirement unload mechanism
787 as they cannot be unloaded.
788
789 * Tag automatically loaded module "auto-loaded" prior evaluation to be
790 able to query this state during modulefile evaluation with "module-
791 info tags".
792
793 * Doc: describe in module man page how to initialize Modules in a Ruby
794 script. (fix issue #535)
795
796 * Add PowerShell Core ("pwsh") shell support. (fix issue #326 with
797 contribution from Simon Lukas Märtens)
798
799 * Lib: adapt Modules Tcl extension library to properly load on Tcl 9.
800
801 * Doc: describe how to upgrade Modules in Installing Modules on Unix.
802 (fix issue #544)
803
804 * Set exit code returned by "modulecmd.tcl" script to "1" when a
805 modulefile evaluation fails (modulefile does not exist, is buggy,
806 etc). (fix issue #540)
807
808 * Disable pager when running "modulecmd.tcl" script for script
809 language (*python*, *perl*, *ruby*, *tcl*, *cmake*, *r* and *lisp*).
810 (fix issue #542)
811
812 * Update error and warning messages when attempting to unload a module
813 required by another. Distinguish if this module is a requirement of
814 an already loaded or a currently loading module.
815
816 * Introduce "conflict_unload" configuration option that controls
817 whether or not conflicting modules and their dependent should be
818 unloaded when loading a module. All kind of conflicts are supported:
819 conflicts defined by already loaded modules, conflict declared by
820 loading module through "conflict", "family" or "module unload"
821 commands. "conflict_unload" also handles the unload of a module that
822 is loaded again but with different variant values or from a
823 different modulepath. "conflict_unload" is disabled by default as it
824 changes behaviors of the "automated module handling mode". But
825 everyone is encouraged to enable this new option to benefit from an
826 highly automated experience. This option can be changed at
827 installation time with "--enable-conflict-unload". When
828 "conflict_unload" is changed with "config" sub-command, it sets the
829 "MODULES_CONFLICT_UNLOAD" environment variable. Both "auto_handling"
830 and "conflict_unload" options should be enabled to activate
831 *Conflict Unload* automated behavior. (fix issue #242)
832
833 * When both "auto_handling" and "conflict_unload" options are enabled,
834 all loaded modules matching module specifications set on "conflict"
835 or "module unload" commands are unloaded. If both options are not
836 enabled, only one matching loaded module per specification argument
837 of "module unload" is unloaded. (fix issue #215)
838
839 * When both "auto_handling" and "conflict_unload" options are enabled,
840 "--force" option set on "load" sub-command is taken into account
841 during the *Conflict Unload* mechanism. For instance, it continues
842 this unload process even if one module unload fails.
843
844 * Install: installation option "--enable-new-features" is updated to
845 include "--enable-conflict-unload".
846
847 * Fix detection of already loaded module with variant set. If trying
848 to load same module with compatible variant set, a *module is
849 already loaded* message is now returned instead of *another variant
850 is loaded*.
851
852 * Correctly report module evaluation error in case during the same
853 execution this module was already evaluated and failed silently
854 during a *Requirement Load* mechanism.
855
856 * Split processing of *Dependent Reload* (DepRe) modules to treat the
857 *DepRe* modules consequence of *Useless Requirement Unload* (UReqUn)
858 modules separately, right before unloading the *UReqUn* modules. As
859 a result, modules in conflict with *UReqUn* modules are unloaded
860 right before *UReqUn* process and reloaded with the other *DepRe*
861 modules.
862
863 * Handle *UReqUn* process in case of "switch" sub-command after the
864 switch load phase. Unload of these modules were previously occurring
865 at the end of the switch unload phase. Unload of *DepRe* modules
866 consequence of *UReqUn* modules is also moved after switch load
867 phase.
868
869 * Introduce the *Useless Requirement Unload* (UReqUn) process on
870 "load" sub-command. It eliminates auto loaded modules that were
871 requirements of *Conflict Unload* modules. In case of "switch" sub-
872 command, *UReqUn* modules coming from the switch load phase are
873 handled with *UReqUn* modules coming from switch unload phase.
874
875 * Rework handling of *DepRe* modules that also are *UReqUn* modules to
876 unload them during the *DepRe* unload phase instead of during
877 *UReqUn* process. As a consequence these modules part of both
878 *DepRe* and *UReqUn* lists are unloaded prior main module action and
879 prior unload of the other *UReqUn* modules. The *DepRe* modules may
880 be also qualified *UReqUn* even if they are not a dependency of a
881 module unloaded in the current processing.
882
883 * Mix unload of *Dependent Unload* and *Dependent Reload* modules to
884 ensure they are processed in their reverse loading order. As a
885 result, if a module is part of *DepUn* process and some of its
886 requirements are part of *DepRe* process, requirements are unloaded
887 after their dependent modules.
888
889 * Skip reload of a *Dependent Reload* module if found not loadable
890 (either its requirements are not loaded or a conflict is spotted
891 with loaded environment). Reload is attempted only if module is
892 tagged *super-sticky* or *sticky* and force mode is disabled.
893 Skipped module is considered *Dependent Unload* module.
894
895 * Reload all Dependent Reload modules after the main load, unload or
896 switch module evaluation rather after the sub module evaluation that
897 triggered the Dependent Reload unload phase.
898
899 * Dependent Unload modules of Conflict Unload modules are merged into
900 the Dependent Reload module list. An attempt to reload these
901 dependent modules is tried only if their requirements are satisfied
902 by loaded environment.
903
904 * When a loading module requires a Dependent Unload module, the unload
905 of this module was forced when it was triggered by a Conflict Unload
906 or a switched-off module. The unload of such Dependent Unload module
907 is not forced anymore by default and an error is raised if a loading
908 module requiring the Dependent Unload module is detected.
909
910 * When unloading Dependent Reload modules, do not force by default
911 this unload unless asked with "--force" option. As a result an error
912 is obtained when trying to reload Dependent Reload modules that
913 conflict with other loaded modules. This error may be by-passed with
914 "--force" command-line option.
915
916 * Move stickiness check when unloading a module prior processing any
917 automated module handling mechanism. (fix issue #536)
918
919 Warning:
920
921 Variant names are now fully checked instead of just verifying their
922 first character. Only characters within the "A-Za-z0-9_-" range are
923 allowed. Variant name cannot start with "-" character and the
924 overall name cannot just be a number.
925
926 Warning:
927
928 Existing *versions* modulefiles generated by "--enable-versioning"
929 installation option and installed for Modules 4.7 and upward should
930 be manually fixed by adding the "--not-req" option to the "module
931 unload" commands present in these modulefiles. Following command
932 should fix these files: "sed -i "s|module unload|module unload
933 --not-req|" <version_modulefile>".
934
935
936 Modules 5.4.0 (2024-02-20)
937 ==========================
938
939 * Allow to designate module by its full path file name on "module-
940 tag", "module-hide" and "module-forbid". (fix issue #485)
941
942 * Introduce "tag" extra specifier to search modules on "avail",
943 "whatis" and "paths" sub-commands based on tags applied. Tag
944 abbreviation may also be used as extra specifier name.
945
946 * Add ability to specify multiple names on one extra specifier
947 criterion to select modules matching any of these names (e.g.,
948 "env:PATH,LD_LIBRARY_PATH")
949
950 * Add ability to specify multiple values on one variant criterion to
951 select modules providing any of these variant values (e.g.,
952 "foo=val1,val2")
953
954 * Add the "indesym" element in the allowed value list of the
955 "list_output" and "list_terse_output" configuration options. When
956 set, symbolic versions are reported as independent elements rather
957 along the loaded module they are attached to.
958
959 * Add the "alias" element in the allowed value list of the
960 "list_output" and "list_terse_output" configuration options. When
961 set, module aliases targeting loaded modules are reported.
962
963 * Introduce "sticky_purge" configuration option to define behavior
964 when unloading sticky or super-sticky module during a "purge"
965 command. Raise an "error" (default) or emit a "warning" or be
966 "silent". When set, it defines the "MODULES_STICKY_PURGE"
967 environment variable. Default value can be changed with "--with-
968 sticky-purge" installation option. (fix issue #502)
969
970 * Introduce "modulepath-label" modulerc command, which defines label
971 used instead of modulepath directory path in "avail" output.
972
973 * More than one global rc file can now be specified in "MODULERCFILE"
974 or via "rcfile" configuration option.
975
976 * Add the "unique_name_loaded" configuration option to allow, when
977 enabled, only one module loaded per module name. When set, it
978 defines the "MODULES_UNIQUE_NAME_LOADED" environment variable.
979 Default value (disabled) can be changed with "--enable-unique-name-
980 loaded" installation option.
981
982 * Add Evaluation errors design notes.
983
984 * Add "abort_on_error" configuration option to define module sub-
985 commands that should abort when a module evaluation fails instead of
986 continuing their evaluation sequence. When configuration option is
987 set, it defines the "MODULES_ABORT_ON_ERROR" environment variable.
988 Default value can be changed with "--with-abort-on-error"
989 installation option.
990
991 * Add support for "abort_on_error" evaluation behavior on "load",
992 "mod-to-sh" and "try-load" sub-commands.
993
994 * Report issue on modulefile when it fails to load an erroneous
995 requirement through "module try-load" modulefile command.
996
997 * Doc/Install: modernize modulefile code example in documentation and
998 installed example modulefiles.
999
1000 * Vim: correctly highlight modulefile commands containing a dash
1001 character.
1002
1003 * Update requirement load error report to place it only under the
1004 message block of the module requiring this load. This change helps
1005 to better understand the chronology of actions and from where an
1006 error occurs.
1007
1008 * Do not report requirement load error when an alternative requirement
1009 module is found and loaded afterward. (fix issue #509)
1010
1011 * Do not render an error exit code on multi-module option requirement
1012 when one module option fails to load but another does. (fix issue
1013 #510)
1014
1015 * Do not report *module not found* error when loading a requirement if
1016 an alternative requirement module is found and loaded afterward.
1017 (fix issue #511)
1018
1019 * Add "--glob" option to "remove-path" modulefile command in order to
1020 remove any values in variable matching a glob-style pattern.
1021
1022 * Record module specification on which loaded module stickiness
1023 applies in "__MODULES_LMSTICKYRULE" environment variable. It helps
1024 to determine if stickiness is satisfied when changing loaded
1025 modules. Which was not working correctly for virtual modules. (fix
1026 issue #506)
1027
1028 * Silently ignore cache file when it requires a greater Modules
1029 version. (fix issue #515)
1030
1031 * Doc: move modulefile man page in section 5. (fix issue #518 with
1032 contribution from Laurent Chardon)
1033
1034 * Add "source_cache" configuration option to cache files evaluated in
1035 modulefiles with "source" Tcl command. Files sourced multiple times
1036 are only read once when option is enabled. "source_cache" is
1037 disabled by default. When set, it defines the "MODULES_SOURCE_CACHE"
1038 environment variable. Default value can be changed with "--enable-
1039 source-cache" installation option.
1040
1041 * Add support for "abort_on_error" evaluation behavior on "unload"
1042 sub-command.
1043
1044 * A modulefile is unloaded anyway even if an evaluation error occurs
1045 when "--force" option is used on **ml**, "purge", "reload", "reset",
1046 "restore", "stash", "stashpop", "switch" and "unload" sub-commands.
1047 To forbid the unload of a modulefile it is recommended to tag it
1048 "super-sticky" with "module-tag" command.
1049
1050 * Disable "abort_on_error" when "--force" option is used. In this
1051 case, behavior is to continue when an error occurs.
1052
1053 * Add support for "abort_on_error" evaluation behavior on **ml**
1054 command. *Abort on error* behavior is on by default with **ml**.
1055 Removing it from "abort_on_error"'s value enables the *continue on
1056 error* behavior.
1057
1058 * Add support for "abort_on_error" evaluation behavior on "reload"
1059 command. *Abort on error* behavior is on by default with "reload".
1060 Removing it from "abort_on_error"'s value enables the *continue on
1061 error* behavior.
1062
1063 * Add support for "abort_on_error" evaluation behavior on "purge" sub-
1064 command.
1065
1066 * Add support for "abort_on_error" evaluation behavior on unload phase
1067 of "switch" command. *Abort on error* behavior is on by default
1068 there. Removing "switch_unload" from "abort_on_error"'s value
1069 enables the *continue on error* behavior.
1070
1071 * Add support for "abort_on_error" evaluation behavior on "switch"
1072 command. *Abort on error* behavior is applied if "switch" value is
1073 set in "abort_on_error" and either switch unload or switch load
1074 phase fails.
1075
1076 * Install: installation option "--enable-new-features" is updated to
1077 enable *abort on error* behavior on "load" and "switch" sub-
1078 commands.
1079
1080 * Lib: slightly adapt code of Modules Tcl extension library to
1081 properly build against Tcl 9.0.
1082
1083 * Adapt alias unset shell code for *sh*-kind shells to avoid errors
1084 when alias to unset is not defined.
1085
1086 * Adapt function unset shell code for *sh*-kind shells to avoid errors
1087 when function to unset is not defined.
1088
1089 * No output of *unload of switched-off failed* and *load of switched-
1090 on failed* error messages when "module switch" command is run from a
1091 modulefile.
1092
1093 * No *Switching* block message report when "module switch" command is
1094 run from a modulefile.
1095
1096 * Report all error and warning messages locally under *Loading* or
1097 *Unloading* block message rather reporting some of them under the
1098 block message of the main action. These errors and warnings are thus
1099 reported where they occur.
1100
1101 * Report switched-on load failure as error rather warning.
1102
1103 * Report switched-on module locating or access issues only once.
1104
1105 * Report conflict error message when it occurs rather than after
1106 modulefile evaluation.
1107
1108 * Update conflict error message to report all conflicting modules name
1109 and version rather conflict module specification.
1110
1111 * Fix conflict error check to avoid reporting both *unloading conflict
1112 failed* and *conflict is loading* messages.
1113
1114 * Raise an error and stop modulefile evaluation when "module switch"
1115 command fails unless if "--force" option is set.
1116
1117 * When a *useless requirement unload* fails, do not increase error
1118 count as this failure is reported as a warning and main unload
1119 process is not affected.
1120
1121 * Path element equals to delimiter character is allowed on "append-
1122 path" and "prepend-path" modulefile commands. (fix issue #522)
1123
1124 * Add "bash-eval" shell mode to "source-sh" modulefile command and
1125 "sh-to-mod" sub-command. With this mode, the generated output of the
1126 bash shell script is evaluated to get the environment changes
1127 instead of sourcing this script. (fix issue #519)
1128
1129 * Add "--ignore" option to "source-sh" modulefile command to define
1130 shell elements changed by shell script that should be ignored. (fix
1131 issue #503)
1132
1133 * Init: Improve Tcsh shell completion script to complete against
1134 existing files when pattern starts with "/", "." or "~/". (fix issue
1135 #523)
1136
1137 * Add "--user" option to "module-forbid", "module-hide" and "module-
1138 tag" modulefile commands to forbid, hide or tag only if user is
1139 listed in the value of this new option. (fix issue #520 with
1140 contribution from Jérémy Déchard)
1141
1142 * Add "--group" option to "module-forbid", "module-hide" and "module-
1143 tag" modulefile commands to forbid, hide or tag only if one user's
1144 group is listed in the value of this new option. (fix issue #520
1145 with contribution from Jérémy Déchard)
1146
1147
1148 Modules 5.3.2 (2026-09-07)
1149 ==========================
1150
1151 * Init: fix command injection in Bash completion when module names
1152 contain shell meta-characters. Completion candidates were passed to
1153 "compgen -W" which evaluates command substitution syntax. (fix
1154 CVE-2026-85013 found by AISLE in partnership with Red Hat)
1155
1156
1157 Modules 5.3.1 (2023-06-27)
1158 ==========================
1159
1160 * Fix additional ShellCheck warning reports over sh and bash shell
1161 scripts.
1162
1163 * Install: distribute "ChangeLog" as a zipped file to reduce
1164 installation size. As a consequence, **gzip** becomes a requirement
1165 when building Modules from git repository.
1166
1167 * Install: adapt RPM spec file to install module initialization script
1168 for fish as configuration snippet for this shell.
1169
1170 * Fix extra specifier search to evaluate module matching requirement
1171 query. (fix issue #494)
1172
1173 * Fix extra specifier requirement search when module searched is also
1174 defining a requirement and is the sole module to define it. (fix
1175 issue #495)
1176
1177 * Script: update **pre-commit** and **commit-msg** git hook scripts to
1178 use Hunspell as spell checker instead of Aspell.
1179
1180 * Fix unaligned "list" output when 100 or more modules are loaded.
1181 (fix issue #496)
1182
1183 * Fix extra specifier search when an identical module name and version
1184 is available in several modulepaths. (fix issue #497)
1185
1186 * Do not match module commands with "--not-req" option set on
1187 "require" or "incompat" extra specifier queries. (fix issue #498)
1188
1189 * When one variant is specified multiple times on search context
1190 ("avail", "paths" or "whatis" sub-commands), available modules
1191 returned are those providing all variant values set. (fix issue
1192 #499)
1193
1194 * Add the "indesym" element in the allowed value list of the
1195 "avail_output" and "avail_terse_output" configuration options. When
1196 set, symbolic versions are reported as independent elements rather
1197 along the module or directory they are attached to.
1198
1199 * Init: fix completion scripts to report module symbolic versions and
1200 aliases among available modules. (fix issue #500)
1201
1202
1203 Modules 5.3.0 (2023-05-14)
1204 ==========================
1205
1206 * Add Module cache design notes.
1207
1208 * Add "cachebuild" sub-command to create cache for modulepaths enabled
1209 or specified on the command line. Cache files are named
1210 ".modulecache" and stored at the root of modulepath directories.
1211
1212 * Add "cacheclear" sub-command to delete cache file in all enabled
1213 modulepaths.
1214
1215 * Use cache file if available rather search the content of modulepath
1216 directories when searching for modules (e.g., during "avail",
1217 "load", "display", etc).
1218
1219 * Script: add cache-enabled version of *avail*, *whatis* and *load*
1220 tests on **mb** benchmark utility.
1221
1222 * Add the "ignore_cache" configuration option to ignore module cache
1223 file. Option is disabled by default and when set, it defines
1224 "MODULES_IGNORE_CACHE" environment variable.
1225
1226 * Add "--ignore-cache" command-line switch to enable "ignore_cache"
1227 configuration option and ignore module cache file for current
1228 execution.
1229
1230 * Add "cache_buffer_bytes" configuration option to define buffer size
1231 when reading or writing cache files. Option is set to "32768" by
1232 default. When set it defines "MODULES_CACHE_BUFFER_BYTES"
1233 environment variable.
1234
1235 * Add "cache_expiry_secs" configuration option that defines the number
1236 of seconds a cache file is considered valid after being generated.
1237 Option is set to "0" by default which means cache files never
1238 expire. When option is set it defines "MODULES_CACHE_EXPIRY_SECS"
1239 environment variable.
1240
1241 * Modulefiles and directories that are not accessible by everyone are
1242 not recorded in cache file. A *limited access* directive is recorded
1243 instead to indicate these modulefiles have to be tested and
1244 directories have to be walked down to determine what the running
1245 user can access.
1246
1247 * Doc: update Reduce I/O load cookbook recipe with module cache
1248 description.
1249
1250 * Correctly apply extra tag set when loading a module whose variant
1251 has value automatically set. (fix issue #484)
1252
1253 * Catch collection directory creation error and report appropriate
1254 message. (fix issue #482)
1255
1256 * Fix "source-sh" and "sh-to-mod" shell alias translation when used
1257 with new *fish* shell version (3.6).
1258
1259 * Install: allow to build Modules from a short-depth git repository.
1260 (fix issue #486)
1261
1262 * Install: ensure git log format is not influenced by user's
1263 configuration in **gitlog2changelog.py**. (fix issue #487)
1264
1265 * Init: fix bash shell completion script to be able to complete full
1266 name of available modules. (fix issue #490)
1267
1268 * Install: move license name to SPDX format in RPM spec file.
1269
1270 * Doc: add Extra match search design notes.
1271
1272 * Introduce *extra match search* mechanism that evaluates available
1273 modulefiles during a module search to find those matching an extra
1274 query on a variant value, a dependency or an environment variable
1275 definition. During this specific evaluation, modulefiles are
1276 interpreted in *scan* mode.
1277
1278 * "scan" string is returned by "module-info mode" when queried during
1279 a *scan* modulefile evaluation.
1280
1281 * Add the "variant" element in the allowed value list of the
1282 "avail_output" and "avail_terse_output" configuration options. When
1283 set, variants and their possible values are reported along the
1284 module they are associated to on "avail" command output. Adding
1285 variant information to this output activates the *extra match
1286 search* mechanism that scan modulefiles to find variants they
1287 define. (fix issue #407)
1288
1289 * Apply graphic rendition of default version ("de" SGR key) to default
1290 variant value on either "list" and "avail" command output.
1291
1292 * Apply either loaded or auto-loaded graphic rendition to the loaded
1293 variant value on "avail" command output.
1294
1295 * Update "avail", "paths" and "whatis" sub-commands to take into
1296 account variant set in module specification. Available modules are
1297 filtered with *extra match search* mechanism to only return those
1298 matching the variant specification.
1299
1300 * Update "avail", "paths" and "whatis" sub-commands to accept module
1301 specification with just a variant set (no module name and version).
1302 Available modules are filtered with *extra match search* mechanism
1303 to only return those matching the variant specification.
1304
1305 * Update "list" sub-command to accept module specification with just a
1306 variant set (no module name and version). Loaded modules are
1307 filtered to only return those matching the variant specification.
1308
1309 * Highlight searched variant name and value ("hi" SGR key) on either
1310 "list" and "avail" command output.
1311
1312 * Doc: add Extra match search description in module man page.
1313
1314 * Introduce *extra specifiers* to query content of modulefiles. *Extra
1315 specifiers* can be specified with *element:name* syntax as part of
1316 module specification on module search commands ("avail", "paths" and
1317 "whatis"). For instance with the "module avail append-path:PATH"
1318 command, all modulefiles defining the "append-path" command on
1319 "PATH" environment variable are returned.
1320
1321 * Add "variant" extra specifier to query modulefile variant
1322 definitions. (fix issue #408)
1323
1324 * Add "setenv", "unsetenv", "append-path", "prepend-path", "remove-
1325 path" and "pushenv" extra specifiers to query modulefile environment
1326 variable definitions. The extra specifier alias "envvar" may also be
1327 used to query any of these modulefile commands.
1328
1329 * Add "complete" and "uncomplete" extra specifiers to query modulefile
1330 shell completion definitions.
1331
1332 * Add "set-alias" and "unset-alias" extra specifiers to query
1333 modulefile shell alias definitions.
1334
1335 * Add "set-function" and "unset-function" extra specifiers to query
1336 modulefile shell function definitions.
1337
1338 * Add "chdir" extra specifier to query modulefile current working
1339 directory change definitions.
1340
1341 * Add "family" extra specifier to query modulefile family definitions.
1342
1343 * Add "prereq", "prereq-any", "prereq-all", "depends-on", "always-
1344 load", "load", "load-any", "try-load", "switch" and "switch-on"
1345 extra specifiers to query modulefile requirement definitions. The
1346 extra specifier alias "require" may also be used to query any of
1347 these modulefile commands.
1348
1349 * Add "conflict", "unload", "switch" and "switch-off" extra specifiers
1350 to query modulefile incompatibility definitions. The extra specifier
1351 alias "incompat" may also be used to query any of these modulefile
1352 commands.
1353
1354 * Requirement and incompatibility extra specifiers accept module
1355 specification as value.
1356
1357 * Doc: add Extra specifier description in module man page.
1358
1359 * Mark loaded modules as qualified for refresh evaluation when they
1360 send content to "stdout" or "prestdout" channels with "puts"
1361 modulefile command. (fix issue #488)
1362
1363 * Add the "ignore_user_rc" configuration option to skip evaluation of
1364 user-specific module rc file. Option is disabled by default and when
1365 set, it defines "MODULES_IGNORE_USER_RC" environment variable.
1366
1367 * Add "--ignore-user-rc" command-line switch to enable
1368 "ignore_user_rc" configuration option and ignore user-specific
1369 module rc file for current execution.
1370
1371 * Add the "variantifspec" element in the allowed value list of the
1372 "avail_output" and "avail_terse_output" configuration options. Set
1373 this new element in the default value list of both options. When set
1374 and if a variant is specified in search query, variants and their
1375 possible values are reported along the module they are associated to
1376 on "avail" command output.
1377
1378 * Accept value starting with "+" or "-" characters on "--output"/"-o"
1379 command-line switches to indicate value should respectively be
1380 appended to or subtracted from current configuration option value.
1381
1382 * Accept value starting with "+" or "-" characters on "avail_output",
1383 "avail_terse_output", "list_output", "list_terse_output", "colors",
1384 "protected_envvars", "shells_with_ksh_fpath", "tag_abbrev",
1385 "tag_color_name", "variant_shortcut" configuration options to
1386 indicate value should respectively be appended to or subtracted from
1387 current configuration option value.
1388
1389 * Fix "switch" sub-command not to unload *sticky* module when
1390 switched-on module does not exist. (fix issue #492)
1391
1392
1393 Modules 5.2.0 (2022-11-08)
1394 ==========================
1395
1396 * Introduce the "--optional" option on "prereq", "prereq-all",
1397 "depends-on" and "always-load" modulefile commands. Expressed
1398 optional dependency is considered satisfied even if modulefile is
1399 not loaded. If optional requirement is loaded afterward, dependent
1400 module is automatically reloaded, unless if the "auto_handling"
1401 configuration option is disabled.
1402
1403 * A dependency expressed in modulefile with "module try-load" command
1404 is considered optional. Dependent module is automatically reloaded
1405 if the optional requirement is loaded afterward, unless if the
1406 "auto_handling" configuration option is disabled.
1407
1408 * Raise error in case of unknown or misplaced option set on "prereq",
1409 "prereq-all", "depends-on" or "always-load" modulefile commands.
1410
1411 * Add the "--timer" command-line switch to report the total execution
1412 time of the **module** command. Also report the execution time of
1413 every internal procedure calls when mixed with "--debug" option.
1414
1415 * Init: move "PATH" setup (to locate Modules' binaries location) from
1416 shell initialization scripts to the "autoinit" sub-command. (fix
1417 issue #462)
1418
1419 * Init: move "MANPATH" setup (to locate Modules' man-pages) from shell
1420 initialization scripts to the "autoinit" sub-command. (fix issue
1421 #462)
1422
1423 * Init: move shell completion setup from shell initialization scripts
1424 to the "autoinit" sub-command. (fix issue #462)
1425
1426 * Enclose installation path references in shell code produced by
1427 "autoinit", in initialization scripts and Makefiles to guaranty
1428 correct evaluation in case these paths contain a space character.
1429 Note that the quarantine mechanism is not compatible with such
1430 installation paths.
1431
1432 * Fix "source-sh" and "sh-to-mod" when used with *fish* shell script
1433 if "regex-easyesc" fish option is enabled. (fix issue #463)
1434
1435 * Add the "protected_envvars" configuration option to define a list of
1436 environment variables that cannot be modified by modulefile
1437 commands. When set, "protected_envvars" defines
1438 "MODULES_PROTECTED_ENVVARS" environment variable. (fix issue #429
1439 with contribution from Adrien Cotte)
1440
1441 * Introduce the "lint" sub-command to statically analyze syntax of
1442 modulefiles, modulerc and global/user rc. (fix issue #451)
1443
1444 * Add the "tcl_linter" configuration option to define the program used
1445 to analyze files with "lint" sub-command. This option is set to
1446 "nagelfar.tcl" by default. When changed from default value, the
1447 "MODULES_TCL_LINTER" environment variable is defined. Default value
1448 can be changed with "--with-tcl-linter" and "--with-tcl-linter-opts"
1449 installation options.
1450
1451 * Add the "--enable-nagelfar-addons" installation option (enabled by
1452 default) to install specific syntax databases and plugins to lint
1453 modulefiles, modulerc and global/user rc with Nagelfar. These files
1454 are installed in the directory designated by the "--nagelfardatadir"
1455 ("DATAROOTDIR/nagelfar" by default).
1456
1457 * Doc: add lint sub-command design notes.
1458
1459 * Install: use **install** command rather **cp** or **mkdir** to
1460 install Modules and guaranty consistent permission modes on deployed
1461 files.
1462
1463 * Also unset "pushenv" value stacks on "clear" sub-command.
1464
1465 * Doc: add mod-to-sh sub-command design notes.
1466
1467 * Introduce the "mod-to-sh" sub-command to translate designated
1468 modulefile(s) into code for specified shell. (fix issue #447)
1469
1470 * Make "source" sub-command accepts modulefile specification as
1471 argument. If argument does not correspond to a file path, search it
1472 among available modulefiles. (fix issue #424)
1473
1474 * Doc: clarify "set-alias" only define shell alias and not shell
1475 function.
1476
1477 * Add the ability to filter the list of collections returned by
1478 "savelist" sub-command. Filtering pattern is matched in a case
1479 insensitive manner by default.
1480
1481 * Add support for "--starts-with" and "--contains" options on
1482 "savelist" sub-command.
1483
1484 * Highlight all search patterns on "list" sub-command output instead
1485 of only the first one..
1486
1487 * Highlight all search patterns on "savelist" sub-command output.
1488
1489 * Add support for "--all" option on "savelist" sub-command not to
1490 limit result to the collection matching currently defined
1491 "collection_target".
1492
1493 * Doc: add Shell support section in modulefile man page to describe
1494 how shells support the different kind of environment changes that
1495 can be defined in modulefiles.
1496
1497 * Record during "autoinit" sub-command the initial environment state
1498 in "__MODULES_LMINIT". Enabled modulepaths and loaded modulefiles
1499 through "modulespath" and "initrc" initialization configuration
1500 files are recorded in this new environment variable.
1501
1502 * Add "reset" sub-command to restore initial environment. It takes
1503 recorded environment in "__MODULES_LMINIT" and restores it.
1504
1505 * Initial environment is restored when collection name specified on
1506 "restore" sub-command equals "__init__".
1507
1508 * When no argument is provided to "restore" sub-command and if
1509 *default* collection does not exist, initial environment is
1510 restored.
1511
1512 * Initial environment content is displayed when collection name
1513 specified on "saveshow" sub-command equals "__init__".
1514
1515 * When no argument is provided to "saveshow" sub-command and if
1516 *default* collection does not exist, initial environment content is
1517 displayed.
1518
1519 * Add "reset_target_state" configuration option to determine behavior
1520 of "reset" sub-command. When set to "__init__" (default value)
1521 initial environment is restored. When set to "__purge__", a "purge"
1522 sub-command is performed. Any other value, corresponds to the name
1523 of a collection to "restore". When set, "reset_target_state" defines
1524 "MODULES_RESET_TARGET_STATE" environment variable.
1525
1526 * Doc: add Initial environment design notes.
1527
1528 * Unload *sticky* modules on "restore" and "reset" sub-commands to
1529 fully set environment in collection or initial state.
1530
1531 * Testsuite: add *lint* testsuite to validate syntax of shell and Tcl
1532 scripts of this project. This testsuite can be invoked with "make
1533 testlint" or "script/mt lint". sh, bash and ksh scripts are checked
1534 with ShellCheck tool and tcl scripts are checked with Nagelfar.
1535
1536 * Update "modulecmd.tcl" code and add Nagelfar inline comments to fix
1537 linter reports.
1538
1539 * Script: add usage message and support for "-h"/"--help" option on
1540 **mrel**, **mpub**, **mt**, **mtreview**, **nglfar2ccov**, **mb**
1541 and **mlprof** development utilities.
1542
1543 * Doc: describe **script/mt** and **script/mb** utilities in
1544 Contributing guide.
1545
1546 * Fix ShellCheck error, warning and info reports over all sh, bash and
1547 ksh shell scripts. (fix issue #470 with contribution from Lukáš
1548 Zaoral)
1549
1550 * Init: update profile script for sh-like shells to only source sh or
1551 bash initialization script when BASH environment variable is found
1552 set. (fix issue #473)
1553
1554 * Add "stash" sub-command to save current environment and restore
1555 initial one.
1556
1557 * Add "stashpop" sub-command to restore stash collection then delete
1558 this collection file.
1559
1560 * Add "stashrm" sub-command to delete stash collection file.
1561
1562 * Add "stashshow" sub-command to display stash collection file.
1563
1564 * Add "stashclear" sub-command to delete all stash collection files.
1565
1566 * Add "stashlist" sub-command to list all stash collection files.
1567
1568 * Update "savelist" sub-command to filter out stash collections unless
1569 if "--all" option is set.
1570
1571 * Doc: ensure current user environment does not break logging system
1572 in Log module command recipe. (fix issue #475)
1573
1574 * Rename the default git branch from *master* to *main* to use
1575 inclusive terminology.
1576
1577 * Mark loaded modules that could benefit from a refresh evaluation in
1578 the "__MODULES_LMREFRESH" environment variable.
1579
1580 * Optimize "refresh" sub-command to only evaluate loaded modules that
1581 defines volatile environment changes (shell completion, alias or
1582 function). (fix issue #477)
1583
1584 * Add "modulefile_extra_cmds" hook variable that could be defined in
1585 "siteconfig.tcl" file to define specific commands in modulefile
1586 interpreter context. "modulefile_extra_cmds" is a list of command
1587 name and relative procedure pairs. (fix issue #286)
1588
1589 * Add "modulefile_extra_vars" hook variable that could be defined in
1590 "siteconfig.tcl" file to define specific variables in modulefile
1591 interpreter context. "modulefile_extra_vars" is a list of variable
1592 name and value pairs. (fix issue #286)
1593
1594 * Add "modulerc_extra_cmds" hook variable that could be defined in
1595 "siteconfig.tcl" file to define specific commands in modulerc
1596 interpreter context. "modulerc_extra_cmds" is a list of command name
1597 and relative procedure pairs. (fix issue #286)
1598
1599 * Add "modulerc_extra_vars" hook variable that could be defined in
1600 "siteconfig.tcl" file to define specific variables in modulerc
1601 interpreter context. "modulerc_extra_vars" is a list of variable
1602 name and value pairs. (fix issue #286)
1603
1604 * Doc: Add Site-specific configuration section in module man page.
1605
1606 * Doc: extend Collections section with examples in module man page.
1607
1608
1609 Modules 5.1.1 (2022-05-31)
1610 ==========================
1611
1612 * Install: add **rpmlint** rc configuration file to filter false
1613 positive warning messages.
1614
1615 * Install: better guess "libdir64" and "libdir32" directory locations
1616 when "libdir" does not end with *64* but contains *64*.
1617
1618 * Install: update RPM spec file to move libtclenvmodules in an
1619 environment-modules directory under "libdir".
1620
1621 * Fix rendering of loading or unloading module designation when
1622 configured color palette does not set the "hi" color key. (fix issue
1623 #455)
1624
1625 * Remove the *already loaded* message displayed when verbosity level
1626 is higher or equal to "verbose2" if new tags are applied to the
1627 loaded module. (fix issue #456)
1628
1629 * Report a global known error when current working directory cannot be
1630 retrieved due to the removal of this directory. (fix issue #457)
1631
1632 * Update tags set through "prereq" command on all already loaded
1633 requirements. (fix issue #459)
1634
1635 * Update module designation with the tags set by reloading dependent
1636 module. (fix issue #460)
1637
1638 * Install: include the "lib/config.guess" and "lib/config.sub" scripts
1639 in distribution tarball if generated by **autoreconf**.
1640
1641 * Install: call "git" command in "Makefile" only if the definitions of
1642 "version.inc" need to get built or refreshed.
1643
1644
1645 Modules 5.1.0 (2022-04-30)
1646 ==========================
1647
1648 * Allow to declare "variant" with no list of accepted value. Such
1649 variant accepts any value specified. (fix issue #405)
1650
1651 * Add the "redirect_output" configuration option to control on *sh*,
1652 *bash*, *ksh*, *zsh* and *fish* shells whether or not the output of
1653 the **module** function should be redirected from stderr to stdout.
1654 When set, "redirect_output" defines "MODULES_REDIRECT_OUTPUT"
1655 environment variable.
1656
1657 * Introduce the "--redirect"/"--no-redirect" command-line switches to
1658 supersede the value of the "redirect_output" configuration option on
1659 *sh*, *bash*, *ksh*, *zsh* and *fish* shells. (fix issue #410)
1660
1661 * Add the "--return-value" option to the "getenv" and "getvariant"
1662 modulefile commands to force to return the value of respectively
1663 designated environment variable or variant when modulefile is
1664 evaluated in *display* mode. (fix issue #422)
1665
1666 * Introduce the "state" sub-command to display Modules states.
1667
1668 * Add the "supported_shells" state to get the list of the shells that
1669 are supported by "modulecmd.tcl" through the "state" sub-command .
1670 (fix issue #426)
1671
1672 * Filter out the variables intended for Modules private usage when
1673 processing the environment changes made by a script evaluated by
1674 "sh-to-mod" sub-command or "source-sh" modulefile command. (fix
1675 issue #427)
1676
1677 * Doc: add Control mode behaviors design notes.
1678
1679 * Doc: add Add new configuration option design notes.
1680
1681 * Set a Code of conduct for the project and its community based on the
1682 widely adopted Contributor Covenant.
1683
1684 * Doc: add Add new module sub-command design notes.
1685
1686 * Add the "--remove-on-unload" option to the "remove-path" to also
1687 remove value when modulefile is unloaded.
1688
1689 * Raise error when an unknown option is set on "module use" or "module
1690 unuse" modulefile command.
1691
1692 * Rework emitted debug messages to remove obvious ones and
1693 systematically report each modulefile command processed with their
1694 arguments.
1695
1696 * Add the "--append-on-unload" option to the "remove-path" and "module
1697 unuse" modulefile commands to append back when modulefile is
1698 unloaded the value removed at load time or a specific value set
1699 after this option.
1700
1701 * Add the "--prepend-on-unload" option to the "remove-path" and
1702 "module unuse" modulefile commands to prepend back when modulefile
1703 is unloaded the value removed at load time or a specific value set
1704 after this option.
1705
1706 * Add the "--noop-on-unload" option to the "unsetenv", "remove-path"
1707 and "module unuse" modulefile commands to perform no operation when
1708 modulefile is unloaded.
1709
1710 * Add the "--unset-on-unload" option to the "unsetenv" modulefile
1711 command to also unset environment variable when modulefile is
1712 unloaded.
1713
1714 * Add the "--set-if-undef" option to the "setenv" modulefile command
1715 to set environment variable when modulefile is loaded only this
1716 variable is not yet defined.
1717
1718 * Install: add the "--with-bashcompletiondir", "--with-
1719 fishcompletiondir" and "--with-zshcompletiondir" installation
1720 options to install shell completion scripts in their system-wide
1721 location. (fix issue #428)
1722
1723 * Doc: add Lmod Tcl modulefile compatibility design notes.
1724
1725 * Introduce the "add-property", "remove-property" and "extensions"
1726 modulefile commands for compatibility with Lmod Tcl modulefiles.
1727 These commands are evaluated as a *no-operation* command.
1728
1729 * Introduce the "prereq-any" modulefile command for compatibility with
1730 Lmod Tcl modulefiles. "prereq-any" is an alias of "prereq" command.
1731
1732 * Produce a clear error message when wrong number of argument is
1733 received by "prereq" command.
1734
1735 * Doc: describe "ModulesVersion" in *Modules Variables* section in
1736 modulefile man page.
1737
1738 * Set "ModuleVersion" as an alias over "ModulesVersion" modulefile
1739 variable for compatibility with Lmod Tcl modulefiles.
1740
1741 * Doc: describe "reportError" and "reportWarning" modulefile commands.
1742
1743 * Add the "require-fullname" modulefile command for compatibility with
1744 Lmod Tcl modulefiles. This command aborts modulefile *load*
1745 evaluation if modulefile's name is not fully specified.
1746
1747 * Add the "prereq-all" modulefile command, alias over the "prereq"
1748 command which acts as an *AND* operation when multiple modulefiles
1749 are specified.
1750
1751 * Add the "depends-on" modulefile command, alias over the "prereq-all"
1752 command for compatibility with Lmod Tcl modulefiles.
1753
1754 * Introduce the "keep-loaded" module tag that avoids an auto-loaded
1755 module to get automatically unloaded when its dependent modules are
1756 getting unloaded. Update default "tag_abbrev" configuration option
1757 to add an abbreviation for the new tag ("kL") and default light and
1758 dark color palettes.
1759
1760 * Add the "always-load" modulefile command for compatibility with Lmod
1761 Tcl modulefiles. This command loads designated modulefile and
1762 applies the "keep-loaded" tag to it.
1763
1764 * Add the "load-any" sub-command and "module load-any" modulefile
1765 command for compatibility with Lmod Tcl modulefiles. This command
1766 loads one modulefile from specified list.
1767
1768 * Add support for "--not-req" option on "module try-load" and "module
1769 load-any" modulefile commands.
1770
1771 * Doc: add Module magic cookie check design notes.
1772
1773 * Add the "mcookie_check" configuration option that control whether
1774 the magic cookie at the start of modulefile (i.e., "#%Module" file
1775 signature) need to get checked or not. When set to "eval" the number
1776 of file checks is significantly reduced when walking through
1777 modulepaths to search for modulefiles. Default value for this option
1778 is overridden by the "MODULES_MCOOKIE_CHECK" environment variable.
1779
1780 * Doc: describe "puts" Tcl command and its specific feature when used
1781 in modulefile.
1782
1783 * Create the "prestdout" channel for "puts" modulefile command to be
1784 able to send content that will be evaluated in current shell session
1785 prior any other content. (fix issue #432)
1786
1787 * Add the "family" modulefile command for compatibility with Lmod Tcl
1788 modulefiles. This command defines family name as a module alias over
1789 currently loading module and express a conflict over this name to
1790 ensure only one member of a family can be loaded in user
1791 environment. "family" also defines the "MODULES_FAMILY_<NAME>" and
1792 "LMOD_FAMILY_<NAME>" environment variables.
1793
1794 * Doc: add Reduce I/O load cookbook recipe.
1795
1796 * Add the ability to filter the list of loaded modules returned by
1797 "list" sub-command. Filtering pattern could be part of module name,
1798 symbolic version or alias and is matched in a case insensitive
1799 manner by default. It could also leverage the Advanced module
1800 version specifiers syntax.
1801
1802 * Add support for "--starts-with" and "--contains" options on "list"
1803 sub-command.
1804
1805 * Doc: add Shell completion design notes.
1806
1807 * Introduce "complete" and "uncomplete" modulefile commands to
1808 respectively enable and disable shell completion for a given command
1809 name. *bash*, *tcsh* and *fish* shells are supported.
1810
1811 * Track shell completion changes of *bash*, *tcsh* and *fish* shell
1812 scripts on "sh-to-mod" sub-command and "source-sh" modulefile
1813 command.
1814
1815 * Fix typos found in code, tests and documentation. (contribution from
1816 Dimitri Papadopoulos Orfanos)
1817
1818 * Update the "sh-to-mod" and "source-sh" mechanisms to support nested
1819 function definition on fish shell.
1820
1821 * Fix the "sh-to-mod" and "source-sh" mechanisms to correctly detect
1822 functions with a "_" character in their name on fish shell.
1823
1824 * Update the **module** shell function definition for sh-kind shell to
1825 enclose the output generated by "modulecmd.tcl" in quotes in order
1826 to pass it to the eval command. This change fixes definition of
1827 shell function, especially when coming from shell script evaluation
1828 over the "sh-to-mod" and "source-sh" mechanisms. (fix issue #434)
1829
1830 * Fix csh shell alias detection on "sh-to-mod" and "source-sh"
1831 mechanisms when enclosed in parenthesis. (fix issue #434)
1832
1833 * Include for fish shell environment analysis on "sh-to-mod" and
1834 "source-sh" mechanisms the private functions defined by evaluated
1835 script, in order to catch all definitions that may be useful for
1836 shell completion.
1837
1838 * Fix the "sh-to-mod" and "source-sh" mechanisms to correctly detect
1839 empty function on fish shell.
1840
1841 * Script: add **pre-commit** git hook script to help verify if commits
1842 are free of misspellings (with codespell tool) and trailing spaces.
1843
1844 * Doc: fix typos found in documentation with Aspell utility.
1845
1846 * Doc: describe Dependencies between modulefiles in modulefile man
1847 page. (fix issues #431 and #433)
1848
1849 * Script: update **pre-commit** git hook script to spell check
1850 documentation files with Aspell tool.
1851
1852 * Script: add **commit-msg** git hook script to spell check commit
1853 message with Aspell tool.
1854
1855 * Doc: clarify that "#%Module" is a file signature also called Modules
1856 magic cookie.
1857
1858 * Doc: update the ENVIRONMENT section in module man page to provide
1859 for each Modules environment variable the name of the configuration
1860 option that could be used to set the variable with the "config" sub-
1861 command.
1862
1863 * Doc: clarify in module man page that "MODULES_SET_SHELL_STARTUP",
1864 "MODULES_SHELLS_WITH_KSH_FPATH" and "MODULES_WA_277" should be set
1865 prior Modules initialization to get taken into account.
1866
1867 * Doc: update Installing Modules on Unix document to provide the name
1868 of the configuration option linked the installation options.
1869
1870 * Doc: describe in module man page the default value of each
1871 configuration option and linked installation option and command-line
1872 switches.
1873
1874 * Doc: add *Configuration options* section in Installing Modules on
1875 Unix document with a table summarizing all configuration options and
1876 their relative installation options and environment variables.
1877
1878 * Add the "pushenv" modulefile command for compatibility with Lmod Tcl
1879 modulefiles. This command sets designated environment variable with
1880 specified value and save the previous value set to restore it when
1881 the modulefile is unloaded. Previous values are saved in a
1882 "__MODULES_PUSHENV_<VAR>" environment variable.
1883
1884 * Doc: add Compatibility with Lmod Tcl modulefile section in
1885 modulefile man page.
1886
1887 * Update definition of the "module()" python function and python
1888 initialization script to explicitly send output to "sys.stderr" to
1889 get the ability to catch this content.
1890
1891 * Lib: handle "sysconf" error in function implementing the
1892 "initStateUsergroups" procedure. (contribution from Lukáš Zaoral)
1893
1894 * Introduce the "--tag" option for the "load", "try-load", "load-any",
1895 "switch" sub-commands and associated "module" modulefile commands
1896 and "prereq", "prereq-all", "depends-on" and "always-load"
1897 modulefile commands. This new option applies specified tags to the
1898 module to load.
1899
1900 * Record tags set to loaded modules with the "--tag" option in the
1901 "__MODULES_LMEXTRATAG" environment variable to make this information
1902 persists after module being loaded.
1903
1904 * When saving a collection, record loaded module tags set with the "--
1905 tag" option and those resulting from module load states (like "auto-
1906 loaded" and "keep-loaded"). The "--notuasked" string previously used
1907 to designate auto-loaded modules in collection is changed into the "
1908 --tag=auto-loaded" option.
1909
1910 * Introduce the "collection_pin_tag" configuration option, that
1911 records in collection all tags set on loaded modules when enabled.
1912 Option is disabled by default and when set it defines the
1913 "MODULES_COLLECTION_PIN_TAG" environment variable.
1914
1915 * When a collection is saved, its content starts with a "#%Module5.1"
1916 file signature if "--tag" option is recorded in it.
1917
1918 * Update the "restore", "savelist", "saveshow" and "is-saved" sub-
1919 commands to exclude from result or return an error when checking a
1920 collection expressing a higher Modules version requirement in its
1921 header signature than the one currently in use.
1922
1923 * Doc: describe differences between run-command file and modulefile
1924 interpretation in modulefile man page.
1925
1926 * Doc: describe "module" sub-commands available as modulefile Tcl
1927 command for each interpretation context in modulefile man page.
1928
1929 * When loading a module with some extra tags defined through the "--
1930 tag" option, if this module is already loaded the new tags are added
1931 to those already set.
1932
1933 * When reporting result of "avail" or "list" sub-commands, enclose
1934 module names in single quotes if they contain a space character.
1935
1936 * When mentioning the loading, unloading or refreshing evaluation of a
1937 module, report the tags associated to this module as done when
1938 printing results of "list" sub-command.
1939
1940 * Fix Log module command cookbook recipe not to break Modules
1941 initialization when using provided "siteconfig.tcl" file. (fix issue
1942 #453 with contribution from Eric Burgueño)
1943
1944 * Mention tagging evaluation of a module, when tag list of an already
1945 loaded module is updated.
1946
1947
1948 Modules 5.0.1 (2021-10-16)
1949 ==========================
1950
1951 * Doc: add *How to preserve my loaded environment when running screen*
1952 entry in Frequently Asked Questions.
1953
1954 * Fix the advanced version specifier resolution when the
1955 "extended_default" option is off and "icase" option is on when
1956 resolving version list specification. (fix issue #411)
1957
1958 * Doc: improve the Log module command cookbook to rely on the "trace"
1959 Tcl command to track every modulefile evaluation and module/ml
1960 procedure calls. (fix issue #412)
1961
1962 * Doc: fix missing space between list entries in Variants design doc.
1963 (fix issue #413)
1964
1965 * Correctly detect tags set on loaded modules when refreshing them.
1966
1967 * Set the "__MODULES_AUTOINIT_INPROGRESS" environment variable when
1968 running the "autoinit" sub-command and quit autoinit process if this
1969 variable is found defined and equal to 1 when starting it. Ensure
1970 this way that an autoinit process will not be triggered indefinitely
1971 by itself when the "set_shell_startup" option is enabled and some
1972 module loaded at initialization time relies on the execution of a
1973 bash script. (fix issue #414)
1974
1975 * Remove warning message when unloading a "prepend-path" or "append-
1976 path" modulefile command with "--duplicates" option set. (fix issue
1977 #421)
1978
1979 * Clarify the module sub-commands that are allowed to be used within a
1980 modulefile. (fix issue #423)
1981
1982 * Install: set in the module magic cookie of the "initrc"
1983 configuration file installed by default the version of Modules
1984 required to evaluate this file.
1985
1986 * Doc: fix documentation of "getenv" modulefile command to describe
1987 that an empty string is now returned when designated environment
1988 variable is not defined and no default value to return is specified.
1989
1990
1991 Modules 5.0.0 (2021-09-12)
1992 ==========================
1993
1994 * Remove deprecated **createmodule.sh** and **createmodule.py** tools
1995 as shell script to modulefile conversion is now achieved with the
1996 "sh-to-mod" sub-command.
1997
1998 * Remove mention of the "init*" sub-commands in module usage message
1999 to put focus on the collection handling sub-commands.
2000
2001 * Do not declare anymore the "chdir", "module", "module-trace",
2002 "module-verbosity", "module-user" and "module-log" commands under
2003 the modulerc Tcl interpreter as no-op commands. A clear error
2004 message is obtained if these commands are still used in modulerc
2005 files instead of silently ignoring them.
2006
2007 * Return by default an empty string rather "_UNDEFINED_" on "getenv"
2008 modulefile command if passed environment variable is not defined.
2009
2010 * Align empty directory name error message obtained on "use" sub-
2011 command with message obtained when module or collection name is
2012 empty.
2013
2014 * Accept non-existent modulepath on "use" sub-command.
2015
2016 * Install: installation option "--enable-auto-handling" is set on by
2017 default which enables the automated module handling mode (see
2018 "MODULES_AUTO_HANDLING").
2019
2020 * Install: installation option "--enable-extended-default" is set on
2021 by default which allows partial module version specification (see
2022 "MODULES_EXTENDED_DEFAULT").
2023
2024 * Install: installation option "--enable-advanced-version-spec" is set
2025 on by default which activates the Advanced module version specifiers
2026
2027 * Install: installation option "--enable-color" is set on by default
2028 which enables the "auto" output color mode (see "MODULES_COLOR").
2029
2030 * Install: installation option "--with-icase" is set to "search" by
2031 default to activate case insensitive match on search contexts (see
2032 "MODULES_ICASE").
2033
2034 * Install: installation option "--enable-new-features" has been reset
2035 following major version change as all the options it implied are now
2036 enabled by default.
2037
2038 * Install: installation option "--enable-set-shell-startup" is set off
2039 by default but could be enabled once installed through the "initrc"
2040 configuration file.
2041
2042 * Install: installation option "--with-initconf-in" is set to "etcdir"
2043 by default to locate configuration files in the directory designated
2044 by the "--etcdir" option. Therefore the initialization configuration
2045 file is named "initrc" in this directory, and the modulepath-
2046 specific configuration file is named "modulespath".
2047
2048 * Only look at configuration files found in the location designated by
2049 the "--etcdir" or "--initdir" option (depending on the value of "--
2050 with-initconf-in" option). Configuration files were previously
2051 searched in both locations.
2052
2053 * Install: remove installation option "--enable-compat-version".
2054 Compatibility version co-installation is discontinued. **switchml**
2055 shell function and "MODULES_USE_COMPAT_VERSION" are thus removed as
2056 well.
2057
2058 * Testsuite: introduce the non-regression quick test mode. When the
2059 "QUICKTEST" environment variable is set to "1", only the main tests
2060 from the non-regression testsuite are run. When first argument of
2061 the **mt** script is "quick", tests are run in quick mode.
2062
2063 * Install: run non-regression testsuite in quick mode in RPM spec
2064 file.
2065
2066 * Rename the environment variables that are used by Modules to track
2067 loaded environment state (variables whose name starts with
2068 "MODULES_LM"). A "__" prefix is added to the name of these variables
2069 to indicate that they are intended for internal use only.
2070
2071 * Rename the environment variables used to indirectly pass to
2072 "modulecmd.tcl" the value of variables set in quarantine (variables
2073 whose name finishes with "_modquar"). A "__MODULES_QUAR_" prefix is
2074 applied to the name of these variables instead of the "_modquar"
2075 suffix to indicate they are intended for Modules internal use of
2076 only.
2077
2078 * Update Tcl requirement to version 8.5 as Tcl 8.4 is deprecated since
2079 a long time and this version is not available anymore on recent OS
2080 distributions. Update internal code of "modulecmd.tcl" to take
2081 benefit from the features brought by Tcl 8.5.
2082
2083 * Split source code in several Tcl files hosted in "tcl" directory.
2084 When building Modules, the Tcl files are concatenated to make the
2085 "modulecmd.tcl" script.
2086
2087 * Record "auto-loaded" tag of loaded modules in "__MODULES_LMTAG"
2088 environment variable rather set a specific entry for module in the
2089 "__MODULES_LMNOTUASKED" environment variable.
2090
2091 * Rename the environment variables used by the reference counting
2092 mechanism of path-like environment variables. A "__MODULES_SHARE_"
2093 prefix is applied to the name of these variables instead of the
2094 "_modshare" suffix to clearly indicate they are intended for Modules
2095 internal use of only.
2096
2097 * Reference counting mechanism is not anymore applied to the Modules-
2098 specific path variables (like "LOADEDMODULES"). As a result no
2099 "__MODULES_SHARE_<VAR>" variable is set in user environment for
2100 these variables. Exception is made for "MODULEPATH" environment
2101 variable where the mechanism still applies.
2102
2103 * When an element is added to a path-like variable through the
2104 "append-path" or "prepend-path" modulefile commands, add this
2105 element to the associated reference counter variable (named
2106 "__MODULES_SHARE_<VAR>") only when this element is added multiple
2107 times to the path-like variable. When an element is removed from a
2108 path-like variable, this element is removed from the reference
2109 counter variable when its counter is equal to 1.
2110
2111 * When the "use" and "unuse" module sub-commands are not called during
2112 a modulefile evaluation, the reference counter associated with each
2113 entry in "MODULEPATH" environment variable is ignored. In such
2114 context, a "module use" will not increase the reference counter of a
2115 path entry already defined and a "module unuse" will remove
2116 specified path whatever its reference counter value.
2117
2118 * When the "append-path", "prepend-path" and "remove-path" module sub-
2119 commands are not called during a modulefile evaluation, the
2120 reference counter associated with each entry in targeted environment
2121 variable is ignored. In such context, a "module append-path/prepend-
2122 path" will not increase the reference counter of a path entry
2123 already defined and a "module remove-path" will remove specified
2124 path whatever its reference counter value.
2125
2126 * Fix "unuse" sub-command when several modulepaths are specified as a
2127 single argument (i.e., "/path/to/dir1:/path/to/dir2"). Enabled
2128 modulepaths were not correctly detected when specified this way.
2129
2130 * Doc: clarify that an already defined path is not added again or
2131 moved when passed to the "use" sub-command or the "append-path
2132 /prepend-path" modulefile commands. (fix issue #60)
2133
2134 * Change the "refresh" sub-command to evaluate all loaded modulefiles
2135 and re-apply the non-persistent environment changes they define
2136 (i.e., shell aliases and functions). With this change the "refresh"
2137 sub-command is restored to the behavior it had on Modules version
2138 3.2.
2139
2140 * Evaluate the modulefile commands resulting from a "source-sh"
2141 command through the current modulefile Tcl interpreter in order to
2142 evaluate them according to the current modulefile evaluation mode.
2143
2144 * When initializing Modules, refresh the loaded modules in case some
2145 user environment is already configured. This is especially useful
2146 when starting a sub-shell session as it ensures that the loaded
2147 environment in parent shell is correctly inherited, as the "refresh"
2148 sub-command re-applies the non-persistent environment configuration
2149 (i.e., shell alias and function that are not exported to the sub-
2150 shell). (fix issue #86)
2151
2152 * Init: add example code in default "initrc", the initialization
2153 script of Modules, to either restore user's default collection if it
2154 exists or load a predefined module list at the end of the
2155 initialization process.
2156
2157 * When initializing Modules, evaluate the "initrc" configuration file
2158 in addition to the the "modulespath" configuration file and not
2159 instead of this file. "initrc" is evaluated after "modulespath"
2160 file.
2161
2162 * When the installation option "--enable-modulespath" is set, the list
2163 of modulepath to enable by default is now only defined in the
2164 "modulespath" configuration file and not anymore in the "initrc"
2165 configuration file.
2166
2167 * No error is raised when evaluating in "display" mode a modulefile
2168 without a value specified for the "variant" it defines. This change
2169 helps to learn all the variant a modulefile defines. As a result,
2170 the unspecified variant is not instantiated in the "ModuleVariant"
2171 array variable. (fix issue #406)
2172
2173 * When running the "unsetenv" modulefile command on an unload
2174 evaluation, do not unset designated environment variable if no value
2175 to restore is provided.
2176
2177 * Fix "unsetenv" to distinguish between being called on a unload
2178 evaluation without a value to restore or with an empty string value
2179 to restore.
2180
2181 * Make "system" modulefile command available from a modulerc
2182 evaluation context whatever the underlying module evaluation mode.
2183
2184 * Make "is-used" modulefile command available from a modulerc
2185 evaluation context.
2186
2187 * Remove internal state "tcl_version_lt85" as Tcl 8.5+ is now a
2188 requirement.
2189
2190 * Forbid use of "module source" command in modulefile or in an
2191 initialization rc file, the "source" Tcl command should be used
2192 instead. "source" sub-command should only be called from the
2193 command-line.
2194
2195 * Report the modules loading and unloading during the **module**
2196 command initialization (i.e., during the evaluation of the "initrc"
2197 configuration file). These report messages are disabled when the
2198 "verbosity" configuration option is set to "concise" or "silent".
2199
2200 * During a module "restore" or "source", only report the module load
2201 and unload directly triggered by these sub-commands. Load and unload
2202 triggered by other modules are reported through the automated module
2203 handling messages of the main modules.
2204
2205 * Enforce use of the module magic cookie (i.e., "#%Module") at the
2206 start of global or user rc files, "initrc" configuration file or any
2207 scriptfile passed for evaluation to the "source" sub-command. These
2208 files are not evaluated and an error is produced if the magic cookie
2209 is missing or if the optional version number placed after the cookie
2210 string is higher than the version of the "modulecmd.tcl" script in
2211 use.
2212
2213 * Doc: alphabetically sort installation option in Installing Modules
2214 on Unix document.
2215
2216 * Update the "--enable-quarantine-support" installation option to
2217 control a "quarantine_support" configuration option. When this
2218 option is enabled, the "autoinit" sub-command produces the shell
2219 code for the **module** shell function definition with quarantine
2220 mechanism support. When disabled, code is generated without
2221 quarantine support.
2222
2223 * Install: installation option "--enable-quarantine-support" is set
2224 off by default.
2225
2226 * Introduce the "MODULES_QUARANTINE_SUPPORT" environment variable to
2227 control the "quarantine_support" configuration option once Modules
2228 is installed. To enable the quarantine mechanism,
2229 "MODULES_QUARANTINE_SUPPORT" should be set to "1" prior Modules
2230 initialization or "quarantine_support" configuration option should
2231 be set to "1" in the "initrc" configuration file.
2232
2233 * Quarantine mechanism code in the Modules shell initialization
2234 scripts is now always defined and mechanism always applies if some
2235 environment variables are defined in "MODULES_RUN_QUARANTINE".
2236
2237 * Code in the "modulecmd.tcl" script to restore environment variables
2238 put in quarantine is now always generated and applies if the
2239 "__MODULES_QUARANTINE_SET" environment variable is set to "1". This
2240 variable is set by the Modules initialization script prior calling
2241 the "autoinit" sub-command or by the **module** shell function if it
2242 has been generated with quarantine support enabled.
2243
2244 * Install: installation option "--enable-silent-shell-debug-support"
2245 is set off by default.
2246
2247 * Code to silence shell debug properties in the Modules shell
2248 initialization scripts is now always defined and mechanism applies
2249 if "MODULES_SILENT_SHELL_DEBUG" environment variable is set to "1".
2250
2251 * Code to silence shell debug properties in the **module** shell
2252 function could now be enabled if "MODULES_SILENT_SHELL_DEBUG" is set
2253 to "1" prior Modules initialization or if the "silent_shell_debug"
2254 configuration option is set to "1" in the "initrc" configuration
2255 file.
2256
2257 * Doc: clarify TOC and title of MIGRATING document.
2258
2259 * Doc: extend description of Modules configuration steps of in
2260 Installing Modules on Unix document.
2261
2262 * Doc: document "initrc" and "modulespath" configuration files in
2263 module man page.
2264
2265 * Install: replace "example.txt" by "INSTALL.txt" guide in RPM.
2266
2267 * Doc/Install: rename "diff_v3_v4" document into changes.
2268
2269 * Doc: reorganize Changes between versions document to let room to
2270 describe Modules 5 changes.
2271
2272
2273 Modules 4.8.0 (2021-07-14)
2274 ==========================
2275
2276 * Introduce the "edit" sub-command that opens modulefile passed as
2277 argument in a text editor. Modulefile can be specified like with any
2278 other sub-command, leveraging defined symbolic versions, aliases or
2279 using advanced version specifiers.
2280
2281 * Add the "editor" configuration option to select the text editor to
2282 use with "edit" sub-command. When this option is set through the
2283 "config" sub-command, the "MODULES_EDITOR" environment variable is
2284 set. The "--with-editor" installation option controls the default
2285 value of "editor" configuration option. If not set at installation
2286 time, "vi" is set as default editor.
2287
2288 * Default value of "editor" configuration option is overridden by the
2289 "VISUAL" or the "EDITOR" environment variables, which are both in
2290 turn overridden by the "MODULES_EDITOR" environment variable.
2291
2292 * Doc: fix "modulecmd.tcl" internal state check in recipes example
2293 codes. (fix issue #396)
2294
2295 * The Advanced module version specifiers mechanism now allows the use
2296 of version range in version list (for instance
2297 "mod@:1.2,1.4:1.6,1.8:"). Such specification helps to exclude
2298 specific versions. (fix issue #397)
2299
2300 * Install: fix installation scripts to allow building Modules when its
2301 repository is set as a git submodule. (fix issue #398)
2302
2303 * Doc: demonstrate in the Source shell script in modulefile recipe how
2304 to use the "source-sh" command when software provide a specific
2305 initialization script for each shell it supports. (fix issue #399)
2306
2307 * When defining a shell function with the "set-function" modulefile
2308 command, only export this function when using the Bash shell (using
2309 the "export -f" shell command) to make it available in sub-shell
2310 contexts. Shell function export is not supported on other kind of sh
2311 shell (sh, ksh and zsh). (fix issue #401)
2312
2313 * Doc: add Variants design notes.
2314
2315 * Add the "variant" modulefile command that enables to pass down
2316 arguments, specified when designating the module to evaluate, within
2317 modulefile evaluation context. This command defines a variant name
2318 and a list of allowed values. When evaluated, "variant" instantiates
2319 an element in the "ModuleVariant" array whose name equals variant
2320 name and value is set with value specified for variant when module
2321 is designated. If specified value does not correspond to an allowed
2322 value or if no value is specified for variant an error is raised.
2323
2324 * Enhance the Advanced module version specifiers to handle variant
2325 specification following Spack's syntax (e.g., *name=value*). When
2326 the "advanced_version_spec" configuration is enabled, variant could
2327 be specified anywhere a module can be specified.
2328
2329 * Add the "--default" option to the "variant" modulefile command to
2330 indicate the default value of the variant to apply when the
2331 designation of the evaluating module does not mention this variant.
2332
2333 * Add the "--boolean" option to the "variant" modulefile command to
2334 indicate that the variant defined is of the Boolean type, thus no
2335 list of accepted value is expected.
2336
2337 * Enhance the Advanced module version specifiers to handle Boolean
2338 variant specification following Spack's syntax (e.g., *+name*,
2339 *~name* and *-name*). The *-name* syntax is not supported on ml
2340 command as the minus sign already means to unload designated module.
2341
2342 * Accept any minus argument (*-word*) set after the sub-command name
2343 when the "advanced_version_spec" configuration is enabled and if
2344 sub-command accepts Advanced module version specifiers (like "load"
2345 or "unload" sub-commands). A *false* value may be set to Boolean
2346 variant this way.
2347
2348 * Add the "variant_shortcut" configuration option to define shortcut
2349 characters that could be used to specify and report module variants.
2350 Default value for this option could be set at installation time with
2351 the "--with-variant-shortcut" option. No variant shortcut is defined
2352 by default. This value could be superseded by setting up the
2353 "variant_shortcut" option with "config" sub-command. Which sets the
2354 "MODULES_VARIANT_SHORTCUT" environment variable.
2355
2356 * Enhance the Advanced module version specifiers to handle variant
2357 shortcut specification (e.g., *<shortcut>value*).
2358
2359 * Record in user loaded environment, with "MODULES_LMVARIANT"
2360 environment variable, the value specified for the variants defined
2361 in the loaded modulefiles and their properties (if it is a Boolean
2362 variant and if the value set is the default one).
2363
2364 * Add the "variant" element in the allowed value list of the
2365 "list_output" and "list_terse_output" configuration options. Set
2366 this new element in the default value list of the "list_output"
2367 option. When set, the variant defined for loaded modules are
2368 reported on module "list" command output.
2369
2370 * Add the "va" color key in default light and dark color palettes to
2371 graphically enhance the report of variant value.
2372
2373 * Update the key section to explain on "list" sub-command output the
2374 reported variant elements (*name=value*, *+name*, *-name* or
2375 *<shortcut>value*)
2376
2377 * Record variant specification of loaded modules when saving
2378 collections and reload specified variants when restoring these
2379 collections.
2380
2381 * When "collection_pin_version" configuration is disabled, only record
2382 in collections the variants whose value is not the default one.
2383
2384 * Update module designation in error, warning or informational
2385 messages to report variant specification enclosed in curly braces
2386 (*{}*), enclose module name and version or variant specification in
2387 single quotes (*''*) if they contain a space character and highlight
2388 the module designation in report message if configured.
2389
2390 * Introduce the "getvariant" modulefile command to query for currently
2391 evaluating module the value of a given variant name.
2392
2393 * When translating the "@loaded" version specifier also retrieve the
2394 variant specified for corresponding loaded module.
2395
2396 * Update hide, forbid and tag mechanisms to apply them only if they
2397 match selected module variant.
2398
2399 * Any variant defined in module specification passed as argument to
2400 search sub-commands ("avail", "whatis", "is-avail", "path" and
2401 "paths") is ignored.
2402
2403 * Raise an error if a variant named "version" is declared in a
2404 modulefile to let room for the future implementation of this
2405 specific variant.
2406
2407 * Doc: describe in the Changes between versions document argument
2408 handling change on "setenv" since v3.2. (fix issue #402)
2409
2410 * Introduce the "try-load" sub-command which like "load" sub-command
2411 tries to load the modulefile passed as argument, but does not
2412 complain if this modulefile cannot be found. (fix issue #392)
2413
2414 * Init: fix stderr redirection in fish shell initialization script,
2415 now that use of the "^" character to redirect stderr is disabled by
2416 default (fish >=3.3).
2417
2418 * Protect quarantine mechanism code from "rcexpandparam" Zsh option
2419 when initializing the **module** command on this shell. (fix issue
2420 #403)
2421
2422
2423 Modules 4.7.1 (2021-04-06)
2424 ==========================
2425
2426 * Doc: clarify the license terms used by the project. (fix issue #389)
2427
2428 * Align all files from the Modules project under the GPLv2+ license.
2429 Scripts and libraries that were previously licensed with GPLv3+ have
2430 been moved to GPLv2+ with the consent of their respective copyright
2431 holders. (fix issue #389)
2432
2433 * Revert "Install: have "configure" script assume the "." dot
2434 directory when invoked without the prepended "./"" as consent was
2435 not obtained from author to re-license the contribution to GPLv2+.
2436
2437 * Doc: fixes few typos in module and modulefile.
2438
2439 * Update the "sh-to-mod" mechanism to support version 3.2 of the fish
2440 shell. Fish 3.2 introduces the "." builtin command that should be
2441 regexp-escaped when determining the shell functions or aliases
2442 defined by the script analyzed by "sh-to-mod".
2443
2444 * Vim: update addon files to highlight modulefile variables
2445 "ModuleTool", "ModuleToolVersion" and "ModulesCurrentModulefile".
2446
2447 * Doc: update the description and default value of the "--with-dark-
2448 background-colors" and "--with-light-background-colors" installation
2449 options.
2450
2451 * Doc: add description of changes that occurred on versions 4.6 and
2452 4.7 for the "--with-dark-background-colors" and "--with-light-
2453 background-colors" installation options and for the "MODULES_COLORS"
2454 environment variable.
2455
2456 * Doc: correct the default value of the "--with-tag-abbrev"
2457 installation option.
2458
2459 * Doc: add Sticky modules cookbook recipe.
2460
2461
2462 Modules 4.7.0 (2021-02-19)
2463 ==========================
2464
2465 * Doc: simplify TOC of New features document
2466
2467 * Add the "ModuleTool" and "ModuleToolVersion" Modules variables to
2468 determine during modulefile or modulerc evaluation the name and
2469 version of the *module* implementation currently in use.
2470
2471 * Introduce the "versioncmp" modulefile command to compare two version
2472 strings passed as argument.
2473
2474 * Enable the use of wildcard character to designate multiple
2475 directories at once in "modulespath" configuration file. (fix issue
2476 #125)
2477
2478 * Distinguish aliases from symbolic versions in "MODULES_LMALTNAME"
2479 environment variable. Prefix these alias entries with the "al|"
2480 string.
2481
2482 * Fetch modulefile modification time only if required by "list" sub-
2483 command display format.
2484
2485 * Use symbolic versions recorded in environment, with
2486 "MODULES_LMALTNAME" variable, to report the symbols applying to
2487 loaded modules on "list" sub-command. Modulerc files are not
2488 evaluated anymore when performing a module list.
2489
2490 * Move the definition of the "FPATH" environment variable for Modules
2491 initialization on ksh shell from the initialization script of this
2492 shell to the resulting output of the "autoinit" sub-command.
2493
2494 * Introduce the "shells_with_ksh_fpath" configuration option to define
2495 a list of shell where to ensure that any ksh sub-shell will get the
2496 module function defined by use of the "FPATH" environment variable.
2497 When the "shells_with_ksh_fpath" option is set through the "config"
2498 sub-command, the "MODULES_SHELLS_WITH_KSH_FPATH" environment
2499 variable is set. Accepted values are a list of shell among *sh*,
2500 *bash*, *csh*, *tcsh* and *fish* separated by colon character (":").
2501
2502 * Add the "implicit_requirement" configuration option to control
2503 whether a prereq or a conflict requirement should be implicitly set
2504 onto modules respectively specified on "module load" or "module
2505 unload" commands in modulefile. Default value for this option could
2506 be set at configure time with the "--enable-implicit-requirement"
2507 option (enabled by default). This value could be superseded by
2508 setting up the "implicit_requirement" option with "config" sub-
2509 command. Which sets the "MODULES_IMPLICIT_REQUIREMENT" environment
2510 variable. (fix issue #260)
2511
2512 * Add the "--not-req" option to the "module" modulefile command to
2513 inhibit for its "load" and "unload" sub-commands the definition of a
2514 prereq or conflict requirement onto specified modules.
2515
2516 * Add the "lpopState" and "currentState" procedures to respectively
2517 remove or return the last entry from the list of values of a given
2518 state.
2519
2520 * Add the "topState" and "depthState" procedures to respectively
2521 return the first element from or the number of elements in the list
2522 of values of a given state.
2523
2524 * Remove the pre-definition of runtime states with no specific
2525 property. These basic states are defined on-the-fly which implied
2526 they are not reported on a "module config --dump-state" command
2527 unless if instantiated.
2528
2529 * Introduce the "loaded" symbolic version among advanced version
2530 specifiers (e.g. "foo@loaded") to designate the currently loaded
2531 version of specified module. (fix issue #366)
2532
2533 * Doc: add *Module tags* design notes.
2534
2535 * Report tags applying to the modules returned by the "avail" sub-
2536 command. Adapt the regular, terse and JSON output styles to report
2537 these tags along the module they are attached to (enclosed in "<>").
2538 Reported tags currently are states that apply to modules: "auto-
2539 loaded", "forbidden", "hidden", "loaded", "nearly-forbidden",
2540 "sticky" and "super-sticky".
2541
2542 * Record tags applying to each loaded module in the "MODULES_LMTAG"
2543 environment variable to make this information persist after module
2544 being loaded.
2545
2546 * Report tags applying to the loaded modules returned by the "list"
2547 sub-command. Adapt the regular and JSON output styles to report
2548 these tags along the module they are attached to (enclosed in "<>").
2549 Reported tags currently are states applying to loaded modules:
2550 "auto-loaded", "hidden-loaded", "nearly-forbidden", "sticky" and
2551 "super-sticky".
2552
2553 * Introduce the "module-info tags" modulefile command to query the
2554 tags that apply to the currently evaluated modulefile.
2555
2556 * Add the "module-tag" modulefile command to associate tag to
2557 designated modulefile. Those tags are reported on "avail" and "list"
2558 sub-commands along the module they are attached to. "module-tag"
2559 supports the advanced module version specifier syntax.
2560
2561 * Add the "tag_abbrev" configuration option to define abbreviated
2562 strings for module tags and use these abbreviations instead of tag
2563 names when reporting tags on "avail" and "list" command results.
2564 Default value for this option could be set at configure time with
2565 the "--with-tag-abbrev" option. By default the following
2566 abbreviations are set: "aL" for *auto-loaded*, "F" for *forbidden*,
2567 "H" for *hidden*, "H" for *hidden-loaded*, "L" for *loaded*, "nF"
2568 for *nearly-forbidden*, "S" for *sticky*, "sS" for *super-sticky*.
2569 This value could be superseded by setting up the "tag_abbrev" option
2570 with "config" sub-command. Which sets the "MODULES_TAG_ABBREV"
2571 environment variable.
2572
2573 * A Select Graphic Rendition (SGR) code can be associated to module
2574 tag names or abbreviation strings in the color palette to
2575 graphically render these tags over the module name they are
2576 associated to. The default light and dark color palettes have been
2577 updated to set a color code for all basic module tags. When a color
2578 code is set for a tag, it is then graphically rendered over the
2579 module names and not reported along module name by its tag name or
2580 abbreviation. When multiple colored tags apply to a given module,
2581 each tag is graphically rendered over a sub-part of the module name.
2582
2583 * Add the "tag_color_name" configuration option to designate module
2584 tags whose graphical rendering should be applied to their own name
2585 or abbreviation rather than over the module name they are attached
2586 to. Default value for this option could be set at configure time
2587 with the "--with-tag-color-name" option (empty by default). This
2588 value could be superseded by setting up the "tag_color_name" option
2589 with "config" sub-command. Which sets the "MODULES_TAG_COLOR_NAME"
2590 environment variable.
2591
2592 * Add the "--hidden-loaded" option to the "module-hide" modulefile
2593 command that indicates module should be hidden once loaded. When
2594 set, the "hidden-loaded" module tag applies to module specification
2595 set on "module-hide" command.
2596
2597 * Do not report on "list" sub-command results the loaded modules
2598 associated with the "hidden-loaded" tag, unless if the "--all"
2599 option is set.
2600
2601 * Doc: add an "hidden-loaded" example in the *Hide and forbid modules*
2602 cookbook recipe.
2603
2604 * Introduce the "verbose2" verbosity level between "verbose" and
2605 "trace" levels. Verbose2 mode can be enabled by setting the
2606 "verbosity" config to the "verbose2" value or by using the "-v"
2607 command-line switch twice.
2608
2609 * Do not report the load, unload or switch of modules set "hidden-
2610 loaded" if these modules have been loaded, unloaded or switched
2611 automatically. Unless the verbosity mode is set to "verbose2" or any
2612 higher level or if any specific messages have to be reported for
2613 these module evaluations.
2614
2615 * Report when trying to load a module which is already loaded or when
2616 trying to unload a module which is not loaded in case the verbosity
2617 mode is set to "verbose2" or any higher level. (fix issue #187)
2618
2619 * Doc: improve readability of version 4 improvements in Changes
2620 between versions document.
2621
2622 * Introduce stickiness: module tagged "sticky" with "module-tag"
2623 command cannot be unloaded unless if the unload is forced or if the
2624 module is reloaded. (fix issue #269)
2625
2626 * Introduce super-stickiness: module tagged "super-sticky" with
2627 "module-tag" command cannot be unloaded even if the unload is forced
2628 unless if the module is reloaded. (fix issue #269)
2629
2630 * Allow swap of sticky or super-sticky modules by another modulefile
2631 version if stickiness definition applies to module parent name.
2632 E.g., *foo/1.0* can be swapped by *foo/2.0* if sticky tag applies to
2633 *foo*.
2634
2635 * When forcing purge with a "purge --force" sub-command, also unload
2636 the modules that are depended by non-unloadable modules.
2637
2638 * Doc: improve readability of Modules installation configuration in
2639 Installing Modules on Unix document and enable hypertext reference
2640 to these elements.
2641
2642 * Doc: improve readability of module command configuration option in
2643 module document and enable hypertext reference to these elements.
2644
2645 * Doc: describe in HTML documentation when installation options,
2646 module command configuration options and options of modulefile
2647 command or module sub-command were introduced.
2648
2649 * Doc: update HTML documentation Table Of Content.
2650
2651 * Doc: improve markup of module sub-commands, modulefile commands,
2652 installation option, module configuration option across
2653 documentation.
2654
2655 * Doc: colorize terminal output examples in New features document.
2656
2657 * Abort modulefile read if first file content chunk does not start
2658 with the "#%Module" magic cookie. (fix issue #375)
2659
2660 * Install: add installation option "--enable-new-features" that
2661 enables all at once the installation options that are disabled by
2662 default due to the substantial behavior changes they imply.
2663
2664 * Add a *Key* section at the end of "avail" and "list" sub-commands to
2665 explain the meaning of graphical renditions or of elements set in
2666 parentheses or chevrons along module name.
2667
2668 * Fix output of "avail" and "list" sub-commands on very small terminal
2669 width. (fix issue #378)
2670
2671 * Add "mcookie_version_check" configuration to define if version set
2672 in modulefile magic cookie should be checked against **module**
2673 current version to determine if modulefile can be evaluated. The new
2674 configuration, which is enabled by default, can be set at
2675 installation time with configure option "--enable-mcookie-version-
2676 check" or can be superseded later on with the
2677 "MODULES_MCOOKIE_VERSION_CHECK" environment variable. (fix issue
2678 #377)
2679
2680 * Fix output of modulefile evaluation error stack trace on very small
2681 terminal width. (fix issues #379 and #381)
2682
2683 * Correct "config" sub-command to set "nearly_forbidden_days"
2684 configuration. (fix issue #380)
2685
2686 * Init: reduce usage of helper variables in "bash_completion" and
2687 "tcsh_completion" that are showing up in the output of the shell's
2688 "set" command. (fix issue #382 with contribution from Colin
2689 Marquardt)
2690
2691 * Consider modulepath starting with a reference to an environment
2692 variable as absolute. (fix issue #376)
2693
2694 * Consider the "module load" performed in the user or the global RC
2695 file like load commands issued from initialization RC file. (fix
2696 issue #372)
2697
2698 * Install: have "configure" script assume the "." dot directory when
2699 invoked without the prepended "./". (contribution from R.K. Owen)
2700
2701 * Install: disable the Makefile rules to build the HTML documentation
2702 in case if the documentation is found pre-built in the dist archive.
2703
2704 * Install: do not flag documentation as pre-built if "configure"
2705 script is ran another time after building docs.
2706
2707 * Restrict the value accepted by "nearly_forbidden_days" configuration
2708 and "--with-nearly-forbidden-days" installation option to integers
2709 comprised between 0 and 365.
2710
2711 * Install: color *ERROR* and *WARNING* message headers produced by
2712 "configure" script if output is sent to a terminal.
2713
2714 * Install: split error messages produced by "configure" script over an
2715 additional line when too long.
2716
2717 * Doc: add *Output configuration* design notes.
2718
2719 * Introduce the "avail_output" and "avail_terse_output" configuration
2720 options to define the content to report in addition to the available
2721 module names respectively for "avail" sub-command regular and terse
2722 output modes. Excepted value for these configuration options is a
2723 colon separated list of elements to report. Default value is
2724 "modulepath:alias:dirwsym:sym:tag:key" for "avail_output" and
2725 "modulepath:alias:dirwsym:sym:tag" for "avail_terse_output". These
2726 values can be changed at installation time respectively with the "--
2727 with-avail-output" and "--with-avail-terse-output" options. These
2728 values can then be superseded by using the "config" sub-command
2729 which sets the "MODULES_AVAIL_OUTPUT" and
2730 "MODULES_AVAIL_TERSE_OUTPUT" environment variables.
2731
2732 * Introduce the "list_output" and "list_terse_output" configuration
2733 options to define the content to report in addition to the available
2734 module names respectively for "list" sub-command regular and terse
2735 output modes. Excepted value for these configuration options is a
2736 colon separated list of elements to report. Default value is
2737 "header:idx:sym:tag:key" for "list_output" and "header" for
2738 "list_terse_output". These values can be changed at installation
2739 time respectively with the "--with-list-output" and "--with-list-
2740 terse-output" options. These values can then be superseded by using
2741 the "config" sub-command which sets the "MODULES_LIST_OUTPUT" and
2742 "MODULES_LIST_TERSE_OUTPUT" environment variables.
2743
2744 * Add the "--output"/"-o" command-line switches to supersede the
2745 output configuration of "avail" or "list" sub-commands on their
2746 regular or terse output modes.
2747
2748 * Remove the "avail_report_dir_sym" and "avail_report_mfile_sym"
2749 locked configuration options whose behaviors can now be obtained by
2750 respectively adding the "dirwsym" and "sym" elements to the
2751 "avail_output" or "avail_terse_output" configuration options.
2752
2753 * When "modulepath" is omitted from the content to report on "avail"
2754 sub-command, available modules collected from global/user rc and
2755 enabled modulepaths are aggregated and reported all together.
2756
2757 * Install: print generated file names rather commands executed to
2758 generate these files on Makefile build targets. Output obtained when
2759 building Modules is this way simplified. When option "V=1" is passed
2760 to "make", the verbose mode is enabled and run commands are shown.
2761 The simplified "make" output does not apply to the install, test and
2762 clean targets or any target similar to them.
2763
2764 * Install: fix configure and build files of Modules Tcl extension
2765 library to make them compatible with autoconf >=2.69.
2766
2767 * Script: correctly detect previous Modules version number released
2768 from a side git branch on **mpub** command.
2769
2770 * Install: align RPM spec file syntax with spec file used on Fedora.
2771 Add missing build dependency on "make" package. Also remove obsolete
2772 "Group" RPM tag.
2773
2774 * Add the "term_width" configuration option to set the width of the
2775 output. This configuration option is set to "0" by default, which
2776 means that the output width is the full terminal width. The "--
2777 width"/"-w" command line switches are added to supersede the value
2778 of the configuration option. (fix issue #359 with contribution from
2779 Anaïs Gaertner)
2780
2781 * Doc: add a *Get Modules* section in Installing Modules on Unix
2782 document to provide download links for Modules' sources. (fix issue
2783 #387)
2784
2785
2786 Modules 4.6.1 (2020-11-14)
2787 ==========================
2788
2789 * Lib: implement "initStateClockSeconds" as a Tcl command in
2790 libtclenvmodules to provide an optimized way to retrieve current
2791 Epoch time.
2792
2793 * Lib: implement "parseDateTimeArg" as a Tcl command in
2794 libtclenvmodules to provide an optimized way to convert a datetime
2795 string into an Epoch time.
2796
2797 * When full module specification is equal to "@", raise an error as no
2798 module name is provided. (fix issue #362)
2799
2800 * Optimize internal recording of hidden module and tag specification
2801 when parsing modulerc files in order to reduce the time taken to
2802 test if a given module is hidden or if a given tag applies to it.
2803
2804 * Script: add the ability to select the benchmark test to perform on
2805 **mb** utility.
2806
2807 * Doc: add *Use new features without breaking old module command*
2808 cookbook recipe
2809
2810 * Doc: rework option description for "module-hide" and "module-forbid"
2811 commands in modulefile document.
2812
2813 * Doc: describe in Changes between versions document that shell
2814 special characters like backticks are escaped when used in values
2815 starting Modules 4.0. (fix issue #365)
2816
2817 * Doc: make the ENVIRONMENT section from modulefile man page point to
2818 the ENVIRONMENT section of module man page.
2819
2820 * Fix "clear" sub-command to unset the "MODULES_LMSOURCESH"
2821 environment variable. (fix issue #367)
2822
2823 * Correctly return on "avail" sub-command a symbolic version defined
2824 in a global RC file when specifically searched. (fix issue #368)
2825
2826 * Fix module hiding resolution for symbolic versions defined in a
2827 global RC file when "module-hide" statements are set in the
2828 modulepath where the modulefiles targeted by these symbols are
2829 located. (fix issue #369)
2830
2831 * When a module fails to unload during a "purge" sub-command, preserve
2832 loaded the modules it requires to keep environment consistent. (fix
2833 issue #370)
2834
2835 * Doc: add *Hide and forbid modules* cookbook recipe.
2836
2837
2838 Modules 4.6.0 (2020-09-16)
2839 ==========================
2840
2841 * Rework internal state handling to gather all state definitions in a
2842 global array and use the same initialization and retrieval
2843 procedure, named "getState", for all these states.
2844
2845 * Add the "setState", "unsetState", "lappendState", "isStateDefined"
2846 and "isStateEqual" procedures to provide unified ways to set or
2847 check the value of state.
2848
2849 * Introduce the "sh-to-mod" sub-command, to evaluate shell script and
2850 determine the environment changes it does. Corresponding modulefile
2851 content is outputted as a result. Changes on environment variables,
2852 shell aliases, shell functions and current working directory are
2853 tracked. The following shells are supported: sh, dash, csh, tcsh,
2854 bash, ksh, ksh93, zsh and fish.
2855
2856 * Doc: add *Source shell script in modulefile* design notes.
2857
2858 * Introduce the "source-sh" modulefile command, to evaluate shell
2859 script and apply resulting environment changes through modulefile
2860 commands. When a modulefile using "source-sh" modulefile command is
2861 loaded, the modulefile commands resulting from shell script
2862 evaluation are recorded in the "MODULES_LMSOURCESH" environment
2863 variable to be able to undo these environment changes when
2864 modulefile is unloaded and to report the modulefile commands used
2865 when modulefile is displayed. The same kind of environment changes
2866 than the "sh-to-mod" sub-command are tracked. The same list of
2867 shells than "sh-to-mod" sub-command are supported. (fix issue #346)
2868
2869 * Doc: add *Source shell script in modulefile* cookbook recipe.
2870
2871 * Doc: embed new Modules logo on website, online README and
2872 documentation portal.
2873
2874 * Install: disable by default the build of Modules compatibility
2875 version. From now on, option "--enable-compat-version" has to be set
2876 to trigger this build.
2877
2878 * Introduce the "username" sub-command to the "module-info" modulefile
2879 command to get the username of the user currently running
2880 "modulecmd.tcl" or to test a string passed as argument corresponds
2881 to this username.
2882
2883 * Introduce the "usergroups" sub-command to the "module-info"
2884 modulefile command to get all the groups of the user currently
2885 running "modulecmd.tcl" or to test a string passed as argument
2886 corresponds to one of these groups.
2887
2888 * Doc: improve markup of Release notes and New features documents
2889 starting from this 4.6 version to enable references to module sub-
2890 commands, command line switches, environment variables and
2891 modulefile Tcl commands.
2892
2893 * Use inclusive terminology to eliminate *master* and *slave* terms as
2894 much as possible from code source and documentation.
2895
2896 * Doc: use a versioned magic cookie in examples that demonstrate new
2897 modulefile features. (fix issue #349)
2898
2899 * Introduce the "--enable-multilib-support" configure option to add
2900 mechanism in "modulecmd.tcl" to look at an alternative location to
2901 find the Modules Tcl extension library in case this library cannot
2902 be found at its main location.
2903
2904 * Lib: remove *fetch_hidden* argument from "getFilesInDirectory"
2905 procedure of Modules Tcl extension library.
2906
2907 * Doc: add *Hide or forbid modulefile* design notes.
2908
2909 * Add the "module-hide" modulefile command, to dynamically hide
2910 modulefile, module alias or symbolic version matching passed
2911 specification. When hidden, a modulefile, an alias or a symbolic
2912 version is not reported nor selected unless referred by its exact
2913 name, like for module whose name or version starts with a dot
2914 character. "module-hide" supports the advanced module version
2915 specifiers. (fix issue #202)
2916
2917 * Add option "--soft" to the "module-hide" modulefile command to
2918 introduce a soften level of camouflage: modules targeted by such
2919 hide directive are made visible as soon as their root name is part
2920 of search query.
2921
2922 * Add option "--hard" to the "module-hide" modulefile command to
2923 introduce a hardened level of camouflage: modules targeted by such
2924 hide directive keep being hidden even if they are fully matched by
2925 search query.
2926
2927 * Do not report among "whatis" search result the modulefiles with
2928 version name prefixed by a dot character and targeted by a symbolic
2929 version unless if they are precisely searched.
2930
2931 * When a loading module has hidden alternative names (hidden due to
2932 their name or version starting with a dot character or because they
2933 match a "module-hide" statement), these alternative names are not
2934 recorded in environment unless if they are not hard-hidden and if
2935 they have been used in query to select loading module.
2936
2937 * On "avail" sub-command, remove hidden symbolic versions from the
2938 list to display along modulefile or directory they target, unless
2939 these symbols are not hard-hidden and are used in query to search
2940 modules.
2941
2942 * When the "--default" filter of "avail" sub-command is set, unhide
2943 all the *default* symbolic versions or modules targeted by these
2944 symbols unless if they are hard-hidden.
2945
2946 * Define the *default* and *latest* automatic symbolic versions only
2947 if relative module name matches search query to ensure all elements
2948 for this module have been processed prior assigning the symbols.
2949
2950 * In case a symbolic version is transitively applied toward a
2951 modulefile, like for instance when this symbol is first set onto a
2952 directory, record the resolution of each transitively applied
2953 symbol. By doing so, a module "load" tentative using the
2954 transitively applied symbolic version will now correctly resolve to
2955 the modulefile targeted by symbol.
2956
2957 * Fix use of the advanced version specifiers in arguments to the "is-
2958 avail" modulefile command.
2959
2960 * Introduce the "--all"/"-a" option for "avail", "aliases", "whatis"
2961 and "search" sub-commands, to include in the search process all
2962 hidden modulefiles, module aliases or symbolic versions. Hard-hidden
2963 modules stay hidden even if "--all"/"-a" option is used.
2964
2965 * Add the "module-forbid" modulefile command, to dynamically forbid
2966 evaluation of modulefile matching passed specification. When
2967 forbidden, a module cannot be loaded and an access error is obtained
2968 when trying to evaluate them. "module-forbid" supports the advanced
2969 module version specifiers.
2970
2971 * Add "--not-user" and "--not-group" options to "module-hide" and
2972 "module-forbid" modulefile commands to ignore hiding or forbidding
2973 definition if current user is respectively part of specified
2974 username list or member of one of specified group list.
2975
2976 * Add "--before" and "--after" options to "module-hide" and "module-
2977 forbid" modulefile commands to ignore hiding or forbidding
2978 definition respectively after and before a specified date time.
2979 Accepted date time format is "YYYY-MM-DD[THH:MM]".
2980
2981 * Add "--message" option to "module-forbid" modulefile command to
2982 supplement the error message obtained when trying to evaluate a
2983 forbidden module.
2984
2985 * When a module that will soon be forbidden (as the date limit
2986 specified on the "--after" option of a matching "module-forbid"
2987 command is near) is evaluated, warn user this module access will
2988 soon be denied.
2989
2990 * The range of time the above warning appears can be controlled with
2991 the "nearly_forbidden_days" configuration option, whose value equals
2992 to the number of days prior the module starts to be forbidden. This
2993 configuration is set to "14" (days) by default and this value can be
2994 controlled at "configure" time with "--with-nearly-forbidden-days"
2995 option. When the "nearly_forbidden_days" configuration is set
2996 through the "config" sub-command, the
2997 "MODULES_NEARLY_FORBIDDEN_DAYS" environment variable is set.
2998
2999 * Add "--nearly-message" option to "module-forbid" modulefile command
3000 to supplement the warning message obtained when evaluating a nearly
3001 forbidden module.
3002
3003 * Add the "debug2" verbosity level, to report each call of
3004 "modulecmd.tcl" internal procedures in addition to debug messages.
3005 Debug2 mode can be enabled by setting the "verbosity" config to the
3006 "debug2" value or by using the "-D" command-line switch twice.
3007
3008 * Install: look for "make" rather "gmake" on MinGW and build library
3009 with a ".dll" extension on this platform.
3010
3011 * Add the "trace" verbosity level, to report details on module
3012 searches, resolutions, selections and evaluations. Trace mode can be
3013 enabled by setting the "verbosity" config to the "trace" value or by
3014 using the "-T"/"--trace" command-line switches.
3015
3016 * Introduce the "tr" key in the color palette to specifically render
3017 trace messages. Default value for "tr" key is "2" (decreased
3018 intensity).
3019
3020 * When trying to set an environment variable to an empty value on the
3021 Windows platform, unset this environment variable instead to cope
3022 with the underlying OS behavior.
3023
3024
3025 Modules 4.5.4 (2026-09-07)
3026 ==========================
3027
3028 * Init: fix command injection in Bash completion when module names
3029 contain shell meta-characters. Completion candidates were passed to
3030 "compgen -W" which evaluates command substitution syntax. (fix
3031 CVE-2026-85013 found by AISLE in partnership with Red Hat)
3032
3033
3034 Modules 4.5.3 (2020-08-31)
3035 ==========================
3036
3037 * Install: take into account the "--build", "--host", "--target", "--
3038 enable-dependency-tracking" and "--disable-dependency-tracking"
3039 configure options to transmit them to the "configure" scripts of
3040 Modules Tcl extension library and Modules compatibility version.
3041 (fix issue #354)
3042
3043 * Install: ignore some regular options of an Autoconf "configure"
3044 script that are useless for this project but usually implied in
3045 build macros (like RPM "%configure" macro).
3046
3047 * Install: ignore unsupported "--enable-*" and "--with-*" options on
3048 "configure" script rather raise an error and add support to define
3049 environment variable and build system type as "configure" script
3050 arguments to comply with GNU configuration recommendations.
3051
3052 * Install: fix "modulecmd" pre-alternatives check in RPM spec file.
3053
3054 * Install: use "%make_build" and "%make_install" macros in RPM spec
3055 file.
3056
3057 * When "module switch" command is used in modulefile, do not state
3058 when processing it a conflict over switched-off module if its
3059 specification on the "module switch" command also matches switched-
3060 on module's specification. Allow this way the replacement of any
3061 loaded version of a module for a specific one required by currently
3062 loading module. (fix issue #355)
3063
3064 * Correctly report failed attempts to load module requirements
3065 expressed with advanced version specifiers. (fix issue #356)
3066
3067
3068 Modules 4.5.2 (2020-07-30)
3069 ==========================
3070
3071 * Init: "list" and "source" sub-commands do not take available modules
3072 as argument in fish completion script.
3073
3074 * Init: fix option list for "search" sub-command in bash completion
3075 script.
3076
3077 * Fix double error counter increase when modulefile evaluation breaks.
3078
3079 * Install: adapt "configure" script to pass to the "configure" script
3080 of Modules compatibility version only a subset of the options it
3081 supports (most commonly used options).
3082
3083 * Install: raise an error when an unknown option is passed to
3084 "configure" script rather silently ignore it. (fix issue #348)
3085
3086 * Install: enable the definition of installation directory options of
3087 "configure" script with the "--option value" syntax in addition to
3088 the "--option=value" syntax. (fix issue #348)
3089
3090 * Doc: alphabetically sort sub-commands of "module-info" modulefile
3091 Tcl command in modulefile document.
3092
3093 * Script: clean previously built environment-modules RPMs in **mrel**.
3094
3095 * Clearly separate quarantine variable definition from tclsh binary on
3096 "modulecmd.tcl" evaluated command call in "_module_raw" function for
3097 *sh*, *bash*, *ksh* and *zsh* shells. (fix issue #350)
3098
3099 * Doc: clarify in documentation index that Environment Modules should
3100 not be confused with language-specific modules. (contribution from
3101 Rob Hurt)
3102
3103 * Adapt conflict detection tests to ensure a module loaded by its full
3104 pathname will not detect itself as a conflict when declaring a
3105 reflexive conflict. (fix issue #352)
3106
3107 * Adapt the **mrel** and **mpub** commands to produce new Modules
3108 release from a *vZ.Y.x* git branch rather than from the repository
3109 main branch.
3110
3111
3112 Modules 4.5.1 (2020-06-01)
3113 ==========================
3114
3115 * Install: consistently output Makefile warning messages on stderr.
3116
3117 * Script: add the "mrel" script, that automates build of the Modules
3118 release files and performs tests over these distribution files to
3119 guaranty their correctness.
3120
3121 * Script: add the "mpub" script, that automates Modules new release
3122 publishing over git repositories and websites.
3123
3124 * Install: remove project-specific tools from git repository export
3125 thus from release distribution files.
3126
3127 * Disable pager when "clear" sub-command is called from "ml" shortcut
3128 command. (fix issue #338)
3129
3130 * In case a modulefile evaluation fails, environment context prior
3131 this failed evaluation is restored. Fix environment variable
3132 restoration mechanism to keep the link that monitors and updates
3133 environment variable array "env" in every Tcl sub-interpreters. (fix
3134 issue #340)
3135
3136 * Ensure environment variable change at the Tcl interpreter level is
3137 propagated to every sub-interpreters used to evaluate modulefiles or
3138 modulercs. (fix issue #342)
3139
3140 * Use absolute path to load Modules Tcl extension library. (fix issue
3141 #344 with contribution from Roy Storey)
3142
3143 * Fix formatting of error stack trace not to look for internal
3144 commands to withdraw if start-up stack pattern cannot be matched.
3145
3146
3147 Modules 4.5.0 (2020-04-07)
3148 ==========================
3149
3150 * Doc: fix typos and grammar mistakes on module, modulefile and
3151 Changes between versions documents. (contribution from Colin
3152 Marquardt)
3153
3154 * Doc: update cookbook recipes to highlight code of the Tcl scripts
3155 included. (contribution from Colin Marquardt)
3156
3157 * Doc: improve markup of module, modulefile and Changes between
3158 versions documents to enable references to module sub-commands,
3159 command line switches, environment variables and modulefile Tcl
3160 commands. (contribution from Colin Marquardt)
3161
3162 * Doc: alphabetically sort module sub-commands, command-line switches,
3163 environment variables and modulefile Tcl commands in module and
3164 modulefile documents.
3165
3166 * Introduce the "ml" command, a handy frontend to the "module"
3167 command. "ml" reduces the number of characters to type to trigger
3168 "module". With no argument "ml" is equivalent to "module list", "ml
3169 mod" corresponds to "module load mod" and "ml -mod" means "module
3170 unload mod". Multiple modules to either load or unload can be
3171 combined on a single command. "ml" accepts all command-line switches
3172 and sub-commands accepted by "module" command. "ml" command is
3173 defined by default. Its definition can be controlled at
3174 "./configure" time with "--enable-ml" option or later on with "ml"
3175 configuration option (which defines "MODULES_ML" environment
3176 variable when set).
3177
3178 * Fix module sub-command abbreviation match to ensure passed
3179 abbreviated form fully match sub-command, not only its minimal
3180 abbreviated form. As an example, "lod" or "loda" do not match
3181 anymore the "load" sub-command, "lo" or "loa" still do.
3182
3183 * Add the "-j"/"--json" command line switches to the "avail", "list",
3184 "savelist", "whatis" and "search" module sub-commands to render
3185 their output in JSON format. (fix issue #303)
3186
3187 * Script: remove need to build project management-specific tools
3188 ("mtreview", "mb", "mlprof" and "playdemo") prior using them.
3189
3190 * Script: gather all distributed and maintained scripts in a "script"
3191 directory at the root of the project repository tree.
3192
3193 * Install: provide Windows-specific batch files when "./configure"
3194 option "--enable-windows-support" is set. module command wrapper
3195 "module.cmd" is installed in "bindir" and initialization script
3196 "cmd.cmd" in "initdir". Those batch files are relocatable and expect
3197 "modulecmd.tcl" in "..\libexec" directory. (fix issue #272 with
3198 contribution from Jacques Raphanel)
3199
3200 * Install: add ml command wrapper "ml.cmd" and install it in "bindir"
3201 when "./configure" option "--enable-windows-support" is set.
3202
3203 * Install: introduce envml command wrapper "envml.cmd" for Windows
3204 "cmd" shell and install it in "bindir" when "./configure" option "--
3205 enable-windows-support" is set. (contribution from Jacques Raphanel)
3206
3207 * Doc: improve documentation portal index.
3208
3209 * Install: add "dist-win" target to Makefile in order to build a
3210 distribution zipball containing the required files to run Modules on
3211 a Windows platform. "INSTALL.bat" and "UNINSTALL.bat" Windows batch
3212 files are introduced and shipped in the zipball to automate
3213 installation and basic configuration of Modules on the Windows
3214 platform.
3215
3216 * Doc: update Installing Modules on Windows document to describe how
3217 to install Modules with newly provided Windows-specific distribution
3218 zipball.
3219
3220 * Install: enable build of Modules from "git archive" tarball or
3221 zipball exports (like download source archives automatically
3222 provided on GitHub project)
3223
3224 * Install: ship reStructuredText and MarkDown source documents at the
3225 root of Modules distribution tarball rather their built txt
3226 counterpart.
3227
3228 * Script: fix "createmodule.sh" script to correctly analyses
3229 environment when shell functions are found defined in it.
3230
3231 * Script: inhibit output generated by scripts evaluated by
3232 "createmodule.sh" and "createmodule.py" to ensure these outputs will
3233 not get in the way when analyzing the environment changes. (fix
3234 issue #309)
3235
3236 * Correctly handle symbolic version target including a whitespace in
3237 their name.
3238
3239 * Testsuite: output test error details whatever the testsuite run
3240 verbose mode.
3241
3242 * Install: adapt configure script and Makefile to detect "python"
3243 command location and set it as shebang for "createmodule.py" and
3244 "gitlog2changelog.py". If "python" command is not found, "python3"
3245 then "python2" are searched.
3246
3247 * Install: enable to pass a specific Python interpreter command name
3248 or location at configure step with "--with-python" option. Specified
3249 command name or location should be found on build system only if
3250 building from git repository.
3251
3252 * Install: build "createmodule.py" script and install it in "bindir".
3253
3254 * Install: update RPM spec file to explicitly define Python
3255 interpreter location.
3256
3257 * Script: fix "createmodule.py" script for Python3 (fix issue #315
3258 with contribution from Armin Wehrfritz)
3259
3260 * Lift Perl variable strictness when defining "_mlstatus" variable in
3261 case "modulecmd.tcl" output is directly evaluated without use of the
3262 "module" sub-routine in Perl script. (with contribution from Andrey
3263 Maslennikov)
3264
3265 * Script: fix path de-duplication in "createmodule.sh". (fix issue
3266 #316)
3267
3268 * Doc: add *Handling Compiler and other Package Dependencies* cookbook
3269 recipe, which discusses various strategies for creating modulefiles
3270 for packages with multiple builds depending on previously loaded
3271 compiler, MPI libraries, etc. (contribution from Tom Payerle)
3272
3273 * Init: test availability of "compopt" Bash builtin prior using it in
3274 Bash completion script to avoid error with versions of this shell
3275 older than 4.0. (fix issue #318)
3276
3277 * Install: adapt configure step to detect if "sed" option "-E" is
3278 supported and fallback to "-r" otherwise in shell completion
3279 scripts. (fix issue #317)
3280
3281 * Add support for the "NO_COLOR" environment variable (https://no-
3282 color.org/) which when set (regardless of its value) prevents the
3283 addition of ANSI color. When set, "NO_COLOR" prevails over
3284 "CLICOLOR" and "CLICOLOR_FORCE" environment variables.
3285 "MODULES_COLOR" overrides these three variables. (fix issue #310)
3286
3287 * Script: when analyzing environment variable changes in
3288 "createmodule.sh" applied by shell script passed as argument,
3289 produce a "setenv" modulefile statement for any variable found set
3290 prior script evaluation and for which value is completely changed
3291 after script evaluation. (fix issue #320)
3292
3293 * When an error message is composed of multiple lines, render it in
3294 the same way whether it is part of a block message or not: lines
3295 after the first one are prepended with a 2-space padding. As a
3296 result error messages appear clearly separated from each other.
3297
3298 * Append to the error message the error stack trace when a general
3299 unknown error occurs in "modulecmd.tcl" and provide a link to
3300 encourage users to report such error to the GitHub project.
3301
3302 * Add to the error message the error stack trace for errors occurring
3303 during site-specific configuration evaluation. Error stack is
3304 expunged from the "modulecmd.tcl" internals to only report
3305 information relevant to site-specific configuration file.
3306
3307 * When an error occurs during the evaluation of a modulefile or a
3308 modulerc, report associated error stack trace expunged from
3309 "modulecmd.tcl" internal references to only output useful
3310 information for users.
3311
3312 * GitHub: add issue templates to guide people submitting a bug report
3313 or a feature request.
3314
3315 * Doc: provide a link toward issues that have been fixed between
3316 versions 3.2 and 4.0 in Changes between versions document.
3317
3318 * Script: introduce "envml.cmd" script for Windows platform providing
3319 similar behavior than "envml" Bash script. (contribution from
3320 Jacques Raphanel)
3321
3322 * Init: add Bash shell completion for the "ml" command. (contribution
3323 from Adrien Cotte)
3324
3325 * Fix Fish shell stderr redirection for newer Fish versions. (fix
3326 issue #325)
3327
3328 * Correctly handle modulefiles and modulepaths containing a space
3329 character in their name whether they are used from the command-line,
3330 in collections, within modulefiles or from loaded environment
3331 definitions.
3332
3333 * Doc: add *Default and latest version specifiers* design note.
3334
3335 * An "avail" search over a symbolic version targeting a directory now
3336 correctly returns the special modules (alias and virtual module)
3337 lying in this directory. (fix issue #327)
3338
3339 * "whatis" and "paths" searches only return special modules (symbolic
3340 version, alias and virtual modules) that fully match search query,
3341 not those that partially match it. (fix issue #328)
3342
3343 * alias and virtual module whose name mention a directory that does
3344 not exists are correctly handled. (fix issue #168)
3345
3346 * Hide special modules (aliases, symbolic versions and virtual
3347 modules) whose version name starts with a dot character (".") from
3348 "avail", "whatis" and "paths" searches if their query does not fully
3349 match special module name. (fix issue #329)
3350
3351 * Filter-out from the output of the "aliases" sub-command all hidden
3352 aliases, symbolic versions or hidden modules targeted by a non-
3353 hidden symbolic version. (fix issue #330)
3354
3355 * Enable resolution of default module in module sub-directory when
3356 this default symbol targets a hidden directory (whose name starts
3357 with a dot character). (fix issue #331)
3358
3359 * Doc: clarify hidden module location in modulefile man page.
3360
3361 * Install: define "LD_PRELOAD" as quarantine var along with
3362 "LD_LIBRARY_PATH" in RPM specfile.
3363
3364 * When "implicit_default" and "advanced_version_spec" configuration
3365 are enabled, automatically define a "default" and "latest" symbolic
3366 version for each module name (at each module depth for deep modules)
3367 if those version names does not already exist. (fix issue #210)
3368
3369 * Once a module is loaded, the automatically defined symbols
3370 associated to it are recorded in loaded environment in the
3371 "MODULES_LMALTNAME" environment variable. They are distinguished
3372 from the other alternative names applying to the module by a "as|"
3373 prefix, which qualifies their *auto symbol* type.
3374
3375 * When an advanced version specifier list contains symbolic version
3376 references, fix resolving to honor default version if part of the
3377 specified list. (fix issue #334)
3378
3379
3380 Modules 4.4.1 (2020-01-03)
3381 ==========================
3382
3383 * Fix error and warning messages relative to dependency management to
3384 enclose dependency specification in single quotes to clearly
3385 distinguish specification from each other.
3386
3387 * Skip output of module loading message if module is already loaded.
3388
3389 * Doc: add demonstration material played at SC19 to promote the new
3390 features of Modules.
3391
3392 * Contrib: add "playdemo" script to play recorded demonstration cast.
3393
3394 * Doc: add a web anchor to each modulefile Tcl command, module sub-
3395 command and module environment variable documentation.
3396
3397 * Install: update RPM spec file to enable build on "el8".
3398
3399 * Doc: fix RST syntax for bullet lists in design docs. (fix issue
3400 #306)
3401
3402 * In case "module avail" query does not match a directory but only its
3403 contained elements (for instance "module av mod/7" matches "mod/7.1"
3404 and "mod/7.2" but not "mod/"), fix query processing to correctly
3405 return latest or default element in case "--latest" or "--default"
3406 flags are set.
3407
3408 * In case a "module avail" query performed in a no-indepth mode with "
3409 --latest" or "--default" flags either enabled or disabled, fix query
3410 processing to return directory elements if they are part of result.
3411
3412 * When a "module avail" query performed in no-indepth mode targets a
3413 virtual module, fix result to filter-out the directory holding the
3414 virtual module from result.
3415
3416 * Fix "module avail --default" queries when modulefile default version
3417 does not match query: select latest version from modulefiles
3418 matching query unless "implicit_default" configuration is disabled
3419 in which case no default version is returned.
3420
3421 * Improve highlighting of module "avail" and "whatis" search result by
3422 coloring module names matching search query expressed with the
3423 advanced version specifiers. "name@1,3" or "name@1:3" queries now
3424 highlight "name/1" and "name/3" strings found in search result.
3425
3426 * Contrib: add the "mlprof" script which wraps "modulecmd.tcl" to
3427 collect profiling information on its execution.
3428
3429 * Contrib: adapt "mb" script to profile "modulecmd.tcl" run tests
3430 rather bench them when "profile" argument is passed to the script.
3431
3432 * Improve overall performances of module names and versions comparison
3433 by introducing optimized procedures and caching in memory module
3434 search results.
3435
3436
3437 Modules 4.4.0 (2019-11-17)
3438 ==========================
3439
3440 * Doc: add *Return file basename on module-info name for full path
3441 modulefile* recipe to cookbook. (fix issue #297)
3442
3443 * Rework internal handling of configuration options to gather all
3444 option definitions in a global array and use the same initialization
3445 and retrieval procedure, named "getConf", for all these options.
3446
3447 * Add the "setConf", "unsetConf" and "lappendConf" procedures to
3448 provide unified ways to set the value of configuration option. These
3449 procedures should be used in site configuration files to override
3450 configuration option value instead of directly setting corresponding
3451 option variable as it was done in previous Modules releases.
3452
3453 * Add the ability to match module specification in a case insensitive
3454 manner. Default case sensitiveness behavior is set at "./configure"
3455 time with the "--with-icase" option. It could be superseded with the
3456 "MODULES_ICASE" environment variable, that could be set with
3457 "config" module sub-command through the "icase" option. Command-line
3458 switch "--icase" ("-i") enables to supersede defined case
3459 sensitiveness configuration. (fix issue #212 with contribution from
3460 Eric Deveaud)
3461
3462 * Introduce the extended default mechanism, to help selecting a module
3463 when only the first numbers in its version are specified. Starting
3464 portion of the version, part separated from the rest of the version
3465 string by a "." character, will get matched to the appropriate
3466 complete version name. In case multiple versions match partial
3467 version specified and only one module should be returned, default
3468 version (implicit or explicit) among matches is returned. In case
3469 "implicit_default" option is disabled and no explicit default is
3470 found among matches, an error is returned. This mechanism is enabled
3471 through a new configuration option named "extended_default" (which
3472 defines "MODULES_EXTENDED_DEFAULT" environment variable when set).
3473 It may be enabled by default in "modulecmd.tcl" script with option "
3474 --enable-extended-default" passed to the "./configure" script.
3475
3476 * Introduce the advanced module version specifiers mechanism to
3477 specify finer constraints on module version. This new feature
3478 enables to filter the module selection to a given version list or
3479 range by specifying after the module name a version constraint
3480 prefixed by the "@" character. It leverages the version specifier
3481 syntax of the Spack package manager. A single version can be
3482 specified with the "@version" syntax, a list of versions with
3483 "@version1,version2,...", a greater than or equal to range with
3484 "@version1:" syntax, a less than or equal to range with "@:version2"
3485 and an in between or equal to range with "@version1:version2"
3486 syntax. In case "implicit_default" option is disabled and no
3487 explicit default is found among version specifier matches, an error
3488 is returned. This mechanism is enabled through a new configuration
3489 option named "advanced_version_spec" (which defines
3490 "MODULES_ADVANCED_VERSION_SPEC" environment variable when set). It
3491 may be enabled by default in "modulecmd.tcl" script with option "--
3492 enable-advanced-version-spec" passed to the "./configure" script.
3493
3494 * Conflict defined with a generic module name or an advanced version
3495 specifier may match multiple loaded modules (generally in case
3496 multiple loaded modules share same root name). Loaded environment
3497 analysis has been fixed to bind conflict to all loaded modules
3498 matching it. As a result the *Dependent Reload* mechanism is not
3499 triggered when one loaded module matching conflict is removed if
3500 another loaded module still match the conflict.
3501
3502 * Doc: add *Module selection contexts*, *Insensitive case*, *Extended
3503 default* and *Advanced module version specifiers* design notes.
3504
3505 * Make "MODULESHOME" environment variable controllable through the
3506 "config" sub-command with "home" configuration option. A "--with-
3507 moduleshome" argument is also added to the ./configure script to set
3508 specific default value for this option at installation time. (fix
3509 issue #292)
3510
3511
3512 Modules 4.3.1 (2019-09-21)
3513 ==========================
3514
3515 * Contrib: add "mb" script to bench Modules versions.
3516
3517 * Correct "modulecmd.tcl" script startup to correctly report error in
3518 case Tcl extension library fails to load. (fix issue #284)
3519
3520 * Install: fix typo on "CFLAGS" definition in "lib/Makefile". (fix
3521 issue #287 with contribution from Felix Neumärker)
3522
3523 * Remove useless code in Modules Tcl extension library
3524
3525 * Make URLs in README correctly rendered in HTML. (contribution from
3526 Per Persson)
3527
3528 * Doc: clarify modulefile evaluation modes in modulefile.4 man page.
3529 (fix issue #289)
3530
3531 * When looking at the closest match among loaded modules when
3532 switching module with just a single module argument specified, load
3533 the information on the currently set environment to get the
3534 alternative names of loaded modules prior to look at closest module
3535 match. (fix issue #290)
3536
3537 * Doc: describe the way to determine the site-specific configuration
3538 script location in cookbook recipes implying the installation of
3539 such a file. (fix issue #266)
3540
3541 * Doc: add *Log module command* recipe to cookbook. (fix issue #283)
3542
3543 * Doc: add *Expose procedures and variables to modulefiles* recipe to
3544 cookbook.
3545
3546 * Doc: add *Make defined modulepaths persist over sudo* recipe to
3547 cookbook.
3548
3549 * Doc: add *Ensure user fully qualify the modules they use* recipe to
3550 cookbook.
3551
3552 * Introduce the "wa_277" configuration option to workaround an issue
3553 with Tcsh history mechanism. Default "module" alias definition for
3554 Tcsh hits an issue with shell history mechanism: erroneous history
3555 entries are recorded each time the "module" command is called. When
3556 "wa_277" option is enabled (which sets the "MODULES_WA_277"
3557 environment variable to *1*), an alternative module alias is defined
3558 which fixes the history mechanism issue. However the alternative
3559 definition of the module alias weakens shell evaluation of the code
3560 produced by modulefiles. Characters with special meaning for Tcsh
3561 shell (like *{* and *}*) may not be used anymore in shell alias
3562 definition elsewhere the evaluation of the code produced by
3563 modulefiles will return a syntax error. (fix issue #277)
3564
3565 * Doc: add *Tips for Code Reuse in Modulefiles* recipe to cookbook.
3566 (contribution from Tom Payerle)
3567
3568 * Fix the "whatis" and "paths" sub-command results for module symbolic
3569 versions targeting a directory when "implicit_default" configuration
3570 option is disabled. No error is returned and same result is now
3571 obtained whether the symbolic name or its target is used as argument
3572 for those two sub-commands. (fix issue #294)
3573
3574 * Fix the "whatis" and "paths" sub-command results for module aliases
3575 targeting a directory when "implicit_default" configuration option
3576 is disabled. No error is returned and same result is now obtained
3577 whether the alias name or its target is used as argument for those
3578 two sub-commands. (fix issue #295)
3579
3580 * Rework all the ternary operator expressions in "modulecmd.tcl" that
3581 may result in a *nan* value (whatever the case used to write this
3582 string) as the "expr" Tcl command raises an error when it returns
3583 such a value, which breaks Modules as soon as a modulefile, an alias
3584 or a symbolic version is named *nan*. (fix issue #296)
3585
3586
3587 Modules 4.3.0 (2019-07-26)
3588 ==========================
3589
3590 * Introduce Vim addon files to highlight the modulefile syntax.
3591 Installation of these files, which is enabled by default, is
3592 controlled by the "--enable-vim-addons" and "--vimdatadir" configure
3593 options. (contribution from Felix Neumärker)
3594
3595 * If modulefile is fully read, cache the content read and the file
3596 header computed to avoid another file read if the same modulefile
3597 need to be read multiple times.
3598
3599 * Except for path, paths, list, avail and aliases module commands
3600 always fully read a modulefile whether its full content is needed or
3601 just its header to verify its validity. Proceed this way to only
3602 read file once on commands that first just check modulefile validity
3603 then read again valid files to get their full content.
3604
3605 * Introduce Modules Tcl extension library (written in C) to extend Tcl
3606 language in order to provide more optimized I/O commands to read a
3607 file or a directory content than native Tcl commands do.
3608
3609 * Install: add "--libdir", "--enable-libtclenvmodules", "--with-tcl"
3610 and "--with-tclinclude" options to configure script to control
3611 libtclenvmodules build and installation.
3612
3613 * When an error is caught during modulecmd.tcl first initialization
3614 steps, ensure the error report facility is initialized to render
3615 error message.
3616
3617 * When looking for modulefiles in enabled modulepaths, take
3618 ".modulerc" file found at the root of a modulepath directory into
3619 account. Which means these rc files are now evaluated like global rc
3620 files and can be used to define module aliases targeting modulefiles
3621 stored in the underlying file tree.
3622
3623 * Correctly get available default (-d) and latest (-L) version whether
3624 search pattern is passed with an ending forward slash character or
3625 not or if it contains a "*" wildcard character.
3626
3627 * Append a forward slash character to any directory result of an avail
3628 command to better distinguish these directories from regular files.
3629
3630 * Introduce the ability to control whether "avail" command search
3631 results should recursively include or not modulefiles from
3632 directories matching search query by use of the "--indepth" and "--
3633 no-indepth" command-line switches or the environment variable
3634 "MODULES_AVAIL_INDEPTH". Default behavior is set at the
3635 "./configure" time with the "--enable-avail-indepth" and "--disable-
3636 avail-indepth" switches. (fix issue #150)
3637
3638 * Update "bash", "fish" and "zsh" completion scripts to propose
3639 available modulefiles in the no in depth mode.
3640
3641 * Add the ability to graphically enhance some part of the produced
3642 output to improve readability by the use of the "--color" command-
3643 line switch or the "MODULES_COLOR" environment variable. Both accept
3644 the following values: "never", "auto" and "always". When color mode
3645 is set to "auto", output is colored if stderr is attached to a
3646 terminal. Default color mode could be controlled at configure time
3647 with the "--enable-color" and the "--disable-color" option, which
3648 respectively correspond to the "auto" and "never" color mode.
3649
3650 * Control the color to apply to each element with the "MODULES_COLORS"
3651 environment variable or the "--with-dark-background-colors" and "--
3652 with-light-background-colors" configure options. These variable and
3653 options take as value a colon-separated list in the same fashion
3654 "LS_COLORS" does. In this list, each element that should be
3655 highlighted is associated to a Select Graphic Rendition (SGR) code.
3656
3657 * Inform Modules of the terminal background color with the
3658 "MODULES_TERM_BACKGROUND" environment variable or the "--with-
3659 terminal-background" configure option, which helps to determine if
3660 either the dark or light background colors should be used to color
3661 output in case no specific color set is defined with the
3662 "MODULES_COLORS".
3663
3664 * Color prefix tag of debug, error, warning, module error and info
3665 messages.
3666
3667 * Highlight the modulefile or collection name when reporting messages
3668 for a an action made over this modulefile or collection.
3669
3670 * Color the modulepaths reported on a "use" command.
3671
3672 * Highlight title of separator lines or column name of table header.
3673
3674 * Color modulepaths, directories, aliases and symbols reported by the
3675 "avail", "aliases", "list", "whatis" and "search" commands.
3676
3677 * When color mode is enabled and module aliases are colored, do not
3678 associate them a "@" tag as the color already distinguish them from
3679 regular modulefile.
3680
3681 * When color mode is enabled and a Select Graphic Rendition (SGR) code
3682 is set for the "default" modulefile symbol, apply this SGR code to
3683 the modulefile name instead of associating it the "default" symbol
3684 tag.
3685
3686 * Highlight matched module search query string among "avail", "whatis"
3687 and "search" command results.
3688
3689 * Highlight the modulefile and collection full path name on "display",
3690 "help", "test" and "saveshow" command reports.
3691
3692 * Color modulefile Tcl commands set in a modulefile on a "display"
3693 command report.
3694
3695 * Color module commands set in a collection on a "saveshow" command
3696 report.
3697
3698 * Re-introduce "clear" sub-command. (fix issue #203)
3699
3700 * Leverage "--force" command-line switch on "clear" sub-command to
3701 skip confirmation dialog. (fix issue #268)
3702
3703 * Init: improve readability of variable definition operations by
3704 writing one definition operation per line rather having multiple
3705 commands on a single line like "VAR=val; export VAR". (fix issue
3706 #225)
3707
3708 * Add the ability to define a site-specific configuration file with an
3709 environment variable: "MODULES_SITECONFIG". When set, the script
3710 file pointed by the variable is sourced (if readable) after the
3711 site-specific configuration file initially defined in
3712 "modulecmd.tcl". (contribution from Ben Bowers, fix issue #234)
3713
3714 * Doc: add description in the module.1 man page of "MODULERCFILE" in
3715 the environment section and "siteconfig.tcl" in the files section.
3716
3717 * Install: provide at installation time a bare site-specific
3718 configuration script in designated "etcdir" if no pre-existing
3719 "siteconfig.tcl" file is found at designated location.
3720
3721 * Introduce the "config" sub-command to get and set "modulecmd.tcl"
3722 options and to report its current state.
3723
3724 * Contrib: update "createmodule.py" script to support execution from
3725 the *cmd* shell. (contribution from Jacques Raphanel, fix issue
3726 #270)
3727
3728 * Add the ability to configure when unloading a module and multiple
3729 loaded modules match request if firstly loaded module should be
3730 chosen or lastly loaded module. Configure option "--with-unload-
3731 match-order" defines this setting which can be superseded with the
3732 "MODULES_UNLOAD_MATCH_ORDER" environment variable. This variable can
3733 be set with the option "unload_match_order" on the "config" sub-
3734 command. By default, lastly loaded module is selected. It is
3735 recommended to keep this behavior when the modulefiles used express
3736 dependencies between each other.
3737
3738 * Add the ability to configure whether an implicit default version
3739 should be defined for modules with no default version explicitly
3740 defined. When enabled, which stays the default behavior, a module
3741 version is automatically selected (latest one) when the generic name
3742 of the module is passed. When implicit default selection is
3743 disabled, the name of modules to evaluate should be fully qualified
3744 elsewhere an error is returned. This option is set at "./configure"
3745 time with the "--enable-implicit-default" and "--disable-implicit-
3746 default" options. It could be superseded with the
3747 "MODULES_IMPLICIT_DEFAULT" environment variable, that could be set
3748 with "config" module sub-command through the "implicit_default"
3749 option.
3750
3751 * Install: add to the configure script the "--with-locked-configs"
3752 option to ignore environment variable superseding of Modules
3753 configurations defined in "modulecmd.tcl" script. Lockable
3754 configuration option are "extra_siteconfig" and "implicit_default".
3755 Currently locked options are reported through the "locked_configs"
3756 option on the "config" sub-command.
3757
3758 * Introduce the ability to control the module search match. Search
3759 query string should match module name start or any part of module
3760 fully qualified name. Default search match behavior is set at
3761 "./configure" time with the "--with-search-match" option. It could
3762 be superseded with the "MODULES_SEARCH_MATCH" environment variable,
3763 that could be set with "config" module sub-command through the
3764 "search_match" option. Command-line switches "--starts-with" ("-S")
3765 and "--contains" ("-C") for "avail" module sub-command enable to
3766 supersede defined search match configuration.
3767
3768 * Introduce the ability not to set the shell startup file that ensure
3769 "module" command is defined once shell has been initialized. Setting
3770 shell startup file currently means defining "ENV" and "BASH_ENV"
3771 environment variables to the Modules bourne shell initialization
3772 script. "./configure" options "--enable-set-shell-startup" and "--
3773 disable-set-shell-startup" define if shell startup should be set or
3774 not by default. It could be superseded with the
3775 "MODULES_SET_SHELL_STARTUP" environment variable, that could be set
3776 with "config" module sub-command through the "set_shell_startup"
3777 option.
3778
3779 * Cookbook: add the *test-modulefiles* recipe. (fix issue #182 with
3780 contribution from Colin Marquardt)
3781
3782 * Fix location of global RC file to "@etcdir@/rc" instead of
3783 "@prefix@/etc/rc" to cope with "@etcdir@" specific setup ("@etcdir@"
3784 defaults to "@prefix@/etc").
3785
3786 * Take into account Modules initialization configurations found in
3787 "etc" directory if they exist rather in "init" directory. If
3788 "initrc" configuration file is found in "etcdir" then it is
3789 preferred over "modulerc" file in "initdir". Following the same
3790 trend, "modulespath" configuration file is found in "etcdir" then it
3791 is preferred over ".modulespath" file in "initdir".
3792
3793 * Introduce the ability to install the Modules initialization
3794 configuration files in the "etcdir" rather than in the "initdir". A
3795 new configure option is introduced for this task: "--with-initconf-
3796 in". Accepted values for this option are: "etcdir" or "initdir"
3797 (default).
3798
3799 * Add the "--enable-modulespath" configure option, which is an alias
3800 for the "--enable-dotmodulespath" option as ".modulespath"
3801 configuration file is named "modulespath" when installed in
3802 "etcdic".
3803
3804 * Install: update RPM spec file to disable "set_shell_startup" option
3805 by default, set "/etc/environment-modules" as configuration
3806 directory and store Modules initialization configuration files in
3807 it.
3808
3809 * Report an error when a module load or unload evaluation aborts due
3810 to the use of the "break" or "exit" modulefile commands. This error
3811 notification clarifies that module evaluation failed. (fix issue
3812 #267)
3813
3814 * Remove the message block display output for the "reload", "purge"
3815 and "restore" sub-commands to preserve this output style for
3816 modulefile evaluation modes (load, unload and switch) and thus
3817 clarify understanding.
3818
3819 * When unloading a module that contains a "module load" or "module
3820 switch" modulefile command, inhibit the unload performed of the
3821 useless requirement when auto_handling mode is disabled if currently
3822 performing a "purge", "reload" or "restore" sub-command. As the
3823 unload sequence is determined and managed from these top commands.
3824
3825 * Add ability to control module command message verbosity with
3826 configuration option. Introduced verbosity levels from the least to
3827 the most verbose are "silent", "concise", "normal", "verbose" and
3828 "debug". This option could be set at "./configure" time with "--
3829 with-verbosity" option. It could be superseded with the
3830 "MODULES_VERBOSITY" environment variable, that could be set with
3831 "config" module sub-command through the "verbosity" option. Silent,
3832 verbose and debug verbosity modes can be set at the command-line
3833 level respectively with "--silent"/"-s", "--verbose"/"-v" and "--
3834 debug"/"-D" command-line switches. (fix issue #204)
3835
3836 * When verbosity level is "normal" or higher, reports every module
3837 loads or unloads performed to "restore" a collection or "source" a
3838 scriptfile, even if there is no specific message to output for these
3839 module evaluations. Clarifies what module evaluations have been
3840 triggered by these sub-commands.
3841
3842 * Also honor the "CLICOLOR" and "CLICOLOR_FORCE" environment variables
3843 to define color mode. (fix issue #279)
3844
3845
3846 Modules 4.2.5 (2019-07-08)
3847 ==========================
3848
3849 * Correctly escape "?" character in shell alias. (fix issue #275)
3850
3851 * When resolving the enabled list of modulepaths, ensure resolved path
3852 entries are unique. (fix issue #274)
3853
3854 * Right trim '#' characters from the fetched modulefile magic cookie
3855 string to ensure a correct compatibility version comparison. Useful
3856 when modulefile first line is equal to "#%Module4.2##############".
3857
3858 * Fix argument parsing for the "append-path", "prepend-path" and
3859 "remove-path" modulefile commands to consider every arguments found
3860 after the variable name as variable values and not command option
3861 even if argument starts with "-" character. (fix issue #278)
3862
3863 * Fix automatic loading of modulefiles when multiple module names are
3864 set on a single "module load" modulefile command. When auto_handling
3865 mode was disabled, the load of not loaded modules was not achieved
3866 as soon as some modules on this list were already loaded. (fix issue
3867 #281)
3868
3869
3870 Modules 4.2.4 (2019-04-26)
3871 ==========================
3872
3873 * Better track each module evaluation and the context associated to it
3874 in order to report a more accurate information on the additional
3875 modules loaded or unloaded when proceeding the main evaluation
3876 request. (fix issue #244, #245, #246, #247 and #248)
3877
3878 * Doc: preserve quotes and dashes when making HTML docs. (fix issue
3879 #250 with contribution from Riccardo Coccioli)
3880
3881 * Fix hanging "list" sub-command when terminal width is equal to the
3882 single column text width to be printed. (contribution from Jesper
3883 Dahlberg)
3884
3885 * During an additional evaluation triggered by an automated module
3886 handling mechanism, ensure warning and error messages are reported
3887 under the message block of the main evaluation. (fix issue #252)
3888
3889 * During the unload of a module when the automated module handling
3890 mode is disabled, report a warning message for each unload of a
3891 useless requirement that fails as done when the automated module
3892 handling mode is enabled. (fix issue #253)
3893
3894 * When multiple modules are listed on a "prereq" command, drop the
3895 output of those modules that fails to load (by the *Requirement
3896 Load* automated mechanism) to only keep the output of the module
3897 whose load succeed. (fix issue #254)
3898
3899 * Fix "switch" sub-command when the switched-off module cannot be
3900 unloaded when other loaded modules depend on it. Whole switch
3901 process is failed and no load of the switched-on module is
3902 attempted. (fix issue #251)
3903
3904 * When switching modules, report failure of switched-off module unload
3905 or switched-on module load under the message block of the switch
3906 action. A failed switched-off module unload is reported as an error,
3907 as it aborts the switch evaluation, whereas a failed switched-on
3908 module load is reported as a warning. (fix issue #255)
3909
3910 * When a module requirement is seen missing but the load of this
3911 module was attempted, report a more specific error or warning
3912 message to let user understand that the load of the requirement was
3913 attempted but failed. (fix issue #257)
3914
3915 * When loading a module, report any missing requirement on the message
3916 reporting block corresponding to this module load. This warning or
3917 error message comes in addition to the eventual *Requirement Load*
3918 message reported under the message block of the main evaluation.
3919 (fix issue #258)
3920
3921 * When unloading a module which has some dependent module still
3922 loaded, produce a more specific error or warning message if an
3923 evaluation of these dependent modules has been realized or if the
3924 unload of the required module is forced. (fix issue #259)
3925
3926 * When a conflicting module is seen loaded but the unload of this
3927 module was attempted, report a *Conflict Unload* error or warning
3928 message toward the main evaluation message block. (fix issue #261)
3929
3930 * When loading a module, report any loaded conflict on the message
3931 reporting block corresponding to this module load. This warning or
3932 error message comes in addition to the eventual *Conflict Unload*
3933 message reported under the message block of the main evaluation.
3934 (fix issue #261)
3935
3936 * Correctly report loading state of conflicting module. (fix issue
3937 #262)
3938
3939 * Adapt warning, error and info messages relative to the *Dependent
3940 Reload* mechanism to distinguish the unload phase from the load
3941 (reload) phase of this mechanism. In the automated module handling
3942 summary report, unloaded modules via this mechanism are reported in
3943 the *Unloading dependent* list and modules reloaded afterward are
3944 reported against the *Reloading dependent* list. (fix issue #263)
3945
3946 * When the automated module handling mode is disabled, do not attempt
3947 to load a requirement expressed in a modulefile with a "module load"
3948 command, if this requirement is already loaded or loading.
3949
3950 * Skip load or unload evaluation of a module whose respectively load
3951 or unload was already attempted but failed. If this second
3952 evaluation attempt occurs within the same main evaluation frame.
3953 (fix issue #264)
3954
3955 * When reloading modules through the *Dependent Reload* automated
3956 mechanism, prevent modules to automatically load of other modules
3957 with the "module load" modulefile command, as it is done for the
3958 "prereq" command. (fix issue #265)
3959
3960 * Raise an error when an invalid option is set on "append-path",
3961 "prepend-path" or "remove-path" modulefile command. (fix issue #249)
3962
3963 * Zsh initializes by default the "MANPATH" environment variable to an
3964 empty value when it starts. To preserve "manpath" system
3965 configuration even after addition to this variable by modulefiles,
3966 set "MANPATH" variable to ":" if found empty. (improve fix for issue
3967 #224)
3968
3969 * Doc: provide a short installation guideline in README file. (fix
3970 issue #230)
3971
3972
3973 Modules 4.2.3 (2019-03-23)
3974 ==========================
3975
3976 * Add all the module dependency-related internal information to those
3977 saved prior a modulefile evaluation in order to correctly restore
3978 internal state in case modulefile evaluation fails.
3979
3980 * Init: in shell initialization scripts, initialize "MANPATH" if not
3981 set with a value that preserves "manpath" system configuration even
3982 after addition of paths to this variable by modulefiles. (fix
3983 issue#224)
3984
3985 * Enable to define an entire path entry to the "MODULEPATH" variable
3986 which corresponds to a variable reference only. (fix issue#223)
3987
3988 * Cookbook: add the *modulefiles-in-git* recipe. (contribution from
3989 Scott Johnson)
3990
3991 * When "module switch" commands are found in modulefiles, track
3992 switched-off modulefile as a conflict and switched-to modulefile as
3993 a requirement to apply same behaviors than for "module load" and
3994 "module unload" commands in modulefiles. If "module switch" has only
3995 one argument, do not define a conflict toward switched-off
3996 modulefile. *CAUTION: it is not recommended to use module switch
3997 command in modulefiles*. (fix issue#229)
3998
3999 * When unloading a module, revert "module switch" commands found in
4000 modulefile: switched-on module is converted to a "module unload",
4001 like for "module load" command. Nothing is done for switched-off
4002 module, like for "module unload" command. (fix issue#226)
4003
4004 * For default element in a modulefile directory which is a module
4005 alias that points to a modulefile, when this modulefile is loaded,
4006 it receives as alternative names the eventual module aliases set on
4007 the distant directory holding the alias pointing to it. (fix
4008 issue#231)
4009
4010 * When unloading a module that contains "module load" or "module
4011 switch" commands in its modulefile, select for unload the
4012 automatically loaded requirement module which has been loaded prior
4013 its dependent. (fix issue#232)
4014
4015 * Doc: describe Emacs settings useful for adhering to coding
4016 conventions in CONTRIBUTING guide. (fix issue #233 with contribution
4017 from Ben Bowers)
4018
4019 * When looking for a loaded or loading dependency requirement, select
4020 among the eventual multiple candidates the closest match to the
4021 dependent module.
4022
4023 * During the unload of a module, if the unload of one of its dependent
4024 (by the *Dependent Unload* mechanism) fails, abort the whole unload
4025 process. Exception made if the force mode is enabled. In this case
4026 failing module stays loaded and the *Dependent Unload* mechanism
4027 continues with next module to unload.
4028
4029 * During the unload of a module, if the unload of one of its useless
4030 requirements (by the *Useless Requirement Unload* mechanism) fails,
4031 keep the requirements of this failing module loaded. Such error is
4032 reported as a warning and it does not stop the whole unload process.
4033 (fix issue#240)
4034
4035 * During the load or the unload of a module, if the unload of one of
4036 its dependent (by the *Dependent Reload* mechanism) fails, abort the
4037 whole unload or load process. Exception made if the force mode is
4038 enabled. In this case failing module stays loaded and *Dependent
4039 Reload* mechanism continues with next module to unload. This failing
4040 module is removed from the *Dependent Reload* list, so it will not
4041 take part of the load phrase of the mechanism. (fix issue#239)
4042
4043 * During the load or the unload of a module, if the load of one of its
4044 dependent (by the *Dependent Reload* mechanism) fails, abort the
4045 whole unload or load process. Exception made if the force mode is
4046 enabled. In this case failing module stays loaded and *Dependent
4047 Reload* mechanism continues with next module to load. When the
4048 mechanism is applied during a "switch" command, force mode is
4049 enabled by default on the load phase. (fix issue#241)
4050
4051 * When reloading all loaded modules with the "reload" sub-command, if
4052 one reloading module fails to unload or load, abort the whole reload
4053 process to preserve environment sanity. (fix issue#237)
4054
4055 * During the unload of a module when the automated module handling
4056 mode is disabled and this module declares its requirements with the
4057 "module load" modulefile command. If the unload of one of its
4058 useless requirements (by the *Useless Requirement Unload* mechanism)
4059 fails, whole unload process is not aborted and continue with next
4060 module to unload. (fix issue#238)
4061
4062 * Contrib: add "mtreview" utility script that analyzes test suite log
4063 file to compare actual and expected output of failed test. "mt" does
4064 not output the full test suite logs anymore but only the information
4065 produced by "mtreview" on failed tests.
4066
4067 * Install: exclude Continuous Integration configurations from dist
4068 tarballs.
4069
4070
4071 Modules 4.2.2 (2019-02-17)
4072 ==========================
4073
4074 * Correct the *Dependent Unload* mechanism when it triggers the unload
4075 of 2 modules making together a requirement from another module. This
4076 module is now also added to the dependent modules to unload.
4077
4078 * Doc: add a cookbook section in the documentation and port there the
4079 3 pre-existing recipes: *inhibit-report-info*, *top-priority-values*
4080 and *unload-firstly-loaded*.
4081
4082 * Doc: add a CONTRIBUTING guide.
4083
4084 * Doc: fix a typo on the Python initialization example in module man
4085 page.
4086
4087 * Doc: add a FAQ entry to describe the use of module from Makefile.
4088 (with contribution from Robert McLay)
4089
4090 * Trim any white-space, newline or ";" characters at the beginning or
4091 end of the function body passed to set-function modulefile command.
4092
4093 * Init: add recognition of the "--auto", "--no-auto" and "--force"
4094 command-line switches in fish shell completion script.
4095
4096 * Init: add recognition of the "--auto", "--no-auto", "--force", "--
4097 paginate" and "--no-pager" command-line switches in zsh shell
4098 completion script.
4099
4100 * When the load of a modulefile is asked but a conflict is registered
4101 against this modulefile by an already loaded module, the load
4102 evaluation is now performed and the conflict is checked after this
4103 evaluation. If the conflict is still there, this evaluation (and the
4104 evaluation of its requirements) is rolled back. (fix issue#216)
4105
4106 * Init: fix "_module_not_yet_loaded" alias in tcsh completion script
4107 to handle situation when "noclobber" variable is set. Also ensure
4108 actual "rm" command is called and not an alias. (fix issue#219)
4109
4110 * Fix warning message when the load of a modulefile is forced over a
4111 reflexive conflict (message was reported twice).
4112
4113 * When looking at the dependency of a loaded module, only consider
4114 requirement loaded before dependent module (holding a prior position
4115 in the loaded module list) as valid. Those loaded after dependent
4116 module are considered as an unmet dependency thus they are not
4117 taking part in the *Dependent Unload*, the *Useless Requirement
4118 Unload* and the *Dependent Reload* mechanisms.
4119
4120
4121 Modules 4.2.1 (2018-11-11)
4122 ==========================
4123
4124 * Cookbook: add the *inhibit-report-info* recipe.
4125
4126 * Cookbook: port *unload-firstly-loaded* and *top-priority-values*
4127 recipes to v4.2.
4128
4129 * Init: fix listing of loaded modules for *fish* and *tcsh* shell
4130 completions.
4131
4132 * Init: fix saved collection listing when no collection found for
4133 *bash*, *zsh*, *tcsh* and *fish* shell completions.
4134
4135 * Adapt "system" modulefile Tcl command to execute the command passed
4136 as argument through shell, like it is performed on compatibility
4137 version. (fix issue#205)
4138
4139 * Correctly filter modulefile search memory cache entries when using a
4140 full search result to search later on a specific modulefile.
4141
4142 * Prefix debug messages by information on the current modulefile or
4143 modulerc interpreter if any.
4144
4145 * Init: fix listing of loaded modules on unload and switch sub-
4146 commands for *bash* shell completion.
4147
4148 * Refrain "module unload" modulefile command from unloading a module
4149 required by another loading module.
4150
4151 * Enable "is-loaded" modulefile Tcl command in modulerc interpretation
4152 context, like done on compatibility version. (fix issue#207)
4153
4154 * Check a required module is not already loading before attempting to
4155 load it. Helps to handle cyclic dependencies.
4156
4157 * Compute loaded modules requirement dependency relations without
4158 cycle and consider the module closing the cycle in a constraint
4159 violation state to avoid reloading loops on the *Dependent Reload*
4160 mechanism.
4161
4162 * Safely unset dependency reference when computing dependency
4163 relations as some dependencies expressed may target same module.
4164
4165 * Ensure a loaded module matching multiple entries of a same *or*
4166 "prereq" will just be considered as one module matching this
4167 requirement.
4168
4169 * Init: quote prompt in *csh* and *tcsh* script with ":q" rather
4170 double quotes to accommodate prompts with embedded newlines. (fix
4171 issue#209 with contribution from Satya Mishra)
4172
4173 * Init: skip shell environment alteration if "autoinit" command fails.
4174 (fix issue#208)
4175
4176 * Reword path-like variable element counter reference handling to
4177 simply ignore the counter values not coherent with the content of
4178 related path-like variable. (fix issue#206)
4179
4180
4181 Modules 4.2.0 (2018-10-18)
4182 ==========================
4183
4184 * Add "chdir" and "puts" environment settings to the per-modulefile
4185 evaluation saved context. So previous values of these settings are
4186 restored in case of evaluation failure.
4187
4188 * Fix save and restore of "x-resource" environment settings on the
4189 per-modulefile evaluation context.
4190
4191 * Use the correct warning procedure to report the full reference
4192 counter inconsistency message (so this message is fully inhibited
4193 during global "whatis" evaluations).
4194
4195 * Make "append-path", "prepend-path", "remove-path" and "unsetenv"
4196 commands alter "env" Tcl global array during "display", "help",
4197 "test" or "whatis" evaluation modes. Thus an invalid argument passed
4198 to these commands will now raise error on these modes. (see
4199 Environment variable change through modulefile evaluation context
4200 section in MIGRATING document)
4201
4202 * On "whatis" mode, "append-path", "prepend-path", "remove-path",
4203 "setenv" and "unsetenv" commands initialize variables if undefined
4204 but do not set them to their accurate value for performance concern.
4205
4206 * Clear value instead of unsetting it during an unload mode evaluation
4207 of "setenv" or "*-path" commands to avoid breaking later reference
4208 to the variable in modulefile.
4209
4210 * Make "getenv" command returns value on "help", "test" or "whatis"
4211 evaluation modes. (fix issue#188)
4212
4213 * Add an argument to the "getenv" command to return the value of this
4214 argument if the queried variable is undefined.
4215
4216 * Use a different modulefile interpreter for each evaluation mode.
4217
4218 * Adapt the procedure called for each modulefile command depending on
4219 the evaluation mode to adapt behavior of these commands to the
4220 module command currently running.
4221
4222 * Report calling name and arguments for modulefile commands on
4223 "display" mode. For the commands evaluated during this mode, trigger
4224 this report at the end of the evaluation.
4225
4226 * Inhibit "chdir", "conflict", "module", "module-log", "module-trace",
4227 "module-user", "module-verbosity", "prereq", "set-alias", "system",
4228 "unset-alias", "x-resource" commands on "help", "test" and "whatis"
4229 evaluation modes.
4230
4231 * Ignore "chdir", "module", "module-trace", "module-verbosity",
4232 "module-user" and "module-log" commands found during modulerc
4233 evaluation.
4234
4235 * Correctly restore an empty string value on sub-interpreter global
4236 variables when sanitizing this interpreter between two
4237 modulefile/modulerc evaluations.
4238
4239 * Cache in memory results of a modulefile search to reuse it in case
4240 of rerun instead of re-walking the filesystem.
4241
4242 * Evaluate global rc files once module sub-command is known and
4243 registered, so it can be queried during their evaluation.
4244
4245 * Rename "_moduleraw" shell function in "_module_raw" to use a common
4246 "_module_" prefix for all module-related internal shell functions.
4247
4248 * Install: add "--enable-append-binpath" and "--enable-append-manpath"
4249 configure options to append rather prepend the bin or man directory
4250 when adding them to the relative environment variable.
4251
4252 * Doc: clarify documentation for module usage on scripting language
4253 like Perl or Python to mention that arguments to the "module"
4254 function should be passed as list and not as a single string.
4255
4256 * When interpreting a "setenv" modulefile order during an unload
4257 evaluation, variable is still set to be unset in generated shell
4258 code but it is set to the value defined on the "setenv" order in the
4259 interpreter context instead of being cleared.
4260
4261 * Register the conflicts defined by loaded modules in the environment
4262 (variable "MODULES_LMCONFLICT") and ensure they keep satisfied. (see
4263 Modulefile conflict constraints consistency section in MIGRATING
4264 document)
4265
4266 * Register the prereqs defined by loaded modules in the environment
4267 (variable "MODULES_LMPREREQ") and ensure they keep satisfied. (see
4268 Modulefile prereq constraints consistency section in MIGRATING
4269 document)
4270
4271 * Introduce the automated module handling mode, which consists in
4272 additional actions triggered when loading or unloading a modulefile
4273 to satisfy the dependency constraints it declares. Those actions are
4274 when loading a modulefile: the *Requirement Load* and the *Dependent
4275 Reload*. When unloading a modulefile, *Dependent Unload*, *Useless
4276 Requirement Unload* and *Dependent Reload* actions are triggered.
4277 (see Automated module handling mode section in MIGRATING document)
4278
4279 * Track the loaded modules that have been automatically loaded (with
4280 environment variable "MODULES_LMNOTUASKED") to distinguish them from
4281 modules that have been explicitly asked by user. This information
4282 helps to determine what module becomes a useless requirement once
4283 all its dependent modules are unloaded.
4284
4285 * Track in saved collections the loaded modules that have been
4286 automatically loaded by add of a "--notuasked" argument to "module
4287 load" collection lines. So this information is restored in loaded
4288 environment when collection is restored. This "--notuasked" argument
4289 is ignored outside of a collection restore context.
4290
4291 * Consider modules loaded from a "module source" file as explicitly
4292 asked by user.
4293
4294 * Install: add "--enable-auto-handling" configure option to enable or
4295 disable the automatic modulefile handling mechanism.
4296
4297 * Process list of loaded modules or modules to load one by one during
4298 the "restore", "purge" and "reload" sub-commands whatever the auto
4299 handling mode is.
4300
4301 * Add the ability to control whether the auto_handling mode should be
4302 enabled or disabled with an environment variable called
4303 "MODULES_AUTO_HANDLING" or from the command-line with "--auto" and "
4304 --no-auto" switches. These command-line switches are ignored when
4305 called from modulefile.
4306
4307 * Init: add pager-related command-line options in shell completion
4308 scripts.
4309
4310 * Doc: describe "MODULES_LMCONFLICT", "MODULES_LMPREREQ" and
4311 "MODULES_LMNOTUASKED" in module.1 man page.
4312
4313 * Add "-f" and "--force" command-line switches to by-pass dependency
4314 consistency during "load", "unload" or "switch" sub-commands. (see
4315 By-passing module defined constraints section in MIGRATING document)
4316
4317 * Disallow collection "save" or loaded modules "reload" if some loaded
4318 modules have some of their dependency constraints unsatisfied.
4319
4320 * The *Dependent Reload* action of a "load", "unload" and "switch"
4321 sub-commands excludes modules that have unsatisfied constraints and
4322 includes modules whose constraints are satisfied again (when sub-
4323 command process solves a conflict for instance).
4324
4325 * Doc: describe "--force", "--auto" and "--no-auto" command-line
4326 switches and "MODULES_AUTO_HANDLING" variable in module.1 man page.
4327
4328 * Ignore directories ".SYNC" (DesignSync) and ".sos" (SOS) when
4329 walking through modulepath directory content. (contribution from
4330 Colin Marquardt)
4331
4332 * Install: look for "make" rather "gmake" on MSYS2.
4333
4334 * Fix "exec()" usage in Python module function definition to retrieve
4335 the correct return status on Python3.
4336
4337 * Cookbook: add the *top-priority-values* and *unload-firstly-loaded*
4338 recipes.
4339
4340 * Install: add "gcc" to the build requirements in RPM specfile.
4341
4342 * Silent any prereq violation warning message when processing
4343 *Dependent Reload* mechanism or "purge" sub-command.
4344
4345 * Doc: mention "createmodule.sh" and "createmodule.py" scripts in FAQ.
4346 (fix issue#189)
4347
4348 * Register all alternative names of loaded modules in environment with
4349 "MODULES_LMALTNAME" variable. These names correspond to the symbolic
4350 versions and aliases resolving to the loaded modules. Helps to
4351 consistently solve "conflict" or "prereq" constraints set over these
4352 alternative names. (fix issue#143 / see Consistency of module
4353 load/unload commands in modulefile section in MIGRATING document)
4354
4355 * Doc: describe "MODULES_LMALTNAME" in module.1 man page.
4356
4357 * Install: add "--with-bin-search-path" configure option to get in
4358 control of the path list used to search the tools required to build
4359 and configure Modules. (fix issue#164)
4360
4361 * Install: add "--enable-silent-shell-debug-support" configure option
4362 to add the ability to control whether or not code to support silent
4363 shell debug should be added to the module function and sh-kind
4364 initialization scripts. (fix issue#166)
4365
4366 * Install: add "--enable-quarantine-support" configure option to add
4367 the ability to control whether or not code to support quarantine
4368 mechanism should be added to the module function and initialization
4369 scripts. (fix issue#167)
4370
4371 * Check version set in modulefile magic cookie. If modulefile sets a
4372 version number greater than "modulecmd.tcl" script version, this
4373 modulefile is not evaluated like when no magic cookie is set at all.
4374 (fix issue#171 / see Express Modules compatibility of modulefile
4375 with versioned magic cookie section in MIGRATING document)
4376
4377 * Fix uninitialized variable in procedure producing list of element
4378 output. (fix issue#195)
4379
4380 * Ensure the consistency of "module load" modulefile command once the
4381 modulefile defining it has been loaded by assimilating this command
4382 to a "prereq" command. Thus the defined constraint is recorded in
4383 the "MODULES_LMPREREQ" environment variable. Same approach is used
4384 for "module unload" modulefile command which is assimilated to a
4385 "conflict" command. Thus the defined constraint is recorded in the
4386 "MODULES_LMCONFLICT" environment variable. (see Modulefile alias and
4387 symbolic modulefile name consistency section in MIGRATING document)
4388
4389 * Only look at loaded modules when unloading so unloading an
4390 nonexistent modulefile does not produce an error anymore. (fix
4391 issue#199)
4392
4393 * Report error raised from modulefile evaluation as "ERROR" rather
4394 "WARNING", like when a conflict constraint is hit. Moreover this
4395 kind of evaluation error is now silenced on global evaluation like
4396 when processing "avail" or "search" sub-commands.
4397
4398 * Record messages to report them by block on when processing a "load"
4399 or an "unload" modulefile evaluation to improve readability on these
4400 evaluating modes that may cascade additional actions. (see Improved
4401 module message report section in MIGRATING document)
4402
4403 * Foreground "load", "unload", "switch" and "restore" actions (i.e.,
4404 asked on the command-line) now report a summary of the additional
4405 load and unload evaluations that were eventually triggered in the
4406 process.
4407
4408 * Support "del" and "remove" aliases for "unload" sub-command like on
4409 compatibility version. (fix issue#200 with contribution from
4410 Wenzler)
4411
4412 * Correctly transmit the arguments along with the command to execute
4413 on "system" modulefile command. (fix issue#201)
4414
4415 * Contrib: add "mt" utility script which helps to run just specific
4416 part of the test suite.
4417
4418 * Introduce "set-function" and "unset-function" modulefile commands to
4419 define shell function on sh-kind and fish shells. (fix issue#193
4420 with contribution from Ben Bowers)
4421
4422
4423 Modules 4.1.4 (2018-08-20)
4424 ==========================
4425
4426 * Doc: fix typo on "getenv" command description in modulefile(5) man
4427 page and clarify this command should be preferred over "::env"
4428 variable to query environment variable value in modulefile.
4429
4430 * Init: fix "bash" and "zsh" completion scripts to enable Extended
4431 Regular Expression (ERE) on "sed" command with "-E" argument (rather
4432 "-r") for compatibility with OS X's and BSDs' sed. (fix issue#178)
4433
4434 * Handle default version sets on an hidden modulefile (were not found
4435 previously). (fix issue#177)
4436
4437 * Init: fix "ksh" initialization script for ksh88 compatibility. (fix
4438 issue#159)
4439
4440 * Install: use "sed" command rather "grep" and "cut" in "configure"
4441 and "Makefile" scripts. (fix issue#175 with contribution from
4442 Michael Sternberg)
4443
4444 * Fix typo, tab indentation and pipe opening mode on "createmodule.py"
4445 utility script. (contribution from Jan Synacek)
4446
4447 * Check "ModulesVersion" value set from ".version" rc file to ensure
4448 this value refers to a version name in current directory. Report
4449 error if a nested value is detected and ignore this value. (fix
4450 issue#176)
4451
4452
4453 Modules 4.1.3 (2018-06-18)
4454 ==========================
4455
4456 * Make "setenv" command alter "env" Tcl global array during "help",
4457 "test" or "whatis" evaluation modes. (fix issue#160)
4458
4459 * Doc: describe MANPATH variable special treatment on compatibility
4460 version in diff_v3_v4 document.
4461
4462 * Initialize and export _moduleraw SH shell function if "stderr" is
4463 attached to a terminal. Was previously checking "stdout". (fix
4464 issue#169)
4465
4466 * For "csh" shells, quote code generated by modulecmd.tcl to pass it
4467 to the "eval" shell command.
4468
4469 * Escape special characters when producing code to define shell
4470 aliases (fix issue#165)
4471
4472 * Correct modulefile lookup when a modulefile directory is overwritten
4473 by a module alias definition but it contains an empty sub-directory.
4474 (fix issue#170)
4475
4476 * Doc: describe "getenv" command in modulefile(5) man page.
4477
4478 * Improve SH shell detection in profile.sh initialization script to
4479 use shell variable on "bash" or "zsh" to determine current shell
4480 name. (fix issue#173)
4481
4482
4483 Modules 4.1.2 (2018-03-31)
4484 ==========================
4485
4486 * Add an example global rc file in "contrib/etc" directory that
4487 ensures "MODULEPATH" is always defined.
4488
4489 * Check "HOME" environment variable is defined on "savelist" and "is-
4490 saved" commands or raise error if not.
4491
4492 * Fix saving of deep module default version in collection when version
4493 pinning is disabled: if "foo/bar/version" is default version for
4494 "foo", collection will retain just "foo" (was retaining "foo/bar").
4495
4496 * Enable to save and restore collections containing full path
4497 modulefiles eventually with no modulepath defined.
4498
4499 * Run "puts" command not related to "stderr" or "stdout" channels in
4500 calling modulefile context to correctly get access to the targeted
4501 file channel. (fix issue#157)
4502
4503 * Quote "autoinit" result for eval interpretation on SH-kind shells to
4504 avoid parameter expansion to randomly occur on generated code
4505 depending on file or directory names of current working directory.
4506 (fix RH bug#1549664)
4507
4508 * Ignore empty elements found in "MODULEPATH", "LOADEDMODULES" or
4509 "_LMFILES_" to ensure all elements in these variables are non-empty
4510 strings.
4511
4512 * Raise error if loaded environment is in an inconsistent state when
4513 calling commands requiring correlation of information from the
4514 "LOADEDMODULES" and the "_LMFILES_" environment variables. Error
4515 raised on "load", "unload", "switch", "reload", "purge", "list",
4516 "save" and "restore" commands. May affect "info-loaded" or "is-
4517 loaded" commands if module passed as argument to these command is
4518 specified as a full path modulefile.
4519
4520 * Fix "list" command to process loaded modules information before
4521 performing any content output.
4522
4523 * Install: adapt "configure" script and Makefiles to support
4524 installation on Cygwin system.
4525
4526 * Detect terminal width on Windows "cmd" terminal with "mode" command.
4527
4528 * Improve Windows "cmd" shell support: error code returned, echoing
4529 text, shell alias creation and removal, working directory change.
4530
4531 * Raise error when an empty module name is passed to module sub-
4532 commands like "load", "display" or "unload".
4533
4534 * Raise error when an empty collection name is passed to module sub-
4535 commands like "save", "saveshow" or "restore".
4536
4537 * Raise error when an empty path is passed to module "unuse" sub-
4538 command, like already done on "use" sub-command.
4539
4540 * Clear argument list if an empty module command name is passed.
4541
4542 * Fix "module" function definition for all shells in "autoinit"
4543 command to correctly handle empty-string parameters or parameters
4544 containing white-spaces, quotes, escape characters.
4545
4546 * Fix "module" function definition for Python to accept being called
4547 with no argument.
4548
4549 * Fix parameter expansion on "module" function for all SH-kind shells
4550 when quarantine mode is activated.
4551
4552 * Escape "\" character when producing R shell code.
4553
4554
4555 Modules 4.1.1 (2018-02-17)
4556 ==========================
4557
4558 * Make separator lines, used on "display" command result for instance,
4559 fit small screen width.
4560
4561 * Install: give ability to build and install Modules from git
4562 repository without documentation if "sphinx-build" cannot be found.
4563
4564 * Install: adapt "configure" script and Makefiles to support
4565 installation on FreeBSD, Solaris and OS X systems. (fix issue#147)
4566
4567 * Rework code generated by "autoinit" for sh-kind shells to avoid use
4568 of local variables as those are defined differently through the sh
4569 variants. (also fix issue#147)
4570
4571 * Init: use a default value on undefined variables in sh-kind scripts
4572 to avoid unbound variables in bash "-eu" mode. (fix issue#151)
4573
4574 * Correctly detect terminal column number on Solaris.
4575
4576 * Init: fix csh init script to get compatibility with pure csh shell
4577
4578 * Sanitize content of "MODULEPATH" before using it at run-time, to
4579 make potential relative paths absolute, remove trailing slashes,
4580 etc. (fix issue#152)
4581
4582 * Check loaded modulefiles still exists before displaying statistics
4583 on them during a "list" action.
4584
4585 * Use a specific reference counter variable name
4586 ("MODULES_MODSHARE_<VAR>" instead of "<VAR>_modshare") for DYLD-
4587 specific variables. (fix issue#153)
4588
4589 * No error raise when updating a DYLD or LD path-like variable on OS X
4590 when System Integrity Protection (SIP) is enabled. In this
4591 situation, these variables are not exported in subshell context, so
4592 they appear undefined.
4593
4594 * Init: protect arguments passed to the "_moduleraw" sh function from
4595 interfering content of current working directory. (fix issue#154)
4596
4597 * Install: move "hostname" RPM requirement to the compat sub-package.
4598
4599 * Start pager process only if some text has to be printed. (partially
4600 fix issue#146)
4601
4602 * Ignore "PAGER" environment variable to configure Modules pager to
4603 avoid side effects coming from a general pager configuration not
4604 compatible with Modules pager handling. (fix issue#146)
4605
4606 * Do not blank anymore default Modules pager options if default pager
4607 is "less" when the "LESS" environment variable is defined. (fix
4608 issue#146)
4609
4610 Warning:
4611
4612 With this bugfix release, changes have been made on the pager setup
4613 to avoid side effects coming from the system general pager
4614 configuration. As a result "PAGER" environment variable is now
4615 ignored and "MODULES_PAGER" should be used instead to adapt Modules
4616 pager configuration at run-time.
4617
4618
4619 Modules 4.1.0 (2018-01-15)
4620 ==========================
4621
4622 * Extend stderr output redirection on sh-kind shells to all terminal-
4623 attached shell session, not only interactive shell session.
4624
4625 * Extend shell code produced by the "autoinit" command to perform the
4626 same environment initialization as done in "init" shell scripts
4627 (default value set for module-specific environment variables, parse
4628 or source of configuration files).
4629
4630 * Make init shell scripts rely on "autoinit" command to define the
4631 "module" command and setup its default environment.
4632
4633 * Fix error rendering code for Tcl shell by producing a call to the
4634 "error" procedure.
4635
4636 * Introduce pager support to handle informational messages, using
4637 "less" command with "-eFKRX" options by default. Environment
4638 variable "MODULES_PAGER" or "PAGER" may be used to supersede default
4639 pager command and options. "--paginate" and "--no-pager" switches
4640 enable or disable pager from the command line.
4641
4642 * Install: add "--with-pager" and "--with-pager-opts" configure
4643 options to define default pager command and its relative command-
4644 line options.
4645
4646 * Introduce quarantine mechanism to protect module execution against
4647 side effect coming from the current environment definition.
4648 Variables whose name has been put in "MODULES_RUN_QUARANTINE" will
4649 be emptied or set to the value hold by "MODULES_RUNENV_<VAR>" in the
4650 modulecmd.tcl run-time environment. Quarantine variable original
4651 value is then restored within modulecmd.tcl execution context once
4652 it has started.
4653
4654 * Install: add "--with-quarantine-vars" configure option to define at
4655 build time the "MODULES_RUN_QUARANTINE" and "MODULES_RUNENV_<VAR>"
4656 environment variables set in initialization scripts.
4657
4658 * Add "MODULES_SILENT_SHELL_DEBUG" environment variable to disable on
4659 sh shell and derivatives any "xtrace" or "verbose" debugging
4660 property for the duration of either the module command or the module
4661 shell initialization script. (fix issue#121)
4662
4663 * Change error code produced by modulecmd.tcl for the Tcl, Perl,
4664 Python, Ruby, CMake and R scripting languages to return a 'false'
4665 boolean value in case of error rather raising a fatal exception.
4666
4667 * Adapt module function definition for Tcl, Perl, Python, Ruby, CMake
4668 and R scripting languages to always return a value, result of the
4669 modulecmd.tcl run. When modulecmd.tcl run does not produce a
4670 specific status, a 'true' boolean value is returned. On CMake,
4671 resulting value is returned though a "module_result" global
4672 variable.
4673
4674 * Spool content sent to the stdout channel with "puts" command during
4675 a modulefile interpretation, to effectively transmit this content to
4676 stdout after rendering the environment changes made by this
4677 modulefile. (fix issue#113)
4678
4679 * Introduce "append-path", "prepend-path", "remove-path" and "is-
4680 loaded" module sub-commands, based on existing modulefile-specific
4681 Tcl commands. (fix issue#116)
4682
4683 * Introduce "is-saved", "is-used" and "is-avail" modulefile Tcl
4684 commands and module sub-commands to test availability of collection,
4685 modulepath or modulefile.
4686
4687 * Raise error when a call to "path" or "paths" module sub-commands is
4688 attempted during a modulefile interpretation. Both commands now
4689 return text rather print text on scripting languages. An empty
4690 string is returned in no match case instead of a false boolean
4691 value.
4692
4693 * Introduce "module-info loaded" modulefile command and its module
4694 sub-command counterpart "info-loaded". This new command returns name
4695 of the modules currently loaded corresponding to the name passed as
4696 argument. (fix issue#3)
4697
4698 * Fix "is-loaded" command to correctly handle multiple module names
4699 passed as argument (fix issue#138)
4700
4701 * Support no argument on "is-loaded", "is-saved" and "is-used"
4702 commands to return if anything is respectively loaded, saved or
4703 used.
4704
4705 * Interpret "module source" command set in modulefile in "unload" mode
4706 when the modulefile itself is interpreted in this mode.
4707
4708 * Consider a modulefile passed with name starting by "./" or "../" a
4709 full path name modulefile, like those starting by "/". These kind of
4710 names are converted to absolute path names, for instance to register
4711 them in loaded modulefile list during a "load" command.
4712
4713 * Correlate modulefile passed as full path name (starting by either
4714 "./", "../" or "/") to already loaded modulefile registered with
4715 regular module name (file name without its modulepath prefix) to
4716 prevent for instance from loading twice same modulefile. Correlate
4717 in the same way regular module name to already loaded full path name
4718 modulefile.
4719
4720 * Introduce "MODULES_COLLECTION_PIN_VERSION" environment variable to
4721 record modulefile version number when saving collections even if
4722 version corresponds to the default one. (fix issue#89)
4723
4724 * Fix location of "etc/rc" global RC file to "@prefix@/etc/rc" instead
4725 of "$MODULESHOME/etc/rc" not to depend on "MODULESHOME" environment
4726 variable value.
4727
4728 * Strengthen argument check for "append-path", "prepend-path" and
4729 "remove-path" modulefile Tcl commands and module sub-commands. Raise
4730 error if argument list is not correct.
4731
4732 * Fix support for the "--delim=C" argument form on "append-path",
4733 "prepend-path" and "remove-path" commands.
4734
4735 * Fix path reference counter handling in case path element is an empty
4736 string. Distinguish an empty path element from a variable set empty
4737 to clear it.
4738
4739 * Pass multiple path elements separated by delimiter character as one
4740 string on "append-path", "prepend-path" and "remove-path" commands.
4741
4742 * Accept multiple path element arguments on "append-path", "prepend-
4743 path" and "remove-path" commands.
4744
4745 * Introduce the "--duplicates" argument option to "append-path" and
4746 "prepend-path" commands to add a path element already registered in
4747 variable.
4748
4749 * Introduce the "--index" argument option to "remove-path" command to
4750 delete a path entry by passing its position index in variable.
4751
4752 * Provide the ability to setup a site-specific configuration sourced
4753 at the start of "modulecmd.tcl" main procedure. This configuration
4754 is a Tcl script named "siteconfig.tcl" which enables to supersede
4755 any Tcl definition made in "modulecmd.tcl". Location of this file is
4756 controlled at configure time with the "--etcdir" option.
4757
4758 * Add the ability to handle paths containing reference to environment
4759 variable in "MODULEPATH". When these kind of paths are used by
4760 "module" command, the variable references are converted to their
4761 corresponding value or to an empty string if they are not defined.
4762
4763 * Enclose value set to environment variable on Tcl within curly braces
4764 rather double quotes to protect special characters in it from
4765 interpretation.
4766
4767 * Correctly parse ".modulespath" initialization file to handle lines
4768 without any "#" character or to handle files with no content to
4769 extract.
4770
4771 * Re-introduce the "--enable-versioning" configure option, which
4772 appends Modules version to installation prefix and deploy a
4773 "versions" modulepath shared between all versioning enabled Modules
4774 installation. A modulefile corresponding to Modules version is added
4775 to the shared modulepath and enables to switch from one Modules
4776 version to another.
4777
4778 * Fix removal of CMake generated temporary script file by stripping
4779 newline character from script file name.
4780
4781 * Add "MODULES_CMD" environment variable to expose path to the
4782 currently active module command script. This variable is set at
4783 initialization time.
4784
4785 * Introduce "modulecmd" wrapper script, installed in binary directory,
4786 which executes the active module command.
4787
4788 * Fix modulefile Tcl interpreter reset when handling list variables.
4789 (fix issue#145)
4790
4791 * Introduce 'module-virtual' modulefile Tcl command to associate a
4792 virtual module name to a modulefile. This module can be located with
4793 its virtual name and the associated modulefile is the script
4794 interpreted when loading, unloading, etc.
4795
4796 * Resolution of relative paths occurring during a modulefile
4797 interpretation to target a modulefile or a modulepath now takes the
4798 directory of the currently interpreted modulefile as the current
4799 working directory to solve the relative paths.
4800
4801
4802 Modules 4.0.0 (2017-10-16)
4803 ==========================
4804
4805 Starting with this release, modules-tcl has become Modules. The
4806 following changes describe the differences with last modules-tcl
4807 release (1.923). To learn about the changes between this release and
4808 last Modules 3.2 release, please see the New features document.
4809
4810 * Relax constraint on command-line argument position so options and
4811 switches can be passed either before or after command name.
4812
4813 * Report "unsupported option" warning rather stop on error when
4814 compatibility-version specific command-line switches are passed ( "
4815 --force", "--human", "--verbose", "--silent", "--create", "--icase",
4816 "--userlvl").
4817
4818 * Keep empty "module load" line in shell configuration files after
4819 running the "initrm" or "initclear" commands.
4820
4821 * Always return the value of "tcl_platform(osVersion)" for "uname
4822 release"
4823
4824 * Optimize code output, for Perl to only return "1;" once for a no-
4825 operation situation and for Python to not "import os" when there is
4826 only an error to render.
4827
4828 * Use value of system command "uname -n" for "uname nodename".
4829
4830 * Add support for CMake *shell*
4831
4832 * Ignore "/" character used as suffix in modulefile name passed on
4833 command line.
4834
4835 * Rename Perl initialization script in "perl.pm" and Python in
4836 "python.py".
4837
4838 * Add support for Ruby *shell* (with contribution from Tammo Tjarks)
4839
4840 * Add support for R *shell* (with contribution from Roy Storey)
4841
4842 * When a *default* is set for a given module name, target modulefile
4843 can be referred on as *modulename/default* in addition to just
4844 *modulename*.
4845
4846 * Locate symbolic versions on "avail" command even these symbols are
4847 set over a module alias or another symbolic version. In this
4848 situation the symbol spread along the resolution path until reaching
4849 a modulefile.
4850
4851 * Define a more standard shebang on modulecmd.tcl script.
4852
4853 * Determine modulefile corresponding to given module name using the
4854 loaded context only on "unload" situation.
4855
4856 * Enable to unload *mod/dir/subdir/vers* when unload of *mod* or
4857 *mod/dir* asked. Was previously working only if deep module to
4858 unload was also the default version for these root names.
4859
4860 * Make -l/-t switches mutually exclusive. Last switch mentioned on the
4861 command-line is honored.
4862
4863 * Output parsable modulepath header when -l/-t switches are enabled.
4864
4865 * When searching for a module in a given modulepath directory, if a
4866 module alias or a symbolic version matches searched module but the
4867 target of this alias or symbol is not found in current modulepath
4868 directory, search for this target restarting search from the first
4869 modulepath in list to ensure modulepath priority.
4870
4871 * Solve aliases or symbolic versions looking for all modulepaths on
4872 "search" and "paths" commands. Was previously solved if their target
4873 was found in same modulepath directory.
4874
4875 * Add support for hidden *dot* modulefiles. A hidden modulefile does
4876 not appear in case of wild search, it is only returned when search
4877 is about its exact name.
4878
4879 * No table header print in --long mode on an "avail" command if no
4880 result are returned.
4881
4882 * Add blank line between displayed list of elements, for instance
4883 between modulepath content on "avail" command.
4884
4885 * Improve readability of error messages encountered during modulefile
4886 execution by putting Tcl error message first after the "Module
4887 ERROR" prefix.
4888
4889 * Do not exit immediately when an internal error occurs in currently
4890 interpreted modulefile. Consider this interpretation as failed and
4891 continue to proceed the other modulefile arguments.
4892
4893 * When multiple modulefiles are passed on "display", "help" and "test"
4894 commands only output one separator line between 2 interpreted
4895 modulefiles.
4896
4897 * Fix environment settings stack handling issue when restoring stack
4898 after a failed attempt to load a modulefile in a modulefile.
4899
4900 * Failed attempt to load or unload a modulefile within a modulefile
4901 now leads to this upper modulefile load or unload failure.
4902 Previously upper modulefile were loaded respectively unloaded even
4903 if its dependent sub-modulefile failed to load or unload.
4904
4905 * During a "switch" command, if the unloading part fails the loading
4906 part will not be tried. Unloading part fails if module to unload
4907 does not exist or its unload interpretation raise error.
4908
4909 * Init: use "module source" rather shell command "source" to load
4910 modulerc system configuration in sh-kind, csh-kind and fish shell
4911 init scripts.
4912
4913 * Install: transform configuration options to bind to an existing
4914 compatibility Modules version into option (--enable-compat-version)
4915 to build and install this compatibility version along with main
4916 version.
4917
4918 * Init: adapt initialization scripts to handle both main and
4919 compatibility version. By default a shell script enables main
4920 version and if the environment variable MODULES_USE_COMPAT_VERSION
4921 is set to 1, the compatibility version is enabled instead of main
4922 version.
4923
4924 * Install: import from compatibility version and install "add.modules"
4925 and "mkroot" utility scripts (scripts developed by R.K. Owen).
4926
4927 * Install: update RPM spec file to handle compatibility version as a
4928 "compat" sub-package.
4929
4930 * Add completion script for Fish shell (contribution from BEFH).
4931
4932 * Doc: extend content of diff_v3_v4 to details all noticeable changes
4933 between v3.2 and v4.0.
4934
4935 * Doc: introduce MIGRATING guide to learn the major changes when
4936 moving from v3.2 to v4.0.
4937
4938 * Fix "list" command when full pathname modulefile is loaded (fix
4939 bug#132)
4940
4941 * Install: handle version number though git tags in scripts,
4942 documentation and RPM spec file.
4943
4944 * Doc: migrate documents from POD format to reStructuredText to
4945 benefit from Sphinx documentation framework and Read The Docs
4946 publishing capabilities.
4947
4948 Above changes describe the differences with modules-tcl release 1.923.
4949 To learn about the changes between Modules 4.0 and last Modules 3.2
4950 release, please see the New features document.
4951
4952
4953 modules-tcl-1.923 (2017-07-20)
4954 ==============================
4955
4956 * Fix "aliases" command when a global or user RC file is set.
4957
4958 * Find and solve global or user RC aliases and symbolic versions on
4959 "search", "whatis" and "paths" commands.
4960
4961 * Do not look at currently loaded modules to resolve the target of a
4962 module alias.
4963
4964 * Rework default and latest versions search on "avail" command.
4965 Correct display when at a given level a sub-directory element is
4966 last element in directory among modulefiles. Previously sub-
4967 directory was printed but last file among modulefiles was also
4968 printed (2 latest versions at the same level). A directory tagged
4969 "default" does not appear anymore in default listing result as its
4970 content (the default version found in that directory) will be
4971 displayed.
4972
4973 * When an alias is set and overrides name of an existing directory,
4974 take this alias into account for default and latest choice and
4975 ignore directory content.
4976
4977 * Bad default set will lead to no result displayed for the
4978 corresponding module in case of default "avail" display.
4979
4980 * Correct inclusion of aliases in output result when these aliases are
4981 not part of the exact same module path than module path of the
4982 search.
4983
4984 * Rewrite existing shell initialization file with initadd,
4985 initprepend, initswitch, initrm and initclear commands rather than
4986 writing a new file then copying this new file to replace the
4987 existing initialization file. In addition only re-writes shell
4988 initialization file if its content need to be altered.
4989
4990 * Raise an error on initadd, initprepend, initswitch, initrm and
4991 initclear commands when no "module load" line are found in shell
4992 initialization file.
4993
4994 * Normalize error messages for the various collection-related commands
4995 when collection cannot be accessed.
4996
4997 * Cleanup existing reference counters of a path list variable when
4998 this variable is altered by a "setenv" or an "unsetenv" command.
4999
5000 * Init: do not pollute tab-completion with moduleraw command. (Bert
5001 Wesarg)
5002
5003 * Make use of the same Tcl interp for each modulefile interpretation
5004 and use another one for each modulerc (but the same for each
5005 modulerc). By doing so we proceed like on C-version where same
5006 interpreter is used across modulefile or modulerc interpretation.
5007 Huge performance improvement is achieved with this change on
5008 commands making intensive use of interp like "avail". Interpreter
5009 state is reset from one interpretation to another: the initial
5010 variable and procedure state is restored before each new
5011 interpretation to avoid spread of definitions from one
5012 interpretation to another. Also in case of nested interpretation
5013 each interpretation level has its own interpreter so a module loaded
5014 by another does not influence the interpretation of the module
5015 loading it.
5016
5017 * Improve performance of aliases and symbolic versions resolution by
5018 computing these resolution at definition time. As a consequence
5019 resolution loop are not registered anymore and produce an error
5020 message when spotted not at display time.
5021
5022 * Reduce number of "access" system call by trying access to modulefile
5023 when reading the content of a modulefile directory rather testing
5024 access before trying it.
5025
5026 * No error raise on empty argument list for load. To cope with initadd
5027 behavior that requires at least an empty "module load" line in
5028 startup files. (fix SF bug#88)
5029
5030 * Fix initadd to handle load line without trailing space. Was
5031 previously expecting load directive to be written "module load " to
5032 get a match. With fix, "module load" line will also be matched.
5033
5034 * Like C-version catch raised error when break or continue are called
5035 from outside of a loop to handle them as when they are called from
5036 modulefile main body. (fix SF bug#87)
5037
5038 * Return error on "module use" command when an empty path string is
5039 provided rather ignoring it.
5040
5041 * Workaround "min" and "max" functions and "lreverse" procedure for
5042 correct operations under Tcl version 8.4.
5043
5044 * Install: add --with-tclsh configure option to give the ability to
5045 choose the Tcl interpreter shell to setup in initialization scripts.
5046
5047 * Handle error raised from the ModulesDisplay, ModulesHelp and
5048 ModulesTest procedures in the same way than for the evaluation of
5049 the modulefile content. An error occurring during the evaluation of
5050 the modulefile content will lead to no evaluation of the "display",
5051 "help" and "test" command specific functions.
5052
5053 * Remove "debug" module command
5054
5055 * Doc: describe "path", "paths" and "autoinit" module command.
5056
5057 * Correct use of xrdb tool when not installed in default path.
5058
5059 * Fix "init*" module commands to behave more like C-version and
5060 document remaining differences in diff_with_c-version.
5061
5062 * Init: make "sh" init script closer to POSIX specification to support
5063 sh flavors different than Bash or Zsh like Dash.
5064
5065 * Fix column-mode display for very short width terminal.
5066
5067 * Install: introduce an "install" non-regression testsuite which is
5068 triggered by the "make testinstall" command and checks modules-tcl
5069 installation is operational.
5070
5071 * Init: fix modulerc load test on "fish" init script.
5072
5073 * Init: fix interactive shell test on "sh" init script.
5074
5075 * Install: add --enable-example-modulefiles configure option that
5076 install by default some modulefiles provided as example in the
5077 system modulefiles directory.
5078
5079 * Install: when uninstalling, do not remove modulefiles directory if
5080 it is not empty.
5081
5082 * Add completion script for Zsh shell.
5083
5084 * Add "module test" command to trigger when called execution of a
5085 ModulesTest procedure in target modulefile following same kind of
5086 mechanism than "module help".
5087
5088
5089 modules-tcl-1.832 (2017-04-29)
5090 ==============================
5091
5092 * Fix "getenv" sub-command to correctly return environment variable
5093 value.
5094
5095 * Clarify in man-pages display of module alias and symbolic version-
5096 name on "avail" command and management of file access issue when
5097 locating modulefiles.
5098
5099 * Distinguish access issue (permission denied) from find issue (cannot
5100 locate) when trying to access directly a directory or a modulefile
5101 as done on "load", "display" or "whatis" commands. In addition on
5102 this kind of access, not readable .modulerc files are ignored rather
5103 producing a missing magic cookie error.
5104
5105 * When mode is set to unload, "module load" commands in modulefile are
5106 interpreted as "module unload" commands. To guaranty correct
5107 behavior regarding requirements, the module list passed to the load
5108 command is reversed to unload the modulefiles in the reverse order
5109 than they have been loaded.
5110
5111 * Correct "display" command to only report module commands set in
5112 modulefile and not those set in the various .modulerc on the path
5113 toward this modulefile.
5114
5115 * Fix bash and tcsh completion scripts to eliminate symbolic version
5116 names from "avail" command result.
5117
5118 * Improve "avail" command when a symbolic version-name is passed as
5119 argument to return the modulefile target of this symbolic version-
5120 name.
5121
5122 * When looking for an implicit default in a directory, now a module
5123 alias is taken into account so it can be returned as the last
5124 element in it (highest numerically sorted version).
5125
5126 * Fix "list" command to correctly display the "default" tag along
5127 loaded modules when set via a .version file.
5128
5129 * Fix long output of "list" command to display the symbolic version-
5130 names associated to each loaded module if any.
5131
5132 * Improve "avail" command to return alias module when an alias name is
5133 passed as argument.
5134
5135 * On a "--default" listing, a modulefile does not appear anymore if a
5136 directory is set default at the same level. On a "--latest" listing,
5137 a directory does not appear anymore if set default but not the
5138 latest.
5139
5140 * Read modulerc and validate its header in a single open/read/close
5141 sequence instead of two in order to reduce to number of IO
5142 operations during an "avail" command.
5143
5144 * Drastically reduce grid size computation time which removes overhead
5145 when displaying module avail results in column-mode.
5146
5147 * Translate module name to currently interpreted module name when name
5148 correspond to the last part this interpreted module only in case of
5149 symbolic version-name or alias resolution.
5150
5151 * Avoid resetting regular path (/usr/bin) or manpath (/usr/share/man)
5152 when switching from Tcl to C version in switchml utility.
5153
5154 * Raise error on x-resource if DISPLAY environment variable is not
5155 set.
5156
5157 * Fix lisp init script which was broken for environment change
5158 actions.
5159
5160
5161 modules-tcl-1.775 (2017-03-07)
5162 ==============================
5163
5164 * Improve README with examples, requirements, links, etc. Also update
5165 INSTALL documentation with details on the new configure/make/make
5166 install process.
5167
5168 * Add display of a release date next to the version number when
5169 calling for "--help" or "--version".
5170
5171 * Update diff_with_c-version document to describe the features of the
5172 Tcl-version that are not supported on the C-version. Also state that
5173 the diff takes C version 3.2.10 against Tcl version 1.729 as a
5174 basis.
5175
5176 * Introduce "switchml" tool, a shell function (or alias for csh or
5177 tcsh shells) that swap currently enabled Modules version (C or Tcl)
5178 by the other version (C or Tcl). Configure option "--with-cver-
5179 initdir" must be defined to enable "switchml" in initialization
5180 script.
5181
5182 * Define a PATH and MANPATH in shell initialization scripts that point
5183 to the defined modules-tcl installation directories.
5184
5185 * Give ability to generate distribution tarball from the git
5186 repository with Makefile "dist" target.
5187
5188 * Introduce an installation process for this software following the
5189 configure/make/make install fashion. Configure step enables to
5190 choose installation paths and init scripts features to activate.
5191 Make step mainly translates init scripts with the configuration set.
5192 Make install creates target directories and copy files into them.
5193
5194 * Fix MODULESHOME setup in autoinit command to define it as an
5195 absolute path and set it to the upper directory when modulecmd.tcl
5196 is located in a "bin" or a "libexec" directory.
5197
5198 * Correct alias and version resolution on avail command which was
5199 erroneous in case of a modulefile holding symbols (like "default")
5200 and targeted by aliases. Avail output was showing the aliases
5201 holding the symbols instead of the modulefile.
5202
5203
5204 modules-tcl-1.729 (2017-02-01)
5205 ==============================
5206
5207 * Add documentation in module(1) man page on the modulefile collection
5208 concept and the relative "save", "restore", "saverm", "saveshow" and
5209 "savelist" commands.
5210
5211 * Add document to list the differences of the functionalities that can
5212 be found on the C-version of the Modules package compared to the
5213 Tcl-version.
5214
5215 * Improve modulecmd.tcl shebang to only search "tclsh" once if found
5216 in PATH.
5217
5218 * Add "module-info mode" check against "remove" and "switch" values.
5219
5220 * Introduce "module-info command" Modules-specific Tcl command to
5221 distinguish complex "load" or "unload" commands that cannot be
5222 determined with "module-info mode" alone. For instance a modulefile
5223 can now be aware that a "switch", a "restore" or a "purge" command
5224 is currently being run.
5225
5226 * Enable usage of "module-info" Modules-specific Tcl command from a
5227 modulerc file.
5228
5229 * Fix "module-info specified" Modules-specific Tcl command.
5230
5231 * No exit raise on modulefile or modulerc error during "avail",
5232 "aliases", "whatis" and "search" commands to avoid harming results
5233 from these global commands if error exists in a few modulefiles.
5234
5235 * Exit with error code when a critical error is encountered when
5236 interpreting a modulefile or a modulerc.
5237
5238 * Inhibit non-critical error report raised from modulefiles during
5239 "avail", "aliases", "whatis" and "search" commands to avoid error
5240 flood when parsing all modulefiles or modulercs.
5241
5242 * Handle multiple lines of "module-whatis" Modules-specific Tcl
5243 commands defined for the same modulefile.
5244
5245 * Handle multiple arguments passed to the "module-whatis" Modules-
5246 specific Tcl commands. They are joined to get a single line of text.
5247
5248 * Return error on "whatis" command if searched modulefile is not
5249 found.
5250
5251
5252 modules-tcl-1.704 (2017-01-20)
5253 ==============================
5254
5255 * Set path variable counter to 1 for paths without a known reference
5256 count (was previously set to 999999999).
5257
5258 * Introduce "envml" utility which acts as an application launcher
5259 where module commands are instantiated to setup environment before
5260 launching the given application.
5261
5262 * Always register paths provided to be part of MODULEPATH environment
5263 variable as absolute paths to get independent from the current
5264 working directory.
5265
5266 * Inhibit next modulefiles interpretation with "exit" Modules-specific
5267 Tcl command only if current mode is "load".
5268
5269 * Add argument to "module-info shell" and "module-info shelltype" to
5270 test current shell or shelltype value.
5271
5272 * Fix use of "default" version-name to not consider it as a module
5273 symbol if a modulefile is named "default".
5274
5275 * Fix path variable counters when ":" character is used in elements of
5276 a path-like variable.
5277
5278 * Update module(1) and modulefile(5) man pages to clear content
5279 specific to the C version of Modules and add content specific to or
5280 adapt content that behave differently on this Tcl version.
5281
5282 * Fix TCLSH variable issue in Python init script.
5283
5284
5285 modules-tcl-1.677 (2017-01-04)
5286 ==============================
5287
5288 * Make "switch" command handle a single argument. The modulefile to
5289 switch to is the one passed on the command-line and the modulefile
5290 to unload is assumed to be the currently loaded module with the same
5291 root name as this modulefile specified on the command-line.
5292
5293 * Make "switch" command idempotent by always ending up with "old"
5294 unloaded and "new" loaded, whatever the starting situation is.
5295
5296 * Fix "exit" Modules-specific Tcl command.
5297
5298 * Add "refresh" command as alias on "reload" command.
5299
5300 * Add dummy "module-log", "module-trace", "module-user" and "module-
5301 verbosity" Modules-specific Tcl commands to enable support for
5302 modulefiles using them.
5303
5304 * Fix "system" Modules-specific Tcl command to behave like described
5305 on the man page.
5306
5307 * Fix "module list" when module loaded with full path
5308
5309 * Disable "g_force" property by default to avoid loading a modulefile
5310 already loaded. It also avoids path element reference counting to
5311 get increased when the same module is asked twice for load.
5312
5313 * Clarify module-info "mode" option and set "help" mode on "module
5314 help" command.
5315
5316 * Clarify module-info "flags" and "user" options.
5317
5318 * Handle empty or separator path on "add-path" ad "unload-path"
5319 commands.
5320
5321 * Delete environment variable targeted by an "unsetenv" command on
5322 "unload" mode if no value has been provided along. On display mode,
5323 print environment variable value if any has been passed to
5324 "unsetenv" command.
5325
5326 * When setting Tcl variable, enclose value within double quotes.
5327
5328 * Fix perl quoting style for variable set, escape single quotes rather
5329 double quotes.
5330
5331 * Call "unuse" command instead of "use" command on a "module unload".
5332
5333 * Fix "continue" Modules-specific Tcl command.
5334
5335 * Add "chdir" Modules-specific Tcl command.
5336
5337 * Fix "break" Modules-specific Tcl command.
5338
5339
5340 modules-tcl-1.655 (2016-11-23)
5341 ==============================
5342
5343 * No display of modulepath header if no module found in it.
5344
5345 * Remove call to "module aliases" on "module avail" command, as
5346 aliases are now directly included in the "avail" results.
5347
5348 * Include module aliases in the displayed result of an "avail"
5349 command. Also display aliases defined in a global or user modulerc
5350 file.
5351
5352 * Exit with error code if error occurred on display or help commands.
5353
5354 * Fix module-info symbols resolution.
5355
5356 * Better handling of .modulerc and .version files when searching for a
5357 modulefile.
5358
5359 * Fix module-info version resolution.
5360
5361 * Fix module-info alias resolution.
5362
5363 * Register alias and version by the short module name and improve
5364 their resolution to avoid loop.
5365
5366 * Source $MODULERCFILE/modulerc when $MODULERCFILE is dir.
5367
5368 * Make it so you can do "module avail un", wildcard "*" character
5369 implied.
5370
5371
5372 modules-tcl-1.632 (2016-09-06)
5373 ==============================
5374
5375 * Raise error if command does not receive the excepted number of
5376 arguments.
5377
5378 * Improve column-mode display to get a denser output on "avail"
5379 command.
5380
5381 * Standardize the output of Warning, Error, InternalBug and
5382 ErrorAndExit messages.
5383
5384 * Add short option -d for --delim on prepend-path.
5385
5386 * Introduce collection target concept to distinguish between machines,
5387 environments or domains that are incompatible with each other.
5388
5389 * Introduce "saveshow" command, to display content of saved
5390 collections.
5391
5392 * Improve "save" and "restore" commands to handle collection specified
5393 as absolute or relative file path.
5394
5395 * Introduce "saverm" command, to delete saved collections.
5396
5397 * Enable to "restore" collection with multiple modulefiles specified
5398 on the same line.
5399
5400 * Fix "restore" command when there is no module to load in collection.
5401
5402 * Fix "restore" command when collection fully rewind module paths.
5403
5404 * Fix "restore" command to preserve module path order set in
5405 collection.
5406
5407 * Raise error if try to save an empty environment in a collection.
5408
5409
5410 modules-tcl-1.602 (2016-08-13)
5411 ==============================
5412
5413 * Add support for Fish shell.
5414
5415 * Import recent tests added to C-version on 10-use and 50-cmds
5416 testsuites.
5417
5418 * Add short option -d for --delim on append-path and remove-path.
5419
5420 * Fix load and implement unload x-resource.
5421
5422 * Fix Python code that was broken or not Python3-compliant. Fixed code
5423 is used to define the module command, to render error and to process
5424 x-resource.
5425
5426 * Always dictionary-sort (also called numerical-sort) list of
5427 modulefiles or list of collections.
5428
5429 * Fix bash completion script to be compliant with bash posix mode.
5430
5431
5432 modules-tcl-1.578 (2014-12-24)
5433 ==============================
5434
5435 * First release to be described in this NEWS file but it does not mean
5436 this is the first version of modules-tcl as this Modules flavor is
5437 born in 2002.
5438
5439 * At this stage, modules-tcl handles a majority of the module commands
5440 and modulefile Tcl commands available on C version.