[v4] Documentation: kunit: Add CLI args for kunit_tool

Commit Message

Sadiya Kazi July 26, 2022, 4:12 a.m. UTC

Some kunit_tool command line arguments are missing in run_wrapper.rst.
Document them.

Reported-by: Bagas Sanjaya <[e-mail]>
Reported-by: kernel test robot <[e-mail]>
Reviewed-by: David Gow <[e-mail]>
Reviewed-by: Brendan Higgins <[e-mail]>
Reviewed-by: Daniel Latypov <[e-mail]>
Reviewed-by: Maíra Canal <[e-mail]>
Signed-off-by: Sadiya Kazi <[e-mail]>
---

Changes since v3:
https://lore.kernel.org/linux-kselftest/[e-mail]/
-Fixed the indention bug in the run_wrapper.rst file. Thanks for
catching that(Kernel test robot, Bagas).
-Updated the commit message.

Changes since v2:
https://lore.kernel.org/linux-kselftest/[e-mail]/
-Added a code block for —kconfig_add argument to make the styling consistent
-Slightly changed the words for —arch argument
-Changed QEMU to qemu wherever applicable for the cli args
-Changed the style for ``-smp 8``
-Changed "Might be repeated" to "may be repeated” for kernel_args

Changes since V1:
https://lore.kernel.org/linux-kselftest/[e-mail]/
- Addressed most of the review comments from Maira and David, except
  removing the duplicate arguments as I felt its worth keeping them in
  the reference documentation as well as in context. We can improve them
  and differentiate their use cases in the future patches.

---
 Documentation/dev-tools/kunit/run_wrapper.rst | 63 ++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

Comments

Bagas Sanjaya July 26, 2022, 9:15 a.m. UTC | #1

On Tue, Jul 26, 2022 at 04:12:50AM +0000, Sadiya Kazi wrote:
> Some kunit_tool command line arguments are missing in run_wrapper.rst.
> Document them.
> 
> Reported-by: Bagas Sanjaya <[e-mail]>
> Reported-by: kernel test robot <[e-mail]>
> Reviewed-by: David Gow <[e-mail]>
> Reviewed-by: Brendan Higgins <[e-mail]>
> Reviewed-by: Daniel Latypov <[e-mail]>
> Reviewed-by: Maíra Canal <[e-mail]>
> Signed-off-by: Sadiya Kazi <[e-mail]>

I think Reported-by should only be used when submitting patches that
fixes build warnings/failure pointed to the code that is already in the
tree (like mainline).

Otherwise, the documentation builds succesfully without new warnings.

Reviewed-by: Bagas Sanjaya <[e-mail]>
Tested-by: Bagas Sanjaya <[e-mail]>

Patch

diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst
index 5e560f2c5fca..cce203138fb7 100644
--- a/Documentation/dev-tools/kunit/run_wrapper.rst
+++ b/Documentation/dev-tools/kunit/run_wrapper.rst
@@ -233,7 +233,7 @@  Command-Line Arguments
 ======================
 
 kunit_tool has a number of other command-line arguments which can
-be useful for our test environment. Below the most commonly used
+be useful for our test environment. Below are the most commonly used
 command line arguments:
 
 - ``--help``: Lists all available options. To list common options,
@@ -257,3 +257,64 @@  command line arguments:
             added or modified. Instead, enable all tests
             which have satisfied dependencies by adding
             ``CONFIG_KUNIT_ALL_TESTS=y`` to your ``.kunitconfig``.
+
+- ``--kunitconfig``: Specifies the path or the directory of the ``.kunitconfig``
+  file. For example:
+
+  - ``lib/kunit/.kunitconfig`` can be the path of the file.
+
+  - ``lib/kunit`` can be the directory in which the file is located.
+
+  This file is used to build and run with a predefined set of tests
+  and their dependencies. For example, to run tests for a given subsystem.
+
+- ``--kconfig_add``: Specifies additional configuration options to be
+  appended to the ``.kunitconfig`` file. For example:
+
+  .. code-block::
+
+	./tools/testing/kunit/kunit.py run --kconfig_add CONFIG_KASAN=y
+
+- ``--arch``: Runs tests on the specified architecture. The architecture
+  argument is same as the Kbuild ARCH environment variable.
+  For example, i386, x86_64, arm, um, etc. Non-UML architectures run on qemu.
+  Default is `um`.
+
+- ``--cross_compile``: Specifies the Kbuild toolchain. It passes the
+  same argument as passed to the ``CROSS_COMPILE`` variable used by
+  Kbuild. This will be the prefix for the toolchain
+  binaries such as GCC. For example:
+
+  - ``sparc64-linux-gnu-`` if we have the sparc toolchain installed on
+    our system.
+
+  - ``$HOME/toolchains/microblaze/gcc-9.2.0-nolibc/microblaze-linux/bin/microblaze-linux``
+    if we have downloaded the microblaze toolchain from the 0-day
+    website to a specified path in our home directory called toolchains.
+
+- ``--qemu_config``: Specifies the path to a file containing a
+  custom qemu architecture definition. This should be a python file
+  containing a `QemuArchParams` object.
+
+- ``--qemu_args``: Specifies additional qemu arguments, for example, ``-smp 8``.
+
+- ``--jobs``: Specifies the number of jobs (commands) to run simultaneously.
+  By default, this is set to the number of cores on your system.
+
+- ``--timeout``: Specifies the maximum number of seconds allowed for all tests to run.
+  This does not include the time taken to build the tests.
+
+- ``--kernel_args``: Specifies additional kernel command-line arguments. May be repeated.
+
+- ``--run_isolated``: If set, boots the kernel for each individual suite/test.
+  This is useful for debugging a non-hermetic test, one that
+  might pass/fail based on what ran before it.
+
+- ``--raw_output``: If set, generates unformatted output from kernel. Possible options are:
+
+   - ``all``: To view the full kernel output, use ``--raw_output=all``.
+
+   - ``kunit``: This is the default option and filters to KUnit output. Use ``--raw_output`` or ``--raw_output=kunit``.
+
+- ``--json``: If set, stores the test results in a JSON format and prints to `stdout` or
+  saves to a file if a filename is specified.