Re: [PATCH linux-kselftest/test v3] Documentation: kunit: add documentation for kunit_tool

From: Brendan Higgins
Date: Tue Nov 19 2019 - 20:14:34 EST


On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> On 11/18/19 4:31 PM, Brendan Higgins wrote:
> > +How do I use kunit_tool?
> > +=================================
>
> Hi,
> I haven't tested this, but Sphinx (or some doc tool) usually complains if the
> underline length is not the same as the header text length. (I.e., use fewer
> = signs above.)

Hmmm...Sphinx and checkpatch didn't complain. I wonder if it is a
different script, or maybe I have to use a particular option with
Sphinx.

In any case, thanks for catching this!

> > +
> > +If a kunitconfig is present at the root directory, all you have to do is:
> > +
> > +.. code-block:: bash
> > +
> > + ./tools/testing/kunit/kunit.py run