Skip to content

Commit a82763e

Browse files
bjh83shuahkh
authored andcommitted
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 <[email protected]> Reviewed-by: Stephen Boyd <[email protected]> Signed-off-by: Shuah Khan <[email protected]>
1 parent 45dcbb6 commit a82763e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Documentation/dev-tools/kunit/usage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ KUnit test framework.
211211
.. note::
212212
A test case will only be run if it is associated with a test suite.
213213

214+
``kunit_test_suite(...)`` is a macro which tells the linker to put the specified
215+
test suite in a special linker section so that it can be run by KUnit either
216+
after late_init, or when the test module is loaded (depending on whether the
217+
test was built in or not).
218+
214219
For more information on these types of things see the :doc:`api/test`.
215220

216221
Isolating Behavior

0 commit comments

Comments
 (0)