linux-kernel - Re: [PATCH v2] Documentation: kunit: fix path to .kunitconfig in start.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CABVgOSm-t2qs8c4b6+xw1O8V8DfUPXEZV4ahjyLoqwQFSjJp1g@mail.gmail.com>
Date:   Tue, 1 Feb 2022 12:35:27 +0800
From:   David Gow <davidgow@...gle.com>
To:     Daniel Latypov <dlatypov@...gle.com>
Cc:     Brendan Higgins <brendanhiggins@...gle.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        Shuah Khan <skhan@...uxfoundation.org>,
        Yifan Yuan <alpc_metic@...e.com>
Subject: Re: [PATCH v2] Documentation: kunit: fix path to .kunitconfig in start.rst

On Tue, Feb 1, 2022 at 5:23 AM Daniel Latypov <dlatypov@...gle.com> wrote:
>
> Commit ddbd60c779b4 ("kunit: use --build_dir=.kunit as default") changed
> the default --build_dir, which had the side effect of making
> `.kunitconfig` move to `.kunit/.kunitconfig`.
>
> However, the first few lines of kunit/start.rst never got updated, oops.
>
> Fix this by telling people to run kunit.py first, which will
> automatically generate the .kunit directory and .kunitconfig file, and
> then edit the file manually as desired.
>
> Reported-by: Yifan Yuan <alpc_metic@...e.com>
> Signed-off-by: Daniel Latypov <dlatypov@...gle.com>
> ---
> v1 -> v2: rebase onto 5.17 (had the kunit docs rewrite)
> ---

Looks good: this was definitely confusing. And (my version of) sphinx
doesn't complain, which is reassuring.

Reviewed-by: David Gow <davidgow@...gle.com>

Cheers,
-- David

>  Documentation/dev-tools/kunit/start.rst | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index ad168d16968f..867a4bba6bf6 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -41,13 +41,18 @@ or ``VFAT_FS``. To run ``FAT_KUNIT_TEST``, the ``.kunitconfig`` has:
>         CONFIG_MSDOS_FS=y
>         CONFIG_FAT_KUNIT_TEST=y
>
> -1. A good starting point for the ``.kunitconfig``, is the KUnit default
> -   config. Run the command:
> +1. A good starting point for the ``.kunitconfig`` is the KUnit default config.
> +   You can generate it by running:
>
>  .. code-block:: bash
>
>         cd $PATH_TO_LINUX_REPO
> -       cp tools/testing/kunit/configs/default.config .kunitconfig
> +       tools/testing/kunit/kunit.py config
> +       cat .kunit/.kunitconfig
> +
> +.. note ::
> +   ``.kunitconfig`` lives in the ``--build_dir`` used by kunit.py, which is
> +   ``.kunit`` by default.
>
>  .. note ::
>     You may want to remove CONFIG_KUNIT_ALL_TESTS from the ``.kunitconfig`` as
>
> base-commit: c2741453478badf571ef020d160053e8d5e1ba94
> --
> 2.35.0.rc2.247.g8bbb082509-goog
>