Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion doc/source/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3250,7 +3250,10 @@ Module Sub-Commands
requests the default prepend behavior.

When *directory* is already defined in :envvar:`MODULEPATH`, it is not added
again or moved at the end or at the beginning of the environment variable.
again or moved at the end or at the beginning of the environment variable,
unless the :mconfig:`path_entry_reorder` configuration option is enabled, in
which case *directory* is moved at the beginning of :envvar:`MODULEPATH` or
at its end if the ``--append`` flag is set.

The ``--priority`` option assigns a priority *N* to the added *directory*,
like the ``--priority`` option of :mfcmd:`prepend-path` and
Expand Down Expand Up @@ -3284,6 +3287,10 @@ Module Sub-Commands
:subcmd:`module use<use>` is called from the command-line or within an
initialization modulefile script

.. versionchanged:: 5.7
*directory* already defined in :envvar:`MODULEPATH` is moved when
:mconfig:`path_entry_reorder` configuration option is enabled

.. versionchanged:: 5.8
Option ``--priority`` added

Expand Down
9 changes: 8 additions & 1 deletion doc/source/modulefile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1272,7 +1272,10 @@ the *modulefile* is being loaded.
When *value* is already defined in environment *variable*, it is not added
again or moved at the end or at the beginning of *variable*. Exception is
made when the ``--duplicates`` option is set in which case *value* is added
again to *variable*.
again to *variable*. When the :mconfig:`path_entry_reorder` configuration
option is enabled, *value* is moved at the beginning of *variable* with
:mfcmd:`prepend-path` or at its end with :mfcmd:`append-path`, unless the
``--duplicates`` option is set.

If the *variable* is not set, it is created. When a *modulefile* is
unloaded, :mfcmd:`append-path` and :mfcmd:`prepend-path` become
Expand Down Expand Up @@ -1338,6 +1341,10 @@ the *modulefile* is being loaded.
modulefile adding path to :envvar:`MODULEPATH` environment variable is
considered a requirement of modulefiles stored in this path.

.. versionchanged:: 5.7
*value* already defined in *variable* is moved when
:mconfig:`path_entry_reorder` configuration option is enabled

.. versionchanged:: 5.8
Option ``--priority`` added

Expand Down
8 changes: 4 additions & 4 deletions doc/source/other-implementations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ table highlights features that are unique to each implementation.
* Save configuration under :envvar:`XDG_CONFIG_HOME`
* `i18n`_
* `Find best module`_
* `Path entry priorities`_
* ``--regexp`` search option
* `settarg`_
* `MarkDown support in module help and whatis`_
Expand Down Expand Up @@ -76,7 +75,6 @@ table highlights features that are unique to each implementation.
.. _Inactive modules: https://lmod.readthedocs.io/en/latest/010_user.html#module-hierarchy
.. _Find best module: https://lmod.readthedocs.io/en/latest/060_locating.html
.. _i18n: https://lmod.readthedocs.io/en/latest/185_localization.html
.. _Path entry priorities: https://lmod.readthedocs.io/en/latest/077_ref_counting.html#specifying-priorities-for-path-entries
.. _Update path entry order: https://lmod.readthedocs.io/en/latest/077_ref_counting.html
.. _settarg: https://lmod.readthedocs.io/en/latest/310_settarg.html
.. _Hook functions: https://lmod.readthedocs.io/en/latest/170_hooks.html#hook-functions
Expand Down Expand Up @@ -218,6 +216,8 @@ implementation.
- |[email protected]:7.0|_
* - ``latest("foo")``
- |foo@latest|_
* - ``prepend_path{"PATH","/foo",priority=100}``
- :mfcmd:`prepend-path` ``--priority 100 PATH /foo``
* - ``myModuleFullName()``
- :mfcmd:`module-info name<module-info>`
* - ``myModuleName()``
Expand Down Expand Up @@ -300,5 +300,5 @@ additional tools that enhance how modulefiles are handled.
If you're aware of a ``module``-related project missing from this list, feel
free to :ref:`contact us<Community>` so we can add it.

.. |modules_version| replace:: Modules 5.7.0
.. |lmod_version| replace:: Lmod 9.4.2
.. |modules_version| replace:: Modules 5.8.0 (not yet released)
.. |lmod_version| replace:: Lmod 9.4.5
Loading