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

From: Jonathan Corbet
Date: Wed Nov 20 2019 - 08:32:22 EST


On Tue, 19 Nov 2019 17:14:20 -0800
Brendan Higgins <brendanhiggins@xxxxxxxxxx> wrote:

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

Sphinx wants the underline to be at least as long as the subheading text
above; it's entirely happy if it's longer, though.

jon