doc: add variant info to module-info in modulefile(4)

This commit is contained in:
Xavier Delaruelle
2021-07-10 10:02:32 +02:00
parent f77cde3eeb
commit a015be2d26

View File

@@ -447,6 +447,10 @@ the *modulefile* is being loaded.
*modulefiles* from the directory will be returned. The parameter
*modulefile* may also be a symbolic modulefile name or a modulefile alias.
This command only returns the name and version of designated loaded module.
The defined variants of the loaded module are not included in the returned
string.
.. only:: html
.. versionadded:: 4.1
@@ -466,6 +470,11 @@ the *modulefile* is being loaded.
*modulefile*. See the `Modules Variables`_ section for information on the
full pathname.
This command only returns the name and version of currently evaluating
*modulefile*. The defined variants are not included in the returned string.
See :mfcmd:`getvariant` command or :mfvar:`ModuleVariant` array variable to
get defined variant values for currently evaluating *modulefile*.
**module-info shell** [shellname]
Return the current shell under which :file:`modulecmd.tcl` was invoked if
@@ -493,7 +502,8 @@ the *modulefile* is being loaded.
**module-info specified**
Return the name of the *modulefile* specified on the command line.
Return the module designation (name, version and variants) specified that
led to current *modulefile* evaluation.
**module-info symbols** modulefile
@@ -508,6 +518,9 @@ the *modulefile* is being loaded.
strings if no *tag* name is given (see :ref:`Module tags` section in
:ref:`module(1)`)
When tags are assigned to specific module variants, they are returned only
if this variant is the one currently evaluated.
Returns ``1`` if one of the tags applying to currently evaluated
*modulefile* is *tag*. Returns ``0`` otherwise.