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)
downloadast2050-yocto-poky-c0859cd2b641a6481759a78aec2403a96cd6564a.zip
ast2050-yocto-poky-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 ec9b218..f631f98 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
<para>
During a build, the unpacked temporary source code used by recipes
- to build packages is available in the Yocto Project build directory as
+ to build packages is available in the Yocto Project Build Directory as
defined by the
<filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-S'>S</ulink></filename> variable.
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
</literallayout>
Let's look at an example without variables.
Assuming a Yocto Project Files top-level directory named <filename>poky</filename>
- and a default Yocto Project build directory of <filename>poky/build</filename>,
+ and a default Yocto Project Build Directory of <filename>poky/build</filename>,
the following is the work directory for the <filename>acl</filename> package:
<literallayout class='monospaced'>
~/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
${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout>
Again, assuming a Yocto Project Files top-level directory named <filename>poky</filename>
- and a default Yocto Project build directory of <filename>poky/build</filename>, the
+ and a default Yocto Project Build Directory of <filename>poky/build</filename>, the
following is the work directory for the <filename>acl</filename> package that is being
built for a MIPS-based device:
<literallayout class='monospaced'>
@@ -861,7 +861,7 @@ so that there are some definite steps on how to do this. I need more detail her
<orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the Yocto Project build system is kept in the
- Yocto Project build directory.
+ Yocto Project Build Directory.
See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
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
<orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the Yocto Project build system is kept in the
- Yocto Project build directory.
+ Yocto Project Build Directory.
See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
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
After you have set up the recipes, you need to define the actual
combination of multiple libraries you want to build.
You accomplish this through your <filename>local.conf</filename>
- configuration file in the Yocto Project build directory.
+ configuration file in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
An example configuration would be as follows:
<literallayout class='monospaced'>
MACHINE = "qemux86-64"
@@ -1185,8 +1186,8 @@ so that there are some definite steps on how to do this. I need more detail her
<itemizedlist>
<listitem><para>A unique architecture is defined for the Multilib packages,
along with creating a unique deploy folder under
- <filename>tmp/deploy/rpm</filename> in the Yocto
- Project build directory.
+ <filename>tmp/deploy/rpm</filename> in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
For example, consider <filename>lib32</filename> in a
<filename>qemux86-64</filename> image.
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 e460d8d..9be8673 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -427,7 +427,8 @@
When saved, changes using <filename>menuconfig</filename> update the kernel's
<filename>.config</filename>.
Try to resist the temptation of directly editing the <filename>.config</filename>
- file found in the Yocto Project build directory at
+ file found in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link> at
<filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
Doing so, can produce unexpected results when the Yocto Project build system
regenerates the configuration file.</para>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index f9980fc..e9077c4 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -147,8 +147,9 @@
</para></listitem>
<listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various
<filename>.conf</filename> files provides global definitions of variables.
- The <filename>conf/local.conf</filename> configuration file in the Yocto Project
- build directory contains user-defined variables that affect each build.
+ The <filename>conf/local.conf</filename> configuration file in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>
+ contains user-defined variables that affect each build.
The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file
defines Yocto ‘distro’ configuration
variables used only when building with this policy.
@@ -327,7 +328,8 @@
You can find this list in the Yocto Project files directory at
<filename>meta/files/common-licenses</filename>.
Once the build completes, the list of all licenses found and used during that build are
- kept in the Yocto Project build directory at
+ kept in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link> at
<filename>tmp/deploy/images/licenses</filename>.
</para>
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index e429065..6bedbc2 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -264,7 +264,9 @@
<listitem><para>Initialize the build environment by sourcing a build environment
script.</para></listitem>
<listitem><para>Optionally ensure the <filename>/conf/local.conf</filename> configuration file,
- which is found in the Yocto Project build directory, is set up how you want it.
+ which is found in the
+ <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>,
+ is set up how you want it.
This file defines many aspects of the build environment including
the target machine architecture through the
<filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable,
OpenPOWER on IntegriCloud