Re: [PATCH v3 3/3] drm/doc: Add KUnit documentation

José Expósito
2022-06-14T18:10:18Z

Hi Javier,

On Tue, Jun 14, 2022 at 02:58:29PM +0200, Javier Martinez Canillas wrote:
> Hello José,
>
> On 6/13/22 19:17, José Expósito wrote:
>
> [snip]
>
> > +KUnit (Kernel unit testing framework) provides a common framework for unit tests
> > +within the Linux kernel.
> > +
>
> I think that it will be useful to have a reference to the KUnit kernel doc here,
> something like the following:
>
> `KUnit <https://docs.kernel.org/dev-tools/kunit/index.html>`_ (Kernel Unit...

There is a link in the next paragraph. Once the documentation is
generated the path "Documentation/dev-tools/kunit/start.rst" is
transformed into a link.

> > +This section covers the specifics for the DRM subsystem. For general information
> > +about KUnit, please refer to Documentation/dev-tools/kunit/start.rst.
> > +
> > +How to run the tests?
> > +~~~~~~~~~~~~~~~~~~~~~
> > +
> > +In order to facilitate running the test suite, a configuration file is present
> > +in ``drivers/gpu/drm/kunit/.kunitconfig``. It can be used by ``kunit.py`` as
> > +follows:
> > +
> > +.. code-block:: bash
> > +
> > + $ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/kunit \
> > + --kconfig_add CONFIG_VIRTIO_UML=y \
> > + --kconfig_add CONFIG_UML_PCI_OVER_VIRTIO=y
> > +
> > +.. note::
> > + The configuration included in ``.kunitconfig`` should be as generic as
> > + possible.
> > + ``CONFIG_VIRTIO_UML`` and ``CONFIG_UML_PCI_OVER_VIRTIO`` are not
> > + included in it because they are only required for User Mode Linux.
> > +
> > +
>
> Maybe also add something like this ?
>
> For example, the following command can be used to run the test for x86_64:
>
> $ ./tools/testing/kunit/kunit.py run --kunitconfig=drivers/gpu/drm/kunit \
> --arch=x86_64

I didn't want to go into much detail because the KUnit docs are
a very good resource and already explain how to run the tests in your
favorite architecture.

Since running the test on x86_64 should not change the results, I'd
prefer to keep it simple and trust the KUnit docs for the "advanced"
options.

> Regardless, the patch looks good to me:
>
> Reviewed-by: Javier Martinez Canillas <javierm@redhat.com>

Thanks a lot for taking the time to review it. I'll add the tag if a v4
is required after chatting with the guys working on the AMDGPU tests.

Jose

> --
> Best regards,
>
> Javier Martinez Canillas
> Linux Engineering
> Red Hat
>