ref-manual: Added new DEPLOYDIR variable.

(From yocto-docs rev: 7edc293539ffc630f05e4a63f6efff4e4e9930b7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 21 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 2f3aafacc6..210b29da17 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1321,6 +1321,27 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm>
+            <glossdef>
+                <para>
+                    For recipes that inherit the
+                    <link linkend='ref-classes-deploy'><filename>deploy</filename></link>
+                    class, the <filename>DEPLOYDIR</filename> points to a
+                    temporary work area for deployed files that is set in the
+                    <filename>deploy</filename> class as follows:
+                    <literallayout class='monospaced'>
+     DEPLOYDIR = "${WORKDIR}/deploy-${<link linkend='var-PN'><filename>PN</filename></link>}"
+                    </literallayout>
+                    Recipes inheriting the <filename>deploy</filename> class
+                    should copy files to be deployed into
+                    <filename>DEPLOYDIR</filename>, and the class will take
+                    care of copying them into
+                    <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
+                    afterwards.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
             <glossdef>
                 <para>The package description used by package managers.