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

Daniel Vetter
2022-06-24T21:02:08Z

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...
>
> > +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
>
> Regardless, the patch looks good to me:
>
> Reviewed-by: Javier Martinez Canillas <javierm@redhat.com>

Hey so since you have a bunch of patches merged into drm already but seem
to lack drm-misc commit rights to push these yourself I think it's time to
get those:

https://drm.pages.freedesktop.org/maintainer-tools/commit-access.html#drm-misc

And I guess Javier can help you with any questions you might have and make
sure the request gets through by poking folks on #dri-devel irc?

Cheers, Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation