From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 266D4C43334 for ; Mon, 25 Jul 2022 19:55:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230347AbiGYTzu (ORCPT ); Mon, 25 Jul 2022 15:55:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35424 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229727AbiGYTzu (ORCPT ); Mon, 25 Jul 2022 15:55:50 -0400 Received: from mx1.riseup.net (mx1.riseup.net [198.252.153.129]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5E03B1FCD4; Mon, 25 Jul 2022 12:55:49 -0700 (PDT) Received: from fews1.riseup.net (fews1-pn.riseup.net [10.0.1.83]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "mail.riseup.net", Issuer "R3" (not verified)) by mx1.riseup.net (Postfix) with ESMTPS id 4Ls9l850sgzDqp7; Mon, 25 Jul 2022 19:55:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=riseup.net; s=squak; t=1658778948; bh=mpReOiN/RY75zoMf4n89mpn8nYOfilNXT1Bz9nVZHtM=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=rAOeofzZIFJw8oDhuu0BZeu2ckd7lmZm8zNsIJEIA9AbdBVQI0W1sTbVNuh/U3bRw grCwSfIovVE5E6/eu/tm0eTqIaRHi7LeeGvDETVni3smPsCMj4qbq8cS+y4Mt3MfEN 7hlLTnszUc6/pV86yJeeJn2eEJDjmfwzcoBXfPX8= X-Riseup-User-ID: 4F0FA5B3531717062ABA367EF50A7BB26B56809C141FF3EF210042EAAD284977 Received: from [127.0.0.1] (localhost [127.0.0.1]) by fews1.riseup.net (Postfix) with ESMTPSA id 4Ls9l56ht1z5vgM; Mon, 25 Jul 2022 19:55:45 +0000 (UTC) Message-ID: Date: Mon, 25 Jul 2022 16:55:42 -0300 MIME-Version: 1.0 Subject: Re: [PATCH v3] Documentation: kunit: Add CLI args for kunit_tool Content-Language: en-US To: Sadiya Kazi , brendanhiggins@google.com, davidgow@google.com, skhan@linuxfoundation.org, corbet@lwn.net Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org References: <20220724184758.1723925-1-sadiyakazi@google.com> From: =?UTF-8?Q?Ma=c3=adra_Canal?= In-Reply-To: <20220724184758.1723925-1-sadiyakazi@google.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kselftest@vger.kernel.org Hi Sadiya, On 7/24/22 15:47, Sadiya Kazi wrote: > Run_wrapper.rst was missing some command line arguments. Added > additional args in the file. > > Signed-off-by: Sadiya Kazi Usually, when people send their Reviewed-by on a previous version, we send the next version with their tags in chronological order [1]. > --- > Changes since v2: > https://lore.kernel.org/linux-kselftest/20220721081026.1247067-1-sadiyakazi@google.com/ > -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 > Also, it is a common practice to keep the entire changelog here [1]. Other than the error reported-by kernel test robot, looks good to me. Reviewed-by: Maíra Canal [1] https://docs.kernel.org/process/submitting-patches.html#the-canonical-patch-format Best Regards, - Maíra Canal > > > --- > Documentation/dev-tools/kunit/run_wrapper.rst | 61 ++++++++++++++++++- > 1 file changed, 60 insertions(+), 1 deletion(-) > > diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/dev-tools/kunit/run_wrapper.rst > index 5e560f2c5fca..ed3715fef32d 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,62 @@ 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.