summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-01-14 18:02:08 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-21 21:58:02 +0000
commit96e3b4206e981c225c77613df3deab53706cb7b5 (patch)
tree178868b70d8fad1053ea7377845626c38403d6fb
parent0829757cf4dcea484643383cd7ff717feef945f3 (diff)
downloadpoky-96e3b4206e981c225c77613df3deab53706cb7b5.tar.gz
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>
-rw-r--r--documentation/ref-manual/ref-variables.xml78
1 files changed, 36 insertions, 42 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index d6c4a76a2b..61f374806d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7194,58 +7194,52 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7194 <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> 7194 <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
7195 <glossdef> 7195 <glossdef>
7196 <para> 7196 <para>
7197 The pathname of the work directory in which the OpenEmbedded build system 7197 The pathname of the work directory in which the OpenEmbedded
7198 builds a recipe. 7198 build system builds a recipe.
7199 This directory is located within the 7199 This directory is located within the
7200 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes 7200 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
7201 as different packages are built. 7201 directory structure and changes as different packages are
7202 built.
7202 </para> 7203 </para>
7203 7204
7204 <para> 7205 <para>
7205 The actual <filename>WORKDIR</filename> directory depends on several things: 7206 The <filename>WORKDIR</filename> directory is defined as
7206 <itemizedlist> 7207 follows:
7207 <listitem>The temporary directory - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link></listitem>
7208 <listitem>The package architecture - <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link></listitem>
7209 <listitem>The target machine - <link linkend='var-MACHINE'><filename>MACHINE</filename></link></listitem>
7210 <listitem>The target operating system - <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link></listitem>
7211 <listitem>The recipe name - <link linkend='var-PN'><filename>PN</filename></link></listitem>
7212 <listitem>The recipe version - <link linkend='var-PV'><filename>PV</filename></link></listitem>
7213 <listitem>The recipe revision - <link linkend='var-PR'><filename>PR</filename></link></listitem>
7214 </itemizedlist>
7215 </para>
7216
7217 <para>
7218 For packages that are not dependent on a particular machine,
7219 <filename>WORKDIR</filename> is defined as follows:
7220 <literallayout class='monospaced'>
7221 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
7222 </literallayout>
7223 As an example, assume a
7224 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
7225 folder name <filename>poky</filename> and a default
7226 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
7227 at <filename>poky/build</filename>.
7228 In this case, the work directory the build system uses to build
7229 the <filename>v86d</filename> package is the following:
7230 <literallayout class='monospaced'> 7208 <literallayout class='monospaced'>
7231 poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0 7209 ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
7232 </literallayout> 7210 </literallayout>
7211 The actual directory depends on several things:
7212 <itemizedlist>
7213 <listitem><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>:
7214 The top-level build output directory</listitem>
7215 <listitem><link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>:
7216 The target system identifier</listitem>
7217 <listitem><link linkend='var-PN'><filename>PN</filename></link>:
7218 The recipe name</listitem>
7219 <listitem><link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>:
7220 The epoch - (if
7221 <link linkend='var-PE'><filename>PE</filename></link>
7222 is not specified, which is usually the case for most
7223 recipes, then <filename>EXTENDPE</filename> is blank)</listitem>
7224 <listitem><link linkend='var-PV'><filename>PV</filename></link>:
7225 The recipe version</listitem>
7226 <listitem><link linkend='var-PR'><filename>PR</filename></link>:
7227 The recipe revision</listitem>
7228 </itemizedlist>
7233 </para> 7229 </para>
7234 7230
7235 <para> 7231 <para>
7236 For packages that are dependent on a particular machine, <filename>WORKDIR</filename> 7232 As an example, assume a Source Directory top-level folder
7237 is defined slightly differently: 7233 name <filename>poky</filename>, a default Build Directory at
7238 <literallayout class='monospaced'> 7234 <filename>poky/build</filename>, and a
7239 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${PV}-${PR} 7235 <filename>qemux86-poky-linux</filename> machine target
7240 </literallayout> 7236 system.
7241 As an example, again assume a Source Directory top-level folder 7237 Furthermore, suppose your recipe is named
7242 named <filename>poky</filename> and a default Build Directory 7238 <filename>foo_1.3.0-r0.bb</filename>.
7243 at <filename>poky/build</filename>. 7239 In this case, the work directory the build system uses to
7244 In this case, the work directory the build system uses to build 7240 build the package would be as follows:
7245 the <filename>acl</filename> recipe, which is being built for a
7246 MIPS-based device, is the following:
7247 <literallayout class='monospaced'> 7241 <literallayout class='monospaced'>
7248 poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 7242 poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
7249 </literallayout> 7243 </literallayout>
7250 </para> 7244 </para>
7251 </glossdef> 7245 </glossdef>