summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-07-13 11:28:34 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-07-17 10:54:09 +0100
commit402383637b9a20614bc56221f86ff5b9013519d2 (patch)
tree9cf339114663f68d3927b9c51706d17680724971 /documentation
parent30f491637c9e4d366eef6cfe2e7e3966d02f3bd7 (diff)
downloadpoky-402383637b9a20614bc56221f86ff5b9013519d2.tar.gz
documentation/poky-ref-manual: Fixed various references to YP
I did a scrub for "Yocto Project" and found some that could be changed. (From yocto-docs rev: 985062b6a9320e8a3ca3d3dafb6516db4fbc5bd5) 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.xml3
-rw-r--r--documentation/poky-ref-manual/introduction.xml21
-rw-r--r--documentation/poky-ref-manual/ref-bitbake.xml4
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml17
-rw-r--r--documentation/poky-ref-manual/resources.xml2
-rw-r--r--documentation/poky-ref-manual/technical-details.xml22
-rw-r--r--documentation/poky-ref-manual/usingpoky.xml9
7 files changed, 39 insertions, 39 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index 9628fcbd15..f7e67a6545 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -45,8 +45,7 @@
45 </para> 45 </para>
46 46
47 <para> 47 <para>
48 This command opens a terminal with a shell prompt within the Yocto Project 48 This command opens a terminal with a shell prompt within the OpenEmbedded build environment.
49 environment.
50 The following occurs: 49 The following occurs:
51 <itemizedlist> 50 <itemizedlist>
52 <listitem><para>The <filename>PATH</filename> variable includes the 51 <listitem><para>The <filename>PATH</filename> variable includes the
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index 249b9a18fd..ac28eaef4e 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -51,13 +51,11 @@
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 54 This appendix describes the
55 Yocto Project files, referred to as the 55 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> created
56 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 56 either by unpacking a released Yocto Project tarball on your host development system,
57 The source directory represents the local file structure created 57 or by cloning the upstream
58 as a result from either cloning the upstream 58 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
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.
61 </para></listitem> 59 </para></listitem>
62 <listitem><para><emphasis> 60 <listitem><para><emphasis>
63 <link linkend='ref-bitbake'>Reference: BitBake</link>:</emphasis> 61 <link linkend='ref-bitbake'>Reference: BitBake</link>:</emphasis>
@@ -76,7 +74,8 @@
76 features during the build process using the OpenEmbedded build system.</para></listitem> 74 features during the build process using the OpenEmbedded build system.</para></listitem>
77 <listitem><para><emphasis> 75 <listitem><para><emphasis>
78 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis> 76 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis>
79 This appendix presents most Yocto Project variables. 77 This appendix presents most variables used by the OpenEmbedded build system, which
78 using BitBake.
80 Entries describe the function of the variable and how to apply them. 79 Entries describe the function of the variable and how to apply them.
81 </para></listitem> 80 </para></listitem>
82 <listitem><para><emphasis> 81 <listitem><para><emphasis>
@@ -128,9 +127,9 @@
128<section id='intro-getit-dev'> 127<section id='intro-getit-dev'>
129 <title>Development Checkouts</title> 128 <title>Development Checkouts</title>
130 <para> 129 <para>
131 Development using the Yocto Project requires a local copy of the Yocto Project files 130 Development using the Yocto Project requires a local
132 referred to as the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 131 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
133 You can set source directory up by downloading a Yocto Project release tarball and unpacking it, 132 You can set up the source directory by downloading a Yocto Project release tarball and unpacking it,
134 or by cloning a copy of the upstream 133 or by cloning a copy of the upstream
135 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. 134 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
136 For information on both these methods, see the 135 For information on both these methods, see the
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml
index 81a8934e6a..8e5d4158b2 100644
--- a/documentation/poky-ref-manual/ref-bitbake.xml
+++ b/documentation/poky-ref-manual/ref-bitbake.xml
@@ -7,8 +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 used by the Yocto Project. 10 BitBake is a program written in Python that interprets the metadata used by the OpenEmbedded
11 The OpenEmbedded build system uses BitBake. 11 build system.
12 At some point, developers wonder what actually happens when you enter: 12 At some point, developers wonder what actually happens when you enter:
13 <literallayout class='monospaced'> 13 <literallayout class='monospaced'>
14 $ bitbake core-image-sato 14 $ bitbake core-image-sato
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml
index 3e6a6a2b6a..9d3c358296 100644
--- a/documentation/poky-ref-manual/ref-structure.xml
+++ b/documentation/poky-ref-manual/ref-structure.xml
@@ -7,10 +7,10 @@
7<title>Reference: Directory Structure</title> 7<title>Reference: Directory Structure</title>
8 8
9<para> 9<para>
10 The Yocto Project consists of several components. 10 The <ulink 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 appendix describes the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> 12 This appendix describes the source directory and gives information about the various
13 and gives information about the various files and directories. 13 files and directories.
14</para> 14</para>
15 15
16<para> 16<para>
@@ -26,7 +26,8 @@
26 <title><filename>bitbake/</filename></title> 26 <title><filename>bitbake/</filename></title>
27 27
28 <para> 28 <para>
29 The Yocto Project includes a copy of BitBake for ease of use. 29 The <ulink url='source-directory'>source directory</ulink>
30 includes a copy of BitBake for ease of use.
30 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.
31 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
32 defined by that data. 33 defined by that data.
@@ -59,7 +60,7 @@
59 the source tree is combined with the output. 60 the source tree is combined with the output.
60 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 61 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
61 is created initially when you <filename>source</filename> 62 is created initially when you <filename>source</filename>
62 the Yocto Project environment setup script <filename>oe-init-build-env</filename>. 63 the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>.
63 </para> 64 </para>
64 65
65 <para> 66 <para>
@@ -90,7 +91,7 @@
90 <title><filename>meta/</filename></title> 91 <title><filename>meta/</filename></title>
91 92
92 <para> 93 <para>
93 This directory contains the Yocto Project core metadata. 94 This directory contains the OpenEmbedded Core metadata.
94 The directory holds machine definitions, the Yocto Project distribution, 95 The directory holds machine definitions, the Yocto Project distribution,
95 and the packages that make up a given system. 96 and the packages that make up a given system.
96 </para> 97 </para>
@@ -101,7 +102,7 @@
101 102
102 <para> 103 <para>
103 This directory contains recipes for applications and demos that are not part of the 104 This directory contains recipes for applications and demos that are not part of the
104 Yocto Project core. 105 OpenEmbedded core.
105 </para> 106 </para>
106 </section> 107 </section>
107 108
@@ -142,7 +143,7 @@
142 <title><filename>oe-init-build-env</filename></title> 143 <title><filename>oe-init-build-env</filename></title>
143 144
144 <para> 145 <para>
145 This script sets up the Yocto Project build environment. 146 This script sets up the OpenEmbedded build environment.
146 Running this script with the <filename>source</filename> command in 147 Running this script with the <filename>source</filename> command in
147 a shell makes changes to <filename>PATH</filename> and sets other core BitBake variables based on the 148 a shell makes changes to <filename>PATH</filename> and sets other core BitBake variables based on the
148 current working directory. 149 current working directory.
diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml
index 9fe5a65a6d..9e1ae69a0a 100644
--- a/documentation/poky-ref-manual/resources.xml
+++ b/documentation/poky-ref-manual/resources.xml
@@ -82,7 +82,7 @@
82 Yocto Project. 82 Yocto Project.
83 Poky derives from and contributes back to the OpenEmbedded project.</para></listitem> 83 Poky derives from and contributes back to the OpenEmbedded project.</para></listitem>
84 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'> 84 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
85 BitBake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem> 85 BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
86 <listitem><para><emphasis><ulink url='http://bitbake.berlios.de/manual/'> 86 <listitem><para><emphasis><ulink url='http://bitbake.berlios.de/manual/'>
87 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. 87 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool.
88 </para></listitem> 88 </para></listitem>
diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml
index 2c6f7c2b98..717015be5c 100644
--- a/documentation/poky-ref-manual/technical-details.xml
+++ b/documentation/poky-ref-manual/technical-details.xml
@@ -15,7 +15,7 @@
15 15
16 <para> 16 <para>
17 The BitBake task executor together with various types of configuration files form the 17 The BitBake task executor together with various types of configuration files form the
18 Yocto Project core. 18 OpenEmbedded Core.
19 This section overviews the BitBake task executor and the 19 This section overviews the BitBake task executor and the
20 configuration files by describing what they are used for and how they interact. 20 configuration files by describing what they are used for and how they interact.
21 </para> 21 </para>
@@ -55,7 +55,7 @@
55 <title>BitBake</title> 55 <title>BitBake</title>
56 56
57 <para> 57 <para>
58 BitBake is the tool at the heart of the Yocto Project and is responsible 58 BitBake is the tool at the heart of the OpenEmbedded build system and is responsible
59 for parsing the metadata, generating a list of tasks from it, 59 for parsing the metadata, generating a list of tasks from it,
60 and then executing those tasks. 60 and then executing those tasks.
61 To see a list of the options BitBake supports, use the following help command: 61 To see a list of the options BitBake supports, use the following help command:
@@ -115,8 +115,8 @@
115 115
116 <para> 116 <para>
117 The term "package" can also be used to describe recipes. 117 The term "package" can also be used to describe recipes.
118 However, since the same word is used for the packaged output from the Yocto 118 However, since the same word is used for the packaged output from the OpenEmbedded
119 Project (i.e. <filename>.ipk</filename> or <filename>.deb</filename> files), 119 build system (i.e. <filename>.ipk</filename> or <filename>.deb</filename> files),
120 this document avoids using the term "package" when referring to recipes. 120 this document avoids using the term "package" when referring to recipes.
121 </para> 121 </para>
122 </section> 122 </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 Yocto Project files build directory). 146 in the <ulink url='build-directory'>build directory</ulink>).
147 </para> 147 </para>
148 </section> 148 </section>
149</section> 149</section>
@@ -171,7 +171,7 @@
171 <para> 171 <para>
172 The Yocto Project implements shared state code that supports incremental builds. 172 The Yocto Project implements shared state code that supports incremental builds.
173 The implementation of the shared state code answers the following questions that 173 The implementation of the shared state code answers the following questions that
174 were fundamental roadblocks within the Yocto Project incremental build support system: 174 were fundamental roadblocks within the OpenEmbedded incremental build support system:
175 <itemizedlist> 175 <itemizedlist>
176 <listitem>What pieces of the system have changed and what pieces have not changed?</listitem> 176 <listitem>What pieces of the system have changed and what pieces have not changed?</listitem>
177 <listitem>How are changed pieces of software removed and replaced?</listitem> 177 <listitem>How are changed pieces of software removed and replaced?</listitem>
@@ -485,7 +485,7 @@
485 <title>Tips and Tricks</title> 485 <title>Tips and Tricks</title>
486 486
487 <para> 487 <para>
488 The code in the Yocto Project that supports incremental builds is not 488 The code in the build system that supports incremental builds is not
489 simple code. 489 simple code.
490 This section presents some tips and tricks that help you work around 490 This section presents some tips and tricks that help you work around
491 issues related to shared state code. 491 issues related to shared state code.
@@ -691,10 +691,10 @@
691 <title>Tracking License Changes</title> 691 <title>Tracking License Changes</title>
692 692
693 <para> 693 <para>
694 The license of an upstream project might change in the future. In order to prevent these changes 694 The license of an upstream project might change in the future.
695 going unnoticed, the Yocto Project provides a 695 In order to prevent these changes going unnoticed, the
696 <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename> 696 <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename>
697 variable to track changes to the license text. The checksums are validated at the end of the 697 variable tracks changes to the license text. The checksums are validated at the end of the
698 configure step, and if the checksums do not match, the build will fail. 698 configure step, and if the checksums do not match, the build will fail.
699 </para> 699 </para>
700 700
@@ -714,7 +714,7 @@
714 </para> 714 </para>
715 715
716 <para> 716 <para>
717 The Yocto Project uses the 717 The build system uses the
718 <filename><link linkend='var-S'>S</link></filename> variable as the 718 <filename><link linkend='var-S'>S</link></filename> variable as the
719 default directory used when searching files listed in 719 default directory used when searching files listed in
720 <filename>LIC_FILES_CHKSUM</filename>. 720 <filename>LIC_FILES_CHKSUM</filename>.
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 1dde656140..121650cd54 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -27,7 +27,7 @@
27 <title>Build Overview</title> 27 <title>Build Overview</title>
28 28
29 <para> 29 <para>
30 The first thing you need to do is set up the Yocto Project 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-build-env [build_dir]
@@ -35,8 +35,9 @@
35 </para> 35 </para>
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 the
39 uses for the build - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 39 OpenEmbedded build system uses for the build -
40 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> 41 If you do not specify a build directory it defaults to <filename>build</filename>
41 in your current working directory. 42 in your current working directory.
42 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.
@@ -47,7 +48,7 @@
47 </para> 48 </para>
48 49
49 <para> 50 <para>
50 Once the Yocto Project build environment is set up, you can build a target using: 51 Once the build environment is set up, you can build a target using:
51 <literallayout class='monospaced'> 52 <literallayout class='monospaced'>
52 $ bitbake &lt;target&gt; 53 $ bitbake &lt;target&gt;
53 </literallayout> 54 </literallayout>