summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-22 13:51:35 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:08:00 -0800
commitc0859cd2b641a6481759a78aec2403a96cd6564a (patch)
treeacd753a98bc0da776de35b28ad0d9460183a1d77 /documentation/dev-manual
parentee69fb57825cac80fa6fa71b95e772d772862bd7 (diff)
downloadpoky-c0859cd2b641a6481759a78aec2403a96cd6564a.tar.gz
documentation/dev-manual: Fixed YP Build Directory Term
Throughout the manual there is a specific term to refer to the YP build directory: "Yocto Project Build Directory." This term was being loosely referred to and was not consisten in linking to the actual term definition in the Terms chapter. All this is fixed. (From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml17
-rw-r--r--documentation/dev-manual/dev-manual-model.xml3
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml8
-rw-r--r--documentation/dev-manual/dev-manual-start.xml4
4 files changed, 19 insertions, 13 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ec9b2183e9..f631f98e18 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -771,7 +771,7 @@ so that there are some definite steps on how to do this. I need more detail her
771 771
772 <para> 772 <para>
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 777 Below is the default value for the <filename>S</filename> variable as defined in the
@@ -802,7 +802,7 @@ so that there are some definite steps on how to do this. I need more detail her
802 </literallayout> 802 </literallayout>
803 Let's look at an example without variables. 803 Let's look at an example without variables.
804 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>
805 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>,
806 the following is the work directory for the <filename>acl</filename> package: 806 the following is the work directory for the <filename>acl</filename> package:
807 <literallayout class='monospaced'> 807 <literallayout class='monospaced'>
808 ~/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
@@ -815,7 +815,7 @@ so that there are some definite steps on how to do this. I need more detail her
815 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 815 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
816 </literallayout> 816 </literallayout>
817 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>
818 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
819 following is the work directory for the <filename>acl</filename> package that is being 819 following is the work directory for the <filename>acl</filename> package that is being
820 built for a MIPS-based device: 820 built for a MIPS-based device:
821 <literallayout class='monospaced'> 821 <literallayout class='monospaced'>
@@ -861,7 +861,7 @@ so that there are some definite steps on how to do this. I need more detail her
861 <orderedlist> 861 <orderedlist>
862 <listitem><para><emphasis>Find the Source Code:</emphasis> 862 <listitem><para><emphasis>Find the Source Code:</emphasis>
863 The temporary source code used by the Yocto Project build system is kept in the 863 The temporary source code used by the Yocto Project build system is kept in the
864 Yocto Project build directory. 864 Yocto Project Build Directory.
865 See the 865 See the
866 "<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>"
867 section to learn how to locate the directory that has the temporary source code for a 867 section to learn how to locate the directory that has the temporary source code for a
@@ -957,7 +957,7 @@ so that there are some definite steps on how to do this. I need more detail her
957 <orderedlist> 957 <orderedlist>
958 <listitem><para><emphasis>Find the Source Code:</emphasis> 958 <listitem><para><emphasis>Find the Source Code:</emphasis>
959 The temporary source code used by the Yocto Project build system is kept in the 959 The temporary source code used by the Yocto Project build system is kept in the
960 Yocto Project build directory. 960 Yocto Project Build Directory.
961 See the 961 See the
962 "<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>"
963 section to learn how to locate the directory that has the temporary source code for a 963 section to learn how to locate the directory that has the temporary source code for a
@@ -1141,7 +1141,8 @@ so that there are some definite steps on how to do this. I need more detail her
1141 After you have set up the recipes, you need to define the actual 1141 After you have set up the recipes, you need to define the actual
1142 combination of multiple libraries you want to build. 1142 combination of multiple libraries you want to build.
1143 You accomplish this through your <filename>local.conf</filename> 1143 You accomplish this through your <filename>local.conf</filename>
1144 configuration file in the Yocto Project build directory. 1144 configuration file in the
1145 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
1145 An example configuration would be as follows: 1146 An example configuration would be as follows:
1146 <literallayout class='monospaced'> 1147 <literallayout class='monospaced'>
1147 MACHINE = "qemux86-64" 1148 MACHINE = "qemux86-64"
@@ -1185,8 +1186,8 @@ so that there are some definite steps on how to do this. I need more detail her
1185 <itemizedlist> 1186 <itemizedlist>
1186 <listitem><para>A unique architecture is defined for the Multilib packages, 1187 <listitem><para>A unique architecture is defined for the Multilib packages,
1187 along with creating a unique deploy folder under 1188 along with creating a unique deploy folder under
1188 <filename>tmp/deploy/rpm</filename> in the Yocto 1189 <filename>tmp/deploy/rpm</filename> in the
1189 Project build directory. 1190 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
1190 For example, consider <filename>lib32</filename> in a 1191 For example, consider <filename>lib32</filename> in a
1191 <filename>qemux86-64</filename> image. 1192 <filename>qemux86-64</filename> image.
1192 The possible architectures in the system are "all", "qemux86_64", 1193 The possible architectures in the system are "all", "qemux86_64",
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index e460d8d696..9be8673244 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -427,7 +427,8 @@
427 When saved, changes using <filename>menuconfig</filename> update the kernel's 427 When saved, changes using <filename>menuconfig</filename> update the kernel's
428 <filename>.config</filename>. 428 <filename>.config</filename>.
429 Try to resist the temptation of directly editing the <filename>.config</filename> 429 Try to resist the temptation of directly editing the <filename>.config</filename>
430 file found in the Yocto Project build directory at 430 file found in the
431 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link> at
431 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>. 432 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
432 Doing so, can produce unexpected results when the Yocto Project build system 433 Doing so, can produce unexpected results when the Yocto Project build system
433 regenerates the configuration file.</para> 434 regenerates the configuration file.</para>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index f9980fc555..e9077c4efc 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -147,8 +147,9 @@
147 </para></listitem> 147 </para></listitem>
148 <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various 148 <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various
149 <filename>.conf</filename> files provides global definitions of variables. 149 <filename>.conf</filename> files provides global definitions of variables.
150 The <filename>conf/local.conf</filename> configuration file in the Yocto Project 150 The <filename>conf/local.conf</filename> configuration file in the
151 build directory contains user-defined variables that affect each build. 151 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>
152 contains user-defined variables that affect each build.
152 The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file 153 The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file
153 defines Yocto ‘distro’ configuration 154 defines Yocto ‘distro’ configuration
154 variables used only when building with this policy. 155 variables used only when building with this policy.
@@ -327,7 +328,8 @@
327 You can find this list in the Yocto Project files directory at 328 You can find this list in the Yocto Project files directory at
328 <filename>meta/files/common-licenses</filename>. 329 <filename>meta/files/common-licenses</filename>.
329 Once the build completes, the list of all licenses found and used during that build are 330 Once the build completes, the list of all licenses found and used during that build are
330 kept in the Yocto Project build directory at 331 kept in the
332 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link> at
331 <filename>tmp/deploy/images/licenses</filename>. 333 <filename>tmp/deploy/images/licenses</filename>.
332 </para> 334 </para>
333 335
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index e429065b7a..6bedbc273a 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -264,7 +264,9 @@
264 <listitem><para>Initialize the build environment by sourcing a build environment 264 <listitem><para>Initialize the build environment by sourcing a build environment
265 script.</para></listitem> 265 script.</para></listitem>
266 <listitem><para>Optionally ensure the <filename>/conf/local.conf</filename> configuration file, 266 <listitem><para>Optionally ensure the <filename>/conf/local.conf</filename> configuration file,
267 which is found in the Yocto Project build directory, is set up how you want it. 267 which is found in the
268 <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>,
269 is set up how you want it.
268 This file defines many aspects of the build environment including 270 This file defines many aspects of the build environment including
269 the target machine architecture through the 271 the target machine architecture through the
270 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable, 272 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable,