Add -nochunks makefile targets for documentation generation (user's manual).
[bitbake.git] / doc / manual / usermanual.xml
1 <?xml version="1.0"?>
2 <!--
3   ex:ts=4:sw=4:sts=4:et
4   -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
5 -->
6 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
7                       "">
8 <book>
9     <bookinfo>
10         <title>BitBake User Manual</title>
11         <authorgroup>
12             <corpauthor>BitBake Team</corpauthor>
13         </authorgroup>
14         <copyright>
15             <year>2004</year>
16             <holder>Chris Larson</holder>
17             <holder>Phil Blundell</holder>
18         </copyright>
19         <legalnotice>
20             <para>This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit <ulink url=""></ulink> or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.</para>
21         </legalnotice>
22     </bookinfo>
23     <chapter>
24         <title>Introduction</title>
25         <section>
26             <title>Overview</title>
27             <para>BitBake is, at its simplest, a tool for executing
28 tasks and managing metadata.  As such, its similarities to GNU make and other
29 build 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="">OpenEmbedded</ulink> project, which is being used to build and maintain a number of embedded Linux distributions, including OpenZaurus and Familiar.</para>
30         </section>
31         <section>
32             <title>Background and Goals</title>
33             <para>Prior to BitBake, no other build tool adequately met
34 the needs of an aspiring embedded Linux distribution.  All of the
35 buildsystems used by traditional desktop Linux distributions lacked
36 important functionality, and none of the ad-hoc
37 <emphasis>buildroot</emphasis> systems, prevalent in the
38 embedded space, were scalable or maintainable.</para>
40       <para>Some important goals for BitBake were:
41             <itemizedlist>
42                 <listitem><para>Handle crosscompilation.</para></listitem>
43                 <listitem><para>Handle interpackage dependencies (build time on target architecture, build time on native architecture, and runtime).</para></listitem>
44                 <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>
45                 <listitem><para>Must be linux distribution agnostic (both build and target).</para></listitem>
46                 <listitem><para>Must be architecture agnostic</para></listitem>
47                 <listitem><para>Must support multiple build and target operating systems (including cygwin, the BSDs, etc).</para></listitem>
48                 <listitem><para>Must be able to be self contained, rather than tightly integrated into the build machine's root filesystem.</para></listitem>
49                 <listitem><para>There must be a way to handle conditional metadata (on target architecture, operating system, distribution, machine).</para></listitem>
50                 <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>
51                 <listitem><para>Must make it easy to collaborate
52 between multiple projects using BitBake for their
53 builds.</para></listitem>
54                 <listitem><para>Should provide an inheritance mechanism to
55 share common metadata between many packages.</para></listitem>
56                 <listitem><para>Et cetera...</para></listitem>
57             </itemizedlist>
58         </para>
59         <para>BitBake satisfies all these and many more.  Flexibility and power have always been the priorities.  It is highly extensible, supporting embedded Python code and execution of any arbitrary tasks.</para>
60         </section>
61     </chapter>
62     <chapter>
63         <title>Metadata</title>
64         <section>
65             <title>Description</title>
66             <itemizedlist>
67                 <para>BitBake metadata can be classified into 3 major areas:</para>
68                 <listitem>
69                     <para>Configuration Files</para>
70                 </listitem>
71                 <listitem>
72                     <para>.bb Files</para>
73                 </listitem>
74                 <listitem>
75                     <para>Classes</para>
76                 </listitem>
77             </itemizedlist>
78             <para>What follows are a large number of examples of BitBake metadata.  Any syntax which isn't supported in any of the aforementioned areas will be documented as such.</para>
79             <section>
80                 <title>Basic variable setting</title>
81                 <para><screen><varname>VARIABLE</varname> = "value"</screen></para>
82                 <para>In this example, <varname>VARIABLE</varname> is <literal>value</literal>.</para>
83             </section>
84             <section>
85                 <title>Variable expansion</title>
86                 <para>BitBake supports variables referencing one another's contents using a syntax which is similar to shell scripting</para>
87                 <para><screen><varname>A</varname> = "aval"
88 <varname>B</varname> = "pre${A}post"</screen></para>
89                 <para>This results in <varname>A</varname> containing <literal>aval</literal> and <varname>B</varname> containing <literal>preavalpost</literal>.</para>
90             </section>
91             <section>
92                 <title>Immediate variable expansion (:=)</title>
93                 <para>:= results in a variable's contents being expanded immediately, rather than when the variable is actually used.</para>
94                 <para><screen><varname>T</varname> = "123"
95 <varname>A</varname> := "${B} ${A} test ${T}"
96 <varname>T</varname> = "456"
97 <varname>B</varname> = "${T} bval"
99 <varname>C</varname> = "cval"
100 <varname>C</varname> := "${C}append"</screen></para>
101                 <para>In that example, <varname>A</varname> would contain <literal> test 123</literal>, <varname>B</varname> would contain <literal>456 bval</literal>, and <varname>C</varname> would be <literal>cvalappend</literal>.</para>
102             </section>
103             <section>
104                 <title>Appending (+=) and prepending (=+)</title>
105                 <para><screen><varname>B</varname> = "bval"
106 <varname>B</varname> += "additionaldata"
107 <varname>C</varname> = "cval"
108 <varname>C</varname> =+ "test"</screen></para>
109                 <para>In this example, <varname>B</varname> is now <literal>bval additionaldata</literal> and <varname>C</varname> is <literal>test cval</literal>.</para>
110             </section>
111             <section>
112                 <title>Conditional metadata set</title>
113                 <para>OVERRIDES is a <quote>:</quote> seperated variable containing each item you want to satisfy conditions.  So, if you have a variable which is conditional on <quote>arm</quote>, and <quote>arm</quote> is in OVERRIDES, then the <quote>arm</quote> specific version of the variable is used rather than the non-conditional version.  Example:</para>
114                 <para><screen><varname>OVERRIDES</varname> = "architecture:os:machine"
115 <varname>TEST</varname> = "defaultvalue"
116 <varname>TEST_os</varname> = "osspecificvalue"
117 <varname>TEST_condnotinoverrides</varname> = "othercondvalue"</screen></para>
118                 <para>In this example, <varname>TEST</varname> would be <literal>osspecificvalue</literal>, due to the condition <quote>os</quote> being in <varname>OVERRIDES</varname>.</para>
119             </section>
120             <section>
121                 <title>Conditional appending</title>
122                 <para>BitBake also supports appending and prepending to variables based on whether something is in OVERRIDES.  Example:</para>
123                 <para><screen><varname>DEPENDS</varname> = "glibc ncurses"
124 <varname>OVERRIDES</varname> = "machine:local"
125 <varname>DEPENDS_append_machine</varname> = " libmad"</screen></para>
126                 <para>In this example, <varname>DEPENDS</varname> is set to <literal>glibc ncurses libmad</literal>.</para>
127             </section>
128             <section>
129                 <title>Inclusion</title>
130                 <para>Next, there is the <literal>include</literal> directive, which causes BitBake to parse in whatever file you specify, and insert it at that location, which is not unlike <command>make</command>.  However, if the path specified on the <literal>include</literal> line is a relative path, BitBake will locate the first one it can find within <envar>BBPATH</envar>.</para>
131             </section>
132             <section>
133                 <title>Python variable expansion</title>
134                 <para><screen><varname>DATE</varname> = "${@time.strftime('%Y%m%d',time.gmtime())}"</screen></para>
135                 <para>This would result in the <varname>DATE</varname> variable containing today's date.</para>
136             </section>
137             <section>
138                 <title>Defining executable metadata</title>
139                 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
140                 <para><screen>do_mytask () {
141     echo "Hello, world!"
142 }</screen></para>
143                 <para>This is essentially identical to setting a variable, except that this variable happens to be executable shell code.</para>
144                 <para><screen>python do_printdate () {
145     import time
146     print time.strftime('%Y%m%d', time.gmtime())
147 }</screen></para>
148                 <para>This is the similar to the previous, but flags it as python so that BitBake knows it is python code.</para>
149             </section>
150             <section>
151                 <title>Defining python functions into the global python namespace</title>
152                 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
153                 <para><screen>def get_depends(bb, d):
154     if'SOMECONDITION', d, 1):
155         return "dependencywithcond"
156     else:
157         return "dependency"
159 <varname>SOMECONDITION</varname> = "1"
160 <varname>DEPENDS</varname> = "${@get_depends(bb, d)}"</screen></para>
161                 <para>This would result in <varname>DEPENDS</varname> containing <literal>dependencywithcond</literal>.</para>
162             </section>
163             <section>
164                 <title>Inheritance</title>
165                 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
166                 <para>The <literal>inherit</literal> directive is a means of specifying what classes of functionality your .bb requires.  It is a rudamentary form of inheritence.  For example, you can easily abstract out the tasks involved in building a package that uses autoconf and automake, and put that into a bbclass for your packages to make use of.  A given bbclass is located by searching for classes/filename.oeclass in <envar>BBPATH</envar>, where filename is what you inherited.</para>
167             </section>
168             <section>
169                 <title>Tasks</title>
170                 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
171                 <para>In BitBake, each step that needs to be run for a given .bb is known as a task.  There is a command <literal>addtask</literal> to add new tasks (must be a defined python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.</para>
172                 <para><screen>python do_printdate () {
173     import time
174     print time.strftime('%Y%m%d', time.gmtime())
175 }
177 addtask printdate before do_build</screen></para>
178                 <para>This defines the necessary python function and adds it as a task which is now a dependency of do_build (the default task).  If anyone executes the do_build task, that will result in do_printdate being run first.</para>
179             </section>
180             <section>
181                 <title>Events</title>
182                 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
183                 <para>BitBake also implements a means of registering event handlers.  Events are triggered at certain points during operation, such as, the beginning of operation against a given .bb, the start of a given task, task failure, task success, et cetera.  The intent was to make it easy to do things like email notifications on build failure.</para>
184                 <para><emphasis>[Insert instructions on how to add event handlers here]</emphasis></para>
185             </section>
186         </section>
187         <section>
188             <title>Parsing</title>
189             <section>
190                 <title>Configuration Files</title>
191                 <para>The first of the classifications of metadata in BitBake is configuration metadata.  This metadata is global, and therefore affects <emphasis>all</emphasis> packages and tasks which are executed.  Currently, BitBake has hardcoded knowledge of a single configuration file.  It expects to find 'conf/bitbake.conf' somewhere in the user specified <envar>BBPATH</envar>.  That configuration file generally has include directives to pull in any other metadata (generally files specific to architecture, machine, <emphasis>local</emphasis> and so on.</para>
192                 <para>Only variable definitions and include directives are allowed in .conf files.</para>
193             </section>
194             <section>
195                 <title>Classes</title>
196                 <para>BitBake classes are our rudamentary inheritence mechanism.  As briefly mentioned in the metadata introduction, they're parsed when an <literal>inherit</literal> directive is encountered, and they are located in classes/ relative to the dirs in <envar>BBPATH</envar>.</para>
197             </section>
198             <section>
199                 <title>.bb Files</title>
200                 <para>A BitBake (.bb) file is a logical unit of tasks to be executed.  Normally this is a package to be built. dependencies are obeyed.  The files themselves are located via the <varname>BBFILES</varname> variable, which is set to a space seperated list of .bb files, and does handle wildcards.</para>
201             </section>
202         </section>
203     </chapter>
204     <chapter>
205         <title>Commands</title>
206         <section>
207             <title>bbread</title>
208             <para>bbread is a command for displaying BitBake metadata.  When run with no arguments, it has the core parse 'conf/bitbake.conf', as located in BBPATH, and displays that.  If you supply a file on the commandline, such as a .bb, then it parses that afterwards, using the aforementioned configuration metadata.</para>
209         </section>
210         <section>
211             <title>bitbake</title>
212             <section>
213                 <title>Introduction</title>
214                 <para>bitbake is the primary command in the system.  It facilitates executing tasks in a single .bb file, or executing a given task on a set of multiple .bb files, accounting for interdependencies amongst them.</para>
215             </section>
216             <section>
217                 <title>Usage and Syntax</title>
218                 <para>
219                     <screen><prompt>$ </prompt>bitbake --help
220 usage: bitbake [options] [package ...]
222 Executes the specified task (default is 'build') for a given set of BitBake files.
223 It expects that BBFILES is defined, which is a space seperated list of files to
224 be executed.  BBFILES does support wildcards.
225 Default BBFILES are the .bb files in the current directory.
227 options:
228   --version             show program's version number and exit
229   -h, --help            show this help message and exit
230   -bBUILDFILE, --buildfile=BUILDFILE
231                         execute the task against this .bb file, rather than a
232                         package from BBFILES.
233   -k, --continue        continue as much as possible after an error. While the
234                         target that failed, and those that depend on it, cannot
235                         be remade, the other dependencies of these targets can
236                         be processed all the same.
237   -f, --force           force run of specified cmd, regardless of stamp status
238   -cCMD, --cmd=CMD      Specify task to execute
239   -rFILE, --read=FILE   read the specified file before bitbake.conf
240   -v, --verbose         output more chit-chat to the terminal
241   -D, --debug           Increase the debug level
242   -n, --dry-run         don't execute, just go through the motions
243   -p, --parse-only      quit after parsing the BB files (developers only)
244   -d, --disable-psyco   disable using the psyco just-in-time compiler (not
245                         recommended)
246   -s, --show-versions   show current and preferred versions of all packages</screen>
247                 </para>
248                 <para>
249                 <example>
250                     <title>Executing a task against a single .bb</title>
251                     <para>Executing tasks for a single file is relatively simple.  You specify the file in question, and bitbake parses it and executes the specified task (or <quote>build</quote> by default).  It obeys intertask dependencies when doing so.</para>
252                     <para><quote>clean</quote> task:</para>
253                     <para><screen><prompt>$ </prompt>bitbake -b -c clean</screen></para>
254                     <para><quote>build</quote> task:</para>
255                     <para><screen><prompt>$ </prompt>bitbake -b</screen></para>
256                 </example>
257                 </para>
258                 <para>
259                 <example>
260                     <title>Executing tasks against a set of .bb files</title>
261                     <para>There are a number of additional complexities introduced when one wants to manage multiple .bb files.  Clearly there needs to be a way to tell bitbake what files are available, and of those, which we want to execute at this time.  There also needs to be a way for each .bb to express its dependencies, both for build time and runtime.  There must be a way for the user to express their preferences when multiple .bb's provide the same functionality, or when there are multiple versions of a .bb.</para>
262                     <para>The next section, Metadata, outlines how one goes about specifying such things.</para>
263                     <para>Note that the bitbake command, when not using --buildfile, accepts a <varname>PROVIDER</varname>, not a filename or anything else.  By default, a .bb generally PROVIDES its packagename, packagename-version, and packagename-version-revision.</para>
264                     <screen><prompt>$ </prompt>bitbake blah</screen>
265                     <screen><prompt>$ </prompt>bitbake blah-1.0</screen>
266                     <screen><prompt>$ </prompt>bitbake blah-1.0-r0</screen>
267                     <screen><prompt>$ </prompt>bitbake -c clean blah</screen>
268                     <screen><prompt>$ </prompt>bitbake virtual/whatever</screen>
269                     <screen><prompt>$ </prompt>bitbake -c clean virtual/whatever</screen>
270                 </example>
271                 </para>
272             </section>
273             <section>
274                 <title>Metadata</title>
275                 <para>As you may have seen in the usage information, or in the information about .bb files, the BBFILES variable is how the bitbake tool locates its files.  This variable is a space seperated list of files that are available, and supports wildcards.
276                 <example>
277                     <title>Setting BBFILES</title>
278                     <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting>
279                 </example></para>
280                 <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space seperated list of <quote>package names</quote>, which themselves are the <varname>PN</varname> variable.  The <varname>PN</varname> variable is, in general, by default, set to a component of the .bb filename.</para>
281                 <example>
282                     <title>Depending on another .bb</title>
283                     <para>
284     <screen>PN = "package-a"
285     DEPENDS += "package-b"</screen>
286                     </para>
287                     <para>
288     <screen>PN = "package-b"</screen>
289                     </para>
290                 </example>
291                 <example>
292                     <title>Using PROVIDES</title>
293                     <para>This example shows the usage of the PROVIDES variable, which allows a given .bb to specify what functionality it provides.</para>
294                     <para>
295     <screen>PROVIDES += "virtual/package"</screen>
296                     </para>
297                     <para>
298     <screen>DEPENDS += "virtual/package"</screen>
299                     </para>
300                     <para>
301     <screen>PROVIDES += "virtual/package"</screen>
302                     </para>
303                     <para>As you can see, here there are two different .bb's that provide the same functionality (virtual/package).  Clearly, there needs to be a way for the person running bitbake to control which of those providers gets used.  There is, indeed, such a way.</para>
304                     <para>The following would go into a .conf file, to select package1:
305     <screen>PREFERRED_PROVIDER_virtual/package = "package1"</screen>
306                     </para>
307                 </example>
308                 <example>
309                     <title>Specifying version preference</title>
310                     <para>When there are multiple <quote>versions</quote> of a given package, bitbake defaults to selecting the most recent version, unless otherwise specified.  If the .bb in question has a <varname>DEFAULT_PREFERENCE</varname> set lower than the other .bb's (default is 0), then it will not be selected.  This allows the person or persons maintaining the repository of .bb files to specify their preferences for the default selected version.  In addition, the user can specify their preferences with regard to version.</para>
311                     <para>If the first .bb is named <filename></filename>, then the <varname>PN</varname> variable will be set to <quote>a</quote>, and the <varname>PV</varname> variable will be set to 1.1.</para>
312                     <para>If we then have an <filename></filename>, bitbake will choose 1.2 by default.  However, if we define the following variable in a .conf that bitbake parses, we can change that.
313     <screen>PREFERRED_VERSION_a = "1.1"</screen>
314                     </para>
315                 </example>
316                 <example>
317                     <title>Using <quote>bbfile collections</quote></title>
318                     <para>bbfile collections exist to allow the user to have multiple repositories of bbfiles that contain the same exact package.  For example, one could easily use them to make one's own local copy of an upstream repository, but with custom modifications that one does not want upstream.  Usage:</para>
319                     <screen>BBFILES = "/stuff/openembedded/*/*.bb /stuff/openembedded.modified/*/*.bb"
320 BBFILE_COLLECTIONS = "upstream local"
321 BBFILE_PATTERN_upstream = "^/stuff/openembedded/"
322 BBFILE_PATTERN_local = "^/stuff/openembedded.modified/"
323 BBFILE_PRIORITY_upstream = "5"
324 BBFILE_PRIORITY_local = "10"</screen>
325                 </example>
326             </section>
327         </section>
328     </chapter>
329 </book>