diff mbox series

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

Message ID 20220813042055.136832-5-tales.aparecida@gmail.com (mailing list archive)
State Accepted
Commit 3920c725cbff5c6db69d7077716987a93b0e6a9a
Delegated to: Brendan Higgins
Headers show
Series Documentation: KUnit: minor fixes | expand

Commit Message

Tales Aug. 13, 2022, 4:20 a.m. UTC
Add an organic link to the "other kinds of tests" in the index page

Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
---
 Documentation/dev-tools/kunit/faq.rst   | 2 ++
 Documentation/dev-tools/kunit/index.rst | 2 ++
 2 files changed, 4 insertions(+)

Comments

David Gow Aug. 13, 2022, 7:04 a.m. UTC | #1
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.
diff mbox series

Patch

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?
 ================