Commit a81fe7ec authored by David Gow's avatar David Gow Committed by Shuah Khan
Browse files

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: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarSadiya Kazi <sadiyakazi@google.com>
Reviewed-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 5937e0c0

Documentation/dev-tools/kunit/index.rst

+8 −11
Original line number Diff line number Diff line
@@ -99,14 +99,11 @@ Read also :ref:`kinds-of-tests`. 
How do I use it?

================



*   Documentation/dev-tools/kunit/start.rst - for KUnit new users.

*   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.
 
You can find a step-by-step guide to writing and running KUnit tests in

Documentation/dev-tools/kunit/start.rst



Alternatively, feel free to look through the rest of the KUnit documentation,

or to experiment with tools/testing/kunit/kunit.py and the example test under

lib/kunit/kunit-example-test.c



Happy testing!

Documentation/dev-tools/kunit/start.rst

+8 −10
Original line number Diff line number Diff line
@@ -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