[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <ff728926-22e4-e65b-ee94-2ed958c92993@riseup.net>
Date: Fri, 19 Aug 2022 08:28:36 -0300
From: Maíra Canal <mairacanal@...eup.net>
To: Tales Aparecida <tales.aparecida@...il.com>,
Sadiya Kazi <sadiyakazi@...gle.com>
Cc: linux-kernel@...r.kernel.org, kunit-dev@...glegroups.com,
linux-doc@...r.kernel.org, linux-kselftest@...r.kernel.org,
davidgow@...gle.com, corbet@....net, brendan.higgins@...ux.dev,
Trevor Woerner <twoerner@...il.com>, siqueirajordao@...eup.net,
mwen@...lia.com, andrealmeid@...eup.net,
Isabella Basso <isabbasso@...eup.net>, magalilemes00@...il.com
Subject: Re: [PATCH 5/8] Documentation: KUnit: add intro to the
getting-started page
Hi Tales
On 8/19/22 02:32, Tales Aparecida wrote:
> 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@...il.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.
Some grammar nits:
- s/an overview about/an overview of
- s/Kunit/KUnit for consistency
- s/existent/existing
- s/covering/covers
Other than this small nits,
Reviewed-by: Maíra Canal <mairacanal@...eup.net>
Best Regards,
- Maíra Canal
> +
> Installing Dependencies
> =======================
> KUnit has the same dependencies as the Linux kernel. As long as you can
Powered by blists - more mailing lists