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 5/8] Documentation: KUnit: add intro to the getting-started page
Date: Fri, 19 Aug 2022 02:32:31 -0300	[thread overview]
Message-ID: <20220819053234.241501-6-tales.aparecida@gmail.com> (raw)
In-Reply-To: <20220819053234.241501-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>
---
 Documentation/dev-tools/kunit/start.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst
index f0ec64207bd3..3855402a5b3e 100644
--- a/Documentation/dev-tools/kunit/start.rst
+++ b/Documentation/dev-tools/kunit/start.rst
@@ -4,6 +4,11 @@
 Getting Started
 ===============
 
+This page contains an overview about the kunit_tool and Kunit framework,
+teaching how to run existent tests and then how to write a simple test-case,
+and covering common problems users face when using Kunit for the first time.
+It is recommended that the reader had compiled the Kernel at least once before.
+
 Installing Dependencies
 =======================
 KUnit has the same dependencies as the Linux kernel. As long as you can
-- 
2.37.1


  parent reply	other threads:[~2022-08-19  5:33 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 ` [PATCH 2/8] Documentation: KUnit: avoid repeating "kunit.py run" in start.rst Tales Aparecida
2022-08-19 11:04   ` 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 ` Tales Aparecida [this message]
2022-08-19 11:28   ` [PATCH 5/8] Documentation: KUnit: add intro to the getting-started page 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-6-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