[yocto] [yocto-docs][PATCH 1/1] ref-manual, dev-manual: Updates to support PTEST_RUN_SCRIPT_PATH.

Ian Ray ian.ray at ge.com
Fri Sep 18 06:42:18 PDT 2015


In the ref-manual, I added a new variable description for the
PTEST_RUN_SCRIPT_PATH variable.

In the dev-manual, I added a note to the "Getting Your Package
Ready" section to mention that PTEST_RUN_SCRIPT_PATH can be used
to locate the run-ptest script.

Signed-off-by: Ian Ray <ian.ray at ge.com>
---
 documentation/dev-manual/dev-manual-common-tasks.xml |  5 ++++-
 documentation/ref-manual/ref-variables.xml           | 15 +++++++++++++++
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 7a28176..cd5bf51 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -7357,7 +7357,10 @@
                             This script starts your test.
                             Locate the script where you will refer to it
                             using
-                            <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
+                            <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> or
+                            <ulink url='&YOCTO_DOCS_REF_URL;#var-PTEST_RUN_SCRIPT_PATH'><filename>PTEST_RUN_SCRIPT_PATH</filename></ulink>
+                            if the ptest-run script is included with the recipe sources and unpacked to
+                            <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>.
                             Here is an example that starts a test for
                             <filename>dbus</filename>:
                             <literallayout class='monospaced'>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ecac2b6..7cc30c1 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -9188,6 +9188,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PTEST_RUN_SCRIPT_PATH'><glossterm>PTEST_RUN_SCRIPT_PATH</glossterm>
+            <info>
+                PTEST_RUN_SCRIPT_PATH[doc] = "Points to a directory where the run-ptest script is located."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    Points to a directory where the run-ptest script is located.
+                    This location defaults to the work directory
+                    (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>),
+                    but may be overridden within a recipe if a package ships its own run-ptest script.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PV'><glossterm>PV</glossterm>
             <info>
                 PV[doc] = "The version of the recipe. The version is normally extracted from the recipe filename."
-- 
1.8.3.1




More information about the yocto mailing list