"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/build/changes.txt" between
modules-5.1.1.tar.bz2 and modules-5.2.0.tar.bz2

About: The Environment Modules package provides for the dynamic modification of a user’s environment via modulefiles.

changes.txt  (modules-5.1.1.tar.bz2)	:	changes.txt  (modules-5.2.0.tar.bz2)
skipping to change at line 505		skipping to change at line 505
On version 4 and for *sh*, *bash*, *ksh*, *zsh* and *fish* shells,		On version 4 and for *sh*, *bash*, *ksh*, *zsh* and *fish* shells,
text output, like listing from the "avail" command, is redirected from		text output, like listing from the "avail" command, is redirected from
*stderr* to *stdout* after shell command evaluation if shell is in		*stderr* to *stdout* after shell command evaluation if shell is in
interactive mode. Starting version "4.1", this content redirection		interactive mode. Starting version "4.1", this content redirection
occurs if shell session is attached to a terminal.		occurs if shell session is attached to a terminal.
Starting version "4.5", a new alias or function called **ml** may be		Starting version "4.5", a new alias or function called **ml** may be
defined at initialization time, to provide a handy frontend to the		defined at initialization time, to provide a handy frontend to the
**module** command.		**module** command.
		Starting version "4.5", support for Windows *cmd* shell is introduced.
Modulecmd startup		Modulecmd startup
~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~
Starting with version "4.1", "modulecmd.tcl" sources upon invocation a		Starting with version "4.1", "modulecmd.tcl" sources upon invocation a
site-specific configuration script named "siteconfig.tcl". This Tcl		site-specific configuration script named "siteconfig.tcl". This Tcl
script enables to supersede any global variable or procedure		script enables to supersede any global variable or procedure
definition of modulecmd.tcl.		definition of modulecmd.tcl.
Command line switches		Command line switches
~~~~~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~~~~~
skipping to change at line 860		skipping to change at line 862
functions). With this change the "refresh" sub-command is restored		functions). With this change the "refresh" sub-command is restored
to the behavior it had on Modules version 3.2.		to the behavior it had on Modules version 3.2.
"restore", "source"		"restore", "source"
Only report the module load and unload directly triggered by these		Only report the module load and unload directly triggered by these
sub-commands. Load and unload triggered by other modules are		sub-commands. Load and unload triggered by other modules are
reported through the automated module handling messages of the main		reported through the automated module handling messages of the main
modules.		modules.
		"restore"
		Starting Modules 5.2:
		* if no argument is provided and if default collection does not
		exist, initial environment is restored.
		* *sticky* modules are unloaded when restoring a collection.
"source"		"source"
Enforce use of the Modules magic cookie (i.e., "#%Module" file		Enforce use of the Modules magic cookie (i.e., "#%Module" file
signature) at the start of any scriptfile passed for evaluation to		signature) at the start of any scriptfile passed for evaluation to
the "source" sub-command. These files are not evaluated and an		the "source" sub-command. These files are not evaluated and an
error is produced if the magic cookie is missing or if the optional		error is produced if the magic cookie is missing or if the optional
version number placed after the cookie string is higher than the		version number placed after the cookie string is higher than the
version of the "modulecmd.tcl" script in use.		version of the "modulecmd.tcl" script in use.
		"saveshow"
		Starting Modules 5.2, if no argument is provided and if default
		collection does not exist, initial environment is displayed.
"use"		"use"
Non-existent modulepath is now accepted as argument.		Non-existent modulepath is now accepted as argument.
Reference counting mechanism is ignored when sub-command is not		Reference counting mechanism is ignored when sub-command is not
called during a modulefile evaluation. In such context, a "module		called during a modulefile evaluation. In such context, a "module
use" will not increase the reference counter of a path entry		use" will not increase the reference counter of a path entry
already defined.		already defined.
"unuse"		"unuse"
skipping to change at line 912		skipping to change at line 928
These modulefile commands have been undeclared from the modulerc		These modulefile commands have been undeclared from the modulerc
Tcl interpreter on Modules 5. An error message is obtained if still		Tcl interpreter on Modules 5. An error message is obtained if still
used instead of silently ignoring it.		used instead of silently ignoring it.
"getenv"		"getenv"
When passed environment variable is not defined, an empty string is		When passed environment variable is not defined, an empty string is
returned by default rather "_UNDEFINED_".		returned by default rather "_UNDEFINED_".
Starting version 5.1, the "--return-value" option is added to
return environment variable value or its fallback when modulefile
is evaluated in *display* mode.
"module"		"module"
Forbid use of "module source" command in modulefile or in an		Forbid use of "module source" command in modulefile or in an
initialization rc file, the "source" Tcl command should be used		initialization rc file, the "source" Tcl command should be used
instead.		instead.
Starting version "5.1", an error is raised when an unused option is		Starting version "5.1" an error is raised when an unused option is
set on "module use" or "module unuse" commands.		set on "module use" or "module unuse" commands.
Starting version "5.1", options "--*-on-unload" added to the
"remove-path" command are also added to the "module unuse" command.
"remove-path"
Starting with version "5.1", the "--remove-on-unload" option is
added to also remove value when modulefile is unloaded.
Starting with version "5.1", the "--append-on-unload" and "--
prepend-on-unload" options are added to restore when modulefile is
unloaded the value list unset at load time.
Starting with version "5.1", the "--noop-on-unload" option is added
to perform no operation when modulefile is unloaded.
"setenv"
Starting with version "5.1", the "--set-if-undef" option is added
to set environment variable when modulefile is loaded only if not
yet defined.
"unsetenv"		"unsetenv"
When running on an unload evaluation, do not unset designated		When running on an unload evaluation, do not unset designated
environment variable if no value to restore is provided.		environment variable if no value to restore is provided.
Distinguish between being called on a unload evaluation without a		Distinguish between being called on a unload evaluation without a
value to restore or with an empty string value to restore.		value to restore or with an empty string value to restore.
Starting with version "5.1", the "--noop-on-unload" option is added
to perform no operation when modulefile is unloaded.
Starting with version "5.1", the "--unset-on-unload" option is
added to also unset variable when modulefile is unloaded.
"variant"		"variant"
Starting version 5.1, "variant" command accepts being called		Starting version 5.1, "variant" command accepts being called
without a list of accepted value defined. In this case, any value		without a list of accepted value defined. In this case, any value
specified is accepted.		specified is accepted.
Starting version 5.1, the "--return-value" option is added to
return variant value or its fallback when modulefile is evaluated
in *display* mode.
Locating Modulefiles		Locating Modulefiles
~~~~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~~~~
As the Advanced module version specifiers mechanism is enabled by		As the Advanced module version specifiers mechanism is enabled by
default on Modules 5, several characters are made special and cannot		default on Modules 5, several characters are made special and cannot
be used anymore in module name or version. These characters are "@",		be used anymore in module name or version. These characters are "@",
"=", "~", "+" and ",". Also a module name cannot start with "-"		"=", "~", "+" and ",". Also a module name cannot start with "-"
character. Module name is allowed to finish by one or more "+"		character. Module name is allowed to finish by one or more "+"
character but "+" cannot be used at the start or inside a module name.		character but "+" cannot be used at the start or inside a module name.
skipping to change at line 1054		skipping to change at line 1035
~~~~~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~~~~~
The following command line switches appeared on Modules 5.		The following command line switches appeared on Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New command line switches |		| Introduced | New command line switches |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.1 | "--redirect", "--no-redirect", "--tag" |		| 5.1 | "--redirect", "--no-redirect", "--tag" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
		| 5.2 | "--timer"
		|
		+--------------+----------------------------------------------------------------
		---+
Module Sub-Commands		Module Sub-Commands
~~~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~~~
The following module sub-commands appeared on Modules 5.		The following module sub-commands appeared on Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New module sub-commands |		| Introduced | New module sub-commands |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.1 | "state", "load-any" |		| 5.1 | "state", "load-any" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
		| 5.2 | "lint", "mod-to-sh", "reset", "stash", "stashpop", "stashrm",
		|
		| | "stashshow", "stashclear", "stashlist"
		|
		+--------------+----------------------------------------------------------------
		---+
"list"		"list"
Starting Modules 5.1, this sub-command accepts patterns to filter		Starting Modules 5.1:
the loaded modules to list.
		* this sub-command accepts patterns to filter the loaded modules to
		list.
		* the "--starts-with" and "--contains" options are supported on
		this sub-command to provide the regular search match
		capabilities.
		"refresh"
		Starting Modules 5.2, only the loaded modules listed in the
		"__MODULES_LMREFRESH" environment variables are refreshed.
		"restore"
		Starting Modules 5.2, initial environment is restored when
		specified collection name is "__init__".
		"savelist"
		Starting Modules 5.2:
		* this sub-command accepts patterns to filter the named collections
		to list.
Starting Modules 5.1, the "--starts-with" and "--contains" options		* the "--starts-with" and "--contains" options are supported on
are supported on this sub-command to provide the regular search		this sub-command to provide the regular search match
match capabilities.		capabilities.
		* the "--all" option is supported on this sub-command not to limit
		to the collection matching currently set collection target.
		"saveshow"
		Starting Modules 5.2, initial environment is displayed when
		specified collection name is "__init__".
"sh-to-mod"		"sh-to-mod"
Starting Modules 5.1, this sub-command also tracks shell completion		Starting Modules 5.1, this sub-command also tracks shell completion
changes for bash, tcsh and fish shells.		changes for bash, tcsh and fish shells.
		"source"
		Starting Modules 5.2, this sub-command accepts modulefile
		specification as argument in addition to file path.
Environment		Environment
~~~~~~~~~~~		~~~~~~~~~~~
The following environment variables appeared on Modules 5.		The following environment variables appeared on Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New environment variables |		| Introduced | New environment variables |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.0 | "MODULES_QUARANTINE_SUPPORT", "__MODULES_QUARANTINE_SET", |		| 5.0 | "MODULES_QUARANTINE_SUPPORT", "__MODULES_QUARANTINE_SET", |
| | "__MODULES_AUTOINIT_INPROGRESS" |		| | "__MODULES_AUTOINIT_INPROGRESS" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| 5.1 | "MODULES_REDIRECT_OUTPUT", "MODULES_MCOOKIE_CHECK", |		| 5.1 | "MODULES_REDIRECT_OUTPUT", "MODULES_MCOOKIE_CHECK", |
| | "MODULES_FAMILY_<NAME>", "__MODULES_PUSHENV_<VAR>", |		| | "MODULES_FAMILY_<NAME>", "__MODULES_PUSHENV_<VAR>", |
| | "__MODULES_LMEXTRATAG", "MODULES_COLLECTION_PIN_TAG" |		| | "__MODULES_LMEXTRATAG", "MODULES_COLLECTION_PIN_TAG" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
		| 5.2 | "MODULES_PROTECTED_ENVVARS", "MODULES_TCL_LINTER",
		|
		| | "__MODULES_LMINIT", "MODULES_RESET_TARGET_STATE",
		|
		| | "__MODULES_LMREFRESH"
		|
		+--------------+----------------------------------------------------------------
		---+
Modules Specific Tcl Commands		Modules Specific Tcl Commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following modulefile Tcl commands appeared on Modules 5.		The following modulefile Tcl commands appeared on Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New modulefile Tcl commands |		| Introduced | New modulefile Tcl commands |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.1 | "add-property", "remove-property", "extensions", "prereq-any", |		| 5.1 | "add-property", "remove-property", "extensions", "prereq-any", |
| | "require-fullname", "depends-on", "prereq-all", "always-load", |		| | "require-fullname", "depends-on", "prereq-all", "always-load", |
| | "module load-any", "family", "complete", "uncomplete", "pushenv " |		| | "module load-any", "family", "complete", "uncomplete", "pushenv " |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
"system", "is-used"		"system", "is-used"
Starting Modules 5.0, these modulefile commands are available from		Starting Modules 5.0, these modulefile commands are available from
a modulerc evaluation context.		a modulerc evaluation context.
		"getenv"
		Starting version 5.1, the "--return-value" option is added to
		return environment variable value or its fallback when modulefile
		is evaluated in *display* mode.
"prereq", "module load/try-load/load-any/switch"		"prereq", "module load/try-load/load-any/switch"
Starting Modules 5.1, these modulefile commands accept the "--tag"		Starting Modules 5.1, these modulefile commands accept the "--tag"
option.		option.
		"prereq", "prereq-all", "always-load", "depends-on"
		Starting Modules 5.2, these modulefile commands accept the "--
		optional" option.
"module try-load/load-any"		"module try-load/load-any"
Starting Modules 5.1, these modulefile commands accept the "--not-		Starting Modules 5.1, these modulefile commands accept the "--not-
req" option.		req" option.
		"module unuse"
		Starting version "5.1" options "--*-on-unload" added to the
		"remove-path" command are also added to the "module unuse" command.
"puts"		"puts"
Starting Modules 5.1, if content is sent to the "prestdout"		Starting Modules 5.1, if content is sent to the "prestdout"
channel, it is rendered as command to evaluate in current shell		channel, it is rendered as command to evaluate in current shell
session and prior any other environment changes.		session and prior any other environment changes.
		"remove-path"
		Starting with version "5.1":
		* the "--remove-on-unload" option is added to also remove value
		when modulefile is unloaded.
		* the "--append-on-unload" and "--prepend-on-unload" options are
		added to restore when modulefile is unloaded the value list unset
		at load time.
		* the "--noop-on-unload" option is added to perform no operation
		when modulefile is unloaded.
		"setenv"
		Starting with version "5.1", the "--set-if-undef" option is added
		to set environment variable when modulefile is loaded only if not
		yet defined.
"source-sh"		"source-sh"
Starting Modules 5.1, this modulefile command also tracks shell		Starting Modules 5.1, this modulefile command also tracks shell
completion changes for bash, tcsh and fish shells.		completion changes for bash, tcsh and fish shells.
		"unsetenv"
		Starting with version "5.1":
		* the "--noop-on-unload" option is added to perform no operation
		when modulefile is unloaded.
		* the "--unset-on-unload" option is added to also unset variable
		when modulefile is unloaded.
		"variant"
		Starting version 5.1, the "--return-value" option is added to
		return variant value or its fallback when modulefile is evaluated
		in *display* mode.
Modules Variables		Modules Variables
~~~~~~~~~~~~~~~~~		~~~~~~~~~~~~~~~~~
The following Modules-specific Tcl variables appeared on Modules 5.		The following Modules-specific Tcl variables appeared on Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New Modules-specific Tcl variables |		| Introduced | New Modules-specific Tcl variables |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.1 | "ModuleVersion" |		| 5.1 | "ModuleVersion" |
skipping to change at line 1164		skipping to change at line 1242
Modules 5.		Modules 5.
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| Introduced | New Modules configuration options |		| Introduced | New Modules configuration options |
| in version | |		| in version | |
|==============|================================================================ ===|		|==============|================================================================ ===|
| 5.0 | "quarantine_support" |		| 5.0 | "quarantine_support" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
| 5.1 | "redirect_output", "mcookie_check", "collection_pin_tag" |		| 5.1 | "redirect_output", "mcookie_check", "collection_pin_tag" |
+--------------+---------------------------------------------------------------- ---+		+--------------+---------------------------------------------------------------- ---+
		| 5.2 | "tcl_linter", "protected_envvars", "reset_target_state"
		|
		+--------------+----------------------------------------------------------------
		---+
End of changes. 20 change blocks.
41 lines changed or deleted		128 lines changed or added

---