module-selection-contexts.rst (modules-5.1.1.tar.bz2) | : | module-selection-contexts.rst (modules-5.2.0.tar.bz2) | ||
---|---|---|---|---|
skipping to change at line 17 | skipping to change at line 17 | |||
.. _module_identification_to_select_one_module: | .. _module_identification_to_select_one_module: | |||
Module identification to select one module | Module identification to select one module | |||
------------------------------------------ | ------------------------------------------ | |||
- specification expresses exactly one module | - specification expresses exactly one module | |||
- must qualify version to select in case a module has multiple versions | - must qualify version to select in case a module has multiple versions | |||
- expression may | - expression may | |||
- be absolute like *mod/version* | - be absolute like *mod/version* | |||
- be relative to the modulefile currently being evaluated like *./version* o | - be relative to the modulefile currently being evaluated like *./version* or | |||
r */version* | */version* | |||
- refer to symbolic version or module alias | - refer to symbolic version or module alias | |||
- specification used to resolve argument passed to the following commands: | - specification used to resolve argument passed to the following commands: | |||
- ``module-version`` | - ``module-version`` | |||
- ``module-alias`` | - ``module-alias`` | |||
- ``module-virtual`` (cannot use symbolic version or module alias, should de | - ``module-virtual`` (cannot use symbolic version or module alias, should defi | |||
fine an actual module) | ne an actual module) | |||
- ``module-info symbols`` | - ``module-info symbols`` | |||
- ``module-info version`` | - ``module-info version`` | |||
- ``module-info loaded`` | - ``module-info loaded`` | |||
- relies on ``getModuleNameVersion`` procedure to get absolute name | - relies on ``getModuleNameVersion`` procedure to get absolute name | |||
.. _module_version_specification_to_return_all_matching_modules: | .. _module_version_specification_to_return_all_matching_modules: | |||
Module version specification to return all matching modules | Module version specification to return all matching modules | |||
----------------------------------------------------------- | ----------------------------------------------------------- | |||
- specification expresses one or multiple modules | - specification expresses one or multiple modules | |||
- expression may | - expression may | |||
- be absolute like *mod/version* | - be absolute like *mod/version* | |||
- refer to implicit or explicitly defined default version like *mod* | - refer to implicit or explicitly defined default version like *mod* | |||
- refer to extended default version like *mod/1* (to refer to *mod/1.1.1*) | - refer to extended default version like *mod/1* (to refer to *mod/1.1.1*) | |||
- refer to symbolic version or module alias | - refer to symbolic version or module alias | |||
- specify multiple versions as list (*mod@1,2*) or range (*mod@:1* or *mod@1 | - specify multiple versions as list (*mod@1,2*) or range (*mod@:1* or *mod@1:2 | |||
:2*) | *) | |||
- all modules matching specification are retrieved with ``getModules`` | - all modules matching specification are retrieved with ``getModules`` | |||
- specification used to resolve argument passed to the following commands: | - specification used to resolve argument passed to the following commands: | |||
- ``avail`` | - ``avail`` | |||
- ``paths`` | - ``paths`` | |||
- ``whatis`` | - ``whatis`` | |||
- used to get all alias and symbolic version of loaded modules treated by: | - used to get all alias and symbolic version of loaded modules treated by: | |||
- ``list`` | - ``list`` | |||
- used to get all existing aliases and symbolic version (no module specification ) by: | - used to get all existing aliases and symbolic version (no module specification ) by: | |||
- ``aliases`` | - ``aliases`` | |||
- used to get all existing modulefiles (no module specification) by: | - used to get all existing modulefiles (no module specification) by: | |||
- ``search`` | - ``search`` | |||
.. _module_version_specification_to_select_one_module: | .. _module_version_specification_to_select_one_module: | |||
Module version specification to select one module | Module version specification to select one module | |||
------------------------------------------------- | ------------------------------------------------- | |||
- specification expresses one or multiple modules | - specification expresses one or multiple modules | |||
- relies on the module version specification to return all matching modules | - relies on the module version specification to return all matching modules | |||
- then among matching modules, one is selected with ``getPathToModule``: | - then among matching modules, one is selected with ``getPathToModule``: | |||
- the one set has the default version (also called the explicit default vers | - the one set has the default version (also called the explicit default versio | |||
ion) | n) | |||
- or the highest version in case no explicit default is found among results | - or the highest version in case no explicit default is found among results (a | |||
(also called the implicit default version) | lso called the implicit default version) | |||
- nothing is returned in case no explicit default is found among matching mo | - nothing is returned in case no explicit default is found among matching modu | |||
dules and implicit default version mechanism is disabled | les and implicit default version mechanism is disabled | |||
- module selection may trigger another match retrieval | - module selection may trigger another match retrieval | |||
- for instance in case selection leads to an alias that resolves to a bare m odule name | - for instance in case selection leads to an alias that resolves to a bare mod ule name | |||
- specification used to resolve argument passed to the following commands: | - specification used to resolve argument passed to the following commands: | |||
- ``load`` | - ``load`` | |||
- ``unload`` (with attempt to match against loaded modules to resolve argume | - ``unload`` (with attempt to match against loaded modules to resolve argument | |||
nt) | ) | |||
- ``switch`` | - ``switch`` | |||
- ``help`` | - ``help`` | |||
- ``test`` | - ``test`` | |||
- ``display`` | - ``display`` | |||
- ``path`` | - ``path`` | |||
- ``is-avail`` | - ``is-avail`` | |||
- used to resolve aliases or symbolic versions treated by following commands: | - used to resolve aliases or symbolic versions treated by following commands: | |||
- ``paths`` | - ``paths`` | |||
- ``search`` | - ``search`` | |||
.. _module_version_specification_to_check_compatibility: | .. _module_version_specification_to_check_compatibility: | |||
Module version specification to check compatibility | Module version specification to check compatibility | |||
--------------------------------------------------- | --------------------------------------------------- | |||
- specification expresses one or multiple modules | - specification expresses one or multiple modules | |||
- expression may | - expression may | |||
- be absolute like *mod/version* | - be absolute like *mod/version* | |||
- refer to implicit or explicitly defined default version like *mod* | - refer to implicit or explicitly defined default version like *mod* | |||
- refer to extended default version like *mod/1* (to refer to *mod/1.1.1*) | - refer to extended default version like *mod/1* (to refer to *mod/1.1.1*) | |||
- refer to symbolic version or module alias | - refer to symbolic version or module alias | |||
- specify multiple versions as list (*mod@1,2*) or range (*mod@:1* or *mod@1 | - specify multiple versions as list (*mod@1,2*) or range (*mod@:1* or *mod@1:2 | |||
:2*) | *) | |||
- version specification is matched against loaded or loading modules with variet y of procedures: | - version specification is matched against loaded or loading modules with variet y of procedures: | |||
- ``getLoadedMatchingName`` | - ``getLoadedMatchingName`` | |||
- ``getLoadedWithClosestName`` | - ``getLoadedWithClosestName`` | |||
- ``isModuleEvaluated`` | - ``isModuleEvaluated`` | |||
- specification used to resolve argument passed to the following commands: | - specification used to resolve argument passed to the following commands: | |||
- ``is-loaded`` | - ``is-loaded`` | |||
- ``info-loaded`` | - ``info-loaded`` | |||
- ``prereq`` | - ``prereq`` | |||
- ``conflict`` | - ``conflict`` | |||
- for prereq command when version specification does not have a match among load ed or loading modules | - for prereq command when version specification does not have a match among load ed or loading modules | |||
- version specification is used to select one module per module specificatio | - version specification is used to select one module per module specification | |||
n | - for instance ``prereq mod@:1.8 mod@1.10`` triggers load tentative of default | |||
- for instance ``prereq mod@:1.8 mod@1.10`` triggers load tentative of defau | version among *mod@:1.8* then if this tentative fails load of *mod@1.10* is att | |||
lt version among *mod@:1.8* then if this tentative fails load of *mod@1.10* is a | empted | |||
ttempted | - another example with ``prereq mod mod@1.10``, which triggers load tentative | |||
- another example with ``prereq mod mod@1.10``, which triggers load tentativ | of *mod/default* then if it fails load of mod@1.10 is attempted | |||
e of *mod/default* then if it fails load of mod@1.10 is attempted | ||||
.. vim:set tabstop=2 shiftwidth=2 expandtab autoindent: | ||||
End of changes. 15 change blocks. | ||||
54 lines changed or deleted | 54 lines changed or added |