From nobody Sat Apr 18 02:47:54 2026 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 425D2C43334 for ; Tue, 19 Jul 2022 09:22:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237143AbiGSJWm (ORCPT ); Tue, 19 Jul 2022 05:22:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48038 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235846AbiGSJWY (ORCPT ); Tue, 19 Jul 2022 05:22:24 -0400 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AD1AF10D6 for ; Tue, 19 Jul 2022 02:22:21 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-31e55e88567so19660307b3.15 for ; Tue, 19 Jul 2022 02:22:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=date:message-id:mime-version:subject:from:to:cc; bh=KovM5m9Iu+8wBRMriioge8BEE5ifITpdRRU2nQEdeDk=; b=kDYGB4RydVygHc+YAmyBVD8txGmKH2WudLiJiTqu7qOhG/e7lQZsTPTZ5/FDBj2ieQ li6ymq8ImnMB8etvsp4FbDjajNykpVJsOPiB2vmDlC6jLoPgZ+u8VDuGgbruJXTtuVvl MydfGqW+adgx+dBr4xdUAjzIH9lL+QVmMtPsWJz5eSppfx/zzA+DOa1uaCdqsqT3maC6 LMyJsJTot5FPa8CBI1Yxl0QM2JWsp9BK5JgBSglSK1WudskNYgM1PF/JW5gOtwbplNra RjBSRqoAiW2Ye7Ye5IxXjZgBeLRNjuggB+RvOoeKEvvegXGun5/AJlDy+dyaK15Favp+ OVZA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:message-id:mime-version:subject:from:to:cc; bh=KovM5m9Iu+8wBRMriioge8BEE5ifITpdRRU2nQEdeDk=; b=hTVZaMhkeEMSdgc8OPl92keXWinTdSFHFm22NoiUQGDvTnHn9SChhjt8rtqIYmzHfj me6yPWaInjVKbg3Jkq6HEJ6LXTNZc5OcgBwKF3MVvaxnKN7E7jmRcyjQXggK2l7VmFzw eRZYGQPp4zCcRXG4Q3gHwGLQ862sKryhMW9meUX//GodgyaN8ESn8nWU3w3Y7gYtzBLL Vm+yvCl+OhDkY78m16secdPCuoTBzLRlGyGMP5GUyjSXyXEZOKohAW7K9exLjojH6+Iu deAo9f8xjjBXlq4yjMjxxQjmfVe+/KP8jk3E+joqBkkrXAbzxdDzhkE+58dfOhgtYAzz 4h4Q== X-Gm-Message-State: AJIora88KK7YsE+ZYGdZ44AUvrx6RhNgDKPxqvgDrCrFndSknv/mUPlc /Sc66s+f3QWi8xksxVPvmM6yeaqLyujlBvLy X-Google-Smtp-Source: AGRyM1tX4ntzL6CFfgsSFEX41qDpN6AJFpHeZHzP+J3yvd15fGv8FVkzS1S/ofZm2aLIFJZaud3B0DYoK3Irb4dL X-Received: from skazigti.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:411e]) (user=sadiyakazi job=sendgmr) by 2002:a25:8749:0:b0:66f:28a9:7595 with SMTP id e9-20020a258749000000b0066f28a97595mr29048736ybn.568.1658222540969; Tue, 19 Jul 2022 02:22:20 -0700 (PDT) Date: Tue, 19 Jul 2022 09:22:14 +0000 Message-Id: <20220719092214.995965-1-sadiyakazi@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.37.0.170.g444d1eabd0-goog Subject: [PATCH] Documentation: kunit: Add CLI args for kunit_tool From: Sadiya Kazi To: brendanhiggins@google.com, davidgow@google.com, skhan@linuxfoundation.org, corbet@lwn.net, linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Sadiya Kazi Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Run_wrapper.rst was missing some command line arguments. Added additional args in the file. Included all initial review comments. Signed-off-by: Sadiya Kazi --- Documentation/dev-tools/kunit/run_wrapper.rst | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/Documentation/dev-tools/kunit/run_wrapper.rst b/Documentation/= dev-tools/kunit/run_wrapper.rst index 5e560f2c5fca..91f5dda36e83 100644 --- a/Documentation/dev-tools/kunit/run_wrapper.rst +++ b/Documentation/dev-tools/kunit/run_wrapper.rst @@ -257,3 +257,51 @@ command line arguments: added or modified. Instead, enable all tests which have satisfied dependencies by adding ``CONFIG_KUNIT_ALL_TESTS=3Dy`` to your ``.kunitconfig``. +- ``--kunitconfig``: Specifies the path to the ``.kunitconfig`` file. + This Kconfig fragment enables KUnit tests. The "/.kunitconfig" gets + appended to the path specified. For example, If a directory path "lib/ku= nit" + is given, the complete path will be "lib/kunit/.kunitconfig". + +- ``--kconfig_add``: Specifies additional configuration options to be + appended to the ``.kunitconfig`` file. For example, ``CONFIG_KASAN=3Dy``. + +- ``--arch``: Runs tests with the specified architecture. The architecture + specified must match the string passed to the ARCH make parameter. + For example, i386, x86_64, arm, um, etc. Non-UML architectures run on QE= MU. + Default to '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/mi= croblaze-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 the 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 simultaneousl= y. + By default, this is set to the number of cores on your system. + +- ``--timeout``: Specifies the maximum number of seconds allowed for all t= ests to run. + This does not include the time taken to build the tests. + +- ``--kernel_args``: Specifies the kernel command-line arguments. Might be= repeated. + +- ``--run_isolated``: If set, boots the kernel for each individual suite/t= est. + 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. + If set to ``--raw_output=3Dkunit``, filters to just KUnit output. + +- ``--json``: If set, it stores the test results in a JSON format and prin= ts to stdout or + saves to a file if a filename is specified. --=20 2.37.0.170.g444d1eabd0-goog