| Message ID | 20240620060203.558528-1-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/1] tst_test: Document @message, @scall, @sample | expand |
Hi, Reviewed-by: Avinesh Kumar <akumar@suse.de> On Thursday, June 20, 2024 8:02:03 AM GMT+2 you wrote: > All undocumented members are in the library "undescribed", > better to document the purpose. > > Signed-off-by: Petr Vorel <pvorel@suse.cz> > --- > include/tst_test.h | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/include/tst_test.h b/include/tst_test.h > index 8dc20d110..20960e9b9 100644 > --- a/include/tst_test.h > +++ b/include/tst_test.h > @@ -428,6 +428,10 @@ struct tst_ulimit_val { > * can be set. May be executed several times if test was passed '-i' > * or '-d' command line parameters. > * > + * @scall: Internal only (timer measurement library). > + * > + * @sample: Internal only (timer measurement library). > + * > * @resource_files: A NULL terminated array of filenames that will be copied > * to the test temporary directory from the LTP datafiles > * directory. > @@ -642,6 +646,8 @@ int main(int argc, char *argv[]) > /** > * TST_TEST_TCONF() - Exit tests with a TCONF message. > * > + * @message: Error message (the reason to skip test). > + * > * This macro is used in test that couldn't be compiled either because current > * CPU architecture is unsupported or because of missing development libraries. > */ > Regards, Avinesh
diff --git a/include/tst_test.h b/include/tst_test.h index 8dc20d110..20960e9b9 100644 --- a/include/tst_test.h +++ b/include/tst_test.h @@ -428,6 +428,10 @@ struct tst_ulimit_val { * can be set. May be executed several times if test was passed '-i' * or '-d' command line parameters. * + * @scall: Internal only (timer measurement library). + * + * @sample: Internal only (timer measurement library). + * * @resource_files: A NULL terminated array of filenames that will be copied * to the test temporary directory from the LTP datafiles * directory. @@ -642,6 +646,8 @@ int main(int argc, char *argv[]) /** * TST_TEST_TCONF() - Exit tests with a TCONF message. * + * @message: Error message (the reason to skip test). + * * This macro is used in test that couldn't be compiled either because current * CPU architecture is unsupported or because of missing development libraries. */
All undocumented members are in the library "undescribed", better to document the purpose. Signed-off-by: Petr Vorel <pvorel@suse.cz> --- include/tst_test.h | 6 ++++++ 1 file changed, 6 insertions(+)