From: Anibal Limon <anibal@limonsoftware.com>
To: docs@lists.yoctoproject.org
Cc: antonin.godard@bootlin.com, erik.schumacher@iris-sensing.com,
yoann.congal@smile.fr, Anibal Limon <anibal@limonsoftware.com>
Subject: [PATCHv5] test-manual/ptest: Add info about fail state of ptest-runner/ptests
Date: Thu, 19 Jun 2025 16:13:15 +0000 [thread overview]
Message-ID: <20250619161315.201350-1-anibal@limonsoftware.com> (raw)
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(-)
diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst
index 2c021af51..4e6be35df 100644
--- a/documentation/test-manual/ptest.rst
+++ b/documentation/test-manual/ptest.rst
@@ -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 count of total and failed
+``ptests``. At end the execution summary is written to the console.
+If any of the ``run-ptest`` fails, ``ptest-runner`` returns '1'.
+
+Consequently, you might want to add ``ptest-runner`` 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`` exits with 0 to mark it
+ as successfully executed otherwise will be marked as fail.
+ Here is an example that starts a test for ``dbus``::
#!/bin/sh
cd test
--
2.39.5
next reply other threads:[~2025-06-19 16:13 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-19 16:13 Anibal Limon [this message]
2025-07-01 8:37 ` [PATCHv5] test-manual/ptest: Add info about fail state of ptest-runner/ptests Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250619161315.201350-1-anibal@limonsoftware.com \
--to=anibal@limonsoftware.com \
--cc=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=erik.schumacher@iris-sensing.com \
--cc=yoann.congal@smile.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.