doc: Mention network tests in variables
PATCH 1/1 doc: Mention network tests in variables
---
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.
Kind regards,
Petr
doc/test-writing-guidelines.txt | 3 +++ 1 file changed, 3 insertions(+)
doc/test-writing-guidelines.txt +3 -0
@@ -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 +++++++++++++++++++++++++++++++++
Signature · 1 line
2.22.0
PATCH 1/1 doc: Mention network tests in variables
Hi!
Quoted 8 lines
Signed-off-by Petr Vorel <[email protected]>---
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):
Quoted 8 lines
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.
Quoted 17 lines
doc/test-writing-guidelines.txt +3
-0@@ -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 +++++++++++++++++++++++++++++++++Signature · 1 line
2.22.0
Signature · 2 lines
Cyril Hrubis [email protected]
PATCH 1/1 doc: Mention network tests in variables
Hi,
Quoted 8 lines
Quoted 7 lines
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)
Quoted 6 lines
Quoted 4 lines
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...
It works when using '../../blob/master/testcases/network/README.md' works, see [1] :).
Quoted 2 lines
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.
But unless Alexey objects, I'd be also for plain text version.
Kind regards,
Petr
PATCH 1/1 doc: Mention network tests in variables
Hi,
merged.
Kind regards,
Petr