2020-10-22 12:39:22

by SeongJae Park

Subject: [PATCH] Documentation: kunit: Update Kconfig parts for KUNIT's module support

From: SeongJae Park <[email protected]>

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 <[email protected]>
Reviewed-by: David Gow <[email protected]>
---

Changes from v2
(https://lore.kernel.org/linux-kselftest/[email protected]/)
- Fix a grammar issue (David Gow)
- Add 'Reviewed-by: David Gow <[email protected]>'

Changes from v1
(https://lore.kernel.org/linux-kselftest/[email protected]/)
- Fix a typo (Marco Elver)

---

Documentation/dev-tools/kunit/start.rst | 2 +-
Documentation/dev-tools/kunit/usage.rst | 5 +++++
2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index d23385e3e159..454f307813ea 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -197,7 +197,7 @@ Now add the following to ``drivers/misc/Kconfig``:

config MISC_EXAMPLE_TEST
bool "Test for my example"
- depends on MISC_EXAMPLE && KUNIT
+ depends on MISC_EXAMPLE && KUNIT=y

and the following to ``drivers/misc/Makefile``:

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
-----------------------------------------

--
2.17.1

2020-10-22 12:58:32

by Brendan Higgins

Subject: Re: [PATCH] Documentation: kunit: Update Kconfig parts for KUNIT's module support

On Wed, Oct 21, 2020 at 12:32 PM SeongJae Park <[email protected]> wrote:
>
> From: SeongJae Park <[email protected]>
>
> 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 <[email protected]>
> Reviewed-by: David Gow <[email protected]>

Reviewed-by: Brendan Higgins <[email protected]>