linux-kselftest.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: David Gow <davidgow@google.com>
To: Shuah Khan <skhan@linuxfoundation.org>,
	Brendan Higgins <brendan.higgins@linux.dev>,
	Sadiya Kazi <sadiyakazi@google.com>
Cc: David Gow <davidgow@google.com>, Jonathan Corbet <corbet@lwn.net>,
	Daniel Latypov <dlatypov@google.com>, Rae Moar <rmoar@google.com>,
	linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com,
	linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections
Date: Tue, 29 Nov 2022 17:47:32 +0800	[thread overview]
Message-ID: <20221129094732.306449-1-davidgow@google.com> (raw)

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@google.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


             reply	other threads:[~2022-11-29  9:47 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-29  9:47 David Gow [this message]
2022-11-30  4:45 ` [PATCH] Documentation: kunit: Fix "How Do I Use This" / "Next Steps" sections Sadiya Kazi
2022-11-30  8:18 ` Bagas Sanjaya
2022-12-01 20:48 ` Rae Moar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221129094732.306449-1-davidgow@google.com \
    --to=davidgow@google.com \
    --cc=brendan.higgins@linux.dev \
    --cc=corbet@lwn.net \
    --cc=dlatypov@google.com \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=rmoar@google.com \
    --cc=sadiyakazi@google.com \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).