Re: [PATCH 4/4] Documentation: Kunit: Add ref for other kinds of tests

From: David Gow <davidgow@google.com>
To: Tales Aparecida <tales.aparecida@gmail.com>
Cc: "Sadiya Kazi" <sadiyakazi@google.com>,
	"Brendan Higgins" <brendanhiggins@google.com>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Trevor Woerner" <twoerner@gmail.com>,
	siqueirajordao@riseup.net, mwen@igalia.com,
	andrealmeid@riseup.net, "Maíra Canal" <mairacanal@riseup.net>,
	"Isabella Basso" <isabbasso@riseup.net>,
	magalilemes00@gmail.com,
	"open list:KERNEL SELFTEST FRAMEWORK"
	<linux-kselftest@vger.kernel.org>,
	"KUnit Development" <kunit-dev@googlegroups.com>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	"Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 4/4] Documentation: Kunit: Add ref for other kinds of tests
Date: Sat, 13 Aug 2022 15:04:12 +0800	[thread overview]
Message-ID: <CABVgOSkNwmsojenC6RpNXW82UKK-W2rQsQFLz94E9tmOV9sAzw@mail.gmail.com> (raw)
In-Reply-To: <20220813042055.136832-5-tales.aparecida@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2033 bytes --]

On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida
<tales.aparecida@gmail.com> wrote:
>
> Add an organic link to the "other kinds of tests" in the index page
>
> Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
> ---

Thanks.

It may also be worth looking at and/or linking to the kernel testing guide:
https://docs.kernel.org/dev-tools/testing-overview.html

(This is a fine improvement as-is, regardless.)

Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David

>  Documentation/dev-tools/kunit/faq.rst   | 2 ++
>  Documentation/dev-tools/kunit/index.rst | 2 ++
>  2 files changed, 4 insertions(+)
>
> diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst
> index f1b4cef68ced..fae426f2634a 100644
> --- a/Documentation/dev-tools/kunit/faq.rst
> +++ b/Documentation/dev-tools/kunit/faq.rst
> @@ -39,6 +39,8 @@ more work than using KUnit on UML.
>
>  For more information, see :ref:`kunit-on-non-uml`.
>
> +.. _kinds-of-tests:
> +
>  What is the difference between a unit test and other kinds of tests?
>  ====================================================================
>  Most existing tests for the Linux kernel would be categorized as an integration
> diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
> index 595205348d2d..bc91ad7b8961 100644
> --- a/Documentation/dev-tools/kunit/index.rst
> +++ b/Documentation/dev-tools/kunit/index.rst
> @@ -95,6 +95,8 @@ Unit Testing Advantages
>  - Improves code quality.
>  - Encourages writing testable code.
>
> +Read also :ref:`kinds-of-tests`.
> +
>  How do I use it?
>  ================
>
> --
> 2.37.1
>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-5-tales.aparecida%40gmail.com.

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4003 bytes --]