Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
MIME-Version: 1.0
References: <1575242724-4937-1-git-send-email-sj38.park@gmail.com> <1575242724-4937-3-git-send-email-sj38.park@gmail.com>
In-Reply-To: <1575242724-4937-3-git-send-email-sj38.park@gmail.com>
From:   Brendan Higgins <brendanhiggins@google.com>
Date:   Mon, 2 Dec 2019 09:25:41 -0800
Message-ID: <CAFd5g47C6OShsYy5ngSGTmkL3fQoj-6jb09iQ+CD6FE0usggCA@mail.gmail.com>
Subject: Re: [PATCH 2/6] docs/kunit/start: Skip wrapper run command
To:     SeongJae Park <sj38.park@gmail.com>,
        David Gow <davidgow@google.com>
Cc:     shuah <shuah@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@vger.kernel.org>,
        KUnit Development <kunit-dev@googlegroups.com>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        SeongJae Park <sjpark@amazon.de>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

+David Gow - David has lots of good opinions on our documentation.

On Sun, Dec 1, 2019 at 3:25 PM SeongJae Park <sj38.park@gmail.com> wrote:
>
> From: SeongJae Park <sjpark@amazon.de>
>
> The kunit 'Getting Started' document first shows the wrapper running
> command.  However, a new user who simply following the command might
> encounter a failure like below:
>
>     $ ./tools/testing/kunit/kunit.py run
>     Traceback (most recent call last):
>       File "./tools/testing/kunit/kunit.py", line 140, in <module>
>         main(sys.argv[1:])
>       File "./tools/testing/kunit/kunit.py", line 126, in main
>         linux = kunit_kernel.LinuxSourceTree()
>       File "/home/sjpark/linux/tools/testing/kunit/kunit_kernel.py", line 85, in __init__
>         self._kconfig.read_from_file(KUNITCONFIG_PATH)
>       File "/home/sjpark/linux/tools/testing/kunit/kunit_config.py", line 65, in read_from_file
>         with open(path, 'r') as f:
>     FileNotFoundError: [Errno 2] No such file or directory: 'kunitconfig'
>
> Though the reason of the failure ('kunitconfig') is explained in its
> next section, it would be better to reduce any failure that user might
> encounter.  This commit removes the example command for the reason.

Seems reasonable.

> Signed-off-by: SeongJae Park <sjpark@amazon.de>
> ---
>  Documentation/dev-tools/kunit/start.rst | 6 ------
>  1 file changed, 6 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index 78a0aed..e25978d 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -15,12 +15,6 @@ Included with KUnit is a simple Python wrapper that helps format the output to
>  easily use and read KUnit output. It handles building and running the kernel, as
>  well as formatting the output.
>
> -The wrapper can be run with:
> -
> -.. code-block:: bash
> -
> -   ./tools/testing/kunit/kunit.py run
> -
>  Creating a kunitconfig
>  ======================

I think maybe we should demote this section so that this is a
subsection under KUnit Wrapper. Might also want to add a tie-in
explaining why we are talking about kunitconfig here? Right now this
kind of reads as a non sequitur.

Note: we have tried to address this potential issue for new users in
this patch under review:

https://patchwork.kernel.org/patch/11252953/

I don't feel strongly whether we do it your way or my way. What do
other people think?

>  The Python script is a thin wrapper around Kbuild as such, it needs to be
> --
> 2.7.4
>