[LTP] [PATCH 3/9] doc: Clarify API coverage and navigation

[Andrea Cervesato <andrea.cervesato@suse.de>]

From: Andrea Cervesato <andrea.cervesato@suse.com>

Add the testers guide description to the user documentation index.
Expand the network API page stub with single-host and two-host
overviews and references. Clarify the legacy shell API comparison table
and add the missing needs_cpu_vendor field.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 doc/developers/api_network_tests.rst | 30 +++++++++++++++++++++++++++---
 doc/developers/writing_tests.rst     |  8 ++++++++
 doc/index.rst                        |  3 +++
 3 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/doc/developers/api_network_tests.rst b/doc/developers/api_network_tests.rst
index 3e487d7f2..6b93bce26 100644
--- a/doc/developers/api_network_tests.rst
+++ b/doc/developers/api_network_tests.rst
@@ -1,7 +1,31 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
-.. Include headers in this file with:
-.. .. kernel-doc:: ../../include/tst_test.h
-
 Developing using network API
 ============================
+
+Overview
+--------
+
+LTP network tests support both single-host and two-host test configurations.
+Network stress tests and environment parameters are defined in
+:shell_lib:`tst_net.sh` and documented in
+:master:`testcases/network/README.md`.
+
+Single-host configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Single-host is the default configuration when the ``RHOST`` environment
+variable is not defined. LTP creates an ``ltp_ns`` network namespace and
+configures a ``veth`` pair according to LTP network environment variables.
+
+Two-host configuration
+~~~~~~~~~~~~~~~~~~~~~~
+
+This setup requires the ``RHOST`` environment variable to be set to the
+hostname or IP address of the remote test machine, along with passwordless
+SSH access configured for root. Both machines must have LTP installed in
+the same location.
+
+For more details on network test setup, server service dependencies, and
+running the tests with ``network.sh``, see
+:master:`testcases/network/README.md`.
diff --git a/doc/developers/writing_tests.rst b/doc/developers/writing_tests.rst
index 0edf101ff..9a56c0265 100644
--- a/doc/developers/writing_tests.rst
+++ b/doc/developers/writing_tests.rst
@@ -360,6 +360,11 @@ check :master:`.github/workflows/ci-docker-build.yml`.
 LTP C And Shell Test API Comparison
 -----------------------------------
 
+This table compares :c:struct:`tst_test` members in the C API with
+corresponding ``$TST_*`` variables in the legacy :shell_lib:`tst_test.sh`
+shell API. For tests using the new shell loader library, see
+:doc:`api_shell_tests`.
+
 .. list-table::
     :header-rows: 1
 
@@ -440,6 +445,9 @@ LTP C And Shell Test API Comparison
     * - .needs_cmds
       - TST_NEEDS_CMDS
 
+    * - .needs_cpu_vendor
+      - \-
+
     * - .needs_devfs
       - \-
 
diff --git a/doc/index.rst b/doc/index.rst
index 58944a72d..5f886eed2 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -53,6 +53,9 @@ For users
 :doc:`users/setup_tests`
    How to set up tests execution
 
+:doc:`users/testers_guide`
+   Guidelines and considerations when testing the Linux kernel with LTP
+
 :doc:`users/supported_systems`
    A list of supported technologies by the LTP framework
 

-- 
2.51.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp