@@ -46,13 +46,19 @@ Running ptest
=============
The ``ptest-runner`` package installs a shell script that loops through
-all installed ptest test suites and runs them in sequence. Consequently,
-you might want to add this package to your image.
+all installed ptest test suites and runs them in sequence.
+
+During the execution ``ptest-runner`` keeps counter of total and failed
+``ptests``, At end the execution summary is written to the console. If
+any of the ``run-ptest`` fails returns '1'.
+
+Consequently, you might want to add this package to your image.
+
Getting Your Package Ready
==========================
-In order to enable a recipe to run installed ptests on target hardware,
+In order to enable a recipe to run installed ``ptests`` on target hardware,
you need to prepare the recipes that build the packages you want to
test. Here is what you have to do for each recipe:
@@ -77,8 +83,9 @@ test. Here is what you have to do for each recipe:
- *Create run-ptest:* This script starts your test. Locate the
script where you will refer to it using
- :term:`SRC_URI`. Here is an
- example that starts a test for ``dbus``::
+ :term:`SRC_URI`. Be sure ``run-ptest`` exit with 0 to mark it
+ as sucessfully executed otherwise will be marked as fail.
+ Here is an example that starts a test for ``dbus``::
#!/bin/sh
cd test
On the ML was pointed about no specific information about ptest-runner/ptests so improve docs around. https://lists.yoctoproject.org/g/yocto-patches/message/1622 [YOCTO #15832] Signed-off-by: Anibal Limon <anibal@limonsoftware.com> --- documentation/test-manual/ptest.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-)