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

From: SeongJae Park
Date: Mon Oct 12 2020 - 14:20:13 EST


On Mon, 12 Oct 2020 13:28:42 +0200 Marco Elver <elver@xxxxxxxxxx> wrote:

> On Mon, 12 Oct 2020 at 12:54, 'SeongJae Park' via KUnit Development
> <kunit-dev@xxxxxxxxxxxxxxxx> wrote:
> >
> > From: SeongJae Park <sjpark@xxxxxxxxx>
> >
> > 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@xxxxxxxxx>
> > ---
> > 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 3c3fe8b5fecc..410380fc7fb4 100644
> > --- a/Documentation/dev-tools/kunit/usage.rst
> > +++ b/Documentation/dev-tools/kunit/usage.rst
> > @@ -556,6 +556,11 @@ Once the kernel is built and installed, a simple
> >
> > ...will run the tests.
> >
> > +.. note::
> > + Note that you should make your test depends on ``KUNIT=y`` in Kcofig if the
> > + test does not support module build. Otherwise, it will trigger compile
> > + errors if ``CONFIG_KUNIT`` is ``m``.
>
> s/Kcofig/Kconfig/

Thanks, I will fix this in the next version of this patch.


Thanks,
SeongJae Park