"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/source/design/control-mode-behaviors.rst" 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.

control-mode-behaviors.rst  (modules-5.1.1.tar.bz2)	:	control-mode-behaviors.rst  (modules-5.2.0.tar.bz2)
.. _control-mode-behaviors:		.. _control-mode-behaviors:
Control mode behaviors		Control mode behaviors
======================		======================
- Modulefile commands that modify environment variables applies		- Modulefile commands that modify environment variables applies
- a behavior when modulefile is loaded		- a behavior when modulefile is loaded
- and another behavior when modulefile is unloaded		- and another behavior when modulefile is unloaded
- Depending on the situation, it seems interesting to apply a different		- Depending on the situation, it seems interesting to apply a different
behavior when modulefile is unloaded:		behavior when modulefile is unloaded:
- restore value unset at load time, either:		- restore value unset at load time, either:
- append-on-unload		- append-on-unload
- prepend-on-unload		- prepend-on-unload
- remove value from list: remove-on-unload		- remove value from list: remove-on-unload
- unset full variable value: unset-on-unload		- unset full variable value: unset-on-unload
- set another value, either:		- set another value, either:
- append-on-unload		- append-on-unload
- prepend-on-unload		- prepend-on-unload
- set-on-unload (for non-path-like variable)		- set-on-unload (for non-path-like variable)
- do nothing: noop-on-unload		- do nothing: noop-on-unload
- Also when modulefile loads sometimes it may be interesting to apply a		- Also when modulefile loads sometimes it may be interesting to apply a
slightly different behavior depending on the situation:		slightly different behavior depending on the situation:
- set value only if variable is undefined: set-if-undef		- set value only if variable is undefined: set-if-undef
- Concerned modulefile commands:		- Concerned modulefile commands:
- :mfcmd:`module use<module>`		- :mfcmd:`module use<module>`
- :mfcmd:`module unuse<module>`		- :mfcmd:`module unuse<module>`
- :mfcmd:`setenv`		- :mfcmd:`setenv`
- :mfcmd:`unsetenv`		- :mfcmd:`unsetenv`
- :mfcmd:`append-path`		- :mfcmd:`append-path`
- :mfcmd:`prepend-path`		- :mfcmd:`prepend-path`
- :mfcmd:`remove-path`		- :mfcmd:`remove-path`
- Only applies when the above commands are called from a modulefile (as some		- Only applies when the above commands are called from a modulefile (as some
of these commands can also act as module sub-commands)		of these commands can also act as module sub-commands)
Unload behavior		Unload behavior
---------------		---------------
- Unload behavior of concerned modulefile commands:		- Unload behavior of concerned modulefile commands:
+--------------+-------------------------+--------------------------+--------- --------------+		+--------------+-------------------------+--------------------------+--------- --------------+
skipping to change at line 81		skipping to change at line 81
| remove-path | noop-on-unload | *n/a* | remove-o n-unload, |		| remove-path | noop-on-unload | *n/a* | remove-o n-unload, |
| | | | append-o n-unload, |		| | | | append-o n-unload, |
| | | | prepend- on-unload |		| | | | prepend- on-unload |
+--------------+-------------------------+--------------------------+--------- --------------+		+--------------+-------------------------+--------------------------+--------- --------------+
- When either restoring or setting other value for path-like modulefile		- When either restoring or setting other value for path-like modulefile
commands, it is needed to know if the value should be appended or prepended.		commands, it is needed to know if the value should be appended or prepended.
- Either restoring or setting other value result in the same behavior name		- Either restoring or setting other value result in the same behavior name
- *append-on-unload* and *prepend-on-unload*		- *append-on-unload* and *prepend-on-unload*
- position of the option will determine if the values to set are:		- position of the option will determine if the values to set are:
- those unset at load time: when option is placed prior value list		- those unset at load time: when option is placed prior value list
- a different list of value: when option is placed after value list to		- a different list of value: when option is placed after value list to
unset at load time and another value list is defined after option		unset at load time and another value list is defined after option
- The *set-on-unload* behavior is only useful for modulefile commands which		- The *set-on-unload* behavior is only useful for modulefile commands which
unset value on load mode, as commands that set value on load mode mainly		unset value on load mode, as commands that set value on load mode mainly
need to unset the value set.		need to unset the value set.
- Default unload behavior of ``module unuse``, ``unsetenv`` and		- Default unload behavior of ``module unuse``, ``unsetenv`` and
``remove-path`` commands can also be set as an option in their argument		``remove-path`` commands can also be set as an option in their argument
list. Helps to dynamically choose the behavior to apply, which could be the		list. Helps to dynamically choose the behavior to apply, which could be the
default behavior.		default behavior.
skipping to change at line 127		skipping to change at line 127
+--------------+-----------------------+-----------------------+		+--------------+-----------------------+-----------------------+
| remove-path | remove-on-load | |		| remove-path | remove-on-load | |
+--------------+-----------------------+-----------------------+		+--------------+-----------------------+-----------------------+
Modulefile command options		Modulefile command options
--------------------------		--------------------------
- Alternative behaviors could be specified by setting the associated option		- Alternative behaviors could be specified by setting the associated option
over the modulefile command:		over the modulefile command:
- ``--remove-on-unload``		- ``--remove-on-unload``
- ``--append-on-unload``		- ``--append-on-unload``
- ``--prepend-on-unload``		- ``--prepend-on-unload``
- ``--noop-on-unload``		- ``--noop-on-unload``
- ``--unset-on-unload``		- ``--unset-on-unload``
- ``--set-if-undef``		- ``--set-if-undef``
- The ``--append-on-unload`` and ``--prepend-on-unload`` options either:		- The ``--append-on-unload`` and ``--prepend-on-unload`` options either:
- restore the value list removed at load time if placed prior this value		- restore the value list removed at load time if placed prior this value
list		list
- set a different value list if a different list of value is specified		- set a different value list if a different list of value is specified
after option (all the values set after the option are considered element		after option (all the values set after the option are considered element
to add to the path-like variable)		to add to the path-like variable)
- both options also accept to be set prior or right after variable name or		- both options also accept to be set prior or right after variable name or
even right at the end of argument list to restore value list removed at		even right at the end of argument list to restore value list removed at
load time		load time
- The ``--set-if-undef`` option does not change the behavior of ``setenv``		- The ``--set-if-undef`` option does not change the behavior of ``setenv``
when modulefile is unloaded: environment variable will be unset whether the		when modulefile is unloaded: environment variable will be unset whether the
option is set or not.		option is set or not.
- The ``--remove-on-unload`` option can be set anywhere in argument list		- The ``--remove-on-unload`` option can be set anywhere in argument list
- The ``--remove-on-unload``, ``--append-on-unload`` and		- The ``--remove-on-unload``, ``--append-on-unload`` and
``--prepend-on-unload`` options cannot be mixed with the ``--index`` option		``--prepend-on-unload`` options cannot be mixed with the ``--index`` option
of ``remove-path`` sub-command.		of ``remove-path`` sub-command.
- The ``--remove-on-unload``, ``--append-on-unload``, ``--prepend-on-unload``		- The ``--remove-on-unload``, ``--append-on-unload``, ``--prepend-on-unload``
and ``--noop-on-unload`` options:		and ``--noop-on-unload`` options:
- can be placed at different positions in argument list to limit error		- can be placed at different positions in argument list to limit error
cases		cases
- if multiple options of this kind are defined in argument list, the one		- if multiple options of this kind are defined in argument list, the one
defined at the most right is retained		defined at the most right is retained
Misc		Misc
----		----
- *FUTURE*: what is applied to:		- *FUTURE*: what is applied to:
- ``module use`` may also be interesting for ``module load``		- ``module use`` may also be interesting for ``module load``
- ``module unuse`` may also be interesting for ``module unload``		- ``module unuse`` may also be interesting for ``module unload``
		.. vim:set tabstop=2 shiftwidth=2 expandtab autoindent:
End of changes. 14 change blocks.
43 lines changed or deleted		43 lines changed or added

---