Deduplicates discover information

Currently, the documentation about discover is duplicated in someway between the specification and the plugin section. Adds the missing information into the plugin section as it will be the primary source. Signed-off-by: mcasquer <[email protected]>
teemtee · Oct 23, 2024 · f467ba5 · f467ba5
1 parent b058850
commit f467ba5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 14 deletions.
diff --git a/tmt/steps/discover/fmf.py b/tmt/steps/discover/fmf.py
@@ -215,7 +215,7 @@ class DiscoverFmf(tmt.steps.discover.DiscoverPlugin[DiscoverFmfStepData]):
     If no ``ref`` is provided, the default branch from the origin is used.
 
     For DistGit repo one can extract sources first and discover
-    tests from it by using ``distgit-source: true`` later in Prepare step.
+    tests from it by using ``dist-git-source: true`` later in ``prepare`` step.
     It can be used together with ``ref``, ``path`` and ``url``,
     however ``ref`` is not possible without using ``url``.
 
@@ -225,17 +225,6 @@ class DiscoverFmf(tmt.steps.discover.DiscoverPlugin[DiscoverFmfStepData]):
             how: fmf
             dist-git-source: true
 
-    Related config options (all optional):
-
-    * ``dist-git-merge`` - set to ``true`` if you want to copy in extracted
-      sources to the local repo
-    * ``dist-git-init`` - set to ``true`` and ``fmf init`` will be called inside
-      extracted sources (at ``dist-git-extract`` or top directory)
-    * ``dist-git-extract`` - directory (glob supported) to copy from
-      extracted sources (defaults to inner fmf root)
-    * ``dist-git-remove-fmf-root`` - set to ``true`` to remove fmf root from
-      extracted sources
-
     Selecting tests containing specified link is possible using ``link``
     key accepting ``RELATION:TARGET`` format of values. Regular
     expressions are supported for both relation and target part of the

diff --git a/tmt/steps/discover/shell.py b/tmt/steps/discover/shell.py
@@ -215,8 +215,10 @@ class DiscoverShell(tmt.steps.discover.DiscoverPlugin[DiscoverShellData]):
     Use provided list of shell script tests.
 
     List of test cases to be executed can be defined manually directly
-    in the plan as a list of dictionaries containing test name, actual
-    test script and optionally a path to the test. Example config:
+    in the plan as a list of dictionaries containing ``test name``, actual
+    ``test script`` and optionally the ``duration`` or a ``path`` to the test.
+    The default duration for tests defined directly in the discover step is ``1h``.
+    Example config:
 
     .. code-block:: yaml