[PATCH] Documentation: kunit: Fix verification command

[PATCH] Documentation: kunit: Fix verification command

[SeongJae Park]

kunit wrapper script ('kunit.py') receives a sub-command (only 'run' for
now) as its argument.  If no sub-command is given, it prints help
message and just quit.  However, an example command in the kunit
documentation for a verification of kunit is missing the sub-command.
This commit fixes the example.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 Documentation/dev-tools/kunit/start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index 6dc229e..aeeddfa 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -43,7 +43,7 @@ wrapper from your kernel repo:
 
 .. code-block:: bash
 
-	./tools/testing/kunit/kunit.py
+	./tools/testing/kunit/kunit.py run
 
 .. note::
    You may want to run ``make mrproper`` first.
-- 
2.7.4

Re: [PATCH] Documentation: kunit: Fix verification command

[Brendan Higgins]

On Sat, Sep 7, 2019 at 2:01 PM SeongJae Park <sj38.park@gmail.com> wrote:
>
> kunit wrapper script ('kunit.py') receives a sub-command (only 'run' for
> now) as its argument.  If no sub-command is given, it prints help
> message and just quit.  However, an example command in the kunit
> documentation for a verification of kunit is missing the sub-command.
> This commit fixes the example.
>
> Signed-off-by: SeongJae Park <sj38.park@gmail.com>

Reviewed-by: Brendan Higgins <brendanhiggins@google.com>

> ---
>  Documentation/dev-tools/kunit/start.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
> index 6dc229e..aeeddfa 100644
> --- a/Documentation/dev-tools/kunit/start.rst
> +++ b/Documentation/dev-tools/kunit/start.rst
> @@ -43,7 +43,7 @@ wrapper from your kernel repo:
>
>  .. code-block:: bash
>
> -       ./tools/testing/kunit/kunit.py
> +       ./tools/testing/kunit/kunit.py run

Ooops, that's embarrassing; I have the right command a couple lines above.

In anycase, thanks for finding and fixing this!

>  .. note::
>     You may want to run ``make mrproper`` first.
> --
> 2.7.4
>

Re: [PATCH] Documentation: kunit: Fix verification command

[Brendan Higgins]

On Sun, Sep 8, 2019 at 4:40 PM Brendan Higgins
<brendanhiggins@google.com> wrote:
>
> On Sat, Sep 7, 2019 at 2:01 PM SeongJae Park <sj38.park@gmail.com> wrote:
> >
> > kunit wrapper script ('kunit.py') receives a sub-command (only 'run' for
> > now) as its argument.  If no sub-command is given, it prints help
> > message and just quit.  However, an example command in the kunit
> > documentation for a verification of kunit is missing the sub-command.
> > This commit fixes the example.
> >
> > Signed-off-by: SeongJae Park <sj38.park@gmail.com>
>
> Reviewed-by: Brendan Higgins <brendanhiggins@google.com>

Shuah, can you apply this to the kselftest KUnit branch? This should
not require a resend.

Re: [PATCH] Documentation: kunit: Fix verification command

[shuah]

On 10/7/19 4:04 PM, Brendan Higgins wrote:
> On Sun, Sep 8, 2019 at 4:40 PM Brendan Higgins
> <brendanhiggins@google.com> wrote:
>>
>> On Sat, Sep 7, 2019 at 2:01 PM SeongJae Park <sj38.park@gmail.com> wrote:
>>>
>>> kunit wrapper script ('kunit.py') receives a sub-command (only 'run' for
>>> now) as its argument.  If no sub-command is given, it prints help
>>> message and just quit.  However, an example command in the kunit
>>> documentation for a verification of kunit is missing the sub-command.
>>> This commit fixes the example.
>>>
>>> Signed-off-by: SeongJae Park <sj38.park@gmail.com>
>>
>> Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
> 
> Shuah, can you apply this to the kselftest KUnit branch? This should
> not require a resend.
> 


Done. Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git 
test

thanks,
-- Shuah