On Fri, Oct 23, 2020 at 06:33:42PM +0200, Mauro Carvalho Chehab wrote: > The kernel-doc markups on this file are weird: they don't > follow what's specified at: > > Documentation/doc-guide/kernel-doc.rst > > In particular, markups should use this format: > identifier - description > > and not this: > identifier(args) > > The way the definitions are inside this file cause the > parser to completely miss the identifier name of each > function. > > This prevents improving the script to do some needed validation > tests. > > Address this part. Yet, furter changes are needed in order > for it to fully follow the specs. > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> > --- > tools/testing/selftests/kselftest_harness.h | 66 ++++++++++----------- > 1 file changed, 33 insertions(+), 33 deletions(-) > > diff --git a/tools/testing/selftests/kselftest_harness.h b/tools/testing/selftests/kselftest_harness.h > index f19804df244c..665d04f3b802 100644 > --- a/tools/testing/selftests/kselftest_harness.h > +++ b/tools/testing/selftests/kselftest_harness.h > @@ -79,7 +79,7 @@ > #endif > > /** > - * TH_LOG(fmt, ...) > + * TH_LOG() > * > * @fmt: format string > * @...: optional arguments Hmmm. Yeah, this does need fixing, but I don't want to lose the "examples". Some have stuff like this before the description: * .. code-block:: c * * TH_LOG(format, ...) which retains it, but many don't. Can you add the code-block:: c sections where they're missing so this doesn't lose the syntax hints when just looking at the header file alone. -Kees > @@ -113,7 +113,7 @@ > __FILE__, __LINE__, _metadata->name, ##__VA_ARGS__) > > /** > - * SKIP(statement, fmt, ...) > + * SKIP() > * > * @statement: statement to run after reporting SKIP > * @fmt: format string > @@ -136,7 +136,7 @@ > } while (0) > > /** > - * TEST(test_name) - Defines the test function and creates the registration > + * TEST() - Defines the test function and creates the registration > * stub > * > * @test_name: test name > @@ -155,7 +155,7 @@ > #define TEST(test_name) __TEST_IMPL(test_name, -1) > > /** > - * TEST_SIGNAL(test_name, signal) > + * TEST_SIGNAL() > * > * @test_name: test name > * @signal: signal number > @@ -195,7 +195,7 @@ > struct __test_metadata __attribute__((unused)) *_metadata) > > /** > - * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less > + * FIXTURE_DATA() - Wraps the struct name so we have one less > * argument to pass around > * > * @datatype_name: datatype name > @@ -212,7 +212,7 @@ > #define FIXTURE_DATA(datatype_name) struct _test_data_##datatype_name > > /** > - * FIXTURE(fixture_name) - Called once per fixture to setup the data and > + * FIXTURE() - Called once per fixture to setup the data and > * register > * > * @fixture_name: fixture name > @@ -239,7 +239,7 @@ > FIXTURE_DATA(fixture_name) > > /** > - * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture. > + * FIXTURE_SETUP() - Prepares the setup function for the fixture. > * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly. > * > * @fixture_name: fixture name > @@ -265,7 +265,7 @@ > __attribute__((unused)) *variant) > > /** > - * FIXTURE_TEARDOWN(fixture_name) > + * FIXTURE_TEARDOWN() > * *_metadata* is included so that EXPECT_* and ASSERT_* work correctly. > * > * @fixture_name: fixture name > @@ -286,7 +286,7 @@ > FIXTURE_DATA(fixture_name) __attribute__((unused)) *self) > > /** > - * FIXTURE_VARIANT(fixture_name) - Optionally called once per fixture > + * FIXTURE_VARIANT() - Optionally called once per fixture > * to declare fixture variant > * > * @fixture_name: fixture name > @@ -305,7 +305,7 @@ > #define FIXTURE_VARIANT(fixture_name) struct _fixture_variant_##fixture_name > > /** > - * FIXTURE_VARIANT_ADD(fixture_name, variant_name) - Called once per fixture > + * FIXTURE_VARIANT_ADD() - Called once per fixture > * variant to setup and register the data > * > * @fixture_name: fixture name > @@ -339,7 +339,7 @@ > _##fixture_name##_##variant_name##_variant = > > /** > - * TEST_F(fixture_name, test_name) - Emits test registration and helpers for > + * TEST_F() - Emits test registration and helpers for > * fixture-based test cases > * > * @fixture_name: fixture name > @@ -432,7 +432,7 @@ > */ > > /** > - * ASSERT_EQ(expected, seen) > + * ASSERT_EQ() > * > * @expected: expected value > * @seen: measured value > @@ -443,7 +443,7 @@ > __EXPECT(expected, #expected, seen, #seen, ==, 1) > > /** > - * ASSERT_NE(expected, seen) > + * ASSERT_NE() > * > * @expected: expected value > * @seen: measured value > @@ -454,7 +454,7 @@ > __EXPECT(expected, #expected, seen, #seen, !=, 1) > > /** > - * ASSERT_LT(expected, seen) > + * ASSERT_LT() > * > * @expected: expected value > * @seen: measured value > @@ -465,7 +465,7 @@ > __EXPECT(expected, #expected, seen, #seen, <, 1) > > /** > - * ASSERT_LE(expected, seen) > + * ASSERT_LE() > * > * @expected: expected value > * @seen: measured value > @@ -476,7 +476,7 @@ > __EXPECT(expected, #expected, seen, #seen, <=, 1) > > /** > - * ASSERT_GT(expected, seen) > + * ASSERT_GT() > * > * @expected: expected value > * @seen: measured value > @@ -487,7 +487,7 @@ > __EXPECT(expected, #expected, seen, #seen, >, 1) > > /** > - * ASSERT_GE(expected, seen) > + * ASSERT_GE() > * > * @expected: expected value > * @seen: measured value > @@ -498,7 +498,7 @@ > __EXPECT(expected, #expected, seen, #seen, >=, 1) > > /** > - * ASSERT_NULL(seen) > + * ASSERT_NULL() > * > * @seen: measured value > * > @@ -508,7 +508,7 @@ > __EXPECT(NULL, "NULL", seen, #seen, ==, 1) > > /** > - * ASSERT_TRUE(seen) > + * ASSERT_TRUE() > * > * @seen: measured value > * > @@ -518,7 +518,7 @@ > __EXPECT(0, "0", seen, #seen, !=, 1) > > /** > - * ASSERT_FALSE(seen) > + * ASSERT_FALSE() > * > * @seen: measured value > * > @@ -528,7 +528,7 @@ > __EXPECT(0, "0", seen, #seen, ==, 1) > > /** > - * ASSERT_STREQ(expected, seen) > + * ASSERT_STREQ() > * > * @expected: expected value > * @seen: measured value > @@ -539,7 +539,7 @@ > __EXPECT_STR(expected, seen, ==, 1) > > /** > - * ASSERT_STRNE(expected, seen) > + * ASSERT_STRNE() > * > * @expected: expected value > * @seen: measured value > @@ -550,7 +550,7 @@ > __EXPECT_STR(expected, seen, !=, 1) > > /** > - * EXPECT_EQ(expected, seen) > + * EXPECT_EQ() > * > * @expected: expected value > * @seen: measured value > @@ -561,7 +561,7 @@ > __EXPECT(expected, #expected, seen, #seen, ==, 0) > > /** > - * EXPECT_NE(expected, seen) > + * EXPECT_NE() > * > * @expected: expected value > * @seen: measured value > @@ -572,7 +572,7 @@ > __EXPECT(expected, #expected, seen, #seen, !=, 0) > > /** > - * EXPECT_LT(expected, seen) > + * EXPECT_LT() > * > * @expected: expected value > * @seen: measured value > @@ -583,7 +583,7 @@ > __EXPECT(expected, #expected, seen, #seen, <, 0) > > /** > - * EXPECT_LE(expected, seen) > + * EXPECT_LE() > * > * @expected: expected value > * @seen: measured value > @@ -594,7 +594,7 @@ > __EXPECT(expected, #expected, seen, #seen, <=, 0) > > /** > - * EXPECT_GT(expected, seen) > + * EXPECT_GT() > * > * @expected: expected value > * @seen: measured value > @@ -605,7 +605,7 @@ > __EXPECT(expected, #expected, seen, #seen, >, 0) > > /** > - * EXPECT_GE(expected, seen) > + * EXPECT_GE() > * > * @expected: expected value > * @seen: measured value > @@ -616,7 +616,7 @@ > __EXPECT(expected, #expected, seen, #seen, >=, 0) > > /** > - * EXPECT_NULL(seen) > + * EXPECT_NULL() > * > * @seen: measured value > * > @@ -626,7 +626,7 @@ > __EXPECT(NULL, "NULL", seen, #seen, ==, 0) > > /** > - * EXPECT_TRUE(seen) > + * EXPECT_TRUE() > * > * @seen: measured value > * > @@ -636,7 +636,7 @@ > __EXPECT(0, "0", seen, #seen, !=, 0) > > /** > - * EXPECT_FALSE(seen) > + * EXPECT_FALSE() > * > * @seen: measured value > * > @@ -646,7 +646,7 @@ > __EXPECT(0, "0", seen, #seen, ==, 0) > > /** > - * EXPECT_STREQ(expected, seen) > + * EXPECT_STREQ() > * > * @expected: expected value > * @seen: measured value > @@ -657,7 +657,7 @@ > __EXPECT_STR(expected, seen, ==, 0) > > /** > - * EXPECT_STRNE(expected, seen) > + * EXPECT_STRNE() > * > * @expected: expected value > * @seen: measured value > -- > 2.26.2 > -- Kees Cook
