path: root/Documentation/dev-tools/kunit/usage.rst
diff options
authorBrendan Higgins <brendanhiggins@google.com>2020-08-04 13:47:45 -0700
committerShuah Khan <skhan@linuxfoundation.org>2020-10-09 14:37:55 -0600
commita82763e63ee78c9876211998d0bcc082f4ff63d8 (patch)
tree3d93261c18af7746a7fb882baa7fd4d74f76de48 /Documentation/dev-tools/kunit/usage.rst
parentkunit: test: add test plan to KUnit TAP format (diff)
Documentation: kunit: add a brief blurb about kunit_test_suite
Add a brief blurb saying how and when the kunit_test_suite() macro works to the usage documentation. Signed-off-by: Brendan Higgins <brendanhiggins@google.com> Reviewed-by: Stephen Boyd <sboyd@kernel.org> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools/kunit/usage.rst')
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 3c3fe8b5fecc..961d3ea3ca19 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -211,6 +211,11 @@ KUnit test framework.
.. note::
A test case will only be run if it is associated with a test suite.
+``kunit_test_suite(...)`` is a macro which tells the linker to put the specified
+test suite in a special linker section so that it can be run by KUnit either
+after late_init, or when the test module is loaded (depending on whether the
+test was built in or not).
For more information on these types of things see the :doc:`api/test`.
Isolating Behavior