summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorRichard Purdie <rpurdie@linux.intel.com>2010-01-20 18:46:02 (GMT)
committerRichard Purdie <rpurdie@linux.intel.com>2010-01-20 18:46:02 (GMT)
commit22c29d8651668195f72e2f6a8e059d625eb511c3 (patch)
treedd1dd43f0ec47a9964c8a766eb8b3ad75cf51a64 /bitbake/doc
parent1bfd6edef9db9c9175058ae801d1b601e4f15263 (diff)
downloadpoky-22c29d8651668195f72e2f6a8e059d625eb511c3.tar.gz
bitbake: Switch to bitbake-dev version (bitbake master upstream)
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake.14
-rw-r--r--bitbake/doc/manual/usermanual.xml28
2 files changed, 12 insertions, 20 deletions
diff --git a/bitbake/doc/bitbake.1 b/bitbake/doc/bitbake.1
index e687f0a..036402e 100644
--- a/bitbake/doc/bitbake.1
+++ b/bitbake/doc/bitbake.1
@@ -32,7 +32,7 @@ command.
32\fBbitbake\fP is a program that executes the specified task (default is 'build') 32\fBbitbake\fP is a program that executes the specified task (default is 'build')
33for a given set of BitBake files. 33for a given set of BitBake files.
34.br 34.br
35It expects that BBFILES is defined, which is a space seperated list of files to 35It expects that BBFILES is defined, which is a space separated list of files to
36be executed. BBFILES does support wildcards. 36be executed. BBFILES does support wildcards.
37.br 37.br
38Default BBFILES are the .bb files in the current directory. 38Default BBFILES are the .bb files in the current directory.
@@ -67,7 +67,7 @@ drop into the interactive mode also called the BitBake shell.
67Specify task to execute. Note that this only executes the specified task for 67Specify task to execute. Note that this only executes the specified task for
68the providee and the packages it depends on, i.e. 'compile' does not implicitly 68the providee and the packages it depends on, i.e. 'compile' does not implicitly
69call stage for the dependencies (IOW: use only if you know what you are doing). 69call stage for the dependencies (IOW: use only if you know what you are doing).
70Depending on the base.bbclass a listtaks tasks is defined and will show 70Depending on the base.bbclass a listtasks task is defined and will show
71available tasks. 71available tasks.
72.TP 72.TP
73.B \-rFILE, \-\-read=FILE 73.B \-rFILE, \-\-read=FILE
diff --git a/bitbake/doc/manual/usermanual.xml b/bitbake/doc/manual/usermanual.xml
index a01801e..cdd0599 100644
--- a/bitbake/doc/manual/usermanual.xml
+++ b/bitbake/doc/manual/usermanual.xml
@@ -119,7 +119,7 @@ will be introduced.</para>
119 </section> 119 </section>
120 <section> 120 <section>
121 <title>Conditional metadata set</title> 121 <title>Conditional metadata set</title>
122 <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> 122 <para>OVERRIDES is a <quote>:</quote> separated 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>
123 <para><screen><varname>OVERRIDES</varname> = "architecture:os:machine" 123 <para><screen><varname>OVERRIDES</varname> = "architecture:os:machine"
124<varname>TEST</varname> = "defaultvalue" 124<varname>TEST</varname> = "defaultvalue"
125<varname>TEST_os</varname> = "osspecificvalue" 125<varname>TEST_os</varname> = "osspecificvalue"
@@ -184,7 +184,7 @@ include</literal> directive.</para>
184 <section> 184 <section>
185 <title>Inheritance</title> 185 <title>Inheritance</title>
186 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para> 186 <para><emphasis>NOTE:</emphasis> This is only supported in .bb and .bbclass files.</para>
187 <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> 187 <para>The <literal>inherit</literal> directive is a means of specifying what classes of functionality your .bb requires. It is a rudimentary form of inheritance. 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>
188 </section> 188 </section>
189 <section> 189 <section>
190 <title>Tasks</title> 190 <title>Tasks</title>
@@ -263,11 +263,11 @@ of the event and the content of the <varname>FILE</varname> variable.</para>
263 </section> 263 </section>
264 <section> 264 <section>
265 <title>Classes</title> 265 <title>Classes</title>
266 <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> 266 <para>BitBake classes are our rudimentary inheritance 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>
267 </section> 267 </section>
268 <section> 268 <section>
269 <title>.bb Files</title> 269 <title>.bb Files</title>
270 <para>A BitBake (.bb) file is a logical unit of tasks to be executed. Normally this is a package to be built. Inter-.bb 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> 270 <para>A BitBake (.bb) file is a logical unit of tasks to be executed. Normally this is a package to be built. Inter-.bb dependencies are obeyed. The files themselves are located via the <varname>BBFILES</varname> variable, which is set to a space separated list of .bb files, and does handle wildcards.</para>
271 </section> 271 </section>
272 </section> 272 </section>
273 </chapter> 273 </chapter>
@@ -352,15 +352,7 @@ will be tried first when fetching a file if that fails the actual file will be t
352 352
353 353
354 <chapter> 354 <chapter>
355 <title>Commands</title> 355 <title>The bitbake command</title>
356 <section>
357 <title>bbread</title>
358 <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>
359 <para><emphasis>NOTE: the stand a lone bbread command was removed. Instead of bbread use bitbake -e.
360 </emphasis></para>
361 </section>
362 <section>
363 <title>bitbake</title>
364 <section> 356 <section>
365 <title>Introduction</title> 357 <title>Introduction</title>
366 <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> 358 <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>
@@ -372,7 +364,7 @@ will be tried first when fetching a file if that fails the actual file will be t
372usage: bitbake [options] [package ...] 364usage: bitbake [options] [package ...]
373 365
374Executes the specified task (default is 'build') for a given set of BitBake files. 366Executes the specified task (default is 'build') for a given set of BitBake files.
375It expects that BBFILES is defined, which is a space seperated list of files to 367It expects that BBFILES is defined, which is a space separated list of files to
376be executed. BBFILES does support wildcards. 368be executed. BBFILES does support wildcards.
377Default BBFILES are the .bb files in the current directory. 369Default BBFILES are the .bb files in the current directory.
378 370
@@ -394,7 +386,7 @@ options:
394 it depends on, i.e. 'compile' does not implicitly call 386 it depends on, i.e. 'compile' does not implicitly call
395 stage for the dependencies (IOW: use only if you know 387 stage for the dependencies (IOW: use only if you know
396 what you are doing). Depending on the base.bbclass a 388 what you are doing). Depending on the base.bbclass a
397 listtasks tasks is defined and will show available 389 listtasks task is defined and will show available
398 tasks 390 tasks
399 -r FILE, --read=FILE read the specified file before bitbake.conf 391 -r FILE, --read=FILE read the specified file before bitbake.conf
400 -v, --verbose output more chit-chat to the terminal 392 -v, --verbose output more chit-chat to the terminal
@@ -417,6 +409,7 @@ options:
417 Show debug logging for the specified logging domains 409 Show debug logging for the specified logging domains
418 -P, --profile profile the command and print a report 410 -P, --profile profile the command and print a report
419 411
412
420</screen> 413</screen>
421 </para> 414 </para>
422 <para> 415 <para>
@@ -462,12 +455,12 @@ Two files will be written into the current working directory, <emphasis>depends.
462 </section> 455 </section>
463 <section> 456 <section>
464 <title>Metadata</title> 457 <title>Metadata</title>
465 <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. 458 <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 separated list of files that are available, and supports wildcards.
466 <example> 459 <example>
467 <title>Setting BBFILES</title> 460 <title>Setting BBFILES</title>
468 <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting> 461 <programlisting><varname>BBFILES</varname> = "/path/to/bbfiles/*.bb"</programlisting>
469 </example></para> 462 </example></para>
470 <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> 463 <para>With regard to dependencies, it expects the .bb to define a <varname>DEPENDS</varname> variable, which contains a space separated 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>
471 <example> 464 <example>
472 <title>Depending on another .bb</title> 465 <title>Depending on another .bb</title>
473 <para>a.bb: 466 <para>a.bb:
@@ -514,6 +507,5 @@ BBFILE_PRIORITY_upstream = "5"
514BBFILE_PRIORITY_local = "10"</screen> 507BBFILE_PRIORITY_local = "10"</screen>
515 </example> 508 </example>
516 </section> 509 </section>
517 </section>
518 </chapter> 510 </chapter>
519</book> 511</book>