documentation/poky-ref-manual/ref-variables.xml: Update S variable

Added more information to the "S" glossary entry.  Provided
an example.

(From yocto-docs rev: c36896c167d1721647d756210611667c4351b31b)

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
2012-02-09 10:24:30 -06:00
committed by Richard Purdie
parent e1b3ba8c95
commit c8d0effb67

View File

@@ -1467,10 +1467,26 @@
<glossentry id='var-S'><glossterm>S</glossterm>
<glossdef>
<para>
The path to unpacked sources.
By default, this path is as follows:
The location in the <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'>
Yocto Project Build Directory</ulink> where unpacked package 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-PN'>PN</link></filename>) and
package version (<filename><link linkend='var-PV'>PV</link></filename>) as
follows:
<literallayout class='monospaced'>
${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}
${WORKDIR}/${PN}-${PV}
</literallayout>
As an example, assume a
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>
Yocto Project Files</ulink> top-level directory named <filename>poky</filename>
and a default Yocto Project Build Directory of <filename>poky/build</filename>.
In this case, the working directory the build system uses to build
the <filename>db</filename> package is the following:
<literallayout class='monospaced'>
~/poky/build/tmp/work/qemux86-poky-linux/db-5.1.19-r3/db-5.1.19
</literallayout>
</para>
</glossdef>