From: Jonathan Corbet <corbet@lwn.net>
To: David Gow <davidgow@google.com>,
Shuah Khan <skhan@linuxfoundation.org>,
Andrew Morton <akpm@linux-foundation.org>,
Dmitry Vyukov <dvyukov@google.com>,
Marco Elver <elver@google.com>,
Brendan Higgins <brendanhiggins@google.com>,
Daniel Latypov <dlatypov@google.com>
Cc: David Gow <davidgow@google.com>,
linux-doc@vger.kernel.org,
KUnit Development <kunit-dev@googlegroups.com>,
linux-kselftest@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: dev-tools: Add Testing Overview
Date: Sun, 11 Apr 2021 11:05:29 -0600 [thread overview]
Message-ID: <87zgy4vjja.fsf@meer.lwn.net> (raw)
In-Reply-To: <20210410070529.4113432-1-davidgow@google.com>
A nit but
> +The bulk of kernel tests are written using either the :doc:`kselftest
> +<kselftest>` or :doc:`KUnit <kunit/index>` frameworks. These both provide
> +infrastructure to help make running tests and groups of tests easier, as well
> +as providing helpers to aid in writing new tests.
If you just mention the relevant file, the docs build will make links
for you...so just "Documentation/dev-tools/kselftest.rst" rather than
the :doc: directive. That helps to improve the readability of the
plain-text documentation as well.
> +`KUnit` tests therefore are best written against small, self-contained parts
> +of the kernel, which can be tested in isolation. This aligns well with the
> +concept of Unit testing.
If you want literal text, you need a double backtick: ``KUnit``.
Otherwise I'd just use normal quotes.
Thanks,
jon
next prev parent reply other threads:[~2021-04-11 17:05 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-10 7:05 [PATCH] Documentation: dev-tools: Add Testing Overview David Gow
2021-04-10 11:52 ` Daniel Latypov
2021-04-12 10:43 ` Marco Elver
2021-04-12 21:22 ` Brendan Higgins
2021-04-11 17:05 ` Jonathan Corbet [this message]
2021-04-12 21: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=87zgy4vjja.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=akpm@linux-foundation.org \
--cc=brendanhiggins@google.com \
--cc=davidgow@google.com \
--cc=dlatypov@google.com \
--cc=dvyukov@google.com \
--cc=elver@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=skhan@linuxfoundation.org \
/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).