| Message ID | 20220822022646.98581-7-tales.aparecida@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 79c18e37c4e645560f3952bf177a10b43e94bf88 |
| Delegated to: | Brendan Higgins |
| Headers | show |
| Series | Documentation: Kunit: clean kunit-tool.rst and start.rst | expand |
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 >
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
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> --- Documentation/dev-tools/kunit/index.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)