diff options
author | David Gow <davidgow@google.com> | 2022-12-07 12:33:19 +0800 |
---|---|---|
committer | Shuah Khan <skhan@linuxfoundation.org> | 2022-12-12 14:13:48 -0700 |
commit | a81fe7ecf717e5ae16892c282378ca380d4e99c9 (patch) | |
tree | 52bbe5bd68f023010f4e0e4d65bc4ac5ba8f2a9e /Documentation/dev-tools/kunit/start.rst | |
parent | 5937e0c04afc7d4b7b737fda93316ba4b74183c0 (diff) | |
download | linux-stable-a81fe7ecf717e5ae16892c282378ca380d4e99c9.tar.gz linux-stable-a81fe7ecf717e5ae16892c282378ca380d4e99c9.tar.bz2 linux-stable-a81fe7ecf717e5ae16892c282378ca380d4e99c9.zip |
Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections
The "How Do I Use This" section of index.rst and "Next Steps" section of
start.rst were just copies of the table of contents, and therefore
weren't really useful either when looking a sphinx generated output
(which already had the TOC visible) or when reading the source (where
it's just a list of files that ls could give you).
Instead, provide a small number of concrete next steps, and a bit more
description about what the pages contain.
This also removes the broken reference to 'tips.rst', which was
previously removed.
Fixed git am whitespace complaints during commit:
Shuah Khan <skhan@linuxfoundation.org>
Fixes: 4399c737a97d ("Documentation: kunit: Remove redundant 'tips.rst' page")
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Sadiya Kazi <sadiyakazi@google.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools/kunit/start.rst')
-rw-r--r-- | Documentation/dev-tools/kunit/start.rst | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index f4f504f1fb15..c736613c9b19 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -294,13 +294,11 @@ Congrats! You just wrote your first KUnit test. Next Steps ========== -* Documentation/dev-tools/kunit/architecture.rst - KUnit architecture. -* Documentation/dev-tools/kunit/run_wrapper.rst - run kunit_tool. -* Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit_tool. -* Documentation/dev-tools/kunit/usage.rst - write tests. -* Documentation/dev-tools/kunit/tips.rst - best practices with - examples. -* Documentation/dev-tools/kunit/api/index.rst - KUnit APIs - used for testing. -* Documentation/dev-tools/kunit/faq.rst - KUnit common questions and - answers. +If you're interested in using some of the more advanced features of kunit.py, +take a look at Documentation/dev-tools/kunit/run_wrapper.rst + +If you'd like to run tests without using kunit.py, check out +Documentation/dev-tools/kunit/run_manual.rst + +For more information on writing KUnit tests (including some common techniques +for testing different things), see Documentation/dev-tools/kunit/usage.rst |