summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-17 15:15:24 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:19 +0000
commita713dade850b5b60d46ee78bd9092815892bc6d2 (patch)
tree7d64196b4b1afdad591b2b0da3095adb291d90c4
parent5b60a81c9510b5c2198ade0ada6878ec9dbeaa65 (diff)
downloadpoky-a713dade850b5b60d46ee78bd9092815892bc6d2.tar.gz
bitbake: user-manual-intro: Various minor cleanups/improvements
(Bitbake rev: 5e22c0c5d4bb9e63142a13618f5f87e53c83d9f2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml43
1 files changed, 20 insertions, 23 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index 2ab049eacd..4050e432dc 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -53,7 +53,7 @@
53 an aspiring embedded Linux distribution. 53 an aspiring embedded Linux distribution.
54 All of the build systems used by traditional desktop Linux 54 All of the build systems used by traditional desktop Linux
55 distributions lacked important functionality, and none of the 55 distributions lacked important functionality, and none of the
56 ad-hoc <emphasis>buildroot</emphasis> systems, prevalent in the 56 ad-hoc buildroot systems, prevalent in the
57 embedded space, were scalable or maintainable. 57 embedded space, were scalable or maintainable.
58 </para> 58 </para>
59 59
@@ -109,9 +109,6 @@
109 common metadata between many packages. 109 common metadata between many packages.
110 </para></listitem> 110 </para></listitem>
111 </itemizedlist> 111 </itemizedlist>
112 </para>
113
114 <para>
115 Over time it has become apparent that some further requirements 112 Over time it has become apparent that some further requirements
116 were necessary: 113 were necessary:
117 <itemizedlist> 114 <itemizedlist>
@@ -129,9 +126,6 @@
129 with prebuilt components. 126 with prebuilt components.
130 </para></listitem> 127 </para></listitem>
131 </itemizedlist> 128 </itemizedlist>
132 </para>
133
134 <para>
135 BitBake satisfies all the original requirements and many more 129 BitBake satisfies all the original requirements and many more
136 with extensions being made to the basic functionality to 130 with extensions being made to the basic functionality to
137 reflect the additional requirements. 131 reflect the additional requirements.
@@ -166,21 +160,22 @@
166 A BitBake Recipe, denoted by the file extension 160 A BitBake Recipe, denoted by the file extension
167 <filename>.bb</filename> is the most 161 <filename>.bb</filename> is the most
168 basic metadata file. 162 basic metadata file.
169 It tells BitBake the following: 163 These recipe files tell BitBake the following:
170 <itemizedlist> 164 <itemizedlist>
171 <listitem><para>descriptive information about the package</para></listitem> 165 <listitem><para>Descriptive information about the package</para></listitem>
172 <listitem><para>the version of the recipe</para></listitem> 166 <listitem><para>The version of the recipe</para></listitem>
173 <listitem><para>when dependencies exist</para></listitem> 167 <listitem><para>When dependencies exist</para></listitem>
174 <listitem><para>where the source code resides</para></listitem> 168 <listitem><para>Where the source code resides</para></listitem>
175 <listitem><para>whether the source code requires any patches</para></listitem> 169 <listitem><para>Whether the source code requires any patches</para></listitem>
176 <listitem><para>how to compile the source code</para></listitem> 170 <listitem><para>How to compile the source code</para></listitem>
177 <listitem><para>where on the target machine to install the package being compiled</para></listitem> 171 <listitem><para>Where on the target machine to install the package being compiled</para></listitem>
178 </itemizedlist> 172 </itemizedlist>
179 </para> 173 </para>
180 174
181 <para> 175 <para>
182 Within the context of BitBake, or any project utilizing BitBake 176 Within the context of BitBake, or any project utilizing BitBake
183 as it's build system, files with the .bb extension are referred 177 as it's build system, files with the <filename>.bb</filename>
178 extension are referred
184 to as recipes. 179 to as recipes.
185 The term "package" is also commonly used to describe recipes. 180 The term "package" is also commonly used to describe recipes.
186 However, since the same word is used to describe packaged 181 However, since the same word is used to describe packaged
@@ -201,8 +196,10 @@
201 machine configuration options, distribution configuration 196 machine configuration options, distribution configuration
202 options, compiler tuning options, general common 197 options, compiler tuning options, general common
203 configuration options and user configuration options. 198 configuration options and user configuration options.
204 The main configuration file is the sample bitbake.conf file, 199 The main configuration file is the sample
205 located within the bitbake source tree /conf directory. 200 <filename>bitbake.conf</filename> file,
201 located within the bitbake source tree
202 <filename>/conf</filename> directory.
206 </para> 203 </para>
207 </section> 204 </section>
208 205
@@ -214,11 +211,11 @@
214 <filename>.bbclass</filename> extension contain 211 <filename>.bbclass</filename> extension contain
215 information that is useful to share between metadata files. 212 information that is useful to share between metadata files.
216 The BitBake source tree comes with one class metadata file 213 The BitBake source tree comes with one class metadata file
217 currently, called base.bbclass and it is found in the /classes 214 currently, called <filename>base.bbclass</filename> and it is
218 directory. 215 found in the <filename>/classes</filename> directory.
219 The base.bbclass is special in that any new classes that a 216 The <filename>base.bbclass</filename> is special in that any
220 developer adds to a project is required to inherit it 217 new classes that a developer adds to a project is required to
221 automatically. 218 inherit it automatically.
222 This class contains definitions for standard basic tasks such 219 This class contains definitions for standard basic tasks such
223 as fetching, unpacking, configuring (empty by default), 220 as fetching, unpacking, configuring (empty by default),
224 compiling (runs any Makefile present), installing (empty by 221 compiling (runs any Makefile present), installing (empty by