From 89058e1ef7142765e29f5c403470d5bd2932e298 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 27 Jan 2014 09:01:21 -0600 Subject: bitbake: user-manual-ref-variables.xml: Review edits to several variables in glossary. ASSUME_PROVIDED BBCLASSEXTEND SRC_URI PACKAGES_DYNAMIC BB_NUMBER_THREADS BB_DANGLINGAPPENDS_WARNONLY (Bitbake rev: 8e586ccee6d5e78070d28cda67058578e1fe91d7) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../doc/user-manual/user-manual-ref-variables.xml | 146 ++++++--------------- 1 file changed, 39 insertions(+), 107 deletions(-) (limited to 'bitbake/doc') diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index 7d821ed267..b9db594131 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml @@ -48,7 +48,7 @@ ASSUME_PROVIDED - Recipe names + Lists recipe names (PN values) BitBake does not attempt to build. Instead, BitBake assumes these recipes have already been @@ -56,11 +56,12 @@ - ASSUMED_PROVIDED often specifies - native tools. - A good example is git-native, which - allows for the the Git binary from the host to be used - rather than building git-native. + In OpenEmbedded Core, ASSUME_PROVIDED + mostly specifies native tools that should not be built. + An example is git-native, which + when specified allows for the Git binary from the host to + be used rather than building + git-native. @@ -108,7 +109,6 @@ It is important to realize when your changes are no longer being applied. - @@ -490,6 +490,18 @@ + BB_NUMBER_THREADS + + + The maximum number of tasks BitBake should run in parallel + at any one time. + If your host development system supports multiple cores, + a good rule of thumb is to set this variable to twice the + number of cores. + + + + BB_NUMBER_PARSE_THREADS @@ -530,14 +542,6 @@ - BB_NUMBER_THREADS - - The maximum number of tasks BitBake should run in parallel at any one time. - If your host development system supports multiple cores, a good rule of thumb - is to set this variable to twice the number of cores. - - - BB_RUNFMT @@ -818,19 +822,27 @@ BBCLASSEXTEND - Allows you to extend a recipe so that it builds variants of the software. - Common variants for recipes exist such as "natives" like quilt-native, + Allows you to extend a recipe so that it builds variants + of the software. + Common variants for recipes exist such as "natives" + like quilt-native, which is a copy of Quilt built to run on the build system; "crosses" such as gcc-cross, - which is a compiler built to run on the build machine but produces binaries - that run on the target MACHINE; - "nativesdk", which targets the SDK machine instead of MACHINE; - and "mulitlibs" in the form "multilib:<multilib_name>". + which is a compiler built to run on the build machine + but produces binaries that run on the target + MACHINE; "nativesdk", which targets + the SDK machine instead of MACHINE; + and "mulitlibs" in the form + "multilib:<multilib_name>". - To build a different variant of the recipe with a minimal amount of code, it usually - is as simple as adding the following to your recipe: + To build a different variant of the recipe with a minimal + amount of code, it usually is as simple as adding the + variable to your recipe. + Here are two examples. + The "native" variants are from the OpenEmbedded Core + metadata: BBCLASSEXTEND =+ "native nativesdk" BBCLASSEXTEND =+ "multilib:<multilib_name>" @@ -1511,9 +1523,6 @@ through the PACKAGES_DYNAMIC variable, but a package with the module name is never actually produced, then the other package will be broken. - Thus, if you attempt to include that package in an image, - you will get a dependency failure from the packaging system - during do_rootfs. @@ -1860,7 +1869,8 @@ SRC_URI - The list of source files - local or remote. + + The list of source files - local or remote. This variable tells BitBake which bits to pull in for the build and how to pull them in. For example, if the recipe or append file only needs to @@ -1880,41 +1890,7 @@ from the local machine. The path is relative to the FILESPATH - variable. - Thus, the build system searches, in order, from the - following directories, which are assumed to be a - subdirectories of the directory in which the - recipe file (.bb) or - append file (.bbappend) - resides: - - ${BPN} - - The base recipe name without any special - suffix or version numbers. - - ${BP} - - ${BPN}-${PV}. - The base recipe name and version but without - any special package name suffix. - - files - - Files within a directory that is named - files and is also - alongside the recipe or append file. - - - - If you want the build system to pick up files - specified through a - SRC_URI - statement from your append file, you need to be - sure to extend the - FILESPATH - variable by also using the - FILESEXTRAPATHS - variable from within your append file. - - + variable. bzr:// - Fetches files from a Bazaar revision control repository. git:// - Fetches files from a @@ -1943,50 +1919,6 @@ a Subversion (svn) revision control repository. - Standard and recipe-specific options for SRC_URI exist. - Here are standard options: - - apply - Whether to apply - the patch or not. - The default action is to apply the patch. - striplevel - Which - striplevel to use when applying the patch. - The default level is 1. - patchdir - Specifies - the directory in which the patch should be applied. - The default is ${S}. - - - - Here are options specific to recipes building code from a revision control system: - - mindate - - Apply the patch only if - SRCDATE - is equal to or greater than mindate. - - maxdate - - Apply the patch only if SRCDATE - is not later than mindate. - - minrev - - Apply the patch only if SRCREV - is equal to or greater than minrev. - - maxrev - - Apply the patch only if SRCREV - is not later than maxrev. - - rev - - Apply the patch only if SRCREV - is equal to rev. - - notrev - - Apply the patch only if SRCREV - is not equal to rev. - - - Here are some additional options worth mentioning: unpack - Controls @@ -1994,7 +1926,7 @@ The default action is to unpack the file. subdir - Places the file (or extracts its contents) into the specified - subdirectory of WORKDIR. + subdirectory. This option is useful for unusual tarballs or other archives that do not have their files already in a subdirectory within the archive. -- cgit v1.2.3-54-g00ecf