From 08d68e5bc806e6ffc324595f5a7e83c7ff767e35 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 1 Jul 2014 09:00:49 +0300
Subject: ref-manual, dev-manual: Updates to support PTEST_ENABLED.

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

In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.

(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/dev-manual/dev-manual-common-tasks.xml | 10 ++++++++++
 documentation/ref-manual/ref-variables.xml           | 15 +++++++++++++++
 2 files changed, 25 insertions(+)

(limited to 'documentation')

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 6aabdf4877..1e4f25d918 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5900,6 +5900,16 @@ Gateways via their Web Interfaces</ulink>"</emphasis>
      DISTRO_FEATURES_append = " ptest"
      EXTRA_IMAGE_FEATURES += "ptest-pkgs"
                     </literallayout>
+                    <note>
+                        The OpenEmbedded build system uses the
+                        <ulink url='&YOCTO_DOCS_REF_URL;#var-PTEST_ENABLED'><filename>PTEST_ENABLED</filename></ulink>
+                        variable to see if it should enable ptests during
+                        a build.
+                        This variable is enabled or disabled through your use
+                        of the <filename>DISTRO_FEATURES</filename> variable.
+                        You do not set <filename>PTEST_ENABLED</filename>
+                        directly.
+                    </note>
                     Once your build is complete, the ptest files are installed
                     into the <filename>/usr/lib/&lt;package&gt;/ptest</filename>
                     directory within the image, where
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 2b7a4b9a11..7a7efbcb96 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6485,6 +6485,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PTEST_ENABLED'><glossterm>PTEST_ENABLED</glossterm>
+            <glossdef>
+                <para>
+                    Specifies whether or not
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink>
+                    (ptest) functionality is enabled when building a recipe.
+                    You should not set this variable directly.
+                    Enabling and disabling building Package Tests
+                    at build time should be done by adding "ptest" to (or
+                    removing it from)
+                    <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
+                 </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PV'><glossterm>PV</glossterm>
             <glossdef>
                 <para>
-- 
cgit v1.2.3-54-g00ecf