diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index 05a3fc8989..c1a9aed3a5 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -19,7 +19,7 @@
Introduction
- fundamentally, BitBake is a generic task execution
+ Fundamentally, BitBake is a generic task execution
engine that allows shell and Python tasks to be run
efficiently and in parallel while working within
complex inter-task dependency constraints.
@@ -78,10 +78,9 @@
Today, BitBake is the primary basis of the
OpenEmbedded
- project, which is being used to build and maintain a
- number of projects and embedded Linux distributions
- such as the Angstrom Distribution and the Yocto
- Project.
+ project, which is being used to build and maintain Linux
+ distributions such as the Angstrom Distribution and which is used
+ as the build tool for Linux projects such as the Yocto Project.
@@ -202,11 +201,11 @@
BitBake Recipes, which are denoted by the file extension
.bb, are the most basic metadata files.
- These recipe files provide BitBake the following:
+ These recipe files provide BitBake with the following:
Descriptive information about the package
The version of the recipe
- When dependencies exist
+ Existing Dependencies
Where the source code resides
Whether the source code requires any patches
How to compile the source code
@@ -228,31 +227,6 @@
-
- Append Files
-
-
- Append files, which are files that have the
- .bbappend file extension, add or
- extend build information to an existing
- recipe file.
-
-
-
- BitBake expects every append file to have a corresponding recipe file.
- Furthermore, the append file and corresponding recipe file
- must use the same root filename.
- The filenames can differ only in the file type suffix used
- (e.g. formfactor_0.0.bb and
- formfactor_0.0.bbappend).
-
-
-
- Information in append files overrides the information in the
- similarly-named recipe file.
-
-
-
Configuration Files
@@ -283,9 +257,9 @@
called base.bbclass.
You can find this file in the
classes directory.
- The base.bbclass is special in that any
- new classes that a developer adds to a project are required to
- inherit base.bbclass automatically.
+ The base.bbclass is special since it
+ is always included automatically for all recipes
+ and classes.
This class contains definitions for standard basic tasks such
as fetching, unpacking, configuring (empty by default),
compiling (runs any Makefile present), installing (empty by
@@ -324,6 +298,31 @@
(.bbappend) file.
+
+
+ Append Files
+
+
+ Append files, which are files that have the
+ .bbappend file extension, add or
+ extend build information to an existing
+ recipe file.
+
+
+
+ BitBake expects every append file to have a corresponding recipe file.
+ Furthermore, the append file and corresponding recipe file
+ must use the same root filename.
+ The filenames can differ only in the file type suffix used
+ (e.g. formfactor_0.0.bb and
+ formfactor_0.0.bbappend).
+
+
+
+ Information in append files overrides the information in the
+ similarly-named recipe file.
+
+
@@ -332,35 +331,22 @@
You can obtain BitBake several different ways:
- Installation using your Distribution
- Package Management System:
- This method is not
- recommended because the BitBake version, in most
- cases provided by your distribution, is several
- releases behind a snapshot of the BitBake repository.
-
- Taking a snapshot of BitBake:
- Downloading a snapshot of BitBake from the
- source code repository is the recommended method
- as you are assured of having the most recent stable
- BitBake release.
- The following example downloads a snapshot of
- BitBake version 1.17.0:
-
- $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz
- $ tar zxpvf bitbake-1.17.0.tar.gz
-
- After extraction of the tarball using the tar utility,
- you have a directory entitled
- bitbake-1.17.0.
-
Cloning BitBake:
Using Git to clone the BitBake source code repository
- is also a recommended method when you need the absolute latest
- BitBake source.
- Realize that using this method could expose you to areas of
- BitBake that are under development.
- Here is an example:
+ is the recommended method for obtaining BitBake.
+ Cloning the repository makes it easy to get bug fixes
+ and have access to stable branches and the master
+ branch.
+ Once you have cloned BitBake, you should use
+ the latest stable
+ branch for development since the master branch is for
+ BitBake development and might contain less stable changes.
+
+ You usually need a version of BitBake
+ that matches the metadata you are using.
+ The metadata is generally backwards compatible but
+ not forward compatible.
+ Here is an example that clones the BitBake repository:
$ git clone git://git.openembedded.org/bitbake
@@ -376,6 +362,28 @@
$ git clone git://git.openembedded.org/bitbake bbdev
+ Installation using your Distribution
+ Package Management System:
+ This method is not
+ recommended because the BitBake version that is
+ provided by your distribution, in most cases,
+ is several
+ releases behind a snapshot of the BitBake repository.
+
+ Taking a snapshot of BitBake:
+ Downloading a snapshot of BitBake from the
+ source code repository gives you access to a known
+ branch or release of BitBake.
+ The following example downloads a snapshot of
+ BitBake version 1.17.0:
+
+ $ wget http://git.openembedded.org/bitbake/snapshot/bitbake-1.17.0.tar.gz
+ $ tar zxpvf bitbake-1.17.0.tar.gz
+
+ After extraction of the tarball using the tar utility,
+ you have a directory entitled
+ bitbake-1.17.0.
+