envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-14 00:42:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: clarify hidden module location in modulefile.4

Browse Source
This commit is contained in:
Xavier Delaruelle
2020-03-28 16:44:44 +01:00
parent 2273640cd5
commit bb2c0960ba
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/modulefile.rst
View File

@@ -656,12 +656,16 @@ be adapted to the rights the user has been granted. Exception is made when
trying to directly access a directory or a *modulefile*. In this case,
the access issue is returned as an error message.
A *modulefile* whose name or element in its name starts with a ``.`` (dot) is
considered hidden. Hidden *modulefile* is not displayed or taken into account
except if it is explicitly named. By inheritance, a symbolic version-name
assigned to a hidden *modulefile* is displayed or taken into account only
if explicitly named. Module alias targeting a hidden *modulefile* appears
like any other module alias.
A *modulefile*, virtual module, module alias or symbolic version whose name or
element in their name starts with a ``.`` (dot) are considered hidden. Hidden
*modulefile*, virtual module, module alias or symbolic version are not
displayed or taken into account except if they are explicitly named. By
inheritance, a symbolic version-name assigned to a hidden *modulefile*,
virtual module or module alias is displayed or taken into account only
if explicitly named. Non-hidden module alias targeting a hidden *modulefile*
appears like any other non-hidden module alias. Finally, a hidden symbolic
version targeting a non-hidden module will be displayed along its non-hidden
target.
Advanced module version specifiers