envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-05-30 00:12:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: desc --enable-spider-indepth in INSTALL

Browse Source 
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
This commit is contained in:
Xavier Delaruelle
2024-12-27 09:59:10 +01:00
parent 90f40bc01e
commit 1077948b7e
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
INSTALL.rst
View File

@@ -748,6 +748,22 @@ instance :instopt:`--disable-set-manpath<--enable-set-manpath>`):
.. versionadded:: 5.4
.. instopt:: --enable-spider-indepth
When performing an :subcmd:`spider` sub-command, include in search results
the matching modulefiles and directories and recursively the modulefiles and
directories contained in these matching directories when enabled or limit
search results to the matching modulefiles and directories found at the depth
level expressed by the search query if disabled. (default=yes)
This installation option defines the default value of the
:mconfig:`spider_indepth` configuration option which could be changed after
installation with the :subcmd:`config` sub-command.
.. only:: html
.. versionadded:: 5.6
.. instopt:: --enable-versioning
Append Modules version to installation prefix and deploy a ``versions``
@@ -1627,6 +1643,10 @@ installation.
| :mconfig:`source_cache` | ``0`` | :instopt:`--enable-source-cache`, | | |
| | | :envvar:`MODULES_SOURCE_CACHE` | | |
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
| :mconfig:`spider_indepth` | ``1`` | :instopt:`--enable-spider-indepth`, | | |
| | | :envvar:`MODULES_SPIDER_INDEPTH`, | | |
| | | :option:`--indepth`, :option:`--no-indepth` | | |
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
| :mconfig:`spider_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-spider-output`, | | |
| | variantifspec:key | :envvar:`MODULES_SPIDER_OUTPUT`, | | |
| | | :option:`--output` | | |