linux-kernel - [PATCH] 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-next>] [day] [month] [year] [list]

Message-ID: <20221129094732.306449-1-davidgow@google.com>
Date:   Tue, 29 Nov 2022 17:47:32 +0800
From:   David Gow <davidgow@...gle.com>
To:     Shuah Khan <skhan@...uxfoundation.org>,
        Brendan Higgins <brendan.higgins@...ux.dev>,
        Sadiya Kazi <sadiyakazi@...gle.com>
Cc:     David Gow <davidgow@...gle.com>, Jonathan Corbet <corbet@....net>,
        Daniel Latypov <dlatypov@...gle.com>,
        Rae Moar <rmoar@...gle.com>, linux-kernel@...r.kernel.org,
        kunit-dev@...glegroups.com, linux-kselftest@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: [PATCH] Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections

The 'index' and 'start' pages end with very similar "How Do I Use This"
/ "Next Steps" sections respectively, which link to the other
documentation pages. This wasn't updated when the tips.rst page was
removed.

Remove the reference to tips.rst, as well as tidy up the descriptions on
all of the links (especially given that sphinx gives the page titles
anyway.

Fixes: 4399c737a97d ("Documentation: kunit: Remove redundant 'tips.rst' page")
Signed-off-by: David Gow <davidgow@...gle.com>
---
 Documentation/dev-tools/kunit/index.rst | 18 +++++++-----------
 Documentation/dev-tools/kunit/start.rst | 16 ++++++----------
 2 files changed, 13 insertions(+), 21 deletions(-)

diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
index d5629817cd72..beec6f847ef4 100644
--- a/Documentation/dev-tools/kunit/index.rst
+++ b/Documentation/dev-tools/kunit/index.rst
@@ -99,14 +99,10 @@ 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.
+*   Documentation/dev-tools/kunit/start.rst - for new KUnit users
+*   Documentation/dev-tools/kunit/architecture.rst - how KUnit is put together
+*   Documentation/dev-tools/kunit/run_wrapper.rst - run tests via kunit.py
+*   Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit.py
+*   Documentation/dev-tools/kunit/usage.rst - write tests
+*   Documentation/dev-tools/kunit/api/index.rst - API reference
+*   Documentation/dev-tools/kunit/faq.rst - common questions and answers
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index f4f504f1fb15..58c176348885 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -294,13 +294,9 @@ 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.
+*   Documentation/dev-tools/kunit/architecture.rst - how KUnit is put together
+*   Documentation/dev-tools/kunit/run_wrapper.rst - run tests via kunit.py
+*   Documentation/dev-tools/kunit/run_manual.rst - run tests without kunit.py
+*   Documentation/dev-tools/kunit/usage.rst - write tests
+*   Documentation/dev-tools/kunit/api/index.rst - API reference
+*   Documentation/dev-tools/kunit/faq.rst - common questions and answers
-- 
2.38.1.584.g0f3c55d4c2-goog