ref-manual: New variables descriptions for PKGDATA_DIR and PKGDESTWORK

(From yocto-docs rev: a5c3663f6fa6e8f98a7626b99b5ad9ca2058670b)

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

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index afcf7a72ba659a7244a56edf85ca965a4d20a80f..040c386945abd3538548069340f4526cf647590c 100644 (file)
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3490,6 +3490,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm>
+            <glossdef>
+                <para>
+                    Points to a shared, global-state directory that holds data
+                    generated during the packaging process.
+                    During the packaging process, the
+                    <filename>do_packagedata</filename> task packages
+                    data for each recipe and installs it into this temporary,
+                    shared area.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm>
             <glossdef>
                 <para>
@@ -3507,6 +3520,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm>
+            <glossdef>
+                <para>
+                    Points to a temporary work area used by the
+                    <filename>do_package</filename> task to write output
+                    from the <filename>do_packagedata</filename> task.
+                    The <filename>PKGDESTWORK</filename> location defaults to
+                    the following:
+                    <literallayout class='monospaced'>
+     ${WORKDIR}/pkgdata
+                    </literallayout>
+                    The <filename>do_packagedata</filename> task then packages
+                    the data in the temporary work area and installs it into a
+                    shared directory pointed to by
+                    <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>.
+                </para>
+
+                <para>
+                    Do not change this default.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PN'><glossterm>PN</glossterm>
             <glossdef>
                 <para>This variable can have two separate functions depending on the context: a recipe