aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/dev-tools/kunit/usage.rst
diff options
context:
space:
mode:
authorSeongJae Park <sjpark@amazon.de>2020-10-21 21:25:18 +0200
committerShuah Khan <skhan@linuxfoundation.org>2020-10-26 13:24:46 -0600
commitf0b62039bf7f998fb3f1369ac70dbe571c74f9d8 (patch)
tree8f6329f15aebc26743a25c2dcd27815875808bf5 /Documentation/dev-tools/kunit/usage.rst
parentkunit: test: fix remaining kernel-doc warnings (diff)
downloadlinux-dev-f0b62039bf7f998fb3f1369ac70dbe571c74f9d8.tar.xz
linux-dev-f0b62039bf7f998fb3f1369ac70dbe571c74f9d8.zip
Documentation: kunit: Update Kconfig parts for KUNIT's module support
If 'CONFIG_KUNIT=m', letting kunit tests that do not support loadable module build depends on 'KUNIT' instead of 'KUNIT=y' result in compile errors. This commit updates the document for this. Fixes: 9fe124bf1b77 ("kunit: allow kunit to be loaded as a module") Signed-off-by: SeongJae Park <sjpark@amazon.de> Reviewed-by: David Gow <davidgow@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools/kunit/usage.rst')
-rw-r--r--Documentation/dev-tools/kunit/usage.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 961d3ea3ca19..62142a47488c 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -561,6 +561,11 @@ Once the kernel is built and installed, a simple
...will run the tests.
+.. note::
+ Note that you should make sure your test depends on ``KUNIT=y`` in Kconfig
+ if the test does not support module build. Otherwise, it will trigger
+ compile errors if ``CONFIG_KUNIT`` is ``m``.
+
Writing new tests for other architectures
-----------------------------------------