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

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
...@@ -99,14 +99,11 @@ Read also :ref:`kinds-of-tests`. ...@@ -99,14 +99,11 @@ Read also :ref:`kinds-of-tests`.
How do I use it? How do I use it?
================ ================
* Documentation/dev-tools/kunit/start.rst - for KUnit new users. You can find a step-by-step guide to writing and running KUnit tests in
* Documentation/dev-tools/kunit/architecture.rst - KUnit architecture. Documentation/dev-tools/kunit/start.rst
* Documentation/dev-tools/kunit/run_wrapper.rst - run kunit_tool.
* Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit_tool. Alternatively, feel free to look through the rest of the KUnit documentation,
* Documentation/dev-tools/kunit/usage.rst - write tests. or to experiment with tools/testing/kunit/kunit.py and the example test under
* Documentation/dev-tools/kunit/tips.rst - best practices with lib/kunit/kunit-example-test.c
examples.
* Documentation/dev-tools/kunit/api/index.rst - KUnit APIs Happy testing!
used for testing.
* Documentation/dev-tools/kunit/faq.rst - KUnit common questions and
answers.
...@@ -294,13 +294,11 @@ Congrats! You just wrote your first KUnit test. ...@@ -294,13 +294,11 @@ Congrats! You just wrote your first KUnit test.
Next Steps Next Steps
========== ==========
* Documentation/dev-tools/kunit/architecture.rst - KUnit architecture. If you're interested in using some of the more advanced features of kunit.py,
* Documentation/dev-tools/kunit/run_wrapper.rst - run kunit_tool. take a look at Documentation/dev-tools/kunit/run_wrapper.rst
* Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit_tool.
* Documentation/dev-tools/kunit/usage.rst - write tests. If you'd like to run tests without using kunit.py, check out
* Documentation/dev-tools/kunit/tips.rst - best practices with Documentation/dev-tools/kunit/run_manual.rst
examples.
* Documentation/dev-tools/kunit/api/index.rst - KUnit APIs For more information on writing KUnit tests (including some common techniques
used for testing. for testing different things), see Documentation/dev-tools/kunit/usage.rst
* Documentation/dev-tools/kunit/faq.rst - KUnit common questions and
answers.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment