summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-17 14:58:20 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:18 +0000
commit2ee774782c4a19f13999554a194cddb89462620b (patch)
tree665685b250e99b317a69056f4644449b3ab6a818 /bitbake/doc
parent7c98419b09696c487cfa0e25b7d6be0df64c6d3d (diff)
downloadpoky-2ee774782c4a19f13999554a194cddb89462620b.tar.gz
bitbake: user-manual-intro: Expand introduction and fix spelling mistakes
Expand the introduction section, fill out the section ids and fix some spelling mistakes. Wording from Bill Traynor/Scott Rifenbark (Bitbake rev: 780f61da6a59c52555de8574093a264d565b2a75) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml59
1 files changed, 45 insertions, 14 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index 824dee64eb..c76696f5d5 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -1,27 +1,59 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <chapter> 3 <chapter id="user-manual-intro">
4 <title>BitBake User Manual</title>
5
6 <section id="intro">
4 <title>Introduction</title> 7 <title>Introduction</title>
5 <section> 8 <para>
6 <title>Overview</title> 9 BitBake is a tool for executing tasks commonly performed by software
7 <para>BitBake is, at its simplest, a tool for executing 10 developers when building systems on a daily basis.
8tasks and managing metadata. As such, its similarities to GNU make and other 11 BitBake can build Systems consisting of numerous individual pieces
9build tools are readily apparent. It was inspired by Portage, the package management system used by the Gentoo Linux distribution. BitBake is the basis of the <ulink url="http://www.openembedded.org/">OpenEmbedded</ulink> project, which is being used to build and maintain a number of embedded Linux distributions/projects such as Angstrom and the Yocto project.</para> 12 of software, or can be used to build a single application.
10 </section> 13 Example tasks that BitBake can execute are fetching source code,
11 <section> 14 applying patches to source code, configuring, compiling, and
12 <title>Background and goals</title> 15 packaging applications into a complete system, and managing metadata.
16 BitBake abstracts the information for completing individual tasks
17 into files known as recipes.
18 Recipes contain all of the relevant information required by BitBake
19 to complete a given task including dependencies, source file
20 locations, etc.
21 BitBake is similar to
22 <ulink url='http://www.gnu.org/software/make/'>GNU Make</ulink>
23 and other build tools.
24 </para>
25 </section>
26 <section id="history-and-goals">
27 <title>History and Goals</title>
28 <para>
29 BitBake was originally a part of the OpenEmbedded project.
30 It was inspired by the Portage package management system
31 used by the Gentoo Linux distribution.
32 On December 7, 2004, OpenEmbedded project team member,
33 Chris Larson split the project into two distinct pieces:
34 <itemizedlist>
35 <listitem><para>BitBake, a generic task executor</para></listitem>
36 <listitem><para>OpenEmbedded, a metadata set utilized by
37 BitBake.</para></listitem>
38 </itemizedlist>
39 Today, BitBake is the primary basis of the
40 <ulink url="http://www.openembedded.org/">OpenEmbedded</ulink>
41 project, which is being used to build and maintain a
42 number of projects and embedded Linux distributions
43 such as the Angstrom Distribution and the Yocto
44 Project.
45 </para>
13 <para>Prior to BitBake, no other build tool adequately met 46 <para>Prior to BitBake, no other build tool adequately met
14the needs of an aspiring embedded Linux distribution. All of the 47the needs of an aspiring embedded Linux distribution. All of the
15buildsystems used by traditional desktop Linux distributions lacked 48buildsystems used by traditional desktop Linux distributions lacked
16important functionality, and none of the ad-hoc 49important functionality, and none of the ad-hoc
17<emphasis>buildroot</emphasis> systems, prevalent in the 50<emphasis>buildroot</emphasis> systems, prevalent in the
18embedded space, were scalable or maintainable.</para> 51embedded space, were scalable or maintainable.</para>
19
20 <para>Some important original goals for BitBake were: 52 <para>Some important original goals for BitBake were:
21 <itemizedlist> 53 <itemizedlist>
22 <listitem><para>Handle crosscompilation.</para></listitem> 54 <listitem><para>Handle crosscompilation.</para></listitem>
23 <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem> 55 <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem>
24 <listitem><para>Support running any number of tasks within a given package, including, but not limited to, fetching upstream sources, unpacking them, patching them, configuring them, et cetera.</para></listitem> 56 <listitem><para>Support running any number of tasks within a given package, including, but not limited to, fetching upstream sources, unpacking them, patching them, configuring them, etc.</para></listitem>
25 <listitem><para>Must be Linux distribution agnostic (both build and target).</para></listitem> 57 <listitem><para>Must be Linux distribution agnostic (both build and target).</para></listitem>
26 <listitem><para>Must be architecture agnostic</para></listitem> 58 <listitem><para>Must be architecture agnostic</para></listitem>
27 <listitem><para>Must support multiple build and target operating systems (including Cygwin, the BSDs, etc).</para></listitem> 59 <listitem><para>Must support multiple build and target operating systems (including Cygwin, the BSDs, etc).</para></listitem>
@@ -39,12 +71,11 @@ share common metadata between many packages.</para></listitem>
39 <itemizedlist> 71 <itemizedlist>
40 <listitem><para>Handle variants of a base recipe (native, sdk, multilib).</para></listitem> 72 <listitem><para>Handle variants of a base recipe (native, sdk, multilib).</para></listitem>
41 <listitem><para>Able to split metadata into layers and allow layers to override each other.</para></listitem> 73 <listitem><para>Able to split metadata into layers and allow layers to override each other.</para></listitem>
42 <listitem><para>Allow representation of a given set of input variables to a task as a checksum.</para></listitem> 74 <listitem><para>Allow representation of a given set of input variables to a task as a checksum. Based on that checksum, allow acceleration of builds with prebuilt components.</para></listitem>
43 <listitem><para>based on that checksum, allow acceleration of builds with prebuilt components.</para></listitem>
44 </itemizedlist> 75 </itemizedlist>
45 </para> 76 </para>
46 77
47 <para>BitBake satisfies all the original requirements and many more with extensions being made to the basic functionality to reflect the additionl requirements. Flexibility and power have always been the priorities. It is highly extensible, supporting embedded Python code and execution of any arbitrary tasks.</para> 78 <para>BitBake satisfies all the original requirements and many more with extensions being made to the basic functionality to reflect the additional requirements. Flexibility and power have always been the priorities. It is highly extensible, supporting embedded Python code and execution of any arbitrary tasks.</para>
48 </section> 79 </section>
49 </chapter> 80 </chapter>
50 81