summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-07-02 14:34:39 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-07-03 14:55:03 +0100
commit5966b44893a39847d3d590566dd488323a11ff73 (patch)
tree4cc4c8a6fd8403ea0d9708eb9c449d1e0b8eded2 /documentation
parent7064538309121c23323d442db6c9f0b11c8d6431 (diff)
downloadpoky-5966b44893a39847d3d590566dd488323a11ff73.tar.gz
documentation/poky-ref-manual: Yocto Project scrub
I have changed as many "Yocto Project" terms as possible so that better reflect reality. (From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/development.xml21
-rw-r--r--documentation/poky-ref-manual/faq.xml55
-rw-r--r--documentation/poky-ref-manual/introduction.xml24
-rw-r--r--documentation/poky-ref-manual/ref-bitbake.xml15
-rw-r--r--documentation/poky-ref-manual/ref-classes.xml33
-rw-r--r--documentation/poky-ref-manual/ref-features.xml2
-rw-r--r--documentation/poky-ref-manual/ref-images.xml6
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml61
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml109
-rw-r--r--documentation/poky-ref-manual/resources.xml15
-rw-r--r--documentation/poky-ref-manual/usingpoky.xml27
11 files changed, 200 insertions, 168 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index b897efd550..9628fcbd15 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -10,7 +10,7 @@
10 <para> 10 <para>
11 The Yocto Project supports several methods of application development through which 11 The Yocto Project supports several methods of application development through which
12 you can create user-space software designed to run on an embedded device that uses 12 you can create user-space software designed to run on an embedded device that uses
13 a Linux Yocto image developed with the Yocto Project. 13 a Yocto Project image, which was developed with the OpenEmbedded build system.
14 This flexibility allows you to choose the method that works best for you. 14 This flexibility allows you to choose the method that works best for you.
15 This chapter describes each development method. 15 This chapter describes each development method.
16 </para> 16 </para>
@@ -25,12 +25,12 @@
25 section in that when you invoke <filename>devshell</filename> source files are 25 section in that when you invoke <filename>devshell</filename> source files are
26 extracted into your working directory and patches are applied. 26 extracted into your working directory and patches are applied.
27 Then, a new terminal is opened and you are placed in the working directory. 27 Then, a new terminal is opened and you are placed in the working directory.
28 In the new terminal all the Yocto Project build-related environment variables are 28 In the new terminal, all the OpenEmbedded build-related environment variables are
29 still defined so you can use commands such as <filename>configure</filename> and 29 still defined so you can use commands such as <filename>configure</filename> and
30 <filename>make</filename>. 30 <filename>make</filename>.
31 The commands execute just as if the Yocto Project build system were executing them. 31 The commands execute just as if the OpenEmbedded build system were executing them.
32 Consequently, working this way can be helpful when debugging a build or preparing 32 Consequently, working this way can be helpful when debugging a build or preparing
33 software to be used with the Yocto Project build system. 33 software to be used with the OpenEmbedded build system.
34 </para> 34 </para>
35 35
36 <para> 36 <para>
@@ -45,7 +45,7 @@
45 </para> 45 </para>
46 46
47 <para> 47 <para>
48 This command opens a terminal with a shell prompt within the Poky 48 This command opens a terminal with a shell prompt within the Yocto Project
49 environment. 49 environment.
50 The following occurs: 50 The following occurs:
51 <itemizedlist> 51 <itemizedlist>
@@ -58,7 +58,7 @@
58 </itemizedlist> 58 </itemizedlist>
59 Within this environment, you can run <filename>configure</filename> 59 Within this environment, you can run <filename>configure</filename>
60 or <filename>compile</filename> commands as if they were being run by 60 or <filename>compile</filename> commands as if they were being run by
61 the Yocto Project build system itself. 61 the OpenEmbedded build system itself.
62 As noted earlier, the working directory also automatically changes to the 62 As noted earlier, the working directory also automatically changes to the
63 source directory (<filename><link linkend='var-S'>S</link></filename>). 63 source directory (<filename><link linkend='var-S'>S</link></filename>).
64 </para> 64 </para>
@@ -71,8 +71,8 @@
71 The default shell used by <filename>devshell</filename> is xterm. 71 The default shell used by <filename>devshell</filename> is xterm.
72 For examples of available options, see the "UI/Interaction Configuration" 72 For examples of available options, see the "UI/Interaction Configuration"
73 section of the 73 section of the
74 <filename>meta/conf/bitbake.conf</filename> configuration file in the Yocto Project 74 <filename>meta/conf/bitbake.conf</filename> configuration file in the
75 files. 75 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
76 </para> 76 </para>
77 77
78 <para> 78 <para>
@@ -99,7 +99,7 @@
99 99
100 <para> 100 <para>
101 If you're working on a recipe that pulls from an external Source Code Manager (SCM), it 101 If you're working on a recipe that pulls from an external Source Code Manager (SCM), it
102 is possible to have the Yocto Project build system notice new changes added to the 102 is possible to have the OpenEmbedded build system notice new changes added to the
103 SCM and then build the package that depends on them using the latest version. 103 SCM and then build the package that depends on them using the latest version.
104 This only works for SCMs from which it is possible to get a sensible revision number for changes. 104 This only works for SCMs from which it is possible to get a sensible revision number for changes.
105 Currently, you can do this with Apache Subversion (SVN), Git, and Bazaar (BZR) repositories. 105 Currently, you can do this with Apache Subversion (SVN), Git, and Bazaar (BZR) repositories.
@@ -107,7 +107,8 @@
107 107
108 <para> 108 <para>
109 To enable this behavior, simply add the following to the <filename>local.conf</filename> 109 To enable this behavior, simply add the following to the <filename>local.conf</filename>
110 configuration file in the build directory of the Yocto Project files: 110 configuration file found in the
111 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>:
111 <literallayout class='monospaced'> 112 <literallayout class='monospaced'>
112 SRCREV_pn-&lt;PN&gt; = "${AUTOREV}" 113 SRCREV_pn-&lt;PN&gt; = "${AUTOREV}"
113 </literallayout> 114 </literallayout>
diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml
index 6b56c5abb9..7c2fc11818 100644
--- a/documentation/poky-ref-manual/faq.xml
+++ b/documentation/poky-ref-manual/faq.xml
@@ -13,11 +13,17 @@
13 </question> 13 </question>
14 <answer> 14 <answer>
15 <para> 15 <para>
16 Poky is the Yocto Project build system that was derived from <ulink 16 The term "Poky" is sometimes used to refer to the build system that the
17 Yocto Project uses.
18 The build system used in the Yocto project is referred to as the
19 OpenEmbedded build system because "Poky" was derived from <ulink
17 url='&OE_HOME_URL;'>OpenEmbedded</ulink>. 20 url='&OE_HOME_URL;'>OpenEmbedded</ulink>.
18 Poky is a stable, smaller subset focused on the mobile environment. 21 Poky is a stable, smaller subset focused on the mobile environment.
19 Development in the Yocto Project using Poky is closely tied to OpenEmbedded with 22 Development in the Yocto Project using Poky is closely tied to OpenEmbedded with
20 features being merged regularly between the two for mutual benefit. 23 features being merged regularly between the two for mutual benefit.
24 For a fuller description of the term "Poky", see the
25 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>poky</ulink> term in the Yocto Project
26 Development Manual.
21 </para> 27 </para>
22 </answer> 28 </answer>
23 </qandaentry> 29 </qandaentry>
@@ -64,7 +70,8 @@
64 <para> 70 <para>
65 There are three areas that help with stability; 71 There are three areas that help with stability;
66 <itemizedlist> 72 <itemizedlist>
67 <listitem><para>The Yocto Project team keeps Poky small and focused. 73 <listitem><para>The Yocto Project team keeps
74 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> small and focused.
68 It contains around 650 packages as compared to over 5000 for full 75 It contains around 650 packages as compared to over 5000 for full
69 OpenEmbedded.</para></listitem> 76 OpenEmbedded.</para></listitem>
70 <listitem><para>The Yocto Project only supports hardware that the 77 <listitem><para>The Yocto Project only supports hardware that the
@@ -100,16 +107,17 @@
100 <qandaentry> 107 <qandaentry>
101 <question> 108 <question>
102 <para> 109 <para>
103 Are there any products using Poky? 110 Are there any products using the OpenEmbedded build system (poky)?
104 </para> 111 </para>
105 </question> 112 </question>
106 <answer> 113 <answer>
107 <para> 114 <para>
108 The <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> is using 115 The <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> is using
109 the Yocto Project build system Poky. 116 the OpenEmbedded build system.
110 See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink> 117 See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink>
111 for more information. 118 for more information.
112 There are a number of pre-production devices using Poky and the Yocto Project team 119 There are a number of pre-production devices using the OpenEmbedded build system
120 and the Yocto Project team
113 announces them as soon as they are released. 121 announces them as soon as they are released.
114 </para> 122 </para>
115 </answer> 123 </answer>
@@ -118,13 +126,13 @@
118 <qandaentry> 126 <qandaentry>
119 <question> 127 <question>
120 <para> 128 <para>
121 What does the Yocto Project build system Poky produce as output? 129 What does the OpenEmbedded build system produce as output?
122 </para> 130 </para>
123 </question> 131 </question>
124 <answer> 132 <answer>
125 <para> 133 <para>
126 Because the same set of recipes can be used to create output of various formats, the 134 Because the same set of recipes can be used to create output of various formats, the
127 output of a Yocto Project build depends on how it was started. 135 output of an OpenEmbedded build depends on how it was started.
128 Usually, the output is a flashable image ready for the target device. 136 Usually, the output is a flashable image ready for the target device.
129 </para> 137 </para>
130 </answer> 138 </answer>
@@ -155,7 +163,7 @@
155 </question> 163 </question>
156 <answer> 164 <answer>
157 <para> 165 <para>
158 The Yocto Project can build packages in various formats such as 166 The OpenEmbedded build system can build packages in various formats such as
159 <filename>ipk</filename> for <filename>ipkg</filename>/<filename>opkg</filename>, 167 <filename>ipk</filename> for <filename>ipkg</filename>/<filename>opkg</filename>,
160 Debian package (<filename>.deb</filename>), or RPM. 168 Debian package (<filename>.deb</filename>), or RPM.
161 The packages can then be upgraded using the package tools on the device, much like 169 The packages can then be upgraded using the package tools on the device, much like
@@ -223,8 +231,8 @@
223 </para> 231 </para>
224 232
225 <para> 233 <para>
226 Once these packages are installed, the Yocto Project will be able to build standard 234 Once these packages are installed, the OpenEmbedded build system will be able
227 images. 235 to build standard images.
228 However, there might be a problem with the QEMU emulator segfaulting. 236 However, there might be a problem with the QEMU emulator segfaulting.
229 You can either disable the generation of binary locales by setting 237 You can either disable the generation of binary locales by setting
230 <filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link> 238 <filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link>
@@ -244,14 +252,14 @@
244 <answer> 252 <answer>
245 <para> 253 <para>
246 Nothing is wrong. 254 Nothing is wrong.
247 The Yocto Project checks any configured source mirrors before downloading 255 The OpenEmbedded build system checks any configured source mirrors before downloading
248 from the upstream sources. 256 from the upstream sources.
249 The Yocto Project does this searching for both source archives and 257 The build system does this searching for both source archives and
250 pre-checked out versions of SCM managed software. 258 pre-checked out versions of SCM managed software.
251 These checks help in large installations because it can reduce load on the SCM servers 259 These checks help in large installations because it can reduce load on the SCM servers
252 themselves. 260 themselves.
253 The address above is one of the default mirrors configured into the 261 The address above is one of the default mirrors configured into the
254 Yocto Project. 262 build system.
255 Consequently, if an upstream source disappears, the team 263 Consequently, if an upstream source disappears, the team
256 can place sources there so builds continue to work. 264 can place sources there so builds continue to work.
257 </para> 265 </para>
@@ -284,7 +292,7 @@
284 </question> 292 </question>
285 <answer> 293 <answer>
286 <para> 294 <para>
287 Most source fetching by the Yocto Project is done by <filename>wget</filename> 295 Most source fetching by the OpenEmbedded build system is done by <filename>wget</filename>
288 and you therefore need to specify the proxy settings in a 296 and you therefore need to specify the proxy settings in a
289 <filename>.wgetrc</filename> file in your home directory. 297 <filename>.wgetrc</filename> file in your home directory.
290 Example settings in that file would be 298 Example settings in that file would be
@@ -350,7 +358,7 @@
350 the most likely explanation is that either the hardware you're running the 358 the most likely explanation is that either the hardware you're running the
351 build on has some problem, or, if you are running the build under virtualisation, 359 build on has some problem, or, if you are running the build under virtualisation,
352 the virtualisation probably has bugs. 360 the virtualisation probably has bugs.
353 The Yocto Project processes a massive amount of data causing lots of network, disk and 361 The OpenEmbedded build system processes a massive amount of data causing lots of network, disk and
354 CPU activity and is sensitive to even single bit failures in any of these areas. 362 CPU activity and is sensitive to even single bit failures in any of these areas.
355 True random failures have always been traced back to hardware or virtualisation issues. 363 True random failures have always been traced back to hardware or virtualisation issues.
356 </para> 364 </para>
@@ -449,7 +457,7 @@
449 <answer> 457 <answer>
450 <para> 458 <para>
451 The Yocto Project team has tried to do this before but too many of the tools 459 The Yocto Project team has tried to do this before but too many of the tools
452 the Yocto Project depends on such as <filename>autoconf</filename> 460 the OpenEmbedded build system depends on such as <filename>autoconf</filename>
453 break when they find spaces in pathnames. 461 break when they find spaces in pathnames.
454 Until that situation changes, the team will not support spaces in pathnames. 462 Until that situation changes, the team will not support spaces in pathnames.
455 </para> 463 </para>
@@ -495,14 +503,14 @@
495 <qandaentry> 503 <qandaentry>
496 <question> 504 <question>
497 <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'> 505 <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>
498 How does the Yocto Project build system obtain source code and will it work behind my 506 How does the OpenEmbedded build system obtain source code and will it work behind my
499 firewall or proxy server? 507 firewall or proxy server?
500 </para> 508 </para>
501 </question> 509 </question>
502 <answer> 510 <answer>
503 <para> 511 <para>
504 The way the Yocto Project obtains source code is highly configurable. 512 The way the build system obtains source code is highly configurable.
505 You can setup the Yocto Project to get source code in most environments if 513 You can setup the build system to get source code in most environments if
506 HTTP transport is available. 514 HTTP transport is available.
507 </para> 515 </para>
508 <para> 516 <para>
@@ -511,7 +519,8 @@
511 and then MIRRORS in that order. 519 and then MIRRORS in that order.
512 </para> 520 </para>
513 <para> 521 <para>
514 By default, Poky uses the Yocto Project source PREMIRRORS for SCM-based sources, 522 By default, the OpenEmbedded build system uses the Yocto Project source PREMIRRORS
523 for SCM-based sources,
515 upstreams for normal tarballs, and then falls back to a number of other mirrors 524 upstreams for normal tarballs, and then falls back to a number of other mirrors
516 including the Yocto Project source mirror if those fail. 525 including the Yocto Project source mirror if those fail.
517 </para> 526 </para>
@@ -574,7 +583,7 @@
574 any network accesses to anything other than the PREMIRROR would fail. 583 any network accesses to anything other than the PREMIRROR would fail.
575 </para> 584 </para>
576 <para> 585 <para>
577 Poky also honors the standard shell environment variables 586 The build system also honors the standard shell environment variables
578 <filename>http_proxy</filename>, <filename>ftp_proxy</filename>, 587 <filename>http_proxy</filename>, <filename>ftp_proxy</filename>,
579 <filename>https_proxy</filename>, and <filename>all_proxy</filename> 588 <filename>https_proxy</filename>, and <filename>all_proxy</filename>
580 to redirect requests through proxy servers. 589 to redirect requests through proxy servers.
@@ -600,8 +609,8 @@
600 </para> 609 </para>
601 610
602 <para> 611 <para>
603 Within the Yocto Project Build Directory is the <filename>tmp</filename> 612 Within the <ulink url='&YOCTO_DOCS_DEV_URL;buile-directory'>build directory</ulink>
604 directory. 613 is the <filename>tmp</filename> directory.
605 To remove all the build output yet preserve any source code or downloaded files 614 To remove all the build output yet preserve any source code or downloaded files
606 from previous builds, simply remove the <filename>tmp</filename> directory. 615 from previous builds, simply remove the <filename>tmp</filename> directory.
607 </para> 616 </para>
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index 160cdca73d..249b9a18fd 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -12,8 +12,8 @@
12 This manual provides reference information for the current release of the Yocto Project. 12 This manual provides reference information for the current release of the Yocto Project.
13 The Yocto Project is an open-source collaboration project focused on embedded Linux 13 The Yocto Project is an open-source collaboration project focused on embedded Linux
14 developers. 14 developers.
15 Amongst other things, the Yocto Project uses the Poky build tool to 15 Amongst other things, the Yocto Project uses the OpenEmbedded build system, which
16 construct complete Linux images. 16 is based on the Poky project, to construct complete Linux images.
17 You can find complete introductory and getting started information on the Yocto Project 17 You can find complete introductory and getting started information on the Yocto Project
18 by reading the 18 by reading the
19 <ulink url='&YOCTO_DOCS_QS_URL;'> 19 <ulink url='&YOCTO_DOCS_QS_URL;'>
@@ -51,9 +51,13 @@
51 the Yocto Project.</para></listitem> 51 the Yocto Project.</para></listitem>
52 <listitem><para><emphasis> 52 <listitem><para><emphasis>
53 <link linkend='ref-structure'>Reference: Directory Structure</link>:</emphasis> 53 <link linkend='ref-structure'>Reference: Directory Structure</link>:</emphasis>
54 This appendix describes the directory structure of the Yocto Project files. 54 This appendix describes the directory structure of the
55 The Yocto Project files represent the file structure or Git repository created 55 Yocto Project files, referred to as the
56 as a result of setting up the Yocto Project on your host development system. 56 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
57 The source directory represents the local file structure created
58 as a result from either cloning the upstream
59 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository or unpacking a
60 released Yocto Project tarball on your host development system.
57 </para></listitem> 61 </para></listitem>
58 <listitem><para><emphasis> 62 <listitem><para><emphasis>
59 <link linkend='ref-bitbake'>Reference: BitBake</link>:</emphasis> 63 <link linkend='ref-bitbake'>Reference: BitBake</link>:</emphasis>
@@ -69,7 +73,7 @@
69 <listitem><para><emphasis> 73 <listitem><para><emphasis>
70 <link linkend='ref-features'>Reference: Features</link>:</emphasis> 74 <link linkend='ref-features'>Reference: Features</link>:</emphasis>
71 This appendix describes mechanisms for creating distribution, machine, and image 75 This appendix describes mechanisms for creating distribution, machine, and image
72 features during the build process using the Yocto Project.</para></listitem> 76 features during the build process using the OpenEmbedded build system.</para></listitem>
73 <listitem><para><emphasis> 77 <listitem><para><emphasis>
74 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis> 78 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis>
75 This appendix presents most Yocto Project variables. 79 This appendix presents most Yocto Project variables.
@@ -124,9 +128,11 @@
124<section id='intro-getit-dev'> 128<section id='intro-getit-dev'>
125 <title>Development Checkouts</title> 129 <title>Development Checkouts</title>
126 <para> 130 <para>
127 Development using the Yocto Project requires a local copy of the Yocto Project files. 131 Development using the Yocto Project requires a local copy of the Yocto Project files
128 You can get these files by downloading a Yocto Project release tarball and unpacking it, 132 referred to as the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
129 or by establishing a Git repository of the files. 133 You can set source directory up by downloading a Yocto Project release tarball and unpacking it,
134 or by cloning a copy of the upstream
135 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
130 For information on both these methods, see the 136 For information on both these methods, see the
131 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>" 137 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>"
132 section in The Yocto Project Development Manual. 138 section in The Yocto Project Development Manual.
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 523caf7090..81a8934e6a 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -7,7 +7,8 @@
7 <title>Reference: BitBake</title> 7 <title>Reference: BitBake</title>
8 8
9 <para> 9 <para>
10 BitBake is a program written in Python that interprets the metadata that makes up the Yocto Project. 10 BitBake is a program written in Python that interprets the metadata used by the Yocto Project.
11 The OpenEmbedded build system uses BitBake.
11 At some point, developers wonder what actually happens when you enter: 12 At some point, developers wonder what actually happens when you enter:
12 <literallayout class='monospaced'> 13 <literallayout class='monospaced'>
13 $ bitbake core-image-sato 14 $ bitbake core-image-sato
@@ -34,20 +35,22 @@
34 35
35 <para> 36 <para>
36 The first thing BitBake does is look for the <filename>bitbake.conf</filename> file. 37 The first thing BitBake does is look for the <filename>bitbake.conf</filename> file.
37 The Yocto Project keeps this file in the Yocto Project file's <filename>meta/conf/</filename> 38 This file resides in the
38 directory. 39 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
39 BitBake finds it by examining its <filename>BBPATH</filename> environment 40 within the <filename>meta/conf/</filename> directory.
41 BitBake finds it by examining its
42 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment
40 variable and looking for the <filename>meta/conf/</filename> 43 variable and looking for the <filename>meta/conf/</filename>
41 directory. 44 directory.
42 </para> 45 </para>
43 46
44 <para> 47 <para>
45 In the Yocto Project, <filename>bitbake.conf</filename> lists other configuration 48 The <filename>bitbake.conf</filename> file lists other configuration
46 files to include from a <filename>conf/</filename> 49 files to include from a <filename>conf/</filename>
47 directory below the directories listed in <filename>BBPATH</filename>. 50 directory below the directories listed in <filename>BBPATH</filename>.
48 In general, the most important configuration file from a user's perspective 51 In general, the most important configuration file from a user's perspective
49 is <filename>local.conf</filename>, which contains a user's customized 52 is <filename>local.conf</filename>, which contains a user's customized
50 settings for the Yocto Project build environment. 53 settings for the OpenEmbedded build environment.
51 Other notable configuration files are the distribution 54 Other notable configuration files are the distribution
52 configuration file (set by the 55 configuration file (set by the
53 <filename><link linkend='var-DISTRO'>DISTRO</link></filename> variable) 56 <filename><link linkend='var-DISTRO'>DISTRO</link></filename> variable)
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 35c713434c..67f2454145 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -12,10 +12,11 @@
12 file. 12 file.
13 Class files are identified by the extension <filename>.bbclass</filename> and are usually placed 13 Class files are identified by the extension <filename>.bbclass</filename> and are usually placed
14 in a <filename>classes/</filename> directory beneath the 14 in a <filename>classes/</filename> directory beneath the
15 <filename>meta*/</filename> directory found in the Yocto Project file's area 15 <filename>meta*/</filename> directory found in the
16 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
16 Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as 17 Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as
17 <filename>.conf</filename> files in the <filename>conf</filename> directory. 18 <filename>.conf</filename> files in the <filename>conf</filename> directory.
18 Class files are searched for in <filename>BBPATH</filename> 19 Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
19 using the same method by which <filename>.conf</filename> files are searched. 20 using the same method by which <filename>.conf</filename> files are searched.
20</para> 21</para>
21 22
@@ -111,7 +112,7 @@
111 </para> 112 </para>
112 113
113 <para> 114 <para>
114 Currently, the Yocto Project supports only one binary per package. 115 Currently, the OpenEmbedded build system supports only one binary per package.
115 </para> 116 </para>
116</section> 117</section>
117 118
@@ -121,7 +122,7 @@
121 <para> 122 <para>
122 This class uses <filename>update-rc.d</filename> to safely install an 123 This class uses <filename>update-rc.d</filename> to safely install an
123 initialization script on behalf of the package. 124 initialization script on behalf of the package.
124 The Yocto Project takes care of details such as making sure the script is stopped before 125 The OpenEmbedded build system takes care of details such as making sure the script is stopped before
125 a package is removed and started when the package is installed. 126 a package is removed and started when the package is installed.
126 Three variables control this class: 127 Three variables control this class:
127 <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, 128 <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>,
@@ -254,7 +255,7 @@
254 255
255 <para> 256 <para>
256 This class adds the <filename>devshell</filename> task. 257 This class adds the <filename>devshell</filename> task.
257 Distribution policy dictates whether to include this class as the Yocto Project does. 258 Distribution policy dictates whether to include this class.
258 See the 259 See the
259 "<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section 260 "<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section
260 for more information about using devshell. 261 for more information about using devshell.
@@ -277,8 +278,9 @@
277 <para> 278 <para>
278 You can control the list of resulting package formats by using the 279 You can control the list of resulting package formats by using the
279 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> 280 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
280 variable defined in the <filename>local.conf</filename> configuration file 281 variable defined in the <filename>local.conf</filename> configuration file,
281 found in the Yocto Project file's <filename>conf</filename> directory. 282 which is located in the <filename>conf</filename> folder of the
283 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
282 When defining the variable, you can specify one or more package types. 284 When defining the variable, you can specify one or more package types.
283 Since images are generated from packages, a packaging class is 285 Since images are generated from packages, a packaging class is
284 needed to enable image generation. 286 needed to enable image generation.
@@ -380,7 +382,7 @@
380 The class also performs basic user configuration checks from 382 The class also performs basic user configuration checks from
381 the <filename>local.conf</filename> configuration file to 383 the <filename>local.conf</filename> configuration file to
382 prevent common mistakes that cause build failures. 384 prevent common mistakes that cause build failures.
383 Distribution policy usually whether to include this class as the Yocto Project does. 385 Distribution policy usually determines whether to include this class.
384 </para> 386 </para>
385</section> 387</section>
386 388
@@ -389,10 +391,10 @@
389 391
390 <para> 392 <para>
391 This class adds a step to the package generation process that sanity checks the 393 This class adds a step to the package generation process that sanity checks the
392 packages generated by the Yocto Project. 394 packages generated by the OpenEmbedded build system.
393 A range of checks are performed that check the build's output 395 A range of checks are performed that check the build's output
394 for common problems that show up during runtime. 396 for common problems that show up during runtime.
395 Distribution policy usually dictates whether to include this class as the Yocto Project does. 397 Distribution policy usually dictates whether to include this class.
396 </para> 398 </para>
397 399
398 <para> 400 <para>
@@ -514,7 +516,8 @@
514 you can use this class to specify those packages and associate the users and groups 516 you can use this class to specify those packages and associate the users and groups
515 with those packages. 517 with those packages.
516 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> 518 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename>
517 recipe in the Yocto Project Files provides a simple exmample that shows how to add three 519 recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
520 provides a simple exmample that shows how to add three
518 users and groups to two packages. 521 users and groups to two packages.
519 See the <filename>useradd-example.bb</filename> for more information on how to 522 See the <filename>useradd-example.bb</filename> for more information on how to
520 use this class. 523 use this class.
@@ -526,7 +529,7 @@
526 529
527 <para> 530 <para>
528 You can use this class to build software from source code that is external to the 531 You can use this class to build software from source code that is external to the
529 Yocto Project build system. 532 OpenEmbedded build system.
530 In other words, your source code resides in an external tree outside of the Yocto Project. 533 In other words, your source code resides in an external tree outside of the Yocto Project.
531 Building software from an external source tree means that the normal fetch, unpack, and 534 Building software from an external source tree means that the normal fetch, unpack, and
532 patch process is not used. 535 patch process is not used.
@@ -541,7 +544,7 @@
541 <para> 544 <para>
542 This class expects the source code to support recipe builds that use the 545 This class expects the source code to support recipe builds that use the
543 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in 546 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in
544 which the Yocto Project build system places the generated objects built from the recipes. 547 which the OpenEmbedded build system places the generated objects built from the recipes.
545 By default, the <filename>B</filename> directory is set to the following, which is separate from the 548 By default, the <filename>B</filename> directory is set to the following, which is separate from the
546 source directory (<filename>S</filename>): 549 source directory (<filename>S</filename>):
547 <literallayout class='monospaced'> 550 <literallayout class='monospaced'>
@@ -570,7 +573,7 @@
570 When you do, the <link linkend='var-B'><filename>B</filename></link> variable must support the 573 When you do, the <link linkend='var-B'><filename>B</filename></link> variable must support the
571 recipe's ability to build variants in different working directories. 574 recipe's ability to build variants in different working directories.
572 Most autotools-based recipes support separating these directories. 575 Most autotools-based recipes support separating these directories.
573 The Yocto Project defaults to using separate directories for <filename>gcc</filename> 576 The OpenEmbedded build system defaults to using separate directories for <filename>gcc</filename>
574 and some kernel recipes. 577 and some kernel recipes.
575 Alternatively, you can make sure that separate recipes exist that each 578 Alternatively, you can make sure that separate recipes exist that each
576 use the <filename>BBCLASSEXTEND</filename> variable to build each variant. 579 use the <filename>BBCLASSEXTEND</filename> variable to build each variant.
@@ -591,7 +594,7 @@
591 Thus far, this appendix has discussed only the most useful and important 594 Thus far, this appendix has discussed only the most useful and important
592 classes. 595 classes.
593 However, other classes exist within the <filename>meta/classes</filename> directory 596 However, other classes exist within the <filename>meta/classes</filename> directory
594 in the Yocto Project file's directory structure. 597 in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
595 You can examine the <filename>.bbclass</filename> files directly for more 598 You can examine the <filename>.bbclass</filename> files directly for more
596 information. 599 information.
597 </para> 600 </para>
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
index c61b985f8a..58db94e295 100644
--- a/documentation/poky-ref-manual/ref-features.xml
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -115,7 +115,7 @@
115 <title>Reference: Images</title> 115 <title>Reference: Images</title>
116 116
117 <para> 117 <para>
118 The contents of images generated by the Yocto Project can be controlled by the 118 The contents of images generated by the OpenEmbedded build system can be controlled by the
119 <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> 119 <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
120 and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> 120 and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
121 variables that you typically configure in your image recipes. 121 variables that you typically configure in your image recipes.
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index a4cd926d0d..0ffea5d19f 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -6,7 +6,7 @@
6 <title>Reference: Images</title> 6 <title>Reference: Images</title>
7 7
8 <para> 8 <para>
9 The Yocto Project build process supports several types of images to satisfy different needs. 9 The OpenEmbedded build process supports several types of images to satisfy different needs.
10 When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe 10 When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
11 that essentially begins the build for the type of image you want. 11 that essentially begins the build for the type of image you want.
12 </para> 12 </para>
@@ -32,8 +32,8 @@
32 These recipes reside in the <filename>meta/recipes-core/images</filename>, 32 These recipes reside in the <filename>meta/recipes-core/images</filename>,
33 <filename>meta/recipes-extended/images</filename>, 33 <filename>meta/recipes-extended/images</filename>,
34 <filename>meta/recipes-graphics/images</filename>, and 34 <filename>meta/recipes-graphics/images</filename>, and
35 <filename>meta/recipes-sato/images</filename> directories of your local Yocto Project 35 <filename>meta/recipes-sato/images</filename> directories
36 file structure (Git repository or extracted release tarball). 36 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
37 Although the recipe names are somewhat explanatory, here is a list that describes them: 37 Although the recipe names are somewhat explanatory, here is a list that describes them:
38 </para> 38 </para>
39 39
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index a5bfe5e876..c950671cb0 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -9,12 +9,12 @@
9<para> 9<para>
10 The Yocto Project consists of several components. 10 The Yocto Project consists of several components.
11 Understanding them and knowing where they are located is key to using the Yocto Project well. 11 Understanding them and knowing where they are located is key to using the Yocto Project well.
12 This appendix describes the Yocto Project file's directory structure and gives information about the various 12 This appendix describes the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
13 files and directories. 13 and gives information about the various files and directories.
14</para> 14</para>
15 15
16<para> 16<para>
17 For information on how to establish the Yocto Project files on your local development system, see the 17 For information on how to establish a local source directory on your development system, see the
18 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" 18 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
19 section in the Yocto Project Development Manual. 19 section in the Yocto Project Development Manual.
20</para> 20</para>
@@ -49,18 +49,20 @@
49 49
50 <para> 50 <para>
51 This directory contains user configuration files and the output 51 This directory contains user configuration files and the output
52 generated by the Yocto Project in its standard configuration where the source tree is 52 generated by the OpenEmbedded build system in its standard configuration where
53 combined with the output. 53 the source tree is combined with the output.
54 The build directory is created initially when you <filename>source</filename> 54 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
55 is created initially when you <filename>source</filename>
55 the Yocto Project environment setup script <filename>oe-init-build-env</filename>. 56 the Yocto Project environment setup script <filename>oe-init-build-env</filename>.
56 </para> 57 </para>
57 58
58 <para> 59 <para>
59 It is also possible to place output and configuration 60 It is also possible to place output and configuration
60 files in a directory separate from the Yocto Project files 61 files in a directory separate from the
62 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
61 by providing a directory name when you <filename>source</filename> 63 by providing a directory name when you <filename>source</filename>
62 the setup script. 64 the setup script.
63 For information on separating output from the Yocto Project files, see <link 65 For information on separating output from your local source directory files, see <link
64 linkend='structure-core-script'>oe-init-build-env</link>. 66 linkend='structure-core-script'>oe-init-build-env</link>.
65 </para> 67 </para>
66 </section> 68 </section>
@@ -147,9 +149,11 @@
147 By default, running this script without a build directory argument creates the 149 By default, running this script without a build directory argument creates the
148 <filename>build</filename> directory. 150 <filename>build</filename> directory.
149 If you provide a build directory argument when you <filename>source</filename> 151 If you provide a build directory argument when you <filename>source</filename>
150 the script, you direct the Yocto Project to create a build directory of your choice. 152 the script, you direct OpenEmbedded build system to create a
153 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice.
151 For example, the following command creates a build directory named 154 For example, the following command creates a build directory named
152 <filename>mybuilds</filename> that is outside of the Yocto Project files: 155 <filename>mybuilds</filename> that is outside of the
156 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>sourc directory</ulink>:
153 <literallayout class='monospaced'> 157 <literallayout class='monospaced'>
154 $ source oe-init-build-env ~/mybuilds 158 $ source oe-init-build-env ~/mybuilds
155 </literallayout> 159 </literallayout>
@@ -181,12 +185,12 @@
181 <title><filename>build/conf/local.conf</filename></title> 185 <title><filename>build/conf/local.conf</filename></title>
182 186
183 <para> 187 <para>
184 This file contains all the local user configuration of the Yocto Project. 188 This file contains all the local user configuration for your build environment.
185 If there is no <filename>local.conf</filename> present, it is created from 189 If there is no <filename>local.conf</filename> present, it is created from
186 <filename>local.conf.sample</filename>. 190 <filename>local.conf.sample</filename>.
187 The <filename>local.conf</filename> file contains documentation on the various configuration options. 191 The <filename>local.conf</filename> file contains documentation on the various configuration options.
188 Any variable set here overrides any variable set elsewhere within the Yocto Project unless 192 Any variable set here overrides any variable set elsewhere within the environment unless
189 that variable is hard-coded within the Yocto Project (e.g. by using '=' instead of '?='). 193 that variable is hard-coded within a file (e.g. by using '=' instead of '?=').
190 Some variables are hard-coded for various reasons but these variables are 194 Some variables are hard-coded for various reasons but these variables are
191 relatively rare. 195 relatively rare.
192 </para> 196 </para>
@@ -244,10 +248,11 @@
244 <title><filename>build/tmp/</filename></title> 248 <title><filename>build/tmp/</filename></title>
245 249
246 <para> 250 <para>
247 This directory receives all the Yocto Project output. 251 This directory receives all the OpenEmbedded build system's output.
248 BitBake creates this directory if it does not exist. 252 BitBake creates this directory if it does not exist.
249 As a last resort, to clean the Yocto Project and start a build from scratch (other than downloads), 253 As a last resort, to clean up a build and start it from scratch (other than the downloads),
250 you can remove everything in this directory or get rid of the directory completely. 254 you can remove everything in the <filename>tmp</filename> directory or get rid of the
255 directory completely.
251 If you do, you should also completely remove the <filename>build/sstate-cache</filename> 256 If you do, you should also completely remove the <filename>build/sstate-cache</filename>
252 directory as well. 257 directory as well.
253 </para> 258 </para>
@@ -275,7 +280,7 @@
275 <title><filename>build/tmp/deploy/</filename></title> 280 <title><filename>build/tmp/deploy/</filename></title>
276 281
277 <para> 282 <para>
278 This directory contains any 'end result' output from the Yocto Project build process. 283 This directory contains any 'end result' output from the OpenEmbedded build process.
279 </para> 284 </para>
280 </section> 285 </section>
281 286
@@ -283,7 +288,8 @@
283 <title><filename>build/tmp/deploy/deb/</filename></title> 288 <title><filename>build/tmp/deploy/deb/</filename></title>
284 289
285 <para> 290 <para>
286 This directory receives any <filename>.deb</filename> packages produced by the Yocto Project. 291 This directory receives any <filename>.deb</filename> packages produced by
292 the build process.
287 The packages are sorted into feeds for different architecture types. 293 The packages are sorted into feeds for different architecture types.
288 </para> 294 </para>
289 </section> 295 </section>
@@ -292,7 +298,8 @@
292 <title><filename>build/tmp/deploy/rpm/</filename></title> 298 <title><filename>build/tmp/deploy/rpm/</filename></title>
293 299
294 <para> 300 <para>
295 This directory receives any <filename>.rpm</filename> packages produced by the Yocto Project. 301 This directory receives any <filename>.rpm</filename> packages produced by
302 the build process.
296 The packages are sorted into feeds for different architecture types. 303 The packages are sorted into feeds for different architecture types.
297 </para> 304 </para>
298 </section> 305 </section>
@@ -319,7 +326,9 @@
319 <section id='structure-build-tmp-deploy-ipk'> 326 <section id='structure-build-tmp-deploy-ipk'>
320 <title><filename>build/tmp/deploy/ipk/</filename></title> 327 <title><filename>build/tmp/deploy/ipk/</filename></title>
321 328
322 <para>This directory receives <filename>.ipk</filename> packages produced by the Yocto Project.</para> 329 <para>
330 This directory receives <filename>.ipk</filename> packages produced by
331 the build process.</para>
323 </section> 332 </section>
324 333
325 <section id='structure-build-tmp-sysroots'> 334 <section id='structure-build-tmp-sysroots'>
@@ -380,7 +389,8 @@
380 389
381 <para> 390 <para>
382 It is worth considering the structure of a typical work directory. 391 It is worth considering the structure of a typical work directory.
383 As an example, consider the linux-yocto kernel 3.0 on the machine <filename>qemux86</filename> 392 As an example, consider the <filename>linux-yocto-kernel-3.0</filename>
393 on the machine <filename>qemux86</filename>
384 built within the Yocto Project. 394 built within the Yocto Project.
385 For this package, a work directory of 395 For this package, a work directory of
386 <filename>tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+&lt;.....&gt;</filename>, 396 <filename>tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+&lt;.....&gt;</filename>,
@@ -455,7 +465,7 @@
455 <para> 465 <para>
456 This directory contains all the machine configuration files. 466 This directory contains all the machine configuration files.
457 If you set <filename>MACHINE="qemux86"</filename>, 467 If you set <filename>MACHINE="qemux86"</filename>,
458 Yocto Project looks for a <filename>qemux86.conf</filename> file in this 468 the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this
459 directory. 469 directory.
460 The <filename>include</filename> directory contains various data common to multiple machines. 470 The <filename>include</filename> directory contains various data common to multiple machines.
461 If you want to add support for a new machine to the Yocto Project, look in this directory. 471 If you want to add support for a new machine to the Yocto Project, look in this directory.
@@ -467,12 +477,11 @@
467 477
468 <para> 478 <para>
469 Any distribution-specific configuration is controlled from this directory. 479 Any distribution-specific configuration is controlled from this directory.
470 The Yocto Project only contains the Yocto Project distribution so 480 For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here.
471 <filename>defaultsetup.conf</filename> is the main file here.
472 This directory includes the versions and the 481 This directory includes the versions and the
473 <filename>SRCDATE</filename> definitions for applications that are configured here. 482 <filename>SRCDATE</filename> definitions for applications that are configured here.
474 An example of an alternative configuration is <filename>poky-bleeding.conf</filename> 483 An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>.
475 although this file mainly inherits its configuration from the Yocto Project itself. 484 Although this file mainly inherits its configuration from Poky.
476 </para> 485 </para>
477 </section> 486 </section>
478 487
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index c815d3cfa0..99edab592e 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -8,7 +8,7 @@
8<title>Reference: Variables Glossary</title> 8<title>Reference: Variables Glossary</title>
9 9
10<para> 10<para>
11 This section lists common variables used in the Yocto Project and gives an overview 11 This section lists common variables used in the OpenEmbedded build system and gives an overview
12 of their function and contents. 12 of their function and contents.
13</para> 13</para>
14 14
@@ -89,7 +89,7 @@
89 <glossentry id='var-B'><glossterm>B</glossterm> 89 <glossentry id='var-B'><glossterm>B</glossterm>
90 <glossdef> 90 <glossdef>
91 <para> 91 <para>
92 The directory in which the Yocto Project build system places 92 The directory in which the OpenEmbedded build system places
93 generated objects during a recipe's build process. 93 generated objects during a recipe's build process.
94 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> 94 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
95 directory: 95 directory:
@@ -99,7 +99,7 @@
99 You can separate the source directory (<filename>S</filename>) and the directory pointed to 99 You can separate the source directory (<filename>S</filename>) and the directory pointed to
100 by the <filename>B</filename> variable. 100 by the <filename>B</filename> variable.
101 Most autotools-based recipes support separating these directories. 101 Most autotools-based recipes support separating these directories.
102 The Yocto Project defaults to using separate directories for <filename>gcc</filename> 102 The build system defaults to using separate directories for <filename>gcc</filename>
103 and some kernel recipes. 103 and some kernel recipes.
104 </para> 104 </para>
105 </glossdef> 105 </glossdef>
@@ -160,7 +160,7 @@
160 </literallayout></para> 160 </literallayout></para>
161 <para>Use the <filename>BBMASK</filename> variable from within the 161 <para>Use the <filename>BBMASK</filename> variable from within the
162 <filename>conf/local.conf</filename> file found 162 <filename>conf/local.conf</filename> file found
163 in the Yocto Project build directory.</para> 163 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.</para>
164 </glossdef> 164 </glossdef>
165 </glossentry> 165 </glossentry>
166 166
@@ -243,9 +243,9 @@
243 243
244 <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> 244 <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm>
245 <glossdef> 245 <glossdef>
246 <para>Lists the layers to enable during the Yocto Project build. 246 <para>Lists the layers to enable during the build.
247 This variable is defined in the <filename>bblayers.conf</filename> configuration 247 This variable is defined in the <filename>bblayers.conf</filename> configuration
248 file in the Yocto Project build directory. 248 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
249 Here is an example: 249 Here is an example:
250 <literallayout class='monospaced'> 250 <literallayout class='monospaced'>
251 BBLAYERS = " \ 251 BBLAYERS = " \
@@ -335,8 +335,8 @@
335 <filename>/etc</filename> or <filename>${bindir}</filename> rather 335 <filename>/etc</filename> or <filename>${bindir}</filename> rather
336 than <filename>/usr/bin</filename>. 336 than <filename>/usr/bin</filename>.
337 You can find a list of these variables at the top of the 337 You can find a list of these variables at the top of the
338 <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project 338 <filename>/meta/conf/bitbake.conf</filename> file in the
339 files directory. 339 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
340 </note> 340 </note>
341 </glossdef> 341 </glossdef>
342 </glossentry> 342 </glossentry>
@@ -358,7 +358,7 @@
358 Specifies the list of packages to be added to the image. 358 Specifies the list of packages to be added to the image.
359 This variable should only be set in the <filename>local.conf</filename> 359 This variable should only be set in the <filename>local.conf</filename>
360 configuration file found in the 360 configuration file found in the
361 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project Build Directory</ulink>. 361 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
362 </para> 362 </para>
363 363
364 <para> 364 <para>
@@ -479,7 +479,7 @@
479 This directory is self-maintaining and you should not have 479 This directory is self-maintaining and you should not have
480 to touch it. 480 to touch it.
481 By default, the directory is <filename>downloads</filename> in the 481 By default, the directory is <filename>downloads</filename> in the
482 Yocto Project build directory. 482 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
483 <literallayout class='monospaced'> 483 <literallayout class='monospaced'>
484 #DL_DIR ?= "${TOPDIR}/downloads" 484 #DL_DIR ?= "${TOPDIR}/downloads"
485 </literallayout> 485 </literallayout>
@@ -635,8 +635,8 @@
635 <filename>/etc</filename> or <filename>${bindir}</filename> rather 635 <filename>/etc</filename> or <filename>${bindir}</filename> rather
636 than <filename>/usr/bin</filename>. 636 than <filename>/usr/bin</filename>.
637 You can find a list of these variables at the top of the 637 You can find a list of these variables at the top of the
638 <filename>/meta/conf/bitbake.conf</filename> file in the Yocto Project 638 <filename>/meta/conf/bitbake.conf</filename> file in the
639 files directory. 639 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
640 </note> 640 </note>
641 641
642 <para> 642 <para>
@@ -655,7 +655,7 @@
655 <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> 655 <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm>
656 <glossdef> 656 <glossdef>
657 <para> 657 <para>
658 Extends the search path the Yocto Project build system uses when 658 Extends the search path the OpenEmbedded build system uses when
659 looking for files and patches as it processes recipes. 659 looking for files and patches as it processes recipes.
660 The directories BitBake uses when it processes recipes is defined by the 660 The directories BitBake uses when it processes recipes is defined by the
661 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable. 661 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable.
@@ -691,7 +691,7 @@
691 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> 691 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
692 <glossdef> 692 <glossdef>
693 <para> 693 <para>
694 The default set of directories the Yocto Project build system uses 694 The default set of directories the OpenEmbedded build system uses
695 when searching for patches and files. 695 when searching for patches and files.
696 During the build process, BitBake searches each directory in 696 During the build process, BitBake searches each directory in
697 <filename>FILESPATH</filename> in the specified order when looking for 697 <filename>FILESPATH</filename> in the specified order when looking for
@@ -702,7 +702,7 @@
702 The default value for the <filename>FILESPATH</filename> variable is defined 702 The default value for the <filename>FILESPATH</filename> variable is defined
703 in the <filename>base.bbclass</filename> class found in 703 in the <filename>base.bbclass</filename> class found in
704 <filename>meta/classes</filename> in the 704 <filename>meta/classes</filename> in the
705 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>: 705 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>:
706 <literallayout class='monospaced'> 706 <literallayout class='monospaced'>
707FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ 707FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
708 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ 708 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
@@ -727,16 +727,17 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
727 possible. 727 possible.
728 </para> 728 </para>
729 <para> 729 <para>
730 By default, the Yocto Project uses the <filename>fs-perms.txt</filename>, which 730 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
731 is located in the <filename>meta/files</filename> directory of the Yocto Project 731 is located in the <filename>meta/files</filename> folder in the
732 files directory. 732 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
733 If you create your own file permissions setting table, you should place it in your 733 If you create your own file permissions setting table, you should place it in your
734 layer or the distros layer. 734 layer or the distros layer.
735 </para> 735 </para>
736 <para> 736 <para>
737 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the 737 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
738 <filename>conf/local.conf</filename> file, which is found in the Yocto Project's 738 <filename>conf/local.conf</filename> file, which is found in the
739 build directory, to point to your custom <filename>fs-perms.txt</filename>. 739 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, to
740 point to your custom <filename>fs-perms.txt</filename>.
740 You can specify more than a single file permissions setting table. 741 You can specify more than a single file permissions setting table.
741 The paths you specify to these files must be defined within the 742 The paths you specify to these files must be defined within the
742 <filename>BBPATH</filename> variable. 743 <filename>BBPATH</filename> variable.
@@ -785,7 +786,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
785 Note that you can add extra features to the image by using the 786 Note that you can add extra features to the image by using the
786 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. 787 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
787 See the "<link linkend="ref-features-image">Reference: Images</link>" section for the 788 See the "<link linkend="ref-features-image">Reference: Images</link>" section for the
788 list of features present in images built by the Yocto Project.</para> 789 list of features present in images built by the OpenEmbedded build system.</para>
789 </glossdef> 790 </glossdef>
790 </glossentry> 791 </glossentry>
791 792
@@ -908,7 +909,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
908 <glossdef> 909 <glossdef>
909 <para> 910 <para>
910 Defines the size in Kbytes for the generated image. 911 Defines the size in Kbytes for the generated image.
911 The Yocto Project build system determines the final size for the generated 912 The OpenEmbedded build system determines the final size for the generated
912 image using an algorithm that takes into account the initial disk space used 913 image using an algorithm that takes into account the initial disk space used
913 for the generated image, a requested size for the image, and requested 914 for the generated image, a requested size for the image, and requested
914 additional free disk space to be added to the image. 915 additional free disk space to be added to the image.
@@ -1035,8 +1036,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1035 1036
1036 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> 1037 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
1037 <glossdef> 1038 <glossdef>
1038 <para>Includes additional metadata from the Linux Yocto kernel Git repository. 1039 <para>Includes additional metadata from the Yocto Project kernel Git repository.
1039 In the Yocto Project build system, the default Board Support Packages (BSPs) 1040 In the OpenEmbedded build system, the default Board Support Packages (BSPs)
1040 metadata is provided through 1041 metadata is provided through
1041 the <filename>KMACHINE</filename> and <filename>KBRANCH</filename> variables. 1042 the <filename>KMACHINE</filename> and <filename>KBRANCH</filename> variables.
1042 You can use the <filename>KERNEL_FEATURES</filename> variable to further 1043 You can use the <filename>KERNEL_FEATURES</filename> variable to further
@@ -1049,7 +1050,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1049 In this way, you can provide validated, but optional, sets of kernel 1050 In this way, you can provide validated, but optional, sets of kernel
1050 configurations and features.</para> 1051 configurations and features.</para>
1051 <para>For example, the following adds <filename>netfilter</filename> to all 1052 <para>For example, the following adds <filename>netfilter</filename> to all
1052 the Linux Yocto kernels and adds sound support to the <filename>qemux86</filename> 1053 the Yocto Project kernels and adds sound support to the <filename>qemux86</filename>
1053 machine: 1054 machine:
1054 <literallayout class='monospaced'> 1055 <literallayout class='monospaced'>
1055 # Add netfilter to all linux-yocto kernels 1056 # Add netfilter to all linux-yocto kernels
@@ -1137,7 +1138,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1137 <glossentry id='var-LICENSE_DIR'><glossterm>LICENSE_DIR</glossterm> 1138 <glossentry id='var-LICENSE_DIR'><glossterm>LICENSE_DIR</glossterm>
1138 <glossdef> 1139 <glossdef>
1139 <para>Path to additional licenses used during the build. 1140 <para>Path to additional licenses used during the build.
1140 By default, the Yocto Project uses <filename>COMMON_LICENSE_DIR</filename> 1141 By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename>
1141 to define the directory that holds common license text used during the build. 1142 to define the directory that holds common license text used during the build.
1142 The <filename>LICENSE_DIR</filename> variable allows you to extend that 1143 The <filename>LICENSE_DIR</filename> variable allows you to extend that
1143 location to other areas that have additional licenses: 1144 location to other areas that have additional licenses:
@@ -1341,7 +1342,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1341 <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> 1342 <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
1342 <glossdef> 1343 <glossdef>
1343 <para>This variable, which is set in the <filename>local.conf</filename> configuration 1344 <para>This variable, which is set in the <filename>local.conf</filename> configuration
1344 file found in the Yocto Project file's <filename>conf</filename> directory, 1345 file found in the <filename>conf</filename> folder of the
1346 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>,
1345 specifies the package manager to use when packaging data. 1347 specifies the package manager to use when packaging data.
1346 You can provide one or more arguments for the variable with the first 1348 You can provide one or more arguments for the variable with the first
1347 argument being the package manager used to create images: 1349 argument being the package manager used to create images:
@@ -1534,7 +1536,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1534 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable. 1536 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable.
1535 </para> 1537 </para>
1536 <para> 1538 <para>
1537 The Yocto Project build process automatically installs the list of packages 1539 The OpenEmbedded build process automatically installs the list of packages
1538 as part of the built package. 1540 as part of the built package.
1539 However, you can remove them later if you want. 1541 However, you can remove them later if you want.
1540 If, during the build, a package from the list cannot be found, the build 1542 If, during the build, a package from the list cannot be found, the build
@@ -1572,8 +1574,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1572 <glossentry id='var-S'><glossterm>S</glossterm> 1574 <glossentry id='var-S'><glossterm>S</glossterm>
1573 <glossdef> 1575 <glossdef>
1574 <para> 1576 <para>
1575 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> 1577 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
1576 Yocto Project Build Directory</ulink> where unpacked package source code resides. 1578 where unpacked package source code resides.
1577 This location is within the working directory 1579 This location is within the working directory
1578 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which 1580 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which
1579 is not static. 1581 is not static.
@@ -1585,9 +1587,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1585 ${WORKDIR}/${PN}-${PV} 1587 ${WORKDIR}/${PN}-${PV}
1586 </literallayout> 1588 </literallayout>
1587 As an example, assume a 1589 As an example, assume a
1588 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> 1590 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level
1589 Yocto Project Files</ulink> top-level directory named <filename>poky</filename> 1591 folder named <filename>poky</filename>
1590 and a default Yocto Project Build Directory of <filename>poky/build</filename>. 1592 and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
1593 at <filename>poky/build</filename>.
1591 In this case, the working directory the build system uses to build 1594 In this case, the working directory the build system uses to build
1592 the <filename>db</filename> package is the following: 1595 the <filename>db</filename> package is the following:
1593 <literallayout class='monospaced'> 1596 <literallayout class='monospaced'>
@@ -1661,10 +1664,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1661 <glossdef> 1664 <glossdef>
1662 <para></para> 1665 <para></para>
1663 <para> 1666 <para>
1664 By default, the Yocto Project automatically detects whether 1667 By default, the OpenEmbedded build system automatically detects whether
1665 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> 1668 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>
1666 contains files that are machine-specific. 1669 contains files that are machine-specific.
1667 If so, the Yocto Project automatically changes 1670 If so, the build system automatically changes
1668 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. 1671 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
1669 Setting this variable to "0" disables this behavior. 1672 Setting this variable to "0" disables this behavior.
1670 </para> 1673 </para>
@@ -1728,7 +1731,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1728 <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> 1731 <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm>
1729 <glossdef> 1732 <glossdef>
1730 <para>The architecture of the device being built. 1733 <para>The architecture of the device being built.
1731 While a number of values are possible, the Yocto Project primarily supports 1734 While a number of values are possible, the OpenEmbedded build system primarily supports
1732 <filename>arm</filename> and <filename>i586</filename>.</para> 1735 <filename>arm</filename> and <filename>i586</filename>.</para>
1733 </glossdef> 1736 </glossdef>
1734 </glossentry> 1737 </glossentry>
@@ -1790,11 +1793,11 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1790 </para> 1793 </para>
1791 <para> 1794 <para>
1792 The <filename>TCMODE</filename> variable selects the external toolchain 1795 The <filename>TCMODE</filename> variable selects the external toolchain
1793 built from the Yocto Project or a few supported combinations of 1796 built using the OpenEmbedded build system or a few supported combinations of
1794 the upstream GCC or CodeSourcery Labs toolchain. 1797 the upstream GCC or CodeSourcery Labs toolchain.
1795 The variable determines which of the <filename>tcmode-*</filename> files in 1798 The variable determines which of the <filename>tcmode-*</filename> files in
1796 the <filename>meta/conf/distro/include</filename> directory, which is found in the 1799 the <filename>meta/conf/distro/include</filename> directory, which is found in the
1797 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>, 1800 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>,
1798 is used. 1801 is used.
1799 </para> 1802 </para>
1800 <para> 1803 <para>
@@ -1811,20 +1814,18 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1811 <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm> 1814 <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm>
1812 <glossdef> 1815 <glossdef>
1813 <para> 1816 <para>
1814 This variable is the temporary directory the Yocto Project build system 1817 This variable is the temporary directory the OpenEmbedded build system
1815 uses when it does its work building images. 1818 uses when it does its work building images.
1816 By default, the <filename>TMPDIR</filename> variable is named 1819 By default, the <filename>TMPDIR</filename> variable is named
1817 <filename>tmp</filename> within the 1820 <filename>tmp</filename> within the
1818 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> 1821 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
1819 Yocto Project Build Directory</ulink>.
1820 </para> 1822 </para>
1821 1823
1822 <para> 1824 <para>
1823 If you want to establish this directory in a location other than the 1825 If you want to establish this directory in a location other than the
1824 default, you can uncomment the following statement in the 1826 default, you can uncomment the following statement in the
1825 <filename>conf/local.conf</filename> file in the 1827 <filename>conf/local.conf</filename> file in the
1826 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> 1828 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>:
1827 Yocto Project Files</ulink>:
1828 <literallayout class='monospaced'> 1829 <literallayout class='monospaced'>
1829 #TMPDIR = "${TOPDIR}/tmp" 1830 #TMPDIR = "${TOPDIR}/tmp"
1830 </literallayout> 1831 </literallayout>
@@ -1836,10 +1837,9 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1836 <glossdef> 1837 <glossdef>
1837 <para> 1838 <para>
1838 This variable is the 1839 This variable is the
1839 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> 1840 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
1840 Yocto Project Build Directory</ulink>.
1841 BitBake automatically sets this variable. 1841 BitBake automatically sets this variable.
1842 The Yocto Project build system uses the build directory when building images. 1842 The OpenEmbedded build system uses the build directory when building images.
1843 </para> 1843 </para>
1844 </glossdef> 1844 </glossdef>
1845 </glossentry> 1845 </glossentry>
@@ -1857,7 +1857,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1857 <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> 1857 <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
1858 <glossdef> 1858 <glossdef>
1859 <para> 1859 <para>
1860 The pathname of the working directory in which the Yocto Project build system 1860 The pathname of the working directory in which the OpenEmbedded build system
1861 builds packages. 1861 builds packages.
1862 This directory is located within the 1862 This directory is located within the
1863 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes 1863 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes
@@ -1884,11 +1884,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1884 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1884 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1885 </literallayout> 1885 </literallayout>
1886 As an example, assume a 1886 As an example, assume a
1887 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> 1887 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level
1888 Yocto Project Files</ulink> top-level directory named <filename>poky</filename> 1888 folder name <filename>poky</filename> and a default
1889 and a default 1889 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
1890 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> 1890 at <filename>poky/build</filename>.
1891 Yocto Project Build Directory</ulink> of <filename>poky/build</filename>.
1892 In this case, the working directory the build system uses to build 1891 In this case, the working directory the build system uses to build
1893 the <filename>v86d</filename> package is the following: 1892 the <filename>v86d</filename> package is the following:
1894 <literallayout class='monospaced'> 1893 <literallayout class='monospaced'>
@@ -1902,9 +1901,9 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
1902 <literallayout class='monospaced'> 1901 <literallayout class='monospaced'>
1903 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1902 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1904 </literallayout> 1903 </literallayout>
1905 As an example, again assume a Yocto Project Files top-level directory 1904 As an example, again assume a source directory top-level folder
1906 named <filename>poky</filename> and a default Yocto Project build directory 1905 named <filename>poky</filename> and a default build directory
1907 of <filename>poky/build</filename>. 1906 at <filename>poky/build</filename>.
1908 In this case, the working directory the build system uses to build 1907 In this case, the working directory the build system uses to build
1909 the <filename>acl</filename> package, which is dependent on a 1908 the <filename>acl</filename> package, which is dependent on a
1910 MIPS-based device, is the following: 1909 MIPS-based device, is the following:
diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml
index 5dc6153bcb..15f4bacb34 100644
--- a/documentation/poky-ref-manual/resources.xml
+++ b/documentation/poky-ref-manual/resources.xml
@@ -39,8 +39,8 @@
39 Use this list to monitor Yocto Project development discussions, ask questions, and 39 Use this list to monitor Yocto Project development discussions, ask questions, and
40 get help.</para></listitem> 40 get help.</para></listitem>
41 <listitem><para><emphasis><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink></emphasis>: 41 <listitem><para><emphasis><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink></emphasis>:
42 Use this list to monitor discussions about the Yocto Project build system Poky, 42 Use this list to monitor discussions about the OpenEmbedded build system, which is
43 ask questions, and get help.</para></listitem> 43 based on Poky, ask questions, and get help.</para></listitem>
44 </itemizedlist> 44 </itemizedlist>
45 </para> 45 </para>
46</section> 46</section>
@@ -65,15 +65,16 @@
65 <itemizedlist> 65 <itemizedlist>
66 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: 66 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>:
67 </emphasis> The home site for the Yocto Project.</para></listitem> 67 </emphasis> The home site for the Yocto Project.</para></listitem>
68 <listitem><para><emphasis><ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis> 68<!-- <listitem><para><emphasis><ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis>
69 The company where the Yocto Project build system Poky was first developed. 69 The company where the Yocto Project build system Poky was first developed.
70 OpenedHand has since been acquired by Intel Corporation.</para></listitem> 70 OpenedHand has since been acquired by Intel Corporation.</para></listitem> -->
71 <listitem><para><emphasis><ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> 71 <listitem><para><emphasis><ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis>
72 The company who acquired OpenedHand in 2008 and continues development on the 72 The company who acquired OpenedHand in 2008 and began development on the
73 Yocto Project.</para></listitem> 73 Yocto Project.</para></listitem>
74 <listitem><para><emphasis><ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> 74 <listitem><para><emphasis><ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
75 The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives 75 The upstream, generic, embedded distribution used as the basis for the build system in the
76 from and to which it contributes.</para></listitem> 76 Yocto Project.
77 Poky derives from and contributes back to the OpenEmbedded project.</para></listitem>
77 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'> 78 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
78 BitBake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem> 79 BitBake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem>
79 <listitem><para><emphasis><ulink url='http://bitbake.berlios.de/manual/'> 80 <listitem><para><emphasis><ulink url='http://bitbake.berlios.de/manual/'>
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 914a0f5771..6ce36014f1 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -8,15 +8,15 @@
8 <para> 8 <para>
9 This chapter describes common usage for the Yocto Project. 9 This chapter describes common usage for the Yocto Project.
10 The information is introductory in nature as other manuals in the Yocto Project 10 The information is introductory in nature as other manuals in the Yocto Project
11 provide more details on how to use the Yocto Project. 11 documentation set provide more details on how to use the Yocto Project.
12 </para> 12 </para>
13 13
14<section id='usingpoky-build'> 14<section id='usingpoky-build'>
15 <title>Running a Build</title> 15 <title>Running a Build</title>
16 16
17 <para> 17 <para>
18 You can find general information on how to build an image using the 18 You can find general information on how to build an image using the OpenEmbedded build
19 Yocto Project in the 19 system in the
20 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 20 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
21 section of The Yocto Project Quick Start. 21 section of The Yocto Project Quick Start.
22 This section provides a summary of the build process and provides information 22 This section provides a summary of the build process and provides information
@@ -36,7 +36,7 @@
36 36
37 <para> 37 <para>
38 The <filename>build_dir</filename> is optional and specifies the directory Yocto Project 38 The <filename>build_dir</filename> is optional and specifies the directory Yocto Project
39 uses for the build. 39 uses for the build - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
40 If you do not specify a build directory it defaults to <filename>build</filename> 40 If you do not specify a build directory it defaults to <filename>build</filename>
41 in your current working directory. 41 in your current working directory.
42 A common practice is to use a different build directory for different targets. 42 A common practice is to use a different build directory for different targets.
@@ -56,11 +56,11 @@
56 <para> 56 <para>
57 The <filename>target</filename> is the name of the recipe you want to build. 57 The <filename>target</filename> is the name of the recipe you want to build.
58 Common targets are the images in <filename>meta/recipes-core/images</filename>, 58 Common targets are the images in <filename>meta/recipes-core/images</filename>,
59 <filename>/meta/recipes-sato/images</filename>, etc. all found in the Yocto Project 59 <filename>/meta/recipes-sato/images</filename>, etc. all found in the
60 files. 60 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
61 Or, the target can be the name of a recipe for a specific piece of software such as 61 Or, the target can be the name of a recipe for a specific piece of software such as
62 <application>busybox</application>. 62 <application>busybox</application>.
63 For more details about the images the Yocto Project supports, see the 63 For more details about the images the OpenEmbedded build system supports, see the
64 "<link linkend="ref-images">Reference: Images</link>" appendix. 64 "<link linkend="ref-images">Reference: Images</link>" appendix.
65 </para> 65 </para>
66 66
@@ -89,7 +89,8 @@
89 89
90 <para> 90 <para>
91 Once an image has been built, it often needs to be installed. 91 Once an image has been built, it often needs to be installed.
92 The images and kernels built by the Yocto Project are placed in the build directory in 92 The images and kernels built by the OpenEmbedded build system are placed in the
93 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> in
93 <filename class="directory">tmp/deploy/images</filename>. 94 <filename class="directory">tmp/deploy/images</filename>.
94 For information on how to run pre-built images such as <filename>qemux86</filename> 95 For information on how to run pre-built images such as <filename>qemux86</filename>
95 and <filename>qemuarm</filename>, see the 96 and <filename>qemuarm</filename>, see the
@@ -104,12 +105,12 @@
104 <title>Debugging Build Failures</title> 105 <title>Debugging Build Failures</title>
105 106
106 <para> 107 <para>
107 The exact method for debugging Yocto Project build failures depends on the nature of the 108 The exact method for debugging build failures depends on the nature of the
108 problem and on the system's area from which the bug originates. 109 problem and on the system's area from which the bug originates.
109 Standard debugging practices such as comparison against the last 110 Standard debugging practices such as comparison against the last
110 known working version with examination of the changes and the re-application of steps 111 known working version with examination of the changes and the re-application of steps
111 to identify the one causing the problem are 112 to identify the one causing the problem are
112 valid for Yocto Project just as they are for any other system. 113 valid for the Yocto Project just as they are for any other system.
113 Even though it is impossible to detail every possible potential failure, 114 Even though it is impossible to detail every possible potential failure,
114 this section provides some general tips to aid in debugging. 115 this section provides some general tips to aid in debugging.
115 </para> 116 </para>
@@ -263,10 +264,10 @@
263 </para> 264 </para>
264 265
265 <para> 266 <para>
266 For guidance on how logging is handled 267 For guidance on how logging is handled in both Python and Bash recipes, see the
267 in both Python and Bash recipes, see the
268 <filename>logging.bbclass</filename> file in the 268 <filename>logging.bbclass</filename> file in the
269 <filename>meta/classes</filename> directory of the Yocto Project files. 269 <filename>meta/classes</filename> folder of the
270 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
270 </para> 271 </para>
271 272
272 <section id='logging-with-python'> 273 <section id='logging-with-python'>