Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

David Gow and committed by
Shuah Khan
a81fe7ec 5937e0c0

+16 -21
+8 -11
Documentation/dev-tools/kunit/index.rst
··· 99 99 How do I use it? 100 100 ================ 101 101 102 - * Documentation/dev-tools/kunit/start.rst - for KUnit new users. 103 - * Documentation/dev-tools/kunit/architecture.rst - KUnit architecture. 104 - * Documentation/dev-tools/kunit/run_wrapper.rst - run kunit_tool. 105 - * Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit_tool. 106 - * Documentation/dev-tools/kunit/usage.rst - write tests. 107 - * Documentation/dev-tools/kunit/tips.rst - best practices with 108 - examples. 109 - * Documentation/dev-tools/kunit/api/index.rst - KUnit APIs 110 - used for testing. 111 - * Documentation/dev-tools/kunit/faq.rst - KUnit common questions and 112 - answers. 102 + You can find a step-by-step guide to writing and running KUnit tests in 103 + Documentation/dev-tools/kunit/start.rst 104 + 105 + Alternatively, feel free to look through the rest of the KUnit documentation, 106 + or to experiment with tools/testing/kunit/kunit.py and the example test under 107 + lib/kunit/kunit-example-test.c 108 + 109 + Happy testing!
+8 -10
Documentation/dev-tools/kunit/start.rst
··· 294 294 Next Steps 295 295 ========== 296 296 297 - * Documentation/dev-tools/kunit/architecture.rst - KUnit architecture. 298 - * Documentation/dev-tools/kunit/run_wrapper.rst - run kunit_tool. 299 - * Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit_tool. 300 - * Documentation/dev-tools/kunit/usage.rst - write tests. 301 - * Documentation/dev-tools/kunit/tips.rst - best practices with 302 - examples. 303 - * Documentation/dev-tools/kunit/api/index.rst - KUnit APIs 304 - used for testing. 305 - * Documentation/dev-tools/kunit/faq.rst - KUnit common questions and 306 - answers. 297 + If you're interested in using some of the more advanced features of kunit.py, 298 + take a look at Documentation/dev-tools/kunit/run_wrapper.rst 299 + 300 + If you'd like to run tests without using kunit.py, check out 301 + Documentation/dev-tools/kunit/run_manual.rst 302 + 303 + For more information on writing KUnit tests (including some common techniques 304 + for testing different things), see Documentation/dev-tools/kunit/usage.rst