package provides for the dynamic modification of a user’s environment via modulefiles.
| advanced-module-version-specifiers.rst (modules-5.1.1.tar.bz2) | : | advanced-module-version-specifiers.rst (modules-5.2.0.tar.bz2) |
|---|
| .. _advanced-module-version-specifiers: | | .. _advanced-module-version-specifiers: |
| | |
| Advanced module version specifiers | | Advanced module version specifiers |
| ================================== | | ================================== |
| | |
| Configuration | | Configuration |
| ------------- | | ------------- |
| | |
| - Introduce :mconfig:`advanced_version_spec` option name | | - Introduce :mconfig:`advanced_version_spec` option name |
| | |
|
| - off by default in v4 as previously *soft@1* could be a module name | | - off by default in v4 as previously *soft@1* could be a module name |
| - on by default in v5 | | - on by default in v5 |
| - in case :mconfig:`extended_default` is disabled | | - in case :mconfig:`extended_default` is disabled |
| | |
|
| - means short-hand notation cannot be used | | - means short-hand notation cannot be used |
| | |
|
| - for soft/1.1 query soft@1 returns nothing | | - for soft/1.1 query soft@1 returns nothing |
| | |
|
| - in case :mconfig:`implicit_default` is disabled | | - in case :mconfig:`implicit_default` is disabled |
| | |
|
| - means a default should be found over version range or list in selectio
n context | | - means a default should be found over version range or list in selection co
ntext |
| | |
| Specification | | Specification |
| ------------- | | ------------- |
| | |
| - Following Spack spec | | - Following Spack spec |
| | |
|
| - see https://github.com/spack/spack/blob/develop/lib/spack/spack/spec.py | | - see https://github.com/spack/spack/blob/develop/lib/spack/spack/spec.py |
| - or https://spack.readthedocs.io/en/latest/basic_usage.html#version-specifi | | - or https://spack.readthedocs.io/en/latest/basic_usage.html#version-specifier |
| er | | - this specs covers all needs to specify module versions finely |
| - this specs covers all needs to specify module versions finely | | - Spack users are already familiar with it |
| - Spack users are already familiar with it | | - it copes very well with command-line typing, avoiding most problematic chara |
| - it copes very well with command-line typing, avoiding most problematic cha | | cters |
| racters | | |
| | |
|
| - that are interpreted by shells (like < or >) | | - that are interpreted by shells (like < or >) |
| | |
|
| - specification for one module could | | - specification for one module could |
| | |
|
| - be almost condensed into one word "soft@1.8:" | | - be almost condensed into one word "soft@1.8:" |
| - or be expanded into multiple "soft @1.8:" | | - or be expanded into multiple "soft @1.8:" |
| | |
| - same grammar used whatever the context | | - same grammar used whatever the context |
| | |
|
| - command-line or as argument to modulefile command (like command) | | - command-line or as argument to modulefile command (like command) |
| | |
| - versions are specified whether | | - versions are specified whether |
| | |
|
| - as specific words (separated by " ") | | - as specific words (separated by " ") |
| - or as suffix to module name | | - or as suffix to module name |
| | |
| - change command specifications which were previously accepting list of modules | | - change command specifications which were previously accepting list of modules |
| | |
|
| - like *module1 module2/vers module3* | | - like *module1 module2/vers module3* |
| - now these modules could express versions appended to their name with *@* | | - now these modules could express versions appended to their name with *@* |
| | |
|
| - like *module1@1.8 module2@vers module3* | | - like *module1@1.8 module2@vers module3* |
| | |
|
| - or these versions could be defined as words next to module name | | - or these versions could be defined as words next to module name |
| | |
|
| - like *module1@1.8 module2 @vers module3* | | - like *module1@1.8 module2 @vers module3* |
| | |
|
| - as a consequence, it denies use of *@* in module names | | - as a consequence, it denies use of *@* in module names |
| - such change requires an option to be enabled to avoid breaking compat | | - such change requires an option to be enabled to avoid breaking compat |
| | |
| - single version could be specified with soft@vers | | - single version could be specified with soft@vers |
| | |
|
| - which matches *soft/vers* modulefile | | - which matches *soft/vers* modulefile |
| | |
| - version could be specified as range | | - version could be specified as range |
| | |
|
| - *soft@:vers* or *soft@vers:* or *soft@vers1:vers2* | | - *soft@:vers* or *soft@vers:* or *soft@vers1:vers2* |
| - Tcl-dictionarily determine what is between specified range | | - Tcl-dictionarily determine what is between specified range |
| - ``extended_default`` is always considered *on* when matching range | | - ``extended_default`` is always considered *on* when matching range |
| | |
|
| - as *2.10* is included in *@1:3* whatever the configuration | | - as *2.10* is included in *@1:3* whatever the configuration |
| | |
|
| - to be specified in a range or compared to a range, version major element s
hould match an hexadecimal number | | - to be specified in a range or compared to a range, version major element sho
uld match an hexadecimal number |
| | |
|
| - which also means be only composed by [0-9af] characters | | - which also means be only composed by [0-9af] characters |
| - for instance *10a*, *1.2.3*, *1.foo*, *10.2.good* are versions valid f | | - for instance *10a*, *1.2.3*, *1.foo*, *10.2.good* are versions valid for r |
| or range comparison | | ange comparison |
| - but *10g*, *default*, *foo.2*, *.1.3.4* are versions invalid for range | | - but *10g*, *default*, *foo.2*, *.1.3.4* are versions invalid for range com |
| comparison | | parison |
| | |
|
| - a version range using in its definition version invalid for range comparis
on raises error | | - a version range using in its definition version invalid for range comparison
raises error |
| | |
|
| - for instance *@bar:foo* | | - for instance *@bar:foo* |
| | |
|
| - existing module versions invalid for range comparison are ignored | | - existing module versions invalid for range comparison are ignored |
| | |
|
| - which means versions *10g*, *default*, *.1.13.4* or *new* are excluded
from result for a *@1.10:* range query | | - which means versions *10g*, *default*, *.1.13.4* or *new* are excluded fro
m result for a *@1.10:* range query |
| | |
|
| - when range is defined as *@major:major.minor*, version matching *major* ve
rsion but above *major.minor* are excluded | | - when range is defined as *@major:major.minor*, version matching *major* vers
ion but above *major.minor* are excluded |
| | |
|
| - for instance *@1:1.10* will matches *1.0* and *1.8* but not *1.12* | | - for instance *@1:1.10* will matches *1.0* and *1.8* but not *1.12* |
| | |
| - version could be specified as list | | - version could be specified as list |
| | |
|
| - soft@vers,vers,vers | | - soft@vers,vers,vers |
| - version specified could be text, like if symbolic version names are used | | - version specified could be text, like if symbolic version names are used |
| - should benefit from extended default specification | | - should benefit from extended default specification |
| | |
|
| - to just express version with their major release number for instance | | - to just express version with their major release number for instance |
| | |
|
| - an empty string among list is considered as a specification error | | - an empty string among list is considered as a specification error |
| | |
|
| - for instance *soft@vers,vers,* or *soft@vers,,vers* | | - for instance *soft@vers,vers,* or *soft@vers,,vers* |
| | |
|
| - any version in list can be a single version or a version range | | - any version in list can be a single version or a version range |
| | |
|
| - like *soft@1.2,1.4:1.6,1.8* | | - like *soft@1.2,1.4:1.6,1.8* |
| - helps to designate all versions except a few ones | | - helps to designate all versions except a few ones |
| | |
| - when using extended default syntax | | - when using extended default syntax |
| | |
|
| - version selection is performed same way for *@vers* than for */vers* | | - version selection is performed same way for *@vers* than for */vers* |
| - described in extended default design | | - described in extended default design |
| | |
| - when :mconfig:`icase` is enabled for selection context and multiple directorie
s match module name | | - when :mconfig:`icase` is enabled for selection context and multiple directorie
s match module name |
| | |
|
| - for instance query is *ICase@1.1,1.2,1.4* and following modules exist: *IC | | - for instance query is *ICase@1.1,1.2,1.4* and following modules exist: *ICAS |
| ASE/1.1*, *icase/1.2*, *iCaSe/1.3* and *iCaSe/1.4* | | E/1.1*, *icase/1.2*, *iCaSe/1.3* and *iCaSe/1.4* |
| - as no *ICase* directory exists, and a version in highest directory *icase* | | - as no *ICase* directory exists, and a version in highest directory *icase* m |
| matches query (*1.2*), *icase/1.2* is returned | | atches query (*1.2*), *icase/1.2* is returned |
| - if query is *iCaSe@1.1,1.2,1.4*, *iCaSe/1.4* will be selected as *iCaSe* d | | - if query is *iCaSe@1.1,1.2,1.4*, *iCaSe/1.4* will be selected as *iCaSe* dir |
| irectory matches query module name | | ectory matches query module name |
| - if query is *ICase@1.1,1.4* or *icase@1.1,1.4*, as no version match in hig | | - if query is *ICase@1.1,1.4* or *icase@1.1,1.4*, as no version match in highe |
| hest directory *iCaSe/1.4* will be selected | | st directory *iCaSe/1.4* will be selected |
| | |
| - in case of deep modulefiles | | - in case of deep modulefiles |
| | |
|
| - specified version is matched at the level directly under specified module
name | | - specified version is matched at the level directly under specified module na
me |
| | |
|
| - not below levels | | - not below levels |
| - for instance soft@vers, will match *soft/vers*, not *soft/deep/vers* | | - for instance soft@vers, will match *soft/vers*, not *soft/deep/vers* |
| - to specify version for deep modules:*"soft/deep@vers* | | - to specify version for deep modules:*"soft/deep@vers* |
| - to ease version comparison deep version cannot be specified after the | | - to ease version comparison deep version cannot be specified after the *@* |
| *@* character like *soft@deep/vers* | | character like *soft@deep/vers* |
| | |
|
| - such specification will raise an error | | - such specification will raise an error |
| | |
| - advanced version specifier cannot be used with full path modulefile | | - advanced version specifier cannot be used with full path modulefile |
| | |
|
| - when a full path modulefile is specified any advanced version set afterwar | | - when a full path modulefile is specified any advanced version set afterward |
| d is treated literally | | is treated literally |
| - for instance */path/to/modulefiles/mymod@1.2* will lead to the access of f | | - for instance */path/to/modulefiles/mymod@1.2* will lead to the access of fil |
| ile *mymod@1.2* in directory */path/to/modulefiles* | | e *mymod@1.2* in directory */path/to/modulefiles* |
| | |
| - in case version is specified multiple times | | - in case version is specified multiple times |
| | |
|
| - lastly mentioned (read from left to right) value is retained (it overwrite | | - lastly mentioned (read from left to right) value is retained (it overwrite p |
| previous values) | | revious values) |
| - like *module@1.8 @2.0* or *module@1.8@2.0* | | - like *module@1.8 @2.0* or *module@1.8@2.0* |
| - beware of version specified over a fully qualified modulefile like in *sof | | - beware of version specified over a fully qualified modulefile like in *soft/ |
| t/1.8@1.10" or "soft/1.8 @1.10* | | 1.8@1.10" or "soft/1.8 @1.10* |
| | |
|
| - it resolves to *soft/1.8/1.10* as advanced version specified is treate
d as an additional directory level | | - it resolves to *soft/1.8/1.10* as advanced version specified is treated as
an additional directory level |
| | |
| - in case modulefile is named *module@vers* in filesystem | | - in case modulefile is named *module@vers* in filesystem |
| | |
|
| - it is not found when option ``advanced_version_spec`` is enabled | | - it is not found when option ``advanced_version_spec`` is enabled |
| - as it is translated to *module/vers* | | - as it is translated to *module/vers* |
| | |
| - when special characters like *?* or \* are used in version name or value | | - when special characters like *?* or \* are used in version name or value |
| | |
|
| - they are evaluated as Tcl glob pattern on return all matching modules cont | | - they are evaluated as Tcl glob pattern on return all matching modules contex |
| ext | | t |
| - they are treated literally on single module selection and compatibility ch | | - they are treated literally on single module selection and compatibility chec |
| eck context, no wildcard meaning is applied | | k context, no wildcard meaning is applied |
| - like currently done when specifying module version on command-line | | - like currently done when specifying module version on command-line |
| | |
|
| - which leads to errors as no corresponding module is found:: | | - which leads to errors as no corresponding module is found:: |
| | |
|
| $ module load loc_dv6/* | | $ module load loc_dv6/* |
| ERROR: Unable to locate a modulefile for 'loc_dv6/*' | | ERROR: Unable to locate a modulefile for 'loc_dv6/*' |
| | |
| - if version range or list does not contain a defined default | | - if version range or list does not contain a defined default |
| | |
|
| - in a selection context | | - in a selection context |
| | |
|
| - highest version is returned if ``implicit_default`` is enabled | | - highest version is returned if ``implicit_default`` is enabled |
| - error returned if ``implicit_default`` is disabled | | - error returned if ``implicit_default`` is disabled |
| | |
|
| - even if version range or list specifies non-existent modules and o
nly one existent module | | - even if version range or list specifies non-existent modules and only on
e existent module |
| | |
|
| - in a compatibility expression context | | - in a compatibility expression context |
| | |
|
| - range or list is matched against loaded environment whether the ``impl | | - range or list is matched against loaded environment whether the ``implicit |
| icit_default`` state | | _default`` state |
| - when no match found and evaluation are triggered, selection context ap | | - when no match found and evaluation are triggered, selection context applie |
| plies | | s |
| | |
| - when version is specified over an alias | | - when version is specified over an alias |
| | |
|
| - should proceed like for real modulefile | | - should proceed like for real modulefile |
| - when alias equal to a bare module with no version | | - when alias equal to a bare module with no version |
| | |
|
| - foo is alias on bar modulefile, bar is a file (not a dir with version | | - foo is alias on bar modulefile, bar is a file (not a dir with version modu |
| modulefiles) | | lefiles) |
| - query alias@:2 should behave like query alias/2 | | - query alias@:2 should behave like query alias/2 |
| | |
|
| - when alias equal to a module/version modulefile | | - when alias equal to a module/version modulefile |
| | |
|
| - foo is alias on bar/3 modulefile | | - foo is alias on bar/3 modulefile |
| - query alias@:2 should behave like query alias/2 | | - query alias@:2 should behave like query alias/2 |
| | |
| - Contexts where it could be used | | - Contexts where it could be used |
| | |
|
| - :ref:`module_version_specification_to_return_all_matching_modules` | | - :ref:`module_version_specification_to_return_all_matching_modules` |
| - :ref:`module_version_specification_to_select_one_module` | | - :ref:`module_version_specification_to_select_one_module` |
| - :ref:`module_version_specification_to_check_compatibility` | | - :ref:`module_version_specification_to_check_compatibility` |
| | |
| .. note:: Advanced version specifier does not apply for the moment to the | | .. note:: Advanced version specifier does not apply for the moment to the |
| :ref:`module_identification_to_select_one_module` context. Adding support | | :ref:`module_identification_to_select_one_module` context. Adding support |
| for this context will require a significant rework on module alias and | | for this context will require a significant rework on module alias and |
| symbolic version registering and resolving code. | | symbolic version registering and resolving code. |
| | |
| - impact of advanced version specifier implementation over code | | - impact of advanced version specifier implementation over code |
| | |
|
| - question especially over :mconfig:`auto_handling` code like conflict and p | | - question especially over :mconfig:`auto_handling` code like conflict and pre |
| rereq handling | | req handling |
| - it should not impact triggers and actions | | - it should not impact triggers and actions |
| - but consist in an overall change of procedures comparing queries against l | | - but consist in an overall change of procedures comparing queries against loa |
| oaded environment | | ded environment |
| | |
|
| - procedures like ``doesModuleConflict`` | | - procedures like ``doesModuleConflict`` |
| | |
|
| - also adapting ``getModules`` to restrict version possibilities to what has
been specified | | - also adapting ``getModules`` to restrict version possibilities to what has b
een specified |
| | |
|
| - for instance with query *soft@1,2* should only return versions matchin
g | | - for instance with query *soft@1,2* should only return versions matching |
| | |
| - prereq/conflict persistency | | - prereq/conflict persistency |
| | |
|
| - ``LMPREREQ`` and ``LMCONFLICT`` content should reflect specified version c | | - ``LMPREREQ`` and ``LMCONFLICT`` content should reflect specified version con |
| onstraint | | straint |
| - it could be expressed in these variables somewhat like it is specified to | | - it could be expressed in these variables somewhat like it is specified to th |
| the | | e |
| | |
|
| - prereq/conflict modulefile commands | | - prereq/conflict modulefile commands |
| - for instance ``__MODULES_LMPREREQ=soft/1.10&bar@1.8,1.10&foo@<2|foo@3< | | - for instance ``__MODULES_LMPREREQ=soft/1.10&bar@1.8,1.10&foo@<2|foo@3<4`` |
| 4`` | | - delimiters characters are *:*, *&* and *|* |
| - delimiters characters are *:*, *&* and *|* | | |
| | |
|
| - so use of characters * *, *@*, *,* is not an issue | | - so use of characters * *, *@*, *,* is not an issue |
| - but for *:* which express version ranges it should be substituted | | - but for *:* which express version ranges it should be substituted to *<* |
| to *<* | | |
| | |
| - prereq/conflict specification | | - prereq/conflict specification |
| | |
|
| - could consolidate different version set for same module on the same prereq
/conflict list | | - could consolidate different version set for same module on the same prereq/c
onflict list |
| | |
|
| - to indicate a preferred order (if available) | | - to indicate a preferred order (if available) |
| - like ``prereq foo@1.8 foo@1.10`` | | - like ``prereq foo@1.8 foo@1.10`` |
| - or ``prereq foo @1.8 foo@1.10`` | | - or ``prereq foo @1.8 foo@1.10`` |
| | |
|
| - also to trigger alternative requirement resolution in case first one faile
d | | - also to trigger alternative requirement resolution in case first one failed |
| | |
|
| - as each module version specification leads to one evaluation only | | - as each module version specification leads to one evaluation only |
| | |
|
| - even if multiple modulefiles correspond to this specification | | - even if multiple modulefiles correspond to this specification |
| | |
|
| - like ``prereq soft@1.8,1.9,1.10`` will lead to *soft/1.10* loa
d | | - like ``prereq soft@1.8,1.9,1.10`` will lead to *soft/1.10* load |
| | |
|
| - best candidate is chosen from matches | | - best candidate is chosen from matches |
| | |
|
| - in case ``implicit_default`` is disabled an explicit default s
hould be part of the list or range for the triggered evaluation to succeed | | - in case ``implicit_default`` is disabled an explicit default should be
part of the list or range for the triggered evaluation to succeed |
| | |
|
| - whereas ``prereq soft@1.8 soft@1.9 soft@1.10`` will lead to a tentativ
e load | | - whereas ``prereq soft@1.8 soft@1.9 soft@1.10`` will lead to a tentative lo
ad |
| | |
|
| - of *soft/1.8*, then *soft/1.9* if it failed then *soft/1.8* if it
also failed | | - of *soft/1.8*, then *soft/1.9* if it failed then *soft/1.8* if it also f
ailed |
| | |
|
| - one module version specification may match multiple loaded modules | | - one module version specification may match multiple loaded modules |
| | |
|
| - like ``conflict soft@1.8,1.9,1.10`` matches loaded modules *soft/1.8* | | - like ``conflict soft@1.8,1.9,1.10`` matches loaded modules *soft/1.8* and |
| and *soft/1.10* | | *soft/1.10* |
| - similar to situations where requirement or conflict is expressed over | | - similar to situations where requirement or conflict is expressed over modu |
| module generic name, like *soft*, and multiple versions of module are loaded | | le generic name, like *soft*, and multiple versions of module are loaded |
| | |
| Corner cases | | Corner cases |
| ------------ | | ------------ |
| | |
| - When ``icase`` is enabled on all contexts and multiple directories match same
icase module name | | - When ``icase`` is enabled on all contexts and multiple directories match same
icase module name |
| | |
|
| - for instance following modules exist: *ICASE/1.1*, *icase/1.2*, *iCaSe/1.3 | | - for instance following modules exist: *ICASE/1.1*, *icase/1.2*, *iCaSe/1.3* |
| * and *iCaSe/1.4* | | and *iCaSe/1.4* |
| - a ``module avail -i icase`` will sort *iCaSe/1.4* as the highest entry | | - a ``module avail -i icase`` will sort *iCaSe/1.4* as the highest entry |
| - however a ``module load -i icase@1.1,1.2,1.4`` command will load *icase/1. | | - however a ``module load -i icase@1.1,1.2,1.4`` command will load *icase/1.2* |
| 2* | | |
| | |
|
| - as *icase* directory matches query and version *1.2* is found in *icas
e* directory | | - as *icase* directory matches query and version *1.2* is found in *icase* d
irectory |
| | |
|
| - but a ``module load -i icase@1.1,1.4`` command will load *iCaSe/1.4* | | - but a ``module load -i icase@1.1,1.4`` command will load *iCaSe/1.4* |
| | |
|
| - as no version *1.1* nor *1.4* is found in *icase* directory | | - as no version *1.1* nor *1.4* is found in *icase* directory |
| | |
| | .. vim:set tabstop=2 shiftwidth=2 expandtab autoindent: |
| | | |
| End of changes. 78 change blocks. |
|---|
| 154 lines changed or deleted | | 150 lines changed or added |
|---|
"Fossies" - the Fresh Open Source Software Archive 