[LTP] [PATCH] doc: Mention network tests in variables

Cyril Hrubis
2019-07-18T09:29:11Z

Hi!
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Hi,
>
> I'd prefer using hyperlinks in docs (as it's supposed to be viewed
> mainly in a browser) but these are the only variants (which looks too
> ugly to me):
>
> NOTE: link:../../blob/master/testcases/network/README.md[Network tests] use additional variables
> in 'tst_net.sh'.
> (this one at least keeps links to forks)
>
> NOTE: https://github.com/linux-test-project/ltp/blob/master/testcases/network/README.md[Network tests] use additional variables
> in 'tst_net.sh'.
>
> => I'd be for giving up links.

Given that test-writing-guidelines text is also on the LTP wiki the first one would not work anyways...

So yes I do agree that pointing out people to the relative location of
the README.md is probably the best we can do, acked.

> diff --git a/doc/test-writing-guidelines.txt b/doc/test-writing-guidelines.txt
> index 869e6ed35..e59d72065 100644
> --- a/doc/test-writing-guidelines.txt
> +++ b/doc/test-writing-guidelines.txt
> @@ -1883,6 +1883,9 @@ simply by setting right '$TST_NEEDS_FOO'.
> | 'TST_NEEDS_DRIVERS'| Checks kernel drivers support for the test.
> |=============================================================================
>
> +NOTE: Network tests (see testcases/network/README.md) use additional variables
> +in 'tst_net.sh'.
> +
> Checking for presence of commands
> +++++++++++++++++++++++++++++++++
>
> --
> 2.22.0
>

--
Cyril Hrubis
chrubis@suse.cz