From: Tales Aparecida <tales.aparecida@gmail.com>
To: Sadiya Kazi <sadiyakazi@google.com>, Tim.Bird@sony.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 v2 5/8] Documentation: KUnit: add intro to the getting-started page
Date: Sun, 21 Aug 2022 23:26:43 -0300 [thread overview]
Message-ID: <20220822022646.98581-6-tales.aparecida@gmail.com> (raw)
In-Reply-To: <20220822022646.98581-1-tales.aparecida@gmail.com>
Describe the objective of the Getting Started page, which should be a
brief and beginner-friendly walkthrough for running and writing tests,
showing the reader where to find detailed instructions in other pages.
Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
Reviewed-by: Maíra Canal <mairacanal@riseup.net>
---
Notes:
Remove recommendation about having compiled the kernel before using
kunit_tool. I changed my mind about it after Tim Bird's highlight.
---
Documentation/dev-tools/kunit/start.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index adf782507999..75fd05286396 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -4,6 +4,10 @@
Getting Started
===============
+This page contains an overview of the kunit_tool and KUnit framework,
+teaching how to run existing tests and then how to write a simple test case,
+and covers common problems users face when using KUnit for the first time.
+
Installing Dependencies
=======================
KUnit has the same dependencies as the Linux kernel. As long as you can
--
2.37.2
next prev parent reply other threads:[~2022-08-22 2:30 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-22 2:26 [PATCH v2 0/8] Documentation: Kunit: clean kunit-tool.rst and start.rst Tales Aparecida
2022-08-22 2:26 ` [PATCH v2 1/8] Documentation: KUnit: remove duplicated docs for kunit_tool Tales Aparecida
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst Tales Aparecida
2022-08-22 11:32 ` Maíra Canal
2022-08-22 17:36 ` Sadiya Kazi
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 3/8] Documentation: KUnit: add note about mrproper " Tales Aparecida
2022-08-26 7:29 ` David Gow
2022-08-22 2:26 ` [PATCH v2 4/8] Documentation: KUnit: Reword start guide for selecting tests Tales Aparecida
2022-08-22 6:07 ` Sadiya Kazi
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` Tales Aparecida [this message]
2022-08-22 6:23 ` [PATCH v2 5/8] Documentation: KUnit: add intro to the getting-started page Sadiya Kazi
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 6/8] Documentation: KUnit: update links in the index page Tales Aparecida
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 7/8] lib: overflow: update reference to kunit-tool Tales Aparecida
2022-08-26 7:30 ` David Gow
2022-08-22 2:26 ` [PATCH v2 8/8] lib: stackinit: " Tales Aparecida
2022-08-26 7:31 ` David Gow
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=20220822022646.98581-6-tales.aparecida@gmail.com \
--to=tales.aparecida@gmail.com \
--cc=Tim.Bird@sony.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;
as well as URLs for NNTP newsgroup(s).