Hi,
This is a short series of minor fixes to the Kunit documentation, they probably can be squashed but I suppose it's easier to review them individually.
Thanks for any feedbacks, Tales
Tales Aparecida (4): Documentation: kunit: fix trivial typo Documentation: Kunit: Fix inconsistent titles Documentation: KUnit: Fix non-uml anchor Documentation: Kunit: Add ref for other kinds of tests
Documentation/dev-tools/kunit/architecture.rst | 4 ++-- Documentation/dev-tools/kunit/faq.rst | 8 +++++--- Documentation/dev-tools/kunit/index.rst | 2 ++ Documentation/dev-tools/kunit/run_wrapper.rst | 4 +++- Documentation/dev-tools/kunit/usage.rst | 4 ++-- 5 files changed, 14 insertions(+), 8 deletions(-)
Missing closing block-quote
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com --- Documentation/dev-tools/kunit/run_wrapper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index cce203138fb7..db1e867820e7 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -30,7 +30,7 @@ We may want to use the following options:
.. code-block::
- ./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all + ./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all`
- ``--timeout`` sets a maximum amount of time for tests to run. - ``--jobs`` sets the number of threads to build the kernel.
On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida tales.aparecida@gmail.com wrote:
Missing closing block-quote
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
This is fine. A couple of minor nitpicks: 1. A slightly more descriptive commit title would be nice (e.g. "fix missing quote in run_wrapper") 2. The whole --jobs=`nproc --all` bit shouldn't be necessary anymore, thanks to: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?i...
Neither of those seem worth sending another version out for, but may be worth keeping in mind in the future.
Reviewed-by: David Gow davidgow@google.com
Cheers, -- David
Documentation/dev-tools/kunit/run_wrapper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index cce203138fb7..db1e867820e7 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -30,7 +30,7 @@ We may want to use the following options:
.. code-block::
./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all
./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all`
- ``--timeout`` sets a maximum amount of time for tests to run.
- ``--jobs`` sets the number of threads to build the kernel.
-- 2.37.1
-- You received this message because you are subscribed to the Google Groups "KUnit Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-2-tales.ap....
On Sat, Aug 13, 2022 at 9:51 AM Tales Aparecida tales.aparecida@gmail.com wrote:
Missing closing block-quote
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
Hi, I do agree with David on a more descriptive commit message to be addressed in future patches. Otherwise, it looks good to me.
Reviewed-by: Sadiya Kazi sadiyakazi@google.com
Best Regards, Sadiya
Documentation/dev-tools/kunit/run_wrapper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index cce203138fb7..db1e867820e7 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -30,7 +30,7 @@ We may want to use the following options:
.. code-block::
./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all
./tools/testing/kunit/kunit.py run --timeout=30 --jobs=`nproc --all`
- ``--timeout`` sets a maximum amount of time for tests to run.
- ``--jobs`` sets the number of threads to build the kernel.
-- 2.37.1
Use the same wording when citing and describing Kunit parts.
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com --- Documentation/dev-tools/kunit/architecture.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/dev-tools/kunit/architecture.rst b/Documentation/dev-tools/kunit/architecture.rst index cf9e6e3eeae4..8efe792bdcb9 100644 --- a/Documentation/dev-tools/kunit/architecture.rst +++ b/Documentation/dev-tools/kunit/architecture.rst @@ -6,8 +6,8 @@ KUnit Architecture
The KUnit architecture can be divided into two parts:
-- Kernel testing library -- kunit_tool (Command line test harness) +- `In-Kernel Testing Framework`_ +- `kunit_tool (Command Line Test Harness)`_
In-Kernel Testing Framework ===========================
On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida tales.aparecida@gmail.com wrote:
Use the same wording when citing and describing Kunit parts.
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
Nice catch! This is clearer.
Reviewed-by: David Gow davidgow@google.com
Cheers, -- David
Documentation/dev-tools/kunit/architecture.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/dev-tools/kunit/architecture.rst b/Documentation/dev-tools/kunit/architecture.rst index cf9e6e3eeae4..8efe792bdcb9 100644 --- a/Documentation/dev-tools/kunit/architecture.rst +++ b/Documentation/dev-tools/kunit/architecture.rst @@ -6,8 +6,8 @@ KUnit Architecture
The KUnit architecture can be divided into two parts:
-- Kernel testing library -- kunit_tool (Command line test harness) +- `In-Kernel Testing Framework`_ +- `kunit_tool (Command Line Test Harness)`_
In-Kernel Testing Framework
-- 2.37.1
-- You received this message because you are subscribed to the Google Groups "KUnit Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-3-tales.ap....
On Sat, Aug 13, 2022 at 9:51 AM Tales Aparecida tales.aparecida@gmail.com wrote:
Use the same wording when citing and describing Kunit parts.
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
This looks fine. Reviewed-by: Sadiya Kazi sadiyakazi@google.com
Best Regards, Sadiya
Documentation/dev-tools/kunit/architecture.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/dev-tools/kunit/architecture.rst b/Documentation/dev-tools/kunit/architecture.rst index cf9e6e3eeae4..8efe792bdcb9 100644 --- a/Documentation/dev-tools/kunit/architecture.rst +++ b/Documentation/dev-tools/kunit/architecture.rst @@ -6,8 +6,8 @@ KUnit Architecture
The KUnit architecture can be divided into two parts:
-- Kernel testing library -- kunit_tool (Command line test harness) +- `In-Kernel Testing Framework`_ +- `kunit_tool (Command Line Test Harness)`_
In-Kernel Testing Framework
-- 2.37.1
The section was rewritten but its anchor got left behind. Fix the anchor and add some references to running on QEMU.
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com --- Documentation/dev-tools/kunit/faq.rst | 6 +++--- Documentation/dev-tools/kunit/run_wrapper.rst | 2 ++ Documentation/dev-tools/kunit/usage.rst | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst index 172e239791a8..f1b4cef68ced 100644 --- a/Documentation/dev-tools/kunit/faq.rst +++ b/Documentation/dev-tools/kunit/faq.rst @@ -31,7 +31,8 @@ For the most part, the KUnit core framework (what we use to write the tests) can compile to any architecture. It compiles like just another part of the kernel and runs when the kernel boots, or when built as a module, when the module is loaded. However, there is infrastructure, like the KUnit Wrapper -(``tools/testing/kunit/kunit.py``) that does not support other architectures. +(``tools/testing/kunit/kunit.py``) that might not support some architectures +(see :ref:`kunit-on-qemu`).
In short, yes, you can run KUnit on other architectures, but it might require more work than using KUnit on UML. @@ -95,8 +96,7 @@ things to try. seeing. When tests are built-in, they will execute when the kernel boots, and modules will automatically execute associated tests when loaded. Test results can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and - can be parsed with ``kunit.py parse``. For more details, see "KUnit on - non-UML architectures" in Documentation/dev-tools/kunit/usage.rst. + can be parsed with ``kunit.py parse``. For more details, see :ref:`kunit-on-qemu`.
If none of the above tricks help, you are always welcome to email any issues to kunit-dev@googlegroups.com. diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index db1e867820e7..a1070def284f 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -165,6 +165,8 @@ example: if we only want to run KUnit resource tests, use:
This uses the standard glob format with wildcard characters.
+.. _kunit-on-qemu: + Run Tests on qemu =================
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst index 44158eecb51e..2737863ef365 100644 --- a/Documentation/dev-tools/kunit/usage.rst +++ b/Documentation/dev-tools/kunit/usage.rst @@ -165,6 +165,8 @@ built as a module).
For more information, see Documentation/dev-tools/kunit/api/test.rst.
+.. _kunit-on-non-uml: + Writing Tests For Other Architectures -------------------------------------
@@ -544,8 +546,6 @@ By reusing the same ``cases`` array from above, we can write the test as a {} };
-.. _kunit-on-non-uml: - Exiting Early on Failed Expectations ------------------------------------
On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida tales.aparecida@gmail.com wrote:
The section was rewritten but its anchor got left behind. Fix the anchor and add some references to running on QEMU.
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
Thanks very much for fixing these. This is something we tried to clean up last year when Qemu support happened, and we definitely missed these bits.
Reviewed-by: David Gow davidgow@google.com
Cheers, -- David
Documentation/dev-tools/kunit/faq.rst | 6 +++--- Documentation/dev-tools/kunit/run_wrapper.rst | 2 ++ Documentation/dev-tools/kunit/usage.rst | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst index 172e239791a8..f1b4cef68ced 100644 --- a/Documentation/dev-tools/kunit/faq.rst +++ b/Documentation/dev-tools/kunit/faq.rst @@ -31,7 +31,8 @@ For the most part, the KUnit core framework (what we use to write the tests) can compile to any architecture. It compiles like just another part of the kernel and runs when the kernel boots, or when built as a module, when the module is loaded. However, there is infrastructure, like the KUnit Wrapper -(``tools/testing/kunit/kunit.py``) that does not support other architectures. +(``tools/testing/kunit/kunit.py``) that might not support some architectures +(see :ref:`kunit-on-qemu`).
In short, yes, you can run KUnit on other architectures, but it might require more work than using KUnit on UML. @@ -95,8 +96,7 @@ things to try. seeing. When tests are built-in, they will execute when the kernel boots, and modules will automatically execute associated tests when loaded. Test results can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and
- can be parsed with ``kunit.py parse``. For more details, see "KUnit on
- non-UML architectures" in Documentation/dev-tools/kunit/usage.rst.
- can be parsed with ``kunit.py parse``. For more details, see :ref:`kunit-on-qemu`.
If none of the above tricks help, you are always welcome to email any issues to kunit-dev@googlegroups.com. diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst index db1e867820e7..a1070def284f 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -165,6 +165,8 @@ example: if we only want to run KUnit resource tests, use:
This uses the standard glob format with wildcard characters.
+.. _kunit-on-qemu:
Run Tests on qemu
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst index 44158eecb51e..2737863ef365 100644 --- a/Documentation/dev-tools/kunit/usage.rst +++ b/Documentation/dev-tools/kunit/usage.rst @@ -165,6 +165,8 @@ built as a module).
For more information, see Documentation/dev-tools/kunit/api/test.rst.
+.. _kunit-on-non-uml:
Writing Tests For Other Architectures
@@ -544,8 +546,6 @@ By reusing the same ``cases`` array from above, we can write the test as a {} };
-.. _kunit-on-non-uml:
Exiting Early on Failed Expectations
-- 2.37.1
-- You received this message because you are subscribed to the Google Groups "KUnit Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-4-tales.ap....
Add an organic link to the "other kinds of tests" in the index page
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com --- Documentation/dev-tools/kunit/faq.rst | 2 ++ Documentation/dev-tools/kunit/index.rst | 2 ++ 2 files changed, 4 insertions(+)
diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst index f1b4cef68ced..fae426f2634a 100644 --- a/Documentation/dev-tools/kunit/faq.rst +++ b/Documentation/dev-tools/kunit/faq.rst @@ -39,6 +39,8 @@ more work than using KUnit on UML.
For more information, see :ref:`kunit-on-non-uml`.
+.. _kinds-of-tests: + What is the difference between a unit test and other kinds of tests? ==================================================================== Most existing tests for the Linux kernel would be categorized as an integration diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst index 595205348d2d..bc91ad7b8961 100644 --- a/Documentation/dev-tools/kunit/index.rst +++ b/Documentation/dev-tools/kunit/index.rst @@ -95,6 +95,8 @@ Unit Testing Advantages - Improves code quality. - Encourages writing testable code.
+Read also :ref:`kinds-of-tests`. + How do I use it? ================
On Sat, Aug 13, 2022 at 12:21 PM Tales Aparecida tales.aparecida@gmail.com wrote:
Add an organic link to the "other kinds of tests" in the index page
Signed-off-by: Tales Aparecida tales.aparecida@gmail.com
Thanks.
It may also be worth looking at and/or linking to the kernel testing guide: https://docs.kernel.org/dev-tools/testing-overview.html
(This is a fine improvement as-is, regardless.)
Reviewed-by: David Gow davidgow@google.com
Cheers, -- David
Documentation/dev-tools/kunit/faq.rst | 2 ++ Documentation/dev-tools/kunit/index.rst | 2 ++ 2 files changed, 4 insertions(+)
diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst index f1b4cef68ced..fae426f2634a 100644 --- a/Documentation/dev-tools/kunit/faq.rst +++ b/Documentation/dev-tools/kunit/faq.rst @@ -39,6 +39,8 @@ more work than using KUnit on UML.
For more information, see :ref:`kunit-on-non-uml`.
+.. _kinds-of-tests:
What is the difference between a unit test and other kinds of tests?
Most existing tests for the Linux kernel would be categorized as an integration diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst index 595205348d2d..bc91ad7b8961 100644 --- a/Documentation/dev-tools/kunit/index.rst +++ b/Documentation/dev-tools/kunit/index.rst @@ -95,6 +95,8 @@ Unit Testing Advantages
- Improves code quality.
- Encourages writing testable code.
+Read also :ref:`kinds-of-tests`.
How do I use it?
-- 2.37.1
-- You received this message because you are subscribed to the Google Groups "KUnit Development" group. To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20220813042055.136832-5-tales.ap....
Hi Tales,
On 8/13/22 01:20, Tales Aparecida wrote:
Hi,
This is a short series of minor fixes to the Kunit documentation, they probably can be squashed but I suppose it's easier to review them individually.
Thanks for any feedbacks, Tales
Series is Reviewed-by: André Almeida andrealmeid@igalia.com
On 13/08/2022 01:20, Tales Aparecida wrote:
Hi,
This is a short series of minor fixes to the Kunit documentation, they probably can be squashed but I suppose it's easier to review them individually.
Thanks for any feedbacks, Tales
Tales Aparecida (4): Documentation: kunit: fix trivial typo Documentation: Kunit: Fix inconsistent titles Documentation: KUnit: Fix non-uml anchor Documentation: Kunit: Add ref for other kinds of tests
Documentation/dev-tools/kunit/architecture.rst | 4 ++-- Documentation/dev-tools/kunit/faq.rst | 8 +++++--- Documentation/dev-tools/kunit/index.rst | 2 ++ Documentation/dev-tools/kunit/run_wrapper.rst | 4 +++- Documentation/dev-tools/kunit/usage.rst | 4 ++-- 5 files changed, 14 insertions(+), 8 deletions(-)
Hello,
Thanks for the reviews, everyone! Should I send a V2 with squashed commits or will a committer handle that?
Kind regards, Tales
linux-kselftest-mirror@lists.linaro.org
-
André Almeida -
David Gow -
Sadiya Kazi -
Tales Aparecida -
Tales Lelo da Aparecida