summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/introduction.xml2
-rw-r--r--documentation/poky-ref-manual/ref-bitbake.xml2
-rw-r--r--documentation/poky-ref-manual/ref-classes.xml10
-rw-r--r--documentation/poky-ref-manual/ref-features.xml4
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml38
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml87
-rw-r--r--documentation/poky-ref-manual/technical-details.xml15
-rw-r--r--documentation/poky-ref-manual/usingpoky.xml16
8 files changed, 90 insertions, 84 deletions
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index fb4cc79d0c..ab2e7d0f31 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -306,7 +306,7 @@
306 <title>Development Checkouts</title> 306 <title>Development Checkouts</title>
307 <para> 307 <para>
308 Development using the Yocto Project requires a local 308 Development using the Yocto Project requires a local
309 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 309 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
310 You can set up the source directory by downloading a Yocto Project release tarball and unpacking it, 310 You can set up the source directory by downloading a Yocto Project release tarball and unpacking it,
311 or by cloning a copy of the upstream 311 or by cloning a copy of the upstream
312 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. 312 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index d4b8584a46..b81f12fb7a 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -36,7 +36,7 @@
36 <para> 36 <para>
37 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.
38 This file resides in the 38 This file resides in the
39 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> 39 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
40 within the <filename>meta/conf/</filename> directory. 40 within the <filename>meta/conf/</filename> directory.
41 BitBake finds it by examining its 41 BitBake finds it by examining its
42 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment 42 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index cc403a95fa..973d065f58 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -13,7 +13,7 @@
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 15 <filename>meta*/</filename> directory found in the
16 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 16 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
17 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
18 <filename>.conf</filename> files in the <filename>conf</filename> directory. 18 <filename>.conf</filename> files in the <filename>conf</filename> directory.
19 Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link> 19 Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
@@ -302,7 +302,7 @@
302 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> 302 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
303 variable defined in the <filename>local.conf</filename> configuration file, 303 variable defined in the <filename>local.conf</filename> configuration file,
304 which is located in the <filename>conf</filename> folder of the 304 which is located in the <filename>conf</filename> folder of the
305 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 305 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
306 When defining the variable, you can specify one or more package types. 306 When defining the variable, you can specify one or more package types.
307 Since images are generated from packages, a packaging class is 307 Since images are generated from packages, a packaging class is
308 needed to enable image generation. 308 needed to enable image generation.
@@ -538,7 +538,7 @@
538 you can use this class to specify those packages and associate the users and groups 538 you can use this class to specify those packages and associate the users and groups
539 with those packages. 539 with those packages.
540 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> 540 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename>
541 recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> 541 recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
542 provides a simple exmample that shows how to add three 542 provides a simple exmample that shows how to add three
543 users and groups to two packages. 543 users and groups to two packages.
544 See the <filename>useradd-example.bb</filename> for more information on how to 544 See the <filename>useradd-example.bb</filename> for more information on how to
@@ -568,7 +568,7 @@
568 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in 568 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in
569 which the OpenEmbedded build system places the generated objects built from the recipes. 569 which the OpenEmbedded build system places the generated objects built from the recipes.
570 By default, the <filename>B</filename> directory is set to the following, which is separate from the 570 By default, the <filename>B</filename> directory is set to the following, which is separate from the
571 source directory (<filename>S</filename>): 571 Source Directory (<filename>S</filename>):
572 <literallayout class='monospaced'> 572 <literallayout class='monospaced'>
573 ${WORKDIR}/${BPN}-{PV}/ 573 ${WORKDIR}/${BPN}-{PV}/
574 </literallayout> 574 </literallayout>
@@ -616,7 +616,7 @@
616 Thus far, this chapter has discussed only the most useful and important 616 Thus far, this chapter has discussed only the most useful and important
617 classes. 617 classes.
618 However, other classes exist within the <filename>meta/classes</filename> directory 618 However, other classes exist within the <filename>meta/classes</filename> directory
619 in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 619 in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
620 You can examine the <filename>.bbclass</filename> files directly for more 620 You can examine the <filename>.bbclass</filename> files directly for more
621 information. 621 information.
622 </para> 622 </para>
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
index 063eaadc43..fd0bd29ff7 100644
--- a/documentation/poky-ref-manual/ref-features.xml
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -223,7 +223,7 @@
223 You can disable the feature without affecting 223 You can disable the feature without affecting
224 other existing distro configurations that need PulseAudio support 224 other existing distro configurations that need PulseAudio support
225 by adding "pulseaudio" to 225 by adding "pulseaudio" to
226 DISTRO_FEATURES_BACKFILL_CONSIDERED 226 <filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename>
227 in your distro's <filename>.conf</filename> file. 227 in your distro's <filename>.conf</filename> file.
228 Adding the feature to this variable when it also 228 Adding the feature to this variable when it also
229 exists in the <filename>DISTRO_FEATURES_BACKFILL</filename> 229 exists in the <filename>DISTRO_FEATURES_BACKFILL</filename>
@@ -240,7 +240,7 @@
240 You can disable RTC support for your device without 240 You can disable RTC support for your device without
241 affecting other machines that need RTC support 241 affecting other machines that need RTC support
242 by adding the feature to your machine's 242 by adding the feature to your machine's
243 MACHINE_FEATURES_BACKFILL_CONSIDERED 243 <filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename>
244 list in the machine's <filename>.conf</filename> file. 244 list in the machine's <filename>.conf</filename> file.
245 Adding the feature to this variable when it also 245 Adding the feature to this variable when it also
246 exists in the <filename>MACHINE_FEATURES_BACKFILL</filename> 246 exists in the <filename>MACHINE_FEATURES_BACKFILL</filename>
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index ece4894528..be2773b624 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -7,14 +7,14 @@
7<title>Source Directory Structure</title> 7<title>Source Directory Structure</title>
8 8
9<para> 9<para>
10 The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> consists of several components. 10 The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 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 chapter describes the source directory and gives information about the various 12 This chapter describes the Source Directory and gives information about the various
13 files and directories. 13 files and directories.
14</para> 14</para>
15 15
16<para> 16<para>
17 For information on how to establish a local source directory on your 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>
@@ -26,7 +26,7 @@
26 <title><filename>bitbake/</filename></title> 26 <title><filename>bitbake/</filename></title>
27 27
28 <para> 28 <para>
29 The <ulink url='source-directory'>source directory</ulink> 29 The <ulink url='source-directory'>Source Directory</ulink>
30 includes a copy of BitBake for ease of use. 30 includes a copy of BitBake for ease of use.
31 The copy usually matches the current stable BitBake release from the BitBake project. 31 The copy usually matches the current stable BitBake release from the BitBake project.
32 BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks 32 BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks
@@ -39,7 +39,7 @@
39 When you run the <filename>bitbake</filename> command, the wrapper script in 39 When you run the <filename>bitbake</filename> command, the wrapper script in
40 <filename>scripts/</filename> is executed to run the main BitBake executable, 40 <filename>scripts/</filename> is executed to run the main BitBake executable,
41 which resides in the <filename>bitbake/bin/</filename> directory. 41 which resides in the <filename>bitbake/bin/</filename> directory.
42 Sourcing the <link linkend="structure-core-script">oe-init-build-env</link> 42 Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link>
43 script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> 43 script places the <filename>scripts</filename> and <filename>bitbake/bin</filename>
44 directories (in that order) into the shell's <filename>PATH</filename> environment 44 directories (in that order) into the shell's <filename>PATH</filename> environment
45 variable. 45 variable.
@@ -59,19 +59,19 @@
59 This directory contains user configuration files and the output 59 This directory contains user configuration files and the output
60 generated by the OpenEmbedded build system in its standard configuration where 60 generated by the OpenEmbedded build system in its standard configuration where
61 the source tree is combined with the output. 61 the source tree is combined with the output.
62 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 62 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
63 is created initially when you <filename>source</filename> 63 is created initially when you <filename>source</filename>
64 the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>. 64 the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>.
65 </para> 65 </para>
66 66
67 <para> 67 <para>
68 It is also possible to place output and configuration 68 It is also possible to place output and configuration
69 files in a directory separate from the 69 files in a directory separate from the
70 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> 70 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
71 by providing a directory name when you <filename>source</filename> 71 by providing a directory name when you <filename>source</filename>
72 the setup script. 72 the setup script.
73 For information on separating output from your local source directory files, see <link 73 For information on separating output from your local Source Directory files, see <link
74 linkend='structure-core-script'>oe-init-build-env</link>. 74 linkend='structure-core-script'>&OE_INIT_FILE;</link>.
75 </para> 75 </para>
76 </section> 76 </section>
77 77
@@ -141,7 +141,7 @@
141 <para> 141 <para>
142 This directory contains various integration scripts that implement 142 This directory contains various integration scripts that implement
143 extra functionality in the Yocto Project environment (e.g. QEMU scripts). 143 extra functionality in the Yocto Project environment (e.g. QEMU scripts).
144 The <link linkend="structure-core-script">oe-init-build-env</link> script appends this 144 The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this
145 directory to the shell's <filename>PATH</filename> environment variable. 145 directory to the shell's <filename>PATH</filename> environment variable.
146 </para> 146 </para>
147 147
@@ -153,7 +153,7 @@
153 </section> 153 </section>
154 154
155 <section id='structure-core-script'> 155 <section id='structure-core-script'>
156 <title><filename>oe-init-build-env</filename></title> 156 <title><filename>&OE_INIT_FILE;</filename></title>
157 157
158 <para> 158 <para>
159 This script sets up the OpenEmbedded build environment. 159 This script sets up the OpenEmbedded build environment.
@@ -166,16 +166,16 @@
166 </para> 166 </para>
167 167
168 <para> 168 <para>
169 By default, running this script without a build directory argument creates the 169 By default, running this script without a Build Directory argument creates the
170 <filename>build</filename> directory. 170 <filename>build</filename> directory.
171 If you provide a build directory argument when you <filename>source</filename> 171 If you provide a Build Directory argument when you <filename>source</filename>
172 the script, you direct OpenEmbedded build system to create a 172 the script, you direct OpenEmbedded build system to create a
173 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice. 173 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice.
174 For example, the following command creates a build directory named 174 For example, the following command creates a Build Directory named
175 <filename>mybuilds</filename> that is outside of the 175 <filename>mybuilds</filename> that is outside of the
176 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: 176 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
177 <literallayout class='monospaced'> 177 <literallayout class='monospaced'>
178 $ source oe-init-build-env ~/mybuilds 178 $ source &OE_INIT_FILE; ~/mybuilds
179 </literallayout> 179 </literallayout>
180 </para> 180 </para>
181 </section> 181 </section>
@@ -387,7 +387,7 @@
387 data. 387 data.
388 Packages that need to share output with other packages do so within this directory. 388 Packages that need to share output with other packages do so within this directory.
389 The directory is subdivided by architecture so multiple builds can run within 389 The directory is subdivided by architecture so multiple builds can run within
390 the one build directory. 390 the one Build Directory.
391 </para> 391 </para>
392 </section> 392 </section>
393 393
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 8663cc463c..ac068228cf 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -93,8 +93,8 @@
93 <glossentry id='var-B'><glossterm>B</glossterm> 93 <glossentry id='var-B'><glossterm>B</glossterm>
94 <glossdef> 94 <glossdef>
95 <para> 95 <para>
96 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 96 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
97 The OpenEmbedded build system places generated objects into the build directory 97 The OpenEmbedded build system places generated objects into the Build Directory
98 during a recipe's build process. 98 during a recipe's build process.
99 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> 99 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
100 directory: 100 directory:
@@ -165,7 +165,7 @@
165 </literallayout></para> 165 </literallayout></para>
166 <para>Use the <filename>BBMASK</filename> variable from within the 166 <para>Use the <filename>BBMASK</filename> variable from within the
167 <filename>conf/local.conf</filename> file found 167 <filename>conf/local.conf</filename> file found
168 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.</para> 168 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para>
169 </glossdef> 169 </glossdef>
170 </glossentry> 170 </glossentry>
171 171
@@ -250,7 +250,7 @@
250 <glossdef> 250 <glossdef>
251 <para>Lists the layers to enable during the build. 251 <para>Lists the layers to enable during the build.
252 This variable is defined in the <filename>bblayers.conf</filename> configuration 252 This variable is defined in the <filename>bblayers.conf</filename> configuration
253 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 253 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
254 Here is an example: 254 Here is an example:
255 <literallayout class='monospaced'> 255 <literallayout class='monospaced'>
256 BBLAYERS = " \ 256 BBLAYERS = " \
@@ -362,7 +362,7 @@
362 than <filename>/usr/bin</filename>. 362 than <filename>/usr/bin</filename>.
363 You can find a list of these variables at the top of the 363 You can find a list of these variables at the top of the
364 <filename>/meta/conf/bitbake.conf</filename> file in the 364 <filename>/meta/conf/bitbake.conf</filename> file in the
365 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 365 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
366 </note> 366 </note>
367 </glossdef> 367 </glossdef>
368 </glossentry> 368 </glossentry>
@@ -384,7 +384,7 @@
384 Specifies the list of packages to be added to the image. 384 Specifies the list of packages to be added to the image.
385 This variable should only be set in the <filename>local.conf</filename> 385 This variable should only be set in the <filename>local.conf</filename>
386 configuration file found in the 386 configuration file found in the
387 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 387 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
388 </para> 388 </para>
389 389
390 <para> 390 <para>
@@ -581,7 +581,7 @@
581 This directory is self-maintaining and you should not have 581 This directory is self-maintaining and you should not have
582 to touch it. 582 to touch it.
583 By default, the directory is <filename>downloads</filename> in the 583 By default, the directory is <filename>downloads</filename> in the
584 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 584 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
585 <literallayout class='monospaced'> 585 <literallayout class='monospaced'>
586 #DL_DIR ?= "${TOPDIR}/downloads" 586 #DL_DIR ?= "${TOPDIR}/downloads"
587 </literallayout> 587 </literallayout>
@@ -755,7 +755,7 @@
755 than <filename>/usr/bin</filename>. 755 than <filename>/usr/bin</filename>.
756 You can find a list of these variables at the top of the 756 You can find a list of these variables at the top of the
757 <filename>/meta/conf/bitbake.conf</filename> file in the 757 <filename>/meta/conf/bitbake.conf</filename> file in the
758 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 758 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
759 </note> 759 </note>
760 760
761 <para> 761 <para>
@@ -821,7 +821,7 @@
821 The default value for the <filename>FILESPATH</filename> variable is defined 821 The default value for the <filename>FILESPATH</filename> variable is defined
822 in the <filename>base.bbclass</filename> class found in 822 in the <filename>base.bbclass</filename> class found in
823 <filename>meta/classes</filename> in the 823 <filename>meta/classes</filename> in the
824 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: 824 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
825 <literallayout class='monospaced'> 825 <literallayout class='monospaced'>
826FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ 826FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
827 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ 827 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
@@ -848,14 +848,14 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
848 <para> 848 <para>
849 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which 849 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
850 is located in the <filename>meta/files</filename> folder in the 850 is located in the <filename>meta/files</filename> folder in the
851 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 851 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
852 If you create your own file permissions setting table, you should place it in your 852 If you create your own file permissions setting table, you should place it in your
853 layer or the distros layer. 853 layer or the distros layer.
854 </para> 854 </para>
855 <para> 855 <para>
856 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the 856 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
857 <filename>conf/local.conf</filename> file, which is found in the 857 <filename>conf/local.conf</filename> file, which is found in the
858 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, to 858 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
859 point to your custom <filename>fs-perms.txt</filename>. 859 point to your custom <filename>fs-perms.txt</filename>.
860 You can specify more than a single file permissions setting table. 860 You can specify more than a single file permissions setting table.
861 The paths you specify to these files must be defined within the 861 The paths you specify to these files must be defined within the
@@ -1200,20 +1200,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1200 Values for this variable are set in the kernel's recipe file and the kernel's 1200 Values for this variable are set in the kernel's recipe file and the kernel's
1201 append file. 1201 append file.
1202 For example, if you are using the Yocto Project kernel that is based on the 1202 For example, if you are using the Yocto Project kernel that is based on the
1203 Linux 3.2 kernel, the kernel recipe file is the 1203 Linux 3.4 kernel, the kernel recipe file is the
1204 <filename>meta/recipes-kernel/linux/linux-yocto_3.2.bb</filename> file. 1204 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
1205 Following is the default value for <filename>KBRANCH</filename> and the five overrides 1205 Following is the default value for <filename>KBRANCH</filename> and the default
1206 for the architectures the Yocto Project supports: 1206 override for the architectures the Yocto Project supports:
1207 <literallayout class='monospaced'> 1207 <literallayout class='monospaced'>
1208 KBRANCH = "standard/default/base" 1208 KBRANCH_DEFAULT = "standard/base"
1209 KBRANCH_qemux86 = "standard/default/common-pc/base" 1209 KBRANCH = "${KBRANCH_DEFAULT}"
1210 KBRANCH_qemux86-64 = "standard/default/common-pc-64/base"
1211 KBRANCH_qemuppc = "standard/default/qemu-ppc32"
1212 KBRANCH_qemumips = "standard/default/mti-malta32-be"
1213 KBRANCH_qemuarm = "standard/default/arm-versatile-926ejs"
1214 </literallayout> 1210 </literallayout>
1215 Each of the above branches exist in the <filename>linux-yocto-3.2</filename> kernel Git 1211 This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
1216 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.2/refs/heads'></ulink>. 1212 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
1217 </para> 1213 </para>
1218 1214
1219 <para> 1215 <para>
@@ -1222,16 +1218,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1222 The kernel's append file is located in the BSP layer for a given machine. 1218 The kernel's append file is located in the BSP layer for a given machine.
1223 For example, the kernel append file for the Crown Bay BSP is in the 1219 For example, the kernel append file for the Crown Bay BSP is in the
1224 <filename>meta-intel</filename> Git repository and is named 1220 <filename>meta-intel</filename> Git repository and is named
1225 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend</filename>. 1221 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>.
1226 Here are the related statements from the append file: 1222 Here are the related statements from the append file:
1227 <literallayout class='monospaced'> 1223 <literallayout class='monospaced'>
1228 COMPATIBLE_MACHINE_crownbay = "crownbay" 1224 COMPATIBLE_MACHINE_crownbay = "crownbay"
1229 KMACHINE_crownbay = "crownbay" 1225 KMACHINE_crownbay = "crownbay"
1230 KBRANCH_crownbay = "standard/default/crownbay" 1226 KBRANCH_crownbay = "standard/crownbay"
1231 1227
1232 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" 1228 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
1233 KMACHINE_crownbay-noemgd = "crownbay" 1229 KMACHINE_crownbay-noemgd = "crownbay"
1234 KBRANCH_crownbay-noemgd = "standard/default/crownbay" 1230 KBRANCH_crownbay-noemgd = "standard/crownbay"
1235 </literallayout> 1231 </literallayout>
1236 The <filename>KBRANCH_*</filename> statements identify the kernel branch to 1232 The <filename>KBRANCH_*</filename> statements identify the kernel branch to
1237 use when building for the Crown Bay BSP. 1233 use when building for the Crown Bay BSP.
@@ -1294,10 +1290,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1294 1290
1295 <para> 1291 <para>
1296 Kernel machine names are initially defined in the 1292 Kernel machine names are initially defined in the
1297 <ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink> in 1293 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Yocto Linux Kernel</ulink> in
1294 the <filename>meta</filename> branch.
1295 From the <filename>meta</filename> branch, look in
1298 the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file. 1296 the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file.
1299 For example, in the <filename>linux-yocto-3.4</filename> kernel in the 1297 For example, from the <filename>meta</filename> branch in the
1300 <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file, 1298 <filename>linux-yocto-3.0</filename> kernel, the
1299 <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file
1301 has the following: 1300 has the following:
1302 <literallayout class='monospaced'> 1301 <literallayout class='monospaced'>
1303 define KMACHINE cedartrail 1302 define KMACHINE cedartrail
@@ -1307,7 +1306,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1307 include ktypes/standard 1306 include ktypes/standard
1308 branch cedartrail 1307 branch cedartrail
1309 1308
1310 include cedartrail.scc 1309 include cedartrail.scc
1311 </literallayout> 1310 </literallayout>
1312 You can see that the kernel understands the machine name for the Cedar Trail BSP as 1311 You can see that the kernel understands the machine name for the Cedar Trail BSP as
1313 <filename>cedartrail</filename>. 1312 <filename>cedartrail</filename>.
@@ -1795,7 +1794,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1795 <glossdef> 1794 <glossdef>
1796 <para>This variable, which is set in the <filename>local.conf</filename> configuration 1795 <para>This variable, which is set in the <filename>local.conf</filename> configuration
1797 file found in the <filename>conf</filename> folder of the 1796 file found in the <filename>conf</filename> folder of the
1798 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, 1797 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
1799 specifies the package manager to use when packaging data. 1798 specifies the package manager to use when packaging data.
1800 You can provide one or more arguments for the variable with the first 1799 You can provide one or more arguments for the variable with the first
1801 argument being the package manager used to create images: 1800 argument being the package manager used to create images:
@@ -2134,7 +2133,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2134 <glossentry id='var-S'><glossterm>S</glossterm> 2133 <glossentry id='var-S'><glossterm>S</glossterm>
2135 <glossdef> 2134 <glossdef>
2136 <para> 2135 <para>
2137 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2136 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2138 where unpacked package source code resides. 2137 where unpacked package source code resides.
2139 This location is within the working directory 2138 This location is within the working directory
2140 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which 2139 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which
@@ -2147,9 +2146,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2147 ${WORKDIR}/${PN}-${PV} 2146 ${WORKDIR}/${PN}-${PV}
2148 </literallayout> 2147 </literallayout>
2149 As an example, assume a 2148 As an example, assume a
2150 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level 2149 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
2151 folder named <filename>poky</filename> 2150 folder named <filename>poky</filename>
2152 and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2151 and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2153 at <filename>poky/build</filename>. 2152 at <filename>poky/build</filename>.
2154 In this case, the working directory the build system uses to build 2153 In this case, the working directory the build system uses to build
2155 the <filename>db</filename> package is the following: 2154 the <filename>db</filename> package is the following:
@@ -2578,7 +2577,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2578 the upstream GCC or CodeSourcery Labs toolchain. 2577 the upstream GCC or CodeSourcery Labs toolchain.
2579 The variable identifies the <filename>tcmode-*</filename> files used in 2578 The variable identifies the <filename>tcmode-*</filename> files used in
2580 the <filename>meta/conf/distro/include</filename> directory, which is found in the 2579 the <filename>meta/conf/distro/include</filename> directory, which is found in the
2581 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 2580 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
2582 </para> 2581 </para>
2583 <para> 2582 <para>
2584 By default, <filename>TCMODE</filename> is set to "default", which 2583 By default, <filename>TCMODE</filename> is set to "default", which
@@ -2598,14 +2597,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2598 uses when it does its work building images. 2597 uses when it does its work building images.
2599 By default, the <filename>TMPDIR</filename> variable is named 2598 By default, the <filename>TMPDIR</filename> variable is named
2600 <filename>tmp</filename> within the 2599 <filename>tmp</filename> within the
2601 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 2600 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
2602 </para> 2601 </para>
2603 2602
2604 <para> 2603 <para>
2605 If you want to establish this directory in a location other than the 2604 If you want to establish this directory in a location other than the
2606 default, you can uncomment the following statement in the 2605 default, you can uncomment the following statement in the
2607 <filename>conf/local.conf</filename> file in the 2606 <filename>conf/local.conf</filename> file in the
2608 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: 2607 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
2609 <literallayout class='monospaced'> 2608 <literallayout class='monospaced'>
2610 #TMPDIR = "${TOPDIR}/tmp" 2609 #TMPDIR = "${TOPDIR}/tmp"
2611 </literallayout> 2610 </literallayout>
@@ -2617,9 +2616,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2617 <glossdef> 2616 <glossdef>
2618 <para> 2617 <para>
2619 This variable is the 2618 This variable is the
2620 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 2619 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
2621 BitBake automatically sets this variable. 2620 BitBake automatically sets this variable.
2622 The OpenEmbedded build system uses the build directory when building images. 2621 The OpenEmbedded build system uses the Build Directory when building images.
2623 </para> 2622 </para>
2624 </glossdef> 2623 </glossdef>
2625 </glossentry> 2624 </glossentry>
@@ -2664,9 +2663,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2664 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 2663 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
2665 </literallayout> 2664 </literallayout>
2666 As an example, assume a 2665 As an example, assume a
2667 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level 2666 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
2668 folder name <filename>poky</filename> and a default 2667 folder name <filename>poky</filename> and a default
2669 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 2668 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
2670 at <filename>poky/build</filename>. 2669 at <filename>poky/build</filename>.
2671 In this case, the working directory the build system uses to build 2670 In this case, the working directory the build system uses to build
2672 the <filename>v86d</filename> package is the following: 2671 the <filename>v86d</filename> package is the following:
@@ -2681,8 +2680,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2681 <literallayout class='monospaced'> 2680 <literallayout class='monospaced'>
2682 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 2681 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
2683 </literallayout> 2682 </literallayout>
2684 As an example, again assume a source directory top-level folder 2683 As an example, again assume a Source Directory top-level folder
2685 named <filename>poky</filename> and a default build directory 2684 named <filename>poky</filename> and a default Build Directory
2686 at <filename>poky/build</filename>. 2685 at <filename>poky/build</filename>.
2687 In this case, the working directory the build system uses to build 2686 In this case, the working directory the build system uses to build
2688 the <filename>acl</filename> recipe, which is being built for a 2687 the <filename>acl</filename> recipe, which is being built for a
diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml
index 2e30df1604..654d9252a9 100644
--- a/documentation/poky-ref-manual/technical-details.xml
+++ b/documentation/poky-ref-manual/technical-details.xml
@@ -129,7 +129,7 @@
129 between metadata files. 129 between metadata files.
130 An example is the Autotools class, which contains 130 An example is the Autotools class, which contains
131 common settings for any application that Autotools uses. 131 common settings for any application that Autotools uses.
132 The "<link linkend='ref-classes'>Reference: Classes</link>" chapter provides details 132 The "<link linkend='ref-classes'>Classes</link>" chapter provides details
133 about common classes and how to use them. 133 about common classes and how to use them.
134 </para> 134 </para>
135 </section> 135 </section>
@@ -143,7 +143,7 @@
143 These files fall into several areas that define machine configuration options, 143 These files fall into several areas that define machine configuration options,
144 distribution configuration options, compiler tuning options, general common configuration 144 distribution configuration options, compiler tuning options, general common configuration
145 options and user configuration options (<filename>local.conf</filename>, which is found 145 options and user configuration options (<filename>local.conf</filename>, which is found
146 in the <ulink url='build-directory'>build directory</ulink>). 146 in the <ulink url='build-directory'>Build Directory</ulink>).
147 </para> 147 </para>
148 </section> 148 </section>
149</section> 149</section>
@@ -304,7 +304,7 @@
304 Information based on direct inputs is referred to as the "basehash" in the 304 Information based on direct inputs is referred to as the "basehash" in the
305 code. 305 code.
306 However, there is still the question of a task's indirect inputs - the 306 However, there is still the question of a task's indirect inputs - the
307 things that were already built and present in the build directory. 307 things that were already built and present in the Build Directory.
308 The checksum (or signature) for a particular task needs to add the hashes 308 The checksum (or signature) for a particular task needs to add the hashes
309 of all the tasks on which the particular task depends. 309 of all the tasks on which the particular task depends.
310 Choosing which dependencies to add is a policy decision. 310 Choosing which dependencies to add is a policy decision.
@@ -650,7 +650,7 @@
650 Yocto Project, you can follow these steps to use the x32 spABI: 650 Yocto Project, you can follow these steps to use the x32 spABI:
651 <itemizedlist> 651 <itemizedlist>
652 <listitem><para>Add the <filename>experimental/meta-x32</filename> layer to your local 652 <listitem><para>Add the <filename>experimental/meta-x32</filename> layer to your local
653 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 653 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
654 You can find the <filename>experimental/meta-x32</filename> source repository at 654 You can find the <filename>experimental/meta-x32</filename> source repository at
655 <ulink url='&YOCTO_GIT_URL;'></ulink>.</para></listitem> 655 <ulink url='&YOCTO_GIT_URL;'></ulink>.</para></listitem>
656 <listitem><para>Edit your <filename>conf/bblayers.conf</filename> file so that it includes 656 <listitem><para>Edit your <filename>conf/bblayers.conf</filename> file so that it includes
@@ -698,6 +698,13 @@
698 which by default are disabled. 698 which by default are disabled.
699 </para> 699 </para>
700 700
701 <para>
702 For information that can help you maintain compliance with various open
703 source licensing during the lifecycle of the product, see the
704 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Project's Lifecycle</ulink>" section
705 in the Yocto Project Development Manual.
706 </para>
707
701 <section id="usingpoky-configuring-LIC_FILES_CHKSUM"> 708 <section id="usingpoky-configuring-LIC_FILES_CHKSUM">
702 <title>Tracking License Changes</title> 709 <title>Tracking License Changes</title>
703 710
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 18bd8b7eb0..4ae6545479 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -30,20 +30,20 @@
30 The first thing you need to do is set up the OpenEmbedded build environment by sourcing 30 The first thing you need to do is set up the OpenEmbedded build environment by sourcing
31 the environment setup script as follows: 31 the environment setup script as follows:
32 <literallayout class='monospaced'> 32 <literallayout class='monospaced'>
33 $ source oe-init-build-env [build_dir] 33 $ source &OE_INIT_FILE; [build_dir]
34 </literallayout> 34 </literallayout>
35 </para> 35 </para>
36 36
37 <para> 37 <para>
38 The <filename>build_dir</filename> is optional and specifies the directory the 38 The <filename>build_dir</filename> is optional and specifies the directory the
39 OpenEmbedded build system uses for the build - 39 OpenEmbedded build system uses for the build -
40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
41 If you do not specify a build directory it defaults to <filename>build</filename> 41 If you do not specify a Build Directory it defaults to <filename>build</filename>
42 in your current working directory. 42 in your current working directory.
43 A common practice is to use a different build directory for different targets. 43 A common practice is to use a different Build Directory for different targets.
44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> 44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
45 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target. 45 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.
46 See <link linkend="structure-core-script">oe-init-build-env</link> 46 See <link linkend="structure-core-script">&OE_INIT_FILE;</link>
47 for more information on this script. 47 for more information on this script.
48 </para> 48 </para>
49 49
@@ -58,7 +58,7 @@
58 The <filename>target</filename> is the name of the recipe you want to build. 58 The <filename>target</filename> is the name of the recipe you want to build.
59 Common targets are the images in <filename>meta/recipes-core/images</filename>, 59 Common targets are the images in <filename>meta/recipes-core/images</filename>,
60 <filename>/meta/recipes-sato/images</filename>, etc. all found in the 60 <filename>/meta/recipes-sato/images</filename>, etc. all found in the
61 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 61 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
62 Or, the target can be the name of a recipe for a specific piece of software such as 62 Or, the target can be the name of a recipe for a specific piece of software such as
63 <application>busybox</application>. 63 <application>busybox</application>.
64 For more details about the images the OpenEmbedded build system supports, see the 64 For more details about the images the OpenEmbedded build system supports, see the
@@ -91,7 +91,7 @@
91 <para> 91 <para>
92 Once an image has been built, it often needs to be installed. 92 Once an image has been built, it often needs to be installed.
93 The images and kernels built by the OpenEmbedded build system are placed in the 93 The images and kernels built by the OpenEmbedded build system are placed in the
94 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> in 94 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in
95 <filename class="directory">tmp/deploy/images</filename>. 95 <filename class="directory">tmp/deploy/images</filename>.
96 For information on how to run pre-built images such as <filename>qemux86</filename> 96 For information on how to run pre-built images such as <filename>qemux86</filename>
97 and <filename>qemuarm</filename>, see the 97 and <filename>qemuarm</filename>, see the
@@ -268,7 +268,7 @@
268 For guidance on how logging is handled in both Python and Bash recipes, see the 268 For guidance on how logging is handled in both Python and Bash recipes, see the
269 <filename>logging.bbclass</filename> file in the 269 <filename>logging.bbclass</filename> file in the
270 <filename>meta/classes</filename> folder of the 270 <filename>meta/classes</filename> folder of the
271 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 271 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
272 </para> 272 </para>
273 273
274 <section id='logging-with-python'> 274 <section id='logging-with-python'>