public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Tales Aparecida <tales.aparecida@gmail.com>
To: Sadiya Kazi <sadiyakazi@google.com>
Cc: linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com,
	linux-doc@vger.kernel.org, linux-kselftest@vger.kernel.org,
	davidgow@google.com, corbet@lwn.net, brendan.higgins@linux.dev,
	Trevor Woerner <twoerner@gmail.com>,
	siqueirajordao@riseup.net, mwen@igalia.com,
	andrealmeid@riseup.net, mairacanal@riseup.net,
	Isabella Basso <isabbasso@riseup.net>,
	magalilemes00@gmail.com, tales.aparecida@gmail.com
Subject: [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst
Date: Fri, 19 Aug 2022 02:32:28 -0300	[thread overview]
Message-ID: <20220819053234.241501-3-tales.aparecida@gmail.com> (raw)
In-Reply-To: <20220819053234.241501-1-tales.aparecida@gmail.com>

Combine two sections mentioning "kunit.py run" to streamline the
getting-started guide.

Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
---
 Documentation/dev-tools/kunit/start.rst | 38 ++++++++++---------------
 1 file changed, 15 insertions(+), 23 deletions(-)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index e730df1f468e..165d7964aa13 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -19,7 +19,21 @@ can run kunit_tool:
 
 	./tools/testing/kunit/kunit.py run
 
-For more information on this wrapper, see:
+If everything worked correctly, you should see the following:
+
+.. code-block::
+
+	Generating .config ...
+	Building KUnit Kernel ...
+	Starting KUnit Kernel ...
+
+The tests will pass or fail.
+
+.. note ::
+   Because it is building a lot of sources for the first time, the
+   ``Building KUnit kernel`` may take a while.
+
+For detailed information on this wrapper, see:
 Documentation/dev-tools/kunit/run_wrapper.rst.
 
 Creating a ``.kunitconfig``
@@ -74,28 +88,6 @@ you if you have not included dependencies for the options used.
    tools like ``make menuconfig O=.kunit``. As long as its a superset of
    ``.kunitconfig``, kunit.py won't overwrite your changes.
 
-Running Tests (KUnit Wrapper)
------------------------------
-1. To make sure that everything is set up correctly, invoke the Python
-   wrapper from your kernel repository:
-
-.. code-block:: bash
-
-	./tools/testing/kunit/kunit.py run
-
-If everything worked correctly, you should see the following:
-
-.. code-block::
-
-	Generating .config ...
-	Building KUnit Kernel ...
-	Starting KUnit Kernel ...
-
-The tests will pass or fail.
-
-.. note ::
-   Because it is building a lot of sources for the first time, the
-   ``Building KUnit kernel`` may take a while.
 
 Running Tests without the KUnit Wrapper
 =======================================
-- 
2.37.1


  parent reply	other threads:[~2022-08-19  5:32 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-19  5:32 [PATCH 0/8] Documentation: Kunit: clean kunit-tool.rst and start.rst Tales Aparecida
2022-08-19  5:32 ` [PATCH 1/8] Documentation: KUnit: remove duplicated docs for kunit_tool Tales Aparecida
2022-08-19 12:33   ` Sadiya Kazi
2022-08-19  5:32 ` Tales Aparecida [this message]
2022-08-19 11:04   ` [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst Maíra Canal
2022-08-26  7:01     ` David Gow
2022-08-19 13:10   ` Sadiya Kazi
2022-08-19  5:32 ` [PATCH 3/8] Documentation: KUnit: restore note about mrproper " Tales Aparecida
2022-08-19 13:44   ` Sadiya Kazi
2022-08-19  5:32 ` [PATCH 4/8] Documentation: KUnit: Reword start guide for selecting tests Tales Aparecida
2022-08-19 11:22   ` Maíra Canal
2022-08-19  5:32 ` [PATCH 5/8] Documentation: KUnit: add intro to the getting-started page Tales Aparecida
2022-08-19 11:28   ` Maíra Canal
2022-08-19 15:59   ` Bird, Tim
2022-08-19  5:32 ` [PATCH 6/8] Documentation: KUnit: update links in the index page Tales Aparecida
2022-08-19  5:32 ` [PATCH 7/8] lib: overflow: update reference to kunit-tool Tales Aparecida
2022-08-19 22:18   ` Kees Cook
2022-08-22 20:09   ` Daniel Latypov
2022-08-22 22:35     ` Tales
2022-08-22 22:52       ` Daniel Latypov
2022-08-22 23:12         ` Tales
2022-08-22 23:15           ` Daniel Latypov
2022-08-19  5:32 ` [PATCH 8/8] lib: stackinit: " Tales Aparecida

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=20220819053234.241501-3-tales.aparecida@gmail.com \
    --to=tales.aparecida@gmail.com \
    --cc=andrealmeid@riseup.net \
    --cc=brendan.higgins@linux.dev \
    --cc=corbet@lwn.net \
    --cc=davidgow@google.com \
    --cc=isabbasso@riseup.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=magalilemes00@gmail.com \
    --cc=mairacanal@riseup.net \
    --cc=mwen@igalia.com \
    --cc=sadiyakazi@google.com \
    --cc=siqueirajordao@riseup.net \
    --cc=twoerner@gmail.com \
    /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