summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-22 09:24:39 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:59 -0800
commit87133d137ab84cf3d9332bba83f75bda2f2a6552 (patch)
tree15e9a4dc58dc56265fbe6c50b100cc57afc127d9
parent66ce594d284eac26c4cdcfd04b4e07a7de540118 (diff)
downloadpoky-87133d137ab84cf3d9332bba83f75bda2f2a6552.tar.gz
documentation/dev-manual/dev-manual-common-tasks.xml: Review comments
Applied Paul Eggleton's review comments. Basically trying to clarify what is the S variable and what is the WORKDIR variable when determining where unpacked source files are. (From yocto-docs rev: e139e441653fa00309de204b7ad9f5a7ad7bdcb8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml31
1 files changed, 20 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 9a5160cd9e..c675a373bf 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -773,7 +773,10 @@ so that there are some definite steps on how to do this. I need more detail her
773 During a build, the unpacked temporary source code used by recipes 773 During a build, the unpacked temporary source code used by recipes
774 to build packages is available in the Yocto Project build directory as 774 to build packages is available in the Yocto Project build directory as
775 defined by the 775 defined by the
776 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable: 776 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable.
777 Below is the default value for the <filename>S</filename> variable as defined in the
778 <filename>/conf/local.conf</filename> configuration file in the Yocto
779 Project's Build Directory:
777 <literallayout class='monospaced'> 780 <literallayout class='monospaced'>
778 S = ${WORKDIR}/${PN}-${PV} 781 S = ${WORKDIR}/${PN}-${PV}
779 </literallayout> 782 </literallayout>
@@ -781,9 +784,15 @@ so that there are some definite steps on how to do this. I need more detail her
781 784
782 <para> 785 <para>
783 The actual location within the build directory for the temporary source code 786 The actual location within the build directory for the temporary source code
784 depends on the package name and the architecture of the target device. 787 depends on the package name and the architecture of the target device,
788 which are part of the
789 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink> variable's definition.
790 </para>
791
792 <para>
785 Here is the temporary source code location for packages whose targets are not 793 Here is the temporary source code location for packages whose targets are not
786 device-dependent: 794 device-dependent.
795 This location comprises <filename>WORKDIR</filename>:
787 <literallayout class='monospaced'> 796 <literallayout class='monospaced'>
788 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 797 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
789 </literallayout> 798 </literallayout>
@@ -815,15 +824,15 @@ so that there are some definite steps on how to do this. I need more detail her
815 <note> 824 <note>
816 To better understand how the Yocto Project build system resolves directories during the 825 To better understand how the Yocto Project build system resolves directories during the
817 build process, see the glossary entries for the 826 build process, see the glossary entries for the
818 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'>WORKDIR</ulink>, 827 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>,
819 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TMPDIR'>TMPDIR</ulink>, 828 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TMPDIR'><filename>TMPDIR</filename></ulink>,
820 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TOPDIR'>TOPDIR</ulink>, 829 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TOPDIR'><filename>TOPDIR</filename></ulink>,
821 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGE_ARCH'>PACKAGE_ARCH</ulink>, 830 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>,
822 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_OS'>TARGET_OS</ulink>, 831 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>,
823 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'>PN</ulink>, 832 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PN'><filename>PN</filename></ulink>,
824 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'>PV</ulink>, 833 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PV'><filename>PV</filename></ulink>,
825 and 834 and
826 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'>PR</ulink> 835 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PR'><filename>PR</filename></ulink>
827 variables in the Yocto Project Reference Manual. 836 variables in the Yocto Project Reference Manual.
828 </note> 837 </note>
829 838