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