linux-kselftest.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: SeongJae Park <sj38.park@gmail.com>
To: brendanhiggins@google.com, shuah@kernel.org
Cc: corbet@lwn.net, linux-kselftest@vger.kernel.org,
	kunit-dev@googlegroups.com, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, SeongJae Park <sjpark@amazon.de>
Subject: [PATCH 2/6] docs/kunit/start: Skip wrapper run command
Date: Mon,  2 Dec 2019 08:25:20 +0900	[thread overview]
Message-ID: <1575242724-4937-3-git-send-email-sj38.park@gmail.com> (raw)
In-Reply-To: <1575242724-4937-1-git-send-email-sj38.park@gmail.com>

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.

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
 ======================
 The Python script is a thin wrapper around Kbuild as such, it needs to be
-- 
2.7.4


  parent reply	other threads:[~2019-12-01 23:26 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-01 23:25 [PATCH 0/6] Fix nits in the kunit SeongJae Park
2019-12-01 23:25 ` [PATCH 1/6] docs/kunit/start: Use in-tree 'kunit_defconfig' SeongJae Park
2019-12-02 17:13   ` Brendan Higgins
2019-12-01 23:25 ` SeongJae Park [this message]
2019-12-02 17:25   ` [PATCH 2/6] docs/kunit/start: Skip wrapper run command Brendan Higgins
2019-12-02 20:59     ` SeongJae Park
2019-12-03  8:27       ` SeongJae Park
2019-12-02 21:03     ` David Gow
2019-12-02 21:09       ` SeongJae Park
2019-12-01 23:25 ` [PATCH 3/6] kunit: Remove duplicated defconfig creation SeongJae Park
2019-12-02 17:27   ` Brendan Higgins
2019-12-01 23:25 ` [PATCH 4/6] kunit: Create default config in 'build_dir' SeongJae Park
2019-12-03  6:40   ` Brendan Higgins
2019-12-03  8:28     ` SeongJae Park
2019-12-01 23:25 ` [PATCH 5/6] kunit: Place 'test.log' under the 'build_dir' SeongJae Park
2019-12-03  6:48   ` Brendan Higgins
2019-12-01 23:25 ` [PATCH 6/6] kunit: Rename 'kunitconfig' to '.kunitconfig' SeongJae Park
2019-12-03  7:00 ` [PATCH 0/6] Fix nits in the kunit Brendan Higgins
2019-12-03  7:10   ` SeongJae Park
2019-12-03  8:25     ` SeongJae Park
2019-12-03 17:45       ` Brendan Higgins
2019-12-03 18:10         ` SeongJae Park
2019-12-03 22:35           ` Brendan Higgins

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1575242724-4937-3-git-send-email-sj38.park@gmail.com \
    --to=sj38.park@gmail.com \
    --cc=brendanhiggins@google.com \
    --cc=corbet@lwn.net \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=shuah@kernel.org \
    --cc=sjpark@amazon.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).