summaryrefslogtreecommitdiffstats
path: root/documentation
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
parent5ec03cd359332d87f2fd4f4542a58dea1600ec96 (diff)
downloadpoky-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')
-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 @@
417 <title><filename>do_packagedata</filename></title> 417 <title><filename>do_packagedata</filename></title>
418 418
419 <para> 419 <para>
420 Creates package metadata used by the build system to generate the 420 Saves package metadata generated by the
421 final packages. 421 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
422 The data is saved in 422 task in
423 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>. 423 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
424 to make it available globally.
424 </para> 425 </para>
425 </section> 426 </section>
426 427
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"
9691 9691
9692 <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm> 9692 <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm>
9693 <info> 9693 <info>
9694 PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task." 9694 PKGDESTWORK[doc] = "Points to a temporary work area where the do_package task saves package metadata."
9695 </info> 9695 </info>
9696 <glossdef> 9696 <glossdef>
9697 <para role="glossdeffirst"> 9697 <para role="glossdeffirst">
9698<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9698<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9699 Points to a temporary work area used by the 9699 Points to a temporary work area where the
9700 <link linkend='ref-tasks-package'><filename>do_package</filename></link> 9700 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
9701 task to write output from the 9701 task saves package metadata.
9702 <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
9703 task.
9704 The <filename>PKGDESTWORK</filename> location defaults to 9702 The <filename>PKGDESTWORK</filename> location defaults to
9705 the following: 9703 the following:
9706 <literallayout class='monospaced'> 9704 <literallayout class='monospaced'>
9707 ${WORKDIR}/pkgdata 9705 ${WORKDIR}/pkgdata
9708 </literallayout> 9706 </literallayout>
9707 Do not change this default.
9709 </para> 9708 </para>
9710 9709
9711 <para> 9710 <para>
9712 The <filename>do_packagedata</filename> task then packages 9711 The
9713 the data in the temporary work area and installs it into a 9712 <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
9714 shared directory pointed to by 9713 task copies the package metadata from
9715 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>. 9714 <filename>PKGDESTWORK</filename> to
9716 </para> 9715 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
9717 9716 to make it available globally.
9718 <para>
9719 Do not change this default.
9720 </para> 9717 </para>
9721 </glossdef> 9718 </glossdef>
9722 </glossentry> 9719 </glossentry>