Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections
authorDavid Gow <davidgow@google.com>
Wed, 7 Dec 2022 04:33:19 +0000 (12:33 +0800)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 12 Dec 2022 21:13:48 +0000 (14:13 -0700)
commita81fe7ecf717e5ae16892c282378ca380d4e99c9
tree52bbe5bd68f023010f4e0e4d65bc4ac5ba8f2a9e
parent5937e0c04afc7d4b7b737fda93316ba4b74183c0
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>
Documentation/dev-tools/kunit/index.rst
Documentation/dev-tools/kunit/start.rst