Skip to content

Commit 56ff12d

Browse files
committed
doc: desc. provide{,-d-alias} extra specifiers in NEWS/man
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent a7cc5c1 commit 56ff12d

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

NEWS.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,10 @@ Modules 5.6.0 (not yet released)
175175
*extra match search* mechanism is activated to scan modulefiles to get the
176176
module aliases they define.
177177
* Doc: add :ref:`provide` design notes.
178+
* Introduce ``provide`` and ``provided-alias`` extra specifiers to search
179+
modules on :subcmd:`avail`, :subcmd:`spider`, :subcmd:`whatis` and
180+
:subcmd:`paths` sub-commands. ``provided-alias`` extra specifier is an alias
181+
onto ``provide`` and ``family`` extra specifiers.
178182

179183
.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
180184
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org

doc/source/module.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3155,10 +3155,12 @@ an environment variable, a shell alias, a module specification, etc.
31553155
Supported extra specifier *elements* are:
31563156

31573157
* ``variant``, ``complete``, ``uncomplete``, ``set-alias``, ``unset-alias``,
3158-
``set-function``, ``unset-function``, ``chdir``, ``family``, ``tag``
3158+
``set-function``, ``unset-function``, ``chdir``, ``tag``
31593159
* ``setenv``, ``unsetenv``, ``append-path``, ``prepend-path``, ``remove-path``
31603160
and ``pushenv``: these elements related to environment variable handling may
31613161
also be aliased ``envvar``
3162+
* ``family`` and ``provide``: these elements related to module alias may also
3163+
be aliases ``provided-alias``
31623164
* ``prereq``, ``prereq-any``, ``prereq-all``, ``depends-on``,
31633165
``depends-on-any``, ``always-load``, ``load``, ``load-any``, ``try-load``,
31643166
``switch`` and ``switch-on``: these elements related to module requirement
@@ -3231,6 +3233,9 @@ query.
32313233
.. versionchanged:: 5.6
32323234
Support for :subcmd:`spider` sub-command added
32333235

3236+
.. versionchanged:: 5.6
3237+
Extra specifiers ``provide`` and ``provided-alias`` added
3238+
32343239

32353240
.. _Module tags:
32363241

0 commit comments

Comments
 (0)