summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-22 12:17:02 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:08:00 -0800
commit8268a69c409f504a5cbdb8acd116ae0b99976cf4 (patch)
treef030791c2b8da7545a10d4594207655d8ed05c2a
parent9b5aedc3bcadb8dc2f1133b5e75c21ef4f010a0b (diff)
downloadpoky-8268a69c409f504a5cbdb8acd116ae0b99976cf4.tar.gz
documentation/dev-manual/dev-manual-common-tasks.xml: review comments
Implemented Paul Eggleton's latest set of review comments to the "Modifying Temporary Source Code" section. (From yocto-docs rev: cd43c642308ba7c049e6ba79befa471673c078e7) 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.xml43
1 files changed, 19 insertions, 24 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 893c9e55e4..cecfc95e8b 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -780,6 +780,9 @@ so that there are some definite steps on how to do this. I need more detail her
780 <literallayout class='monospaced'> 780 <literallayout class='monospaced'>
781 S = ${WORKDIR}/${BP} 781 S = ${WORKDIR}/${BP}
782 </literallayout> 782 </literallayout>
783 You should be aware that many recipes override the <filename>S</filename> variable.
784 For example, recipes that fetch their source from Git usually set
785 <filename>S</filename> to <filename>${WORKDIR}/git</filename>.
783 <note> 786 <note>
784 <filename>BP</filename> represents the "Base Package", which is the base package 787 <filename>BP</filename> represents the "Base Package", which is the base package
785 name and the package version: 788 name and the package version:
@@ -790,39 +793,31 @@ so that there are some definite steps on how to do this. I need more detail her
790 </para> 793 </para>
791 794
792 <para> 795 <para>
793 The actual location within the build directory for the temporary source code 796 The path to the work directory for the recipe
794 depends on the package name and the architecture of the target device, 797 (<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends
795 which are part of the 798 on the package name and the architecture of the target device.
796 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-WORKDIR'><filename>WORKDIR</filename></ulink> variable's definition. 799 For example, here is the work directory for packages whose targets are not device-dependent:
797 </para>
798
799 <para>
800 Here is the temporary source code location for packages whose targets are not
801 device-dependent.
802 This location comprises <filename>WORKDIR</filename>:
803 <literallayout class='monospaced'> 800 <literallayout class='monospaced'>
804 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 801 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
805 </literallayout> 802 </literallayout>
806 Let's look at an example. 803 Let's look at an example without variables.
807 Assuming a Yocto Project Files top-level directory named <filename>poky</filename> 804 Assuming a Yocto Project Files top-level directory named <filename>poky</filename>
808 and a default Yocto Project build directory of <filename>poky/build</filename>, 805 and a default Yocto Project build directory of <filename>poky/build</filename>,
809 the following is the temporary source code location for the 806 the following is the work directory for the <filename>acl</filename> package:
810 <filename>acl</filename> package:
811 <literallayout class='monospaced'> 807 <literallayout class='monospaced'>
812 ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3 808 ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3
813 </literallayout> 809 </literallayout>
814 </para> 810 </para>
815 811
816 <para> 812 <para>
817 If your package is dependent on the target device, the temporary 813 If your package is dependent on the target device, the work directory varies slightly:
818 source code location varies slightly:
819 <literallayout class='monospaced'> 814 <literallayout class='monospaced'>
820 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 815 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
821 </literallayout> 816 </literallayout>
822 Again, assuming a Yocto Project Files top-level directory named <filename>poky</filename> 817 Again, assuming a Yocto Project Files top-level directory named <filename>poky</filename>
823 and a default Yocto Project build directory of <filename>poky/build</filename>, the 818 and a default Yocto Project build directory of <filename>poky/build</filename>, the
824 following is the temporary source code location for the 819 following is the work directory for the <filename>acl</filename> package that is being
825 <filename>acl</filename> package that is being built for a MIPS-based device: 820 built for a MIPS-based device:
826 <literallayout class='monospaced'> 821 <literallayout class='monospaced'>
827 ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 822 ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2
828 </literallayout> 823 </literallayout>
@@ -844,7 +839,7 @@ so that there are some definite steps on how to do this. I need more detail her
844 </note> 839 </note>
845 840
846 <para> 841 <para>
847 Now that you know where to locate the temporary source files, you can use a 842 Now that you know where to locate the work directory, you can use a
848 Quilt or Git workflow to make your edits, test the changes, and preserve the 843 Quilt or Git workflow to make your edits, test the changes, and preserve the
849 changes in the form of patches. 844 changes in the form of patches.
850 </para> 845 </para>
@@ -869,10 +864,10 @@ so that there are some definite steps on how to do this. I need more detail her
869 Yocto Project build directory. 864 Yocto Project build directory.
870 See the 865 See the
871 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" 866 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
872 section to learn how to locate temporary source code for a 867 section to learn how to locate the work directory for a
873 particular package.</para></listitem> 868 particular package.</para></listitem>
874 <listitem><para><emphasis>Change Your Working Directory:</emphasis> 869 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
875 You need to be in the directory that has the temporary source code. 870 You need to be in the work directory that has the source code.
876 That directory is defined by the 871 That directory is defined by the
877 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> 872 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink>
878 variable.</para></listitem> 873 variable.</para></listitem>
@@ -965,16 +960,16 @@ so that there are some definite steps on how to do this. I need more detail her
965 Yocto Project build directory. 960 Yocto Project build directory.
966 See the 961 See the
967 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" 962 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
968 section to learn how to locate temporary source code for a 963 section to learn how to locate the work directory for a
969 particular package.</para></listitem> 964 particular package.</para></listitem>
970 <listitem><para><emphasis>Change Your Working Directory:</emphasis> 965 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
971 You need to be in the directory that has the temporary source code. 966 You need to be in the work directory.
972 That directory is defined by the 967 That directory is defined by the
973 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink> 968 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink>
974 variable.</para></listitem> 969 variable.</para></listitem>
975 <listitem><para><emphasis>Initialize a Git Repository:</emphasis> 970 <listitem><para><emphasis>Initialize a Git Repository:</emphasis>
976 Use the <filename>git init</filename> command to initialize a new local repository 971 Use the <filename>git init</filename> command to initialize a new local repository
977 that is based on your source code directory: 972 that is based on the work directory:
978 <literallayout class='monospaced'> 973 <literallayout class='monospaced'>
979 $ git init 974 $ git init
980 </literallayout></para></listitem> 975 </literallayout></para></listitem>
@@ -986,7 +981,7 @@ so that there are some definite steps on how to do this. I need more detail her
986 </literallayout></para></listitem> 981 </literallayout></para></listitem>
987 <listitem><para><emphasis>Commit the Source Files:</emphasis> 982 <listitem><para><emphasis>Commit the Source Files:</emphasis>
988 Use the <filename>git commit</filename> command to initially commit all the files in 983 Use the <filename>git commit</filename> command to initially commit all the files in
989 the source code directory: 984 the work directory:
990 <literallayout class='monospaced'> 985 <literallayout class='monospaced'>
991 $ git commit 986 $ git commit
992 </literallayout> 987 </literallayout>