Skip to contentSkip to conversation

Documentation: kunit: Fix verification command

PATCH In review SeongJae Park 3 participants 4 messages Sep 7, 2019 – Oct 7, 2019

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: kunit: Fix verification command

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.

---
 Documentation/dev-tools/kunit/start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/kunit/start.rst +1 -1
index 6dc229e..aeeddfa 100644
@@ -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.
Signature · 1 line
2.7.4
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · 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.

Quoted 9 lines
---
 Documentation/dev-tools/kunit/start.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/kunit/start.rst +0 -0
index 6dc229e..aeeddfa 100644

Documentation/dev-tools/kunit/start.rst wrapper from your kernel repo: · line 46

Quoted 5 lines
Documentation/dev-tools/kunit/start.rst +1 -1
@@ -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!

Quoted 5 lines
Documentation/dev-tools/kunit/start.rst +0 -1
 .. note::
    You may want to run ``make mrproper`` first.
--

2.7.4

#2 lore raw
Quoted 9 lines · Brendan Higgins
Quoted 7 lines · 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.

Quoted 3 lines
Quoted 1 line

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

maintainer
#3 lore raw
Quoted 11 lines · Brendan Higgins
Quoted 9 lines · Brendan Higgins
Quoted 7 lines · 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.

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

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