linux-stable/Documentation/dev-tools/kunit
David Gow a81fe7ecf7 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>
2022-12-12 14:13:48 -07:00
..
api kunit: split resource API from test.h into new resource.h 2022-04-04 16:23:08 -06:00
architecture.rst Documentation: Kunit: Update architecture.rst for minor fixes 2022-10-27 02:32:41 -06:00
faq.rst Documentation: Kunit: Add ref for other kinds of tests 2022-09-30 13:19:11 -06:00
index.rst Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections 2022-12-12 14:13:48 -07:00
kunit_suitememorydiagram.svg Documentation: KUnit: Added KUnit Architecture 2021-12-23 12:49:06 -07:00
run_manual.rst Documentation: kunit: Reorganize documentation related to running tests 2021-12-23 12:49:43 -07:00
run_wrapper.rst Documentation: kunit: Update description of --alltests option 2022-10-07 10:19:25 -06:00
running_tips.rst Documentation: kunit: fix example run_kunit func to allow spaces in args 2022-07-11 16:33:51 -06:00
start.rst Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections 2022-12-12 14:13:48 -07:00
style.rst Documentation: KUnit: Restyle Test Style and Nomenclature page 2021-12-23 12:49:43 -07:00
usage.rst kunit: Use the static key when retrieving the current test 2022-12-12 14:13:47 -07:00