Commit 9d1587ad authored by Kees Cook's avatar Kees Cook

selftests/harness: Clean up kern-doc for fixtures

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>
Fixes: 74bc7c97 ("kselftest: add fixture variants")
Acked-by: default avatarJakub Kicinski <kuba@kernel.org>
Signed-off-by: default avatarKees Cook <keescook@chromium.org>
parent fe4bfff8
...@@ -195,8 +195,9 @@ ...@@ -195,8 +195,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.
...@@ -211,7 +212,7 @@ ...@@ -211,7 +212,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE(datatype name) { * FIXTURE(fixture_name) {
* type property1; * type property1;
* ... * ...
* }; * };
...@@ -238,7 +239,7 @@ ...@@ -238,7 +239,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
...@@ -264,7 +265,7 @@ ...@@ -264,7 +265,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
...@@ -285,7 +286,7 @@ ...@@ -285,7 +286,7 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_VARIANT(datatype name) { * FIXTURE_VARIANT(fixture_name) {
* type property1; * type property1;
* ... * ...
* }; * };
...@@ -305,8 +306,8 @@ ...@@ -305,8 +306,8 @@
* *
* .. code-block:: c * .. code-block:: c
* *
* FIXTURE_ADD(datatype name) { * FIXTURE_VARIANT_ADD(fixture_name, variant_name) {
* .property1 = val1; * .property1 = val1,
* ... * ...
* }; * };
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment