linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Brendan Higgins <brendanhiggins@google.com>
Cc: Randy Dunlap <rdunlap@infradead.org>, shuah <shuah@kernel.org>,
	David Gow <davidgow@google.com>,
	KUnit Development <kunit-dev@googlegroups.com>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	"open list:KERNEL SELFTEST FRAMEWORK" 
	<linux-kselftest@vger.kernel.org>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	"Theodore Ts'o" <tytso@mit.edu>
Subject: Re: [PATCH linux-kselftest/test v3] Documentation: kunit: add documentation for kunit_tool
Date: Wed, 20 Nov 2019 06:32:19 -0700	[thread overview]
Message-ID: <20191120063219.1ad15b68@lwn.net> (raw)
In-Reply-To: <CAFd5g47+3TN4pOdeM0YmJpMP2uKnpJYUY_OXmqmZEn8OcVz6ow@mail.gmail.com>

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

> On Tue, Nov 19, 2019 at 4:27 PM Randy Dunlap <rdunlap@infradead.org> 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

  reply	other threads:[~2019-11-20 13:32 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-19  0:31 [PATCH linux-kselftest/test v3] Documentation: kunit: add documentation for kunit_tool Brendan Higgins
2019-11-20  0:27 ` Randy Dunlap
2019-11-20  1:14   ` Brendan Higgins
2019-11-20 13:32     ` Jonathan Corbet [this message]
2019-11-20 16:08       ` Randy Dunlap
2019-11-20 16:19         ` Brendan Higgins

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191120063219.1ad15b68@lwn.net \
    --to=corbet@lwn.net \
    --cc=brendanhiggins@google.com \
    --cc=davidgow@google.com \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=shuah@kernel.org \
    --cc=tytso@mit.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).