[LTP] [PATCH 1/1] Tiny doc fixes

[Petr Vorel]

Hi!

> > --- a/doc/test-writing-guidelines.txt
> > +++ b/doc/test-writing-guidelines.txt
> > @@ -260,7 +260,7 @@ static void setup(void)
> >  		tst_brk(TBROK | TERRNO, "setenv() failed");
> >  }

> > -static void test(void)
> > +static void do_test(void)
> >  {
> >  	char *ret;

> > @@ -289,7 +289,7 @@ next:

> >  static struct tst_test test = {
> >  	.tid = "getenv01",
> > -	.test_all = test,
> > +	.test_all = do_test,
> >  	.setup = setup,
> >  };

> What is wrong with this one?
Name collision (function test and struct test). I know, it's just a doc...

> And even if we decide to change the function name, we should fix it in
> the text as well:

> -The test itself is done in the 'test()' function. The test function must work
> +The test itself is done in the 'do_test()' function. The test function must work
Sorry, it seems I can't do search and replace :-(.

> >  -------------------------------------------------------------------------------
> > diff --git a/lib/tst_test.c b/lib/tst_test.c
> > index 06f0339..f592aa5 100644
> > --- a/lib/tst_test.c
> > +++ b/lib/tst_test.c
> > @@ -333,7 +333,7 @@ static struct option {
> >  } options[] = {
> >  	{"h",  "-h       Prints this help"},
> >  	{"i:", "-i n     Execute test n times"},
> > -	{"I:", "-I x     Execute test for n seconds"},
> > +	{"I:", "-I n     Execute test for n seconds"},
> >  	{"C:", "-C ARG   Run child process with ARG arguments (used internally)"},
> >  };

> This one is OK.

> > diff --git a/tools/netpipe-2.4/netpipe.sh b/tools/netpipe-2.4/netpipe.sh
> > index f1445a3..9827e1e 100644
> > --- a/tools/netpipe-2.4/netpipe.sh
> > +++ b/tools/netpipe-2.4/netpipe.sh
> > @@ -17,7 +17,7 @@
> >  #    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

> >  #   FILE        : netpipe.sh
> > -#   DESCRIPTION : a simple infinite loop of NPtcp for use in runalltests.sh
> > +#   DESCRIPTION : a simple infinite loop of NPtcp
> >  #   HISTORY     :
> >  #       02/05/2003 Robbie Williamson (robbiew@austin.ibm.com)
> >  #               written

> This will likely get removed next week, see the:

> "[RFC] Cleanup of tools/ directory" email I've send earlier, so I would
> not bother with this one.
OK. I'll read mailing list more carefully :-).

Petr
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: not available
URL: <http://lists.linux.it/pipermail/ltp/attachments/20161115/516b59c8/attachment-0001.sig>