From 22c29d8651668195f72e2f6a8e059d625eb511c3 Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Wed, 20 Jan 2010 18:46:02 +0000 Subject: bitbake: Switch to bitbake-dev version (bitbake master upstream) Signed-off-by: Richard Purdie --- bitbake/doc/manual/usermanual.xml | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) (limited to 'bitbake/doc/manual') diff --git a/bitbake/doc/manual/usermanual.xml b/bitbake/doc/manual/usermanual.xml index a01801e03f..cdd05998a5 100644 --- a/bitbake/doc/manual/usermanual.xml +++ b/bitbake/doc/manual/usermanual.xml @@ -119,7 +119,7 @@ will be introduced.
Conditional metadata set - OVERRIDES is a : seperated variable containing each item you want to satisfy conditions. So, if you have a variable which is conditional on arm, and arm is in OVERRIDES, then the arm specific version of the variable is used rather than the non-conditional version. Example: + OVERRIDES is a : separated variable containing each item you want to satisfy conditions. So, if you have a variable which is conditional on arm, and arm is in OVERRIDES, then the arm specific version of the variable is used rather than the non-conditional version. Example: OVERRIDES = "architecture:os:machine" TEST = "defaultvalue" TEST_os = "osspecificvalue" @@ -184,7 +184,7 @@ include directive.
Inheritance NOTE: This is only supported in .bb and .bbclass files. - The inherit 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 BBPATH, where filename is what you inherited. + The inherit 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 BBPATH, where filename is what you inherited.
Tasks @@ -263,11 +263,11 @@ of the event and the content of the FILE variable.
Classes - BitBake classes are our rudamentary inheritence mechanism. As briefly mentioned in the metadata introduction, they're parsed when an inherit directive is encountered, and they are located in classes/ relative to the dirs in BBPATH. + BitBake classes are our rudimentary inheritance mechanism. As briefly mentioned in the metadata introduction, they're parsed when an inherit directive is encountered, and they are located in classes/ relative to the dirs in BBPATH.
.bb Files - 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 BBFILES variable, which is set to a space seperated list of .bb files, and does handle wildcards. + 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 BBFILES variable, which is set to a space separated list of .bb files, and does handle wildcards.
@@ -352,15 +352,7 @@ will be tried first when fetching a file if that fails the actual file will be t - Commands -
- bbread - 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. - NOTE: the stand a lone bbread command was removed. Instead of bbread use bitbake -e. - -
-
- bitbake + The bitbake command
Introduction 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. @@ -372,7 +364,7 @@ will be tried first when fetching a file if that fails the actual file will be t usage: bitbake [options] [package ...] Executes the specified task (default is 'build') for a given set of BitBake files. -It expects that BBFILES is defined, which is a space seperated list of files to +It expects that BBFILES is defined, which is a space separated list of files to be executed. BBFILES does support wildcards. Default BBFILES are the .bb files in the current directory. @@ -394,7 +386,7 @@ options: it depends on, i.e. 'compile' does not implicitly call stage for the dependencies (IOW: use only if you know what you are doing). Depending on the base.bbclass a - listtasks tasks is defined and will show available + listtasks task is defined and will show available tasks -r FILE, --read=FILE read the specified file before bitbake.conf -v, --verbose output more chit-chat to the terminal @@ -417,6 +409,7 @@ options: Show debug logging for the specified logging domains -P, --profile profile the command and print a report + @@ -462,12 +455,12 @@ Two files will be written into the current working directory, depends.
Metadata - 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. + 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. Setting BBFILES BBFILES = "/path/to/bbfiles/*.bb" - With regard to dependencies, it expects the .bb to define a DEPENDS variable, which contains a space seperated list of package names, which themselves are the PN variable. The PN variable is, in general, by default, set to a component of the .bb filename. + With regard to dependencies, it expects the .bb to define a DEPENDS variable, which contains a space separated list of package names, which themselves are the PN variable. The PN variable is, in general, by default, set to a component of the .bb filename. Depending on another .bb a.bb: @@ -514,6 +507,5 @@ BBFILE_PRIORITY_upstream = "5" BBFILE_PRIORITY_local = "10"
-
-- cgit v1.2.3-54-g00ecf