sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2012-02-22 13:51:35 -06:00 committed by Richard Purdie
parent ee69fb5782
commit c0859cd2b6
4 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -771,7 +771,7 @@ so that there are some definite steps on how to do this. I need more detail her
<para> <para>
During a build, the unpacked temporary source code used by recipes 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 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. <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 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> </literallayout>
Let's look at an example without variables. Let's look at an example without variables.
Assuming a Yocto Project Files top-level directory named <filename>poky</filename> 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: the following is the work directory for the <filename>acl</filename> package:
<literallayout class='monospaced'> <literallayout class='monospaced'>
~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3 ~/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} ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout> </literallayout>
Again, assuming a Yocto Project Files top-level directory named <filename>poky</filename> 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 following is the work directory for the <filename>acl</filename> package that is being
built for a MIPS-based device: built for a MIPS-based device:
<literallayout class='monospaced'> <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> <orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis> <listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the Yocto Project build system is kept in the 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 See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" "<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 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> <orderedlist>
<listitem><para><emphasis>Find the Source Code:</emphasis> <listitem><para><emphasis>Find the Source Code:</emphasis>
The temporary source code used by the Yocto Project build system is kept in the 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 See the
"<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" "<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 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 After you have set up the recipes, you need to define the actual
combination of multiple libraries you want to build. combination of multiple libraries you want to build.
You accomplish this through your <filename>local.conf</filename> 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: An example configuration would be as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
MACHINE = "qemux86-64" 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> <itemizedlist>
<listitem><para>A unique architecture is defined for the Multilib packages, <listitem><para>A unique architecture is defined for the Multilib packages,
along with creating a unique deploy folder under along with creating a unique deploy folder under
<filename>tmp/deploy/rpm</filename> in the Yocto <filename>tmp/deploy/rpm</filename> in the
Project build directory. <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>.
For example, consider <filename>lib32</filename> in a For example, consider <filename>lib32</filename> in a
<filename>qemux86-64</filename> image. <filename>qemux86-64</filename> image.
The possible architectures in the system are "all", "qemux86_64", The possible architectures in the system are "all", "qemux86_64",

3
documentation/dev-manual/dev-manual-model.xml
View File

@ -427,7 +427,8 @@
When saved, changes using <filename>menuconfig</filename> update the kernel's When saved, changes using <filename>menuconfig</filename> update the kernel's
<filename>.config</filename>. <filename>.config</filename>.
Try to resist the temptation of directly editing the <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>. <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
Doing so, can produce unexpected results when the Yocto Project build system Doing so, can produce unexpected results when the Yocto Project build system
regenerates the configuration file.</para> regenerates the configuration file.</para>

8
documentation/dev-manual/dev-manual-newbie.xml
View File

@ -147,8 +147,9 @@
</para></listitem> </para></listitem>
<listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various
<filename>.conf</filename> files provides global definitions of variables. <filename>.conf</filename> files provides global definitions of variables.
The <filename>conf/local.conf</filename> configuration file in the Yocto Project The <filename>conf/local.conf</filename> configuration file in the
build directory contains user-defined variables that affect each build. <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 The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file
defines Yocto ‘distro’ configuration defines Yocto ‘distro’ configuration
variables used only when building with this policy. variables used only when building with this policy.
@ -327,7 +328,8 @@
You can find this list in the Yocto Project files directory at You can find this list in the Yocto Project files directory at
<filename>meta/files/common-licenses</filename>. <filename>meta/files/common-licenses</filename>.
Once the build completes, the list of all licenses found and used during that build are 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>. <filename>tmp/deploy/images/licenses</filename>.
</para> </para>

4
documentation/dev-manual/dev-manual-start.xml
View File

@ -264,7 +264,9 @@
<listitem><para>Initialize the build environment by sourcing a build environment <listitem><para>Initialize the build environment by sourcing a build environment
script.</para></listitem> script.</para></listitem>
<listitem><para>Optionally ensure the <filename>/conf/local.conf</filename> configuration file, <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 This file defines many aspects of the build environment including
the target machine architecture through the 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, <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable,