[LTP] [PATCH v2 05/11] syscalls: Add a few documentation comments
Cyril Hrubis
chrubis@suse.cz
Thu Nov 5 13:48:10 CET 2020
Hi!
> > + * [DESCRIPTION]
> > + * Checks that process which called abort() gets killed by SIGIOT
> > and dumps core.
>
> ...
>
> > +/*\
> > + * [DOCUMENTATION]
> > + * Verify that acct() returns proper errno on failure.
> > +\*/
> > +
>
> I noticed that in some places the DESCRIPTION tag is used and in
> another DOCUMENTATION. What is the difference between the two and which
> should be used when?
This is one of the open points at the moment. The exact format of the
test description needs to be decided on and written down.
However I wanted to get the code reviewed and included in upstream even
though there are a few loose ends since it's complex enough as it is and
the detail can be worked on later. Especially since I want to make use
of the metadata for parallel test execution and the documentation part
is not that important there.
--
Cyril Hrubis
chrubis@suse.cz
More information about the ltp
mailing list