| Message ID | 20220819053234.241501-6-tales.aparecida@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Delegated to: | Brendan Higgins |
| Headers | show |
| Series | Documentation: Kunit: clean kunit-tool.rst and start.rst | expand |
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@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. 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@riseup.net> Best Regards, - Maíra Canal > + > Installing Dependencies > ======================= > KUnit has the same dependencies as the Linux kernel. As long as you can
> -----Original Message----- > From: Tales Aparecida <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. 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
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
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(+)