linux-kernel - Re: [PATCH v2] Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Wed, 7 Dec 2022 15:58:28 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     David Gow <davidgow@...gle.com>
Cc:     Shuah Khan <skhan@...uxfoundation.org>,
        Brendan Higgins <brendan.higgins@...ux.dev>,
        Sadiya Kazi <sadiyakazi@...gle.com>,
        Rae Moar <rmoar@...gle.com>, Jonathan Corbet <corbet@....net>,
        Daniel Latypov <dlatypov@...gle.com>,
        linux-kernel@...r.kernel.org, kunit-dev@...glegroups.com,
        linux-kselftest@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH v2] Documentation: kunit: Fix "How Do I Use This" / "Next
 Steps" sections

On Wed, Dec 07, 2022 at 12:33:19PM +0800, David Gow wrote:
> 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.
> 
> Fixes: 4399c737a97d ("Documentation: kunit: Remove redundant 'tips.rst' page")
> Signed-off-by: David Gow <davidgow@...gle.com>
> ---
> 
> Thanks everyone for reviewing v1. Since this is pretty much a complete
> rewrite, I've left Reviewed-by tags off, as I don't feel the previous
> reviews totally apply. Feel free to review again if you have any
> comments.
> 
> Cheers,
> -- David
> 
> Changes since v1:
> https://lore.kernel.org/linux-kselftest/20221129094732.306449-1-davidgow@google.com/
> - Totally rewrite both sections to only include (and provide more
>   context for) the most concrete next steps.
>   - Thanks Bagas for pointing out that this basically duplicates the TOC
>     as-is.
> 
> ---
>  Documentation/dev-tools/kunit/index.rst | 19 ++++++++-----------
>  Documentation/dev-tools/kunit/start.rst | 19 +++++++++----------
>  2 files changed, 17 insertions(+), 21 deletions(-)
> 
> diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
> index d5629817cd72..b3593ae29ace 100644
> --- a/Documentation/dev-tools/kunit/index.rst
> +++ b/Documentation/dev-tools/kunit/index.rst
> @@ -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!
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index f4f504f1fb15..224387a43543 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -294,13 +294,12 @@ 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
> +

Much better, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)