2022-08-13 04:27:14

by Tales Aparecida

[permalink] [raw]

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

---

Add an organic link to the "other kinds of tests" in the index page

Signed-off-by: Tales Aparecida <[email protected]>
---
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

2022-08-13 07:06:37

by David Gow

[permalink] [raw]

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

---

On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida
<[email protected]> wrote:
>
> Add an organic link to the "other kinds of tests" in the index page
>
> Signed-off-by: Tales Aparecida <[email protected]>
> ---

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 <[email protected]>

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 [email protected].
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-5-tales.aparecida%40gmail.com.

---

Attachments:

smime.p7s (3.91 kB)
S/MIME Cryptographic Signature