leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

selftests/harness: Clean up kern-doc for fixtures

Browse Source 
The FIXTURE*() macro kern-doc examples had the wrong names for the C code
examples associated with them. Fix those and clarify that FIXTURE_DATA()
usage should be avoided.

Cc: Shuah Khan <shuah@kernel.org>
Cc: Jakub Kicinski <kuba@kernel.org>
Fixes: 74bc7c97fa ("kselftest: add fixture variants")
Signed-off-by: Kees Cook <keescook@chromium.org>
Reviewed-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
This commit is contained in:
Kees Cook 2020-07-04 23:12:30 -07:00 committed by Shuah Khan
parent a80d6055b3
commit 3e4cd8ea7a
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tools/testing/selftests/kselftest_harness.h
View File

@ -202,8 +202,9 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_DATA(datatype name) * FIXTURE_DATA(datatype_name)
* *
* Almost always, you want just FIXTURE() instead (see below).
* This call may be used when the type of the fixture data * This call may be used when the type of the fixture data
* is needed. In general, this should not be needed unless * is needed. In general, this should not be needed unless
* the *self* is being passed to a helper directly. * the *self* is being passed to a helper directly.
@ -218,7 +219,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE(datatype name) { * FIXTURE(fixture_name) {
* type property1; * type property1;
* ... * ...
* }; * };
@ -245,7 +246,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_SETUP(fixture name) { implementation } * FIXTURE_SETUP(fixture_name) { implementation }
* *
* Populates the required "setup" function for a fixture. An instance of the * Populates the required "setup" function for a fixture. An instance of the
* datatype defined with FIXTURE_DATA() will be exposed as *self* for the * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
@ -271,7 +272,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_TEARDOWN(fixture name) { implementation } * FIXTURE_TEARDOWN(fixture_name) { implementation }
* *
* Populates the required "teardown" function for a fixture. An instance of the * Populates the required "teardown" function for a fixture. An instance of the
* datatype defined with FIXTURE_DATA() will be exposed as *self* for the * datatype defined with FIXTURE_DATA() will be exposed as *self* for the
@ -292,7 +293,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_VARIANT(datatype name) { * FIXTURE_VARIANT(fixture_name) {
* type property1; * type property1;
* ... * ...
* }; * };
@ -312,8 +313,8 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_ADD(datatype name) { * FIXTURE_VARIANT_ADD(fixture_name, variant_name) {
* .property1 = val1; * .property1 = val1,
* ... * ...
* }; * };
* *