summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-17 15:00:48 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:18 +0000
commit2038b85a46643ea3083ec37e3538d3d817790eb7 (patch)
treecf01a814cd2f679f05427cab84f4fc08d5f9dd66 /bitbake/doc
parent2ee774782c4a19f13999554a194cddb89462620b (diff)
downloadpoky-2038b85a46643ea3083ec37e3538d3d817790eb7.tar.gz
bitbake: user-manual-intro: Update/improve whitespace
(Bitbake rev: fb74a1926c3a603a4c1ebe0325b27fb2c3aec3ee) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml128
1 files changed, 95 insertions, 33 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index c76696f5d5..347b17a156 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -1,11 +1,13 @@
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 id="user-manual-intro"> 3
4<chapter id="user-manual-intro">
4 <title>BitBake User Manual</title> 5 <title>BitBake User Manual</title>
5 6
6 <section id="intro"> 7 <section id="intro">
7 <title>Introduction</title> 8 <title>Introduction</title>
8 <para> 9
10 <para>
9 BitBake is a tool for executing tasks commonly performed by software 11 BitBake is a tool for executing tasks commonly performed by software
10 developers when building systems on a daily basis. 12 developers when building systems on a daily basis.
11 BitBake can build Systems consisting of numerous individual pieces 13 BitBake can build Systems consisting of numerous individual pieces
@@ -23,8 +25,10 @@
23 and other build tools. 25 and other build tools.
24 </para> 26 </para>
25 </section> 27 </section>
26 <section id="history-and-goals"> 28
27 <title>History and Goals</title> 29 <section id="history-and-goals">
30 <title>History and Goals</title>
31
28 <para> 32 <para>
29 BitBake was originally a part of the OpenEmbedded project. 33 BitBake was originally a part of the OpenEmbedded project.
30 It was inspired by the Portage package management system 34 It was inspired by the Portage package management system
@@ -43,39 +47,97 @@
43 such as the Angstrom Distribution and the Yocto 47 such as the Angstrom Distribution and the Yocto
44 Project. 48 Project.
45 </para> 49 </para>
46 <para>Prior to BitBake, no other build tool adequately met 50
47the needs of an aspiring embedded Linux distribution. All of the 51 <para>
48buildsystems used by traditional desktop Linux distributions lacked 52 Prior to BitBake, no other build tool adequately met the needs of
49important functionality, and none of the ad-hoc 53 an aspiring embedded Linux distribution.
50<emphasis>buildroot</emphasis> systems, prevalent in the 54 All of the build systems used by traditional desktop Linux
51embedded space, were scalable or maintainable.</para> 55 distributions lacked important functionality, and none of the
52 <para>Some important original goals for BitBake were: 56 ad-hoc <emphasis>buildroot</emphasis> systems, prevalent in the
57 embedded space, were scalable or maintainable.
58 </para>
59
60 <para>
61 Some important original goals for BitBake were:
53 <itemizedlist> 62 <itemizedlist>
54 <listitem><para>Handle crosscompilation.</para></listitem> 63 <listitem><para>
55 <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem> 64 Handle cross-compilation.
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> 65 </para></listitem>
57 <listitem><para>Must be Linux distribution agnostic (both build and target).</para></listitem> 66 <listitem><para>
58 <listitem><para>Must be architecture agnostic</para></listitem> 67 Handle inter-package dependencies (build time on
59 <listitem><para>Must support multiple build and target operating systems (including Cygwin, the BSDs, etc).</para></listitem> 68 target architecture, build time on native
60 <listitem><para>Must be able to be self contained, rather than tightly integrated into the build machine's root filesystem.</para></listitem> 69 architecture, and runtime).
61 <listitem><para>There must be a way to handle conditional metadata (on target architecture, operating system, distribution, machine).</para></listitem> 70 </para></listitem>
62 <listitem><para>It must be easy for the person using the tools to supply their own local metadata and packages to operate against.</para></listitem> 71 <listitem><para>
63 <listitem><para>Must make it easy to collaborate 72 Support running any number of tasks within a given
64between multiple projects using BitBake for their 73 package, including, but not limited to, fetching
65builds.</para></listitem> 74 upstream sources, unpacking them, patching them,
66 <listitem><para>Should provide an inheritance mechanism to 75 configuring them, etc.
67share common metadata between many packages.</para></listitem> 76 </para></listitem>
77 <listitem><para>
78 Must be Linux distribution agnostic (both build and
79 target).
80 </para></listitem>
81 <listitem><para>
82 Must be architecture agnostic
83 </para></listitem>
84 <listitem><para>
85 Must support multiple build and target operating systems
86 (including Cygwin, the BSDs, etc).
87 </para></listitem>
88 <listitem><para>
89 Must be able to be self contained, rather than tightly
90 integrated into the build machine's root
91 filesystem.
92 </para></listitem>
93 <listitem><para>
94 There must be a way to handle conditional metadata
95 (on target architecture, operating system,
96 distribution, machine).
97 </para></listitem>
98 <listitem><para>
99 It must be easy for the person using the tools to
100 supply their own local metadata and packages
101 to operate against.
102 </para></listitem>
103 <listitem><para>
104 Must make it easy to collaborate between multiple
105 projects using BitBake for their builds.
106 </para></listitem>
107 <listitem><para>
108 Should provide an inheritance mechanism to share
109 common metadata between many packages.
110 </para></listitem>
68 </itemizedlist> 111 </itemizedlist>
69 </para> 112 </para>
70 <para>Over time it has become apparent that some further requirements were necessary: 113
114 <para>
115 Over time it has become apparent that some further requirements
116 were necessary:
71 <itemizedlist> 117 <itemizedlist>
72 <listitem><para>Handle variants of a base recipe (native, sdk, multilib).</para></listitem> 118 <listitem><para>
73 <listitem><para>Able to split metadata into layers and allow layers to override each other.</para></listitem> 119 Handle variants of a base recipe (native, sdk, multilib).
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> 120 </para></listitem>
121 <listitem><para>
122 Able to split metadata into layers and allow layers
123 to override each other.
124 </para></listitem>
125 <listitem><para>
126 Allow representation of a given set of input variables
127 to a task as a checksum.
128 Based on that checksum, allow acceleration of builds
129 with prebuilt components.
130 </para></listitem>
75 </itemizedlist> 131 </itemizedlist>
76 </para> 132 </para>
77 133
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> 134 <para>
79 </section> 135 BitBake satisfies all the original requirements and many more
80 </chapter> 136 with extensions being made to the basic functionality to
81 137 reflect the additional requirements.
138 Flexibility and power have always been the priorities.
139 It is highly extensible, supporting embedded Python code and
140 execution of any arbitrary tasks.
141 </para>
142 </section>
143</chapter>