From 34572fc589bd7bfe0bf7f285bc783b9dbd9dbf56 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Fri, 27 Dec 2024 10:01:19 +0100 Subject: [PATCH] doc: desc. spider_indepth config in man/changes Signed-off-by: Xavier Delaruelle --- doc/source/changes.rst | 3 ++- doc/source/module.rst | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 0f2725ad..cdcba290 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -1232,7 +1232,8 @@ The following Modules configuration option has been introduced on Modules 5. | 5.5 | :mconfig:`hide_auto_loaded`, :mconfig:`logger`, | | | :mconfig:`logged_events`, :mconfig:`conflict_unload` | +------------+-----------------------------------------------------------------+ -| 5.6 | :mconfig:`spider_output`, :mconfig:`spider_terse_output` | +| 5.6 | :mconfig:`spider_output`, :mconfig:`spider_terse_output`, | +| | :mconfig:`spider_indepth` | +------------+-----------------------------------------------------------------+ :mconfig:`auto_handling` diff --git a/doc/source/module.rst b/doc/source/module.rst index ebcbc72d..87810c63 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -1511,6 +1511,22 @@ Module Sub-Commands .. versionadded:: 5.4 + .. mconfig:: spider_indepth + + :subcmd:`spider` sub-command in depth search mode. + + Default value is ``1``. It can be changed at installation time with + :instopt:`--disable-spider-indepth<--enable-spider-indepth>` option. The + :envvar:`MODULES_SPIDER_INDEPTH` environment variable is defined by + :subcmd:`config` sub-command when changing this configuration option from + its default value. The :option:`--indepth` and :option:`--no-indepth` + command line switches change the value of this configuration option. See + :envvar:`MODULES_SPIDER_INDEPTH` description for details. + + .. only:: html + + .. versionadded:: 5.6 + .. mconfig:: spider_output Content to report in addition to module names on :subcmd:`spider`