ref-manual: Updated the WORKDIR variable description.

Removed the machine-dependent and machine-independent descriptions.
Created matching description from the "Writing a New Recipe"
section.

(From yocto-docs rev: 89a00beb81be60668abfdd67b13f5ee5bdc7ea1c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-01-14 18:02:08 -06:00 committed by Richard Purdie
parent 0829757cf4
commit 96e3b4206e
1 changed files with 36 additions and 42 deletions

View File

@ -7194,58 +7194,52 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
<glossdef>
<para>
The pathname of the work directory in which the OpenEmbedded build system
builds a recipe.
The pathname of the work directory in which the OpenEmbedded
build system builds a recipe.
This directory is located within the
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes
as different packages are built.
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
directory structure and changes as different packages are
built.
</para>
<para>
The actual <filename>WORKDIR</filename> directory depends on several things:
The <filename>WORKDIR</filename> directory is defined as
follows:
<literallayout class='monospaced'>
${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
</literallayout>
The actual directory depends on several things:
<itemizedlist>
<listitem>The temporary directory - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link></listitem>
<listitem>The package architecture - <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link></listitem>
<listitem>The target machine - <link linkend='var-MACHINE'><filename>MACHINE</filename></link></listitem>
<listitem>The target operating system - <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link></listitem>
<listitem>The recipe name - <link linkend='var-PN'><filename>PN</filename></link></listitem>
<listitem>The recipe version - <link linkend='var-PV'><filename>PV</filename></link></listitem>
<listitem>The recipe revision - <link linkend='var-PR'><filename>PR</filename></link></listitem>
<listitem><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>:
The top-level build output directory</listitem>
<listitem><link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>:
The target system identifier</listitem>
<listitem><link linkend='var-PN'><filename>PN</filename></link>:
The recipe name</listitem>
<listitem><link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>:
The epoch - (if
<link linkend='var-PE'><filename>PE</filename></link>
is not specified, which is usually the case for most
recipes, then <filename>EXTENDPE</filename> is blank)</listitem>
<listitem><link linkend='var-PV'><filename>PV</filename></link>:
The recipe version</listitem>
<listitem><link linkend='var-PR'><filename>PR</filename></link>:
The recipe revision</listitem>
</itemizedlist>
</para>
<para>
For packages that are not dependent on a particular machine,
<filename>WORKDIR</filename> is defined as follows:
As an example, assume a Source Directory top-level folder
name <filename>poky</filename>, a default Build Directory at
<filename>poky/build</filename>, and a
<filename>qemux86-poky-linux</filename> machine target
system.
Furthermore, suppose your recipe is named
<filename>foo_1.3.0-r0.bb</filename>.
In this case, the work directory the build system uses to
build the package would be as follows:
<literallayout class='monospaced'>
${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
</literallayout>
As an example, assume a
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
folder name <filename>poky</filename> and a default
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
at <filename>poky/build</filename>.
In this case, the work directory the build system uses to build
the <filename>v86d</filename> package is the following:
<literallayout class='monospaced'>
poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
</literallayout>
</para>
<para>
For packages that are dependent on a particular machine, <filename>WORKDIR</filename>
is defined slightly differently:
<literallayout class='monospaced'>
${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
</literallayout>
As an example, again assume a Source Directory top-level folder
named <filename>poky</filename> and a default Build Directory
at <filename>poky/build</filename>.
In this case, the work directory the build system uses to build
the <filename>acl</filename> recipe, which is being built for a
MIPS-based device, is the following:
<literallayout class='monospaced'>
poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
</literallayout>
</para>
</glossdef>