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