[v5,12/12] Documentation: kunit: add a brief blurb about kunit_test_suite
diff mbox series

Message ID 20200626210917.358969-13-brendanhiggins@google.com
State New
Headers show
  • kunit: create a centralized executor to dispatch all KUnit tests
Related show

Commit Message

Brendan Higgins June 26, 2020, 9:09 p.m. UTC
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>
 Documentation/dev-tools/kunit/usage.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff mbox series

diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 3c3fe8b5feccf..961d3ea3ca19a 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