| Message ID | 20190718092037.13594-1-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Delegated to: | Petr Vorel |
| Headers | show |
| Series | doc: Mention network tests in variables | expand |
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 >
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... It works when using '../../blob/master/testcases/network/README.md' works, see [1] :). > 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 [1] https://github.com/pevik/ltp/wiki/TEST
Hi, merged. Kind regards, Petr
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 +++++++++++++++++++++++++++++++++
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. Kind regards, Petr doc/test-writing-guidelines.txt | 3 +++ 1 file changed, 3 insertions(+)