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

[Petr Vorel <pvorel@suse.cz>]

Hi Andrea,

> +++ 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
Yeah, the docs is now kind of obvious.

> -
>  Developing using network API
>  ============================
> +
> +Overview
> +--------
> +
> +LTP network tests support both single-host and two-host test configurations.
nit: Maybe blank line here (it's own paragraph). But even this is going to lead
to duplicity (functionality described in both places).

> +Network stress tests and environment parameters are defined in
These variables are also for other network tests than just stress tests.

> +:shell_lib:`tst_net.sh` and documented in
> +:master:`testcases/network/README.md`.
The above is ok, but I would just point:

Network tests are documented in :master:`testcases/network/README.md`.
and delete the rest of the docs below ...

> +
> +Single-host configuration
> +~~~~~~~~~~~~~~~~~~~~~~~~~
... because this Single-host and Two-host related sections is a duplicity of
testcases/network/README.md. I'm ok to move testcases/network/README.md to
readthedocs, but it should not be on 2 places.  I recently spent time to remove
doc duplicity, because sooner or later one of them gets outdated, please don't
introduce it again.

The other unrelated changes are ok (feel free to add my RBT for them if in a
separate commit).

Kind regards,
Petr

> +
> +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`.
...

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