ref-manual: Updates to the S variable description in the glossary.

(From yocto-docs rev: 44a2b16f77cb86e37f3dcd46c52f699a59e3b418)

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 2013-08-06 15:53:59 +03:00 committed by Richard Purdie
parent 2111a92a73
commit 97ece259f7
1 changed files with 14 additions and 11 deletions

View File

@ -3389,24 +3389,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-S'><glossterm>S</glossterm>
<glossdef>
<para>
The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
where unpacked package source code resides.
The location in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
where unpacked recipe source code resides.
This location is within the working directory
(<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which
is not static.
The unpacked source location depends on the package name
(<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>),
which is not static.
The unpacked source location depends on the recipe name
(<filename><link linkend='var-PN'>PN</link></filename>) and
package version (<filename><link linkend='var-PV'>PV</link></filename>) as
recipe version
(<filename><link linkend='var-PV'>PV</link></filename>) as
follows:
<literallayout class='monospaced'>
${WORKDIR}/${PN}/${PV}
</literallayout>
As an example, assume a
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
folder named <filename>poky</filename> and a default Build
Directory at <filename>poky/build</filename>.
In this case, the working directory the build system uses to build
the <filename>db</filename> package is the following:
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
top-level folder named <filename>poky</filename> and a
default Build Directory at <filename>poky/build</filename>.
In this case, the working directory the build system uses
to keep the unpacked recipe for <filename>db</filename>
is the following:
<literallayout class='monospaced'>
~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
</literallayout>