aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-09-16 10:43:10 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-09-23 15:27:34 +0100
commitad1ba190df11353df7dd676ca30bbc8bd6e68671 (patch)
tree944d5b6e2f9fd33cc4c9878c8a4384886a988875 /documentation/ref-manual
parent5ec03cd359332d87f2fd4f4542a58dea1600ec96 (diff)
downloadopenembedded-core-contrib-ad1ba190df11353df7dd676ca30bbc8bd6e68671.tar.gz
ref-manual: Updates to PKGDESTWORK and do_packagedata
Fixes [YOCTO #10248] Provided more accurate descriptions for this variable and task. (From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-tasks.xml9
-rw-r--r--documentation/ref-manual/ref-variables.xml23
2 files changed, 15 insertions, 17 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index fa9fca1ce3..0ad3632538 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -417,10 +417,11 @@
<title><filename>do_packagedata</filename></title>
<para>
- Creates package metadata used by the build system to generate the
- final packages.
- The data is saved in
- <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>.
+ Saves package metadata generated by the
+ <link linkend='ref-tasks-package'><filename>do_package</filename></link>
+ task in
+ <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
+ to make it available globally.
</para>
</section>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index a97369dfad..89970421ad 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -9691,32 +9691,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm>
<info>
- PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task."
+ PKGDESTWORK[doc] = "Points to a temporary work area where the do_package task saves package metadata."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
- Points to a temporary work area used by the
+ Points to a temporary work area where the
<link linkend='ref-tasks-package'><filename>do_package</filename></link>
- task to write output from the
- <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
- task.
+ task saves package metadata.
The <filename>PKGDESTWORK</filename> location defaults to
the following:
<literallayout class='monospaced'>
${WORKDIR}/pkgdata
</literallayout>
+ Do not change this default.
</para>
<para>
- 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.
+ The
+ <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
+ task copies the package metadata from
+ <filename>PKGDESTWORK</filename> to
+ <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
+ to make it available globally.
</para>
</glossdef>
</glossentry>