summaryrefslogtreecommitdiffstats
path: root/documentation/test-manual/ptest.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/test-manual/ptest.rst')
-rw-r--r--documentation/test-manual/ptest.rst17
1 files changed, 12 insertions, 5 deletions
diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst
index 2c021af515..4e6be35df5 100644
--- a/documentation/test-manual/ptest.rst
+++ b/documentation/test-manual/ptest.rst
@@ -46,13 +46,19 @@ Running ptest
46============= 46=============
47 47
48The ``ptest-runner`` package installs a shell script that loops through 48The ``ptest-runner`` package installs a shell script that loops through
49all installed ptest test suites and runs them in sequence. Consequently, 49all installed ptest test suites and runs them in sequence.
50you might want to add this package to your image. 50
51During the execution ``ptest-runner`` keeps count of total and failed
52``ptests``. At end the execution summary is written to the console.
53If any of the ``run-ptest`` fails, ``ptest-runner`` returns '1'.
54
55Consequently, you might want to add ``ptest-runner`` to your image.
56
51 57
52Getting Your Package Ready 58Getting Your Package Ready
53========================== 59==========================
54 60
55In order to enable a recipe to run installed ptests on target hardware, 61In order to enable a recipe to run installed ``ptests`` on target hardware,
56you need to prepare the recipes that build the packages you want to 62you need to prepare the recipes that build the packages you want to
57test. Here is what you have to do for each recipe: 63test. Here is what you have to do for each recipe:
58 64
@@ -77,8 +83,9 @@ test. Here is what you have to do for each recipe:
77 83
78- *Create run-ptest:* This script starts your test. Locate the 84- *Create run-ptest:* This script starts your test. Locate the
79 script where you will refer to it using 85 script where you will refer to it using
80 :term:`SRC_URI`. Here is an 86 :term:`SRC_URI`. Be sure ``run-ptest`` exits with 0 to mark it
81 example that starts a test for ``dbus``:: 87 as successfully executed otherwise will be marked as fail.
88 Here is an example that starts a test for ``dbus``::
82 89
83 #!/bin/sh 90 #!/bin/sh
84 cd test 91 cd test