diff options
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 58 |
1 files changed, 56 insertions, 2 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index c8c6a669c9..e9bc81fe7b 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
@@ -1774,8 +1774,62 @@ | |||
1774 | 1774 | ||
1775 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | 1775 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> |
1776 | <glossdef> | 1776 | <glossdef> |
1777 | <para>The path to directory in <filename>tmp/work/</filename> where | 1777 | <para> |
1778 | the package is built.</para> | 1778 | The pathname of the working directory in which the Yocto Project build system |
1779 | builds packages. | ||
1780 | This directory is located within the | ||
1781 | <link linkend='var-TMPDIR'>TMPDIR</link> directory structure and changes | ||
1782 | as different packages are built. | ||
1783 | </para> | ||
1784 | |||
1785 | <para> | ||
1786 | The actual <filename>WORKDIR</filename> directory depends on several things: | ||
1787 | <itemizedlist> | ||
1788 | <listitem>The temporary directory - <link linkend='var-TMPDIR'>TMPDIR</link></listitem> | ||
1789 | <listitem>The package architecture - <link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></listitem> | ||
1790 | <listitem>The target machine - <link linkend='var-MACHINE'>MACHINE</link></listitem> | ||
1791 | <listitem>The target operating system - <link linkend='var-TARGET_OS'>TARGET_OS</link></listitem> | ||
1792 | <listitem>The package name - <link linkend='var-PN'>PN</link></listitem> | ||
1793 | <listitem>The package version - <link linkend='var-PV'>PV</link></listitem> | ||
1794 | <listitem>The package revision - <link linkend='var-PR'>PR</link></listitem> | ||
1795 | </itemizedlist> | ||
1796 | </para> | ||
1797 | |||
1798 | <para> | ||
1799 | For packages that are not dependent on a particular machine, | ||
1800 | <filename>WORKDIR</filename> is defined as follows: | ||
1801 | <literallayout class='monospaced'> | ||
1802 | ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} | ||
1803 | </literallayout> | ||
1804 | As an example, assume a | ||
1805 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'> | ||
1806 | Yocto Project Files</ulink> top-level directory named <filename>poky</filename> | ||
1807 | and a default | ||
1808 | <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'> | ||
1809 | Yocto Project Build Birectory</ulink> of <filename>poky/build</filename>. | ||
1810 | In this case, the working directory the build system uses to build | ||
1811 | the <filename>v86d</filename> package is the following: | ||
1812 | <literallayout class='monospaced'> | ||
1813 | ~/poky/build/tmp/work/qemux86-poky-linux/v86d-01.9-r0 | ||
1814 | </literallayout> | ||
1815 | </para> | ||
1816 | |||
1817 | <para> | ||
1818 | For packages that are dependent on a particular machine, <filename>WORKDIR</filename> | ||
1819 | is defined slightly different: | ||
1820 | <literallayout class='monospaced'> | ||
1821 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} | ||
1822 | </literallayout> | ||
1823 | As an example, again assume a Yocto Project Files top-level directory | ||
1824 | named <filename>poky</filename> and a default Yocto Project build directory | ||
1825 | of <filename>poky/build</filename>. | ||
1826 | In this case, the working directory the build system uses to build | ||
1827 | the <filename>acl</filename> package, which is dependent on a | ||
1828 | MIPS-based device, is the following: | ||
1829 | <literallayout class='monospaced'> | ||
1830 | ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 | ||
1831 | </literallayout> | ||
1832 | </para> | ||
1779 | </glossdef> | 1833 | </glossdef> |
1780 | </glossentry> | 1834 | </glossentry> |
1781 | 1835 | ||