diff mbox series

[v5,03/41] doc: Document make tcheck

Message ID 20210308003517.1574569-4-sjg@chromium.org
State Accepted
Commit 8d16ebdf81cda3e07eb76cd7f2efc52cbaf0475b
Delegated to: Tom Rini
Headers show
Series test: Refactor tests to have a single test runner | expand

Commit Message

Simon Glass March 8, 2021, 12:34 a.m. UTC
Add a comment about this option in the documentation. Also mention the
script that runs these combinations.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v2)

Changes in v2:
- Expand docs on how each type of test is marked

 doc/develop/testing.rst | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

Comments

Heinrich Schuchardt March 8, 2021, 4:27 a.m. UTC | #1
Am 8. März 2021 01:34:39 MEZ schrieb Simon Glass <sjg@chromium.org>:
>Add a comment about this option in the documentation. Also mention the
>script that runs these combinations.
>
>Signed-off-by: Simon Glass <sjg@chromium.org>
>---
>
>(no changes since v2)
>
>Changes in v2:
>- Expand docs on how each type of test is marked
>
> doc/develop/testing.rst | 12 +++++++++++-
> 1 file changed, 11 insertions(+), 1 deletion(-)
>
>diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst
>index bc74eb53e35..f01ca4dc408 100644
>--- a/doc/develop/testing.rst
>+++ b/doc/develop/testing.rst
>@@ -15,10 +15,20 @@ To run most tests on sandbox, type this::
>in the U-Boot directory. Note that only the pytest suite is run using
>this
> command.
> 
>-Some tests take ages to run. To run just the quick ones, type this::

"Ages" is a bit of an exaggeration when referring to a few seconds.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>



>+Some tests take ages to run and are marked with @pytest.mark.slow. To
>run just
>+the quick ones, type this::
> 
>     make qcheck
> 
>+It is also possible to run just the tests for tools (patman, binman,
>etc.).
>+Such tests are included with those tools, i.e. no actual U-Boot unit
>tests are
>+run. Type this::
>+
>+    make tcheck
>+
>+All of the above use the test/run script with a paremeter to select
>which tests
>+are run.
>+
> 
> Sandbox
> -------
Simon Glass March 8, 2021, 3:07 p.m. UTC | #2
Hi Heinrich,

On Sun, 7 Mar 2021 at 23:27, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Am 8. März 2021 01:34:39 MEZ schrieb Simon Glass <sjg@chromium.org>:
> >Add a comment about this option in the documentation. Also mention the
> >script that runs these combinations.
> >
> >Signed-off-by: Simon Glass <sjg@chromium.org>
> >---
> >
> >(no changes since v2)
> >
> >Changes in v2:
> >- Expand docs on how each type of test is marked
> >
> > doc/develop/testing.rst | 12 +++++++++++-
> > 1 file changed, 11 insertions(+), 1 deletion(-)
> >
> >diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst
> >index bc74eb53e35..f01ca4dc408 100644
> >--- a/doc/develop/testing.rst
> >+++ b/doc/develop/testing.rst
> >@@ -15,10 +15,20 @@ To run most tests on sandbox, type this::
> >in the U-Boot directory. Note that only the pytest suite is run using
> >this
> > command.
> >
> >-Some tests take ages to run. To run just the quick ones, type this::
>
> "Ages" is a bit of an exaggeration when referring to a few seconds.

It is actually about 53 seconds extra for me all up, which really does
feel like ages! A slow test in my book is something that takes a
noticeable time, since with close to 1000 tests, it all adds up.

>
> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Regards,
Simon
diff mbox series

Patch

diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst
index bc74eb53e35..f01ca4dc408 100644
--- a/doc/develop/testing.rst
+++ b/doc/develop/testing.rst
@@ -15,10 +15,20 @@  To run most tests on sandbox, type this::
 in the U-Boot directory. Note that only the pytest suite is run using this
 command.
 
-Some tests take ages to run. To run just the quick ones, type this::
+Some tests take ages to run and are marked with @pytest.mark.slow. To run just
+the quick ones, type this::
 
     make qcheck
 
+It is also possible to run just the tests for tools (patman, binman, etc.).
+Such tests are included with those tools, i.e. no actual U-Boot unit tests are
+run. Type this::
+
+    make tcheck
+
+All of the above use the test/run script with a paremeter to select which tests
+are run.
+
 
 Sandbox
 -------