linux-kernel - RE: [PATCH 5/8] Documentation: KUnit: add intro to the getting-started page

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <BYAPR13MB25031D6AEDAE9CBCBC5EDD69FD6C9@BYAPR13MB2503.namprd13.prod.outlook.com>
Date:   Fri, 19 Aug 2022 15:59:38 +0000
From:   "Bird, Tim" <Tim.Bird@...y.com>
To:     Tales Aparecida <tales.aparecida@...il.com>,
        Sadiya Kazi <sadiyakazi@...gle.com>
CC:     "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "kunit-dev@...glegroups.com" <kunit-dev@...glegroups.com>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        "linux-kselftest@...r.kernel.org" <linux-kselftest@...r.kernel.org>,
        "davidgow@...gle.com" <davidgow@...gle.com>,
        "corbet@....net" <corbet@....net>,
        "brendan.higgins@...ux.dev" <brendan.higgins@...ux.dev>,
        Trevor Woerner <twoerner@...il.com>,
        "siqueirajordao@...eup.net" <siqueirajordao@...eup.net>,
        "mwen@...lia.com" <mwen@...lia.com>,
        "andrealmeid@...eup.net" <andrealmeid@...eup.net>,
        "mairacanal@...eup.net" <mairacanal@...eup.net>,
        Isabella Basso <isabbasso@...eup.net>,
        "magalilemes00@...il.com" <magalilemes00@...il.com>
Subject: RE: [PATCH 5/8] Documentation: KUnit: add intro to the
 getting-started page



> -----Original Message-----
> From: Tales Aparecida <tales.aparecida@...il.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@...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.

had -> has

before. -> before (what?? - reading these instructions?, running kunit?)

> +
>  Installing Dependencies
>  =======================
>  KUnit has the same dependencies as the Linux kernel. As long as you can
> --
> 2.37.1