| Message ID | 20220819053234.241501-3-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: > Combine two sections mentioning "kunit.py run" to streamline the > getting-started guide. > > Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com> > --- > Documentation/dev-tools/kunit/start.rst | 38 ++++++++++--------------- > 1 file changed, 15 insertions(+), 23 deletions(-) > > diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst > index e730df1f468e..165d7964aa13 100644 > --- a/Documentation/dev-tools/kunit/start.rst > +++ b/Documentation/dev-tools/kunit/start.rst > @@ -19,7 +19,21 @@ can run kunit_tool: > > ./tools/testing/kunit/kunit.py run > > -For more information on this wrapper, see: > +If everything worked correctly, you should see the following: > + > +.. code-block:: > + > + Generating .config ... When I run ./tools/testing/kunit/kunit.py run, I usually see "Configuring KUnit Kernel ..." instead of "Generating .config ...". Maybe there was a change in the code that didn't reflect on the docs. > + Building KUnit Kernel ... > + Starting KUnit Kernel ... > + > +The tests will pass or fail. > + > +.. note :: > + Because it is building a lot of sources for the first time, the > + ``Building KUnit kernel`` may take a while. Minor nit: s/``Building KUnit kernel``/``Building KUnit Kernel`` Best Regards, - Maíra Canal > + > +For detailed information on this wrapper, see: > Documentation/dev-tools/kunit/run_wrapper.rst. > > Creating a ``.kunitconfig`` > @@ -74,28 +88,6 @@ you if you have not included dependencies for the options used. > tools like ``make menuconfig O=.kunit``. As long as its a superset of > ``.kunitconfig``, kunit.py won't overwrite your changes. > > -Running Tests (KUnit Wrapper) > ------------------------------ > -1. To make sure that everything is set up correctly, invoke the Python > - wrapper from your kernel repository: > - > -.. code-block:: bash > - > - ./tools/testing/kunit/kunit.py run > - > -If everything worked correctly, you should see the following: > - > -.. code-block:: > - > - Generating .config ... > - Building KUnit Kernel ... > - Starting KUnit Kernel ... > - > -The tests will pass or fail. > - > -.. note :: > - Because it is building a lot of sources for the first time, the > - ``Building KUnit kernel`` may take a while. > > Running Tests without the KUnit Wrapper > =======================================
Thanks Tales, Please see my suggestions inline below. Regards, Sadiya Kazi On Fri, Aug 19, 2022 at 11:02 AM Tales Aparecida <tales.aparecida@gmail.com> wrote: > > Combine two sections mentioning "kunit.py run" to streamline the > getting-started guide. > > Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com> > --- > Documentation/dev-tools/kunit/start.rst | 38 ++++++++++--------------- > 1 file changed, 15 insertions(+), 23 deletions(-) > > diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst > index e730df1f468e..165d7964aa13 100644 > --- a/Documentation/dev-tools/kunit/start.rst > +++ b/Documentation/dev-tools/kunit/start.rst > @@ -19,7 +19,21 @@ can run kunit_tool: > > ./tools/testing/kunit/kunit.py run > > -For more information on this wrapper, see: > +If everything worked correctly, you should see the following: > + > +.. code-block:: > + > + Generating .config ... I also see this as "Configuring KUnit Kernel" when I run ./tools/testing/kunit/kunit.py. > + Building KUnit Kernel ... > + Starting KUnit Kernel ... > + > +The tests will pass or fail. > + > +.. note :: > + Because it is building a lot of sources for the first time, the > + ``Building KUnit kernel`` may take a while. > + > +For detailed information on this wrapper, see: > Documentation/dev-tools/kunit/run_wrapper.rst. > > Creating a ``.kunitconfig`` > @@ -74,28 +88,6 @@ you if you have not included dependencies for the options used. > tools like ``make menuconfig O=.kunit``. As long as its a superset of > ``.kunitconfig``, kunit.py won't overwrite your changes. > > -Running Tests (KUnit Wrapper) > ------------------------------ > -1. To make sure that everything is set up correctly, invoke the Python > - wrapper from your kernel repository: > - > -.. code-block:: bash > - > - ./tools/testing/kunit/kunit.py run > - > -If everything worked correctly, you should see the following: > - > -.. code-block:: > - > - Generating .config ... Same comment as above > - Building KUnit Kernel ... > - Starting KUnit Kernel ... > - > -The tests will pass or fail. > - > -.. note :: > - Because it is building a lot of sources for the first time, the > - ``Building KUnit kernel`` may take a while. Minor nit: Because it is building a lot of sources for the first time, the ``Building KUnit kernel`` step may take a while. > > Running Tests without the KUnit Wrapper > ======================================= > -- > 2.37.1 >
On Fri, Aug 19, 2022 at 7:04 PM Maíra Canal <mairacanal@riseup.net> wrote: > > Hi Tales > > On 8/19/22 02:32, Tales Aparecida wrote: > > Combine two sections mentioning "kunit.py run" to streamline the > > getting-started guide. > > > > Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com> > > --- > > Documentation/dev-tools/kunit/start.rst | 38 ++++++++++--------------- > > 1 file changed, 15 insertions(+), 23 deletions(-) > > > > diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst > > index e730df1f468e..165d7964aa13 100644 > > --- a/Documentation/dev-tools/kunit/start.rst > > +++ b/Documentation/dev-tools/kunit/start.rst > > @@ -19,7 +19,21 @@ can run kunit_tool: > > > > ./tools/testing/kunit/kunit.py run > > > > -For more information on this wrapper, see: > > +If everything worked correctly, you should see the following: > > + > > +.. code-block:: > > + > > + Generating .config ... > > When I run ./tools/testing/kunit/kunit.py run, I usually see > "Configuring KUnit Kernel ..." instead of "Generating .config ...". > Maybe there was a change in the code that didn't reflect on the docs. > FYI, The "Generating .config..." message will only appear if there's no .config file present in the build dir. Since this is the case the first time kunit_tool is used, it makes sense to mention it here in the "Getting Started" docs, IMHO. Cheers, -- David
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index e730df1f468e..165d7964aa13 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -19,7 +19,21 @@ can run kunit_tool: ./tools/testing/kunit/kunit.py run -For more information on this wrapper, see: +If everything worked correctly, you should see the following: + +.. code-block:: + + Generating .config ... + Building KUnit Kernel ... + Starting KUnit Kernel ... + +The tests will pass or fail. + +.. note :: + Because it is building a lot of sources for the first time, the + ``Building KUnit kernel`` may take a while. + +For detailed information on this wrapper, see: Documentation/dev-tools/kunit/run_wrapper.rst. Creating a ``.kunitconfig`` @@ -74,28 +88,6 @@ you if you have not included dependencies for the options used. tools like ``make menuconfig O=.kunit``. As long as its a superset of ``.kunitconfig``, kunit.py won't overwrite your changes. -Running Tests (KUnit Wrapper) ------------------------------ -1. To make sure that everything is set up correctly, invoke the Python - wrapper from your kernel repository: - -.. code-block:: bash - - ./tools/testing/kunit/kunit.py run - -If everything worked correctly, you should see the following: - -.. code-block:: - - Generating .config ... - Building KUnit Kernel ... - Starting KUnit Kernel ... - -The tests will pass or fail. - -.. note :: - Because it is building a lot of sources for the first time, the - ``Building KUnit kernel`` may take a while. Running Tests without the KUnit Wrapper =======================================
Combine two sections mentioning "kunit.py run" to streamline the getting-started guide. Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com> --- Documentation/dev-tools/kunit/start.rst | 38 ++++++++++--------------- 1 file changed, 15 insertions(+), 23 deletions(-)