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>
This commit is contained in:
Scott Rifenbark 2016-09-16 10:43:10 -07:00 committed by Richard Purdie
parent 5ec03cd359
commit ad1ba190df
2 changed files with 17 additions and 19 deletions

View File

@ -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>

View File

@ -9691,33 +9691,30 @@ 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>
</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.
</para>
<para>
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>