summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--bitbake/doc/user-manual/user-manual-intro.xml55
1 files changed, 40 insertions, 15 deletions
diff --git a/bitbake/doc/user-manual/user-manual-intro.xml b/bitbake/doc/user-manual/user-manual-intro.xml
index 4050e432dc..f013ee6f45 100644
--- a/bitbake/doc/user-manual/user-manual-intro.xml
+++ b/bitbake/doc/user-manual/user-manual-intro.xml
@@ -8,21 +8,46 @@
8 <title>Introduction</title> 8 <title>Introduction</title>
9 9
10 <para> 10 <para>
11 BitBake is a tool for executing tasks commonly performed by software 11 fundamentally, BitBake is a generic task execution
12 developers when building systems on a daily basis. 12 engine that allows shell and Python tasks to be run
13 BitBake can build Systems consisting of numerous individual pieces 13 efficiently and in parallel while working within
14 of software, or can be used to build a single application. 14 complex inter-task dependency constraints.
15 Example tasks that BitBake can execute are fetching source code, 15 One of BitBake's main users, OpenEmbedded, takes this core
16 applying patches to source code, configuring, compiling, and 16 and builds embedded Linux software stacks using
17 packaging applications into a complete system, and managing metadata. 17 a task-oriented approach.
18 BitBake abstracts the information for completing individual tasks 18 </para>
19 into files known as recipes. 19
20 Recipes contain all of the relevant information required by BitBake 20 <para>
21 to complete a given task including dependencies, source file 21 Conceptually, BitBake is similar to GNU Make in
22 locations, etc. 22 some regards but has significant differences:
23 BitBake is similar to 23 <itemizedlist>
24 <ulink url='http://www.gnu.org/software/make/'>GNU Make</ulink> 24 <listitem><para>
25 and other build tools. 25 BitBake executes tasks according to provided
26 metadata that builds up the tasks.
27 Metadata is stored in recipe (<filename>.bb</filename>),
28 configuration (<filename>.conf</filename>), and class
29 (<filename>.bbclass</filename>) files and provides
30 BitBake with instructions on what tasks to run and
31 the dependencies between those tasks.
32 </para></listitem>
33 <listitem><para>
34 BitBake includes a fetcher library for obtaining source
35 code from various places such as source control
36 systems or websites.
37 </para></listitem>
38 <listitem><para>
39 The instructions for each unit to be built (e.g. a piece
40 of software) are known as recipe files and
41 contain all the information about the unit
42 (dependencies, source file locations, checksums, description
43 and so on).
44 </para></listitem>
45 <listitem><para>
46 BitBake includes a client/server abstraction and can
47 be used from a command line or used as a service over XMLRPC and
48 has several different user interfaces.
49 </para></listitem>
50 </itemizedlist>
26 </para> 51 </para>
27 </section> 52 </section>
28 53