sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

bitbake: user-manual-intro: Various minor cleanups/improvements 

(Bitbake rev: 5e22c0c5d4bb9e63142a13618f5f87e53c83d9f2)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Richard Purdie 2014-01-17 15:15:24 +00:00
parent 5b60a81c95
commit a713dade85
1 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
bitbake/doc/user-manual/user-manual-intro.xml
View File

@ -53,7 +53,7 @@
an aspiring embedded Linux distribution. an aspiring embedded Linux distribution.
All of the build systems used by traditional desktop Linux All of the build systems used by traditional desktop Linux
distributions lacked important functionality, and none of the distributions lacked important functionality, and none of the
ad-hoc <emphasis>buildroot</emphasis> systems, prevalent in the ad-hoc buildroot systems, prevalent in the
embedded space, were scalable or maintainable. embedded space, were scalable or maintainable.
</para> </para>
@ -109,9 +109,6 @@
common metadata between many packages. common metadata between many packages.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para>
<para>
Over time it has become apparent that some further requirements Over time it has become apparent that some further requirements
were necessary: were necessary:
<itemizedlist> <itemizedlist>
@ -129,9 +126,6 @@
with prebuilt components. with prebuilt components.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para>
<para>
BitBake satisfies all the original requirements and many more BitBake satisfies all the original requirements and many more
with extensions being made to the basic functionality to with extensions being made to the basic functionality to
reflect the additional requirements. reflect the additional requirements.
@ -166,21 +160,22 @@
A BitBake Recipe, denoted by the file extension A BitBake Recipe, denoted by the file extension
<filename>.bb</filename> is the most <filename>.bb</filename> is the most
basic metadata file. basic metadata file.
It tells BitBake the following: These recipe files tell BitBake the following:
<itemizedlist> <itemizedlist>
<listitem><para>descriptive information about the package</para></listitem> <listitem><para>Descriptive information about the package</para></listitem>
<listitem><para>the version of the recipe</para></listitem> <listitem><para>The version of the recipe</para></listitem>
<listitem><para>when dependencies exist</para></listitem> <listitem><para>When dependencies exist</para></listitem>
<listitem><para>where the source code resides</para></listitem> <listitem><para>Where the source code resides</para></listitem>
<listitem><para>whether the source code requires any patches</para></listitem> <listitem><para>Whether the source code requires any patches</para></listitem>
<listitem><para>how to compile the source code</para></listitem> <listitem><para>How to compile the source code</para></listitem>
<listitem><para>where on the target machine to install the package being compiled</para></listitem> <listitem><para>Where on the target machine to install the package being compiled</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
Within the context of BitBake, or any project utilizing BitBake Within the context of BitBake, or any project utilizing BitBake
as it's build system, files with the .bb extension are referred as it's build system, files with the <filename>.bb</filename>
extension are referred
to as recipes. to as recipes.
The term "package" is also commonly used to describe recipes. The term "package" is also commonly used to describe recipes.
However, since the same word is used to describe packaged However, since the same word is used to describe packaged
@ -201,8 +196,10 @@
machine configuration options, distribution configuration machine configuration options, distribution configuration
options, compiler tuning options, general common options, compiler tuning options, general common
configuration options and user configuration options. configuration options and user configuration options.
The main configuration file is the sample bitbake.conf file, The main configuration file is the sample
located within the bitbake source tree /conf directory. <filename>bitbake.conf</filename> file,
located within the bitbake source tree
<filename>/conf</filename> directory.
</para> </para>
</section> </section>
@ -214,11 +211,11 @@
<filename>.bbclass</filename> extension contain <filename>.bbclass</filename> extension contain
information that is useful to share between metadata files. information that is useful to share between metadata files.
The BitBake source tree comes with one class metadata file The BitBake source tree comes with one class metadata file
currently, called base.bbclass and it is found in the /classes currently, called <filename>base.bbclass</filename> and it is
directory. found in the <filename>/classes</filename> directory.
The base.bbclass is special in that any new classes that a The <filename>base.bbclass</filename> is special in that any
developer adds to a project is required to inherit it new classes that a developer adds to a project is required to
automatically. inherit it automatically.
This class contains definitions for standard basic tasks such This class contains definitions for standard basic tasks such
as fetching, unpacking, configuring (empty by default), as fetching, unpacking, configuring (empty by default),
compiling (runs any Makefile present), installing (empty by compiling (runs any Makefile present), installing (empty by