system/linux
system/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux synced 2024-10-14 23:39:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

selftests: kselftest_harness.h: partially fix kernel-doc markups

Browse source 
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.

Acked-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/8383758160fdb4fcbb2ac56beeb874ca6dffc6b9.1610610937.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2021-01-14 09:04:46 +01:00 committed by Jonathan Corbet
parent 484cac7910
commit 3950b92f96
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
tools/testing/selftests/kselftest_harness.h
View file

@ -79,7 +79,7 @@
#endif
/**
* TH_LOG(fmt, ...)
* TH_LOG()
*
* @fmt: format string
* @...: optional arguments
@ -113,12 +113,16 @@
__FILE__, __LINE__, _metadata->name, ##__VA_ARGS__)
/**
* SKIP(statement, fmt, ...)
* SKIP()
*
* @statement: statement to run after reporting SKIP
* @fmt: format string
* @...: optional arguments
*
* .. code-block:: c
*
* SKIP(statement, fmt, ...);
*
* This forces a "pass" after reporting why something is being skipped
* and runs "statement", which is usually "return" or "goto skip".
*/
@ -136,7 +140,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 +159,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 +199,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 +216,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 +243,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 +269,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 +290,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 +309,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 +343,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