Re: [PATCH v2 6/8] Documentation: KUnit: update links in the index page

From: David Gow <davidgow@google.com>
To: Tales Aparecida <tales.aparecida@gmail.com>
Cc: "Sadiya Kazi" <sadiyakazi@google.com>,
	"Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>,
	"KUnit Development" <kunit-dev@googlegroups.com>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	"open list:KERNEL SELFTEST FRAMEWORK"
	<linux-kselftest@vger.kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Brendan Higgins" <brendan.higgins@linux.dev>,
	"Trevor Woerner" <twoerner@gmail.com>,
	siqueirajordao@riseup.net, mwen@igalia.com,
	andrealmeid@riseup.net, "Maíra Canal" <mairacanal@riseup.net>,
	"Isabella Basso" <isabbasso@riseup.net>,
	magalilemes00@gmail.com
Subject: Re: [PATCH v2 6/8] Documentation: KUnit: update links in the index page
Date: Fri, 26 Aug 2022 15:30:23 +0800	[thread overview]
Message-ID: <CABVgOSkSMY3ek=5xQL-jPkP53vUCyQXGYmJbwK527fePEEiSxw@mail.gmail.com> (raw)
In-Reply-To: <20220822022646.98581-7-tales.aparecida@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2571 bytes --]

On Mon, Aug 22, 2022 at 10:30 AM Tales Aparecida
<tales.aparecida@gmail.com> wrote:
>
> Replace out-of-date external links with references to the kernel
> documentation, replacing TAP webpage for the more appropriate KTAP
> documentation and the UML webpage by its documentation.
>
> Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
> ---

Thanks. These links are definitely better.

(I'm a little sad about losing the link to the TAP page, but it's
linked-to from the KTAP page, so it's fine.)

Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David

>  Documentation/dev-tools/kunit/index.rst | 13 +++++++------
>  1 file changed, 7 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
> index d7187282ba28..f5d13f1d37be 100644
> --- a/Documentation/dev-tools/kunit/index.rst
> +++ b/Documentation/dev-tools/kunit/index.rst
> @@ -28,10 +28,10 @@ KUnit (Kernel unit testing framework) provides a common framework for
>  unit tests within the Linux kernel. Using KUnit, you can define groups
>  of test cases called test suites. The tests either run on kernel boot
>  if built-in, or load as a module. KUnit automatically flags and reports
> -failed test cases in the kernel log. The test results appear in `TAP
> -(Test Anything Protocol) format <https://testanything.org/>`_. It is inspired by
> -JUnit, Python’s unittest.mock, and GoogleTest/GoogleMock (C++ unit testing
> -framework).
> +failed test cases in the kernel log. The test results appear in
> +:doc:`KTAP (Kernel - Test Anything Protocol) format</dev-tools/ktap>`.
> +It is inspired by JUnit, Python’s unittest.mock, and GoogleTest/GoogleMock
> +(C++ unit testing framework).
>
>  KUnit tests are part of the kernel, written in the C (programming)
>  language, and test parts of the Kernel implementation (example: a C
> @@ -45,8 +45,9 @@ internal system functionality. KUnit runs in kernel space and is not
>  restricted to things exposed to user-space.
>
>  In addition, KUnit has kunit_tool, a script (``tools/testing/kunit/kunit.py``)
> -that configures the Linux kernel, runs KUnit tests under QEMU or UML (`User Mode
> -Linux <http://user-mode-linux.sourceforge.net/>`_), parses the test results and
> +that configures the Linux kernel, runs KUnit tests under QEMU or UML
> +(:doc:`User Mode Linux </virt/uml/user_mode_linux_howto_v2>`),
> +parses the test results and
>  displays them in a user friendly manner.
>
>  Features
> --
> 2.37.2
>

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4003 bytes --]