diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml index f1caaecd2d..46dafeee30 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml @@ -31,7 +31,7 @@ Prior to executing BitBake, you should take advantage of available parallel thread execution on your build host by setting the - BB_NUMBER_THREADS + BB_NUMBER_THREADS variable in your project's local.conf configuration file. @@ -87,9 +87,9 @@ The layer.conf files are used to construct key variables such as - BBPATH + BBPATH and - BBFILES. + BBFILES. BBPATH is used to search for configuration and class files under the conf and classes @@ -117,19 +117,19 @@ at certain variables, including: - BB_ENV_WHITELIST + BB_ENV_WHITELIST - BB_ENV_EXTRAWHITE + BB_ENV_EXTRAWHITE - BB_PRESERVE_ENV + BB_PRESERVE_ENV - BB_ORIGENV + BB_ORIGENV - BITBAKE_UI + BITBAKE_UI The first four variables in this list relate to how BitBake treats shell @@ -156,7 +156,7 @@ BitBake first searches the current working directory for an optional conf/bblayers.conf configuration file. This file is expected to contain a - BBLAYERS + BBLAYERS variable that is a space-delimited list of 'layer' directories. Recall that if BitBake cannot find a bblayers.conf file, then it is assumed the user has set the BBPATH @@ -166,10 +166,10 @@ For each directory (layer) in this list, a conf/layer.conf file is located and parsed with the - LAYERDIR + LAYERDIR variable being set to the directory where the layer was found. The idea is these files automatically set up - BBPATH + BBPATH and other variables correctly for a given build directory. @@ -189,7 +189,7 @@ depending on the environment variables previously mentioned or set in the configuration files. The - "Variables Glossary" + "Variables Glossary" chapter presents a full list of variables. @@ -204,7 +204,7 @@ The base.bbclass file is always included. Other classes that are specified in the configuration using the - INHERIT + INHERIT variable are also included. BitBake searches for class files in a classes subdirectory under @@ -270,7 +270,7 @@ During the configuration phase, BitBake will have set - BBFILES. + BBFILES. BitBake now uses it to construct a list of recipes to parse, along with any append files (.bbappend) to apply. @@ -292,7 +292,7 @@ Any inherit statements cause BitBake to find and then parse class files (.bbclass) using - BBPATH + BBPATH as the search path. Finally, BitBake parses in order any append files found in BBFILES. @@ -303,8 +303,8 @@ pieces of metadata. For example, in bitbake.conf the recipe name and version are used to set the variables - PN and - PV: + PN and + PV: PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}" PV = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or '1.0'}" @@ -336,7 +336,7 @@ recipe information. The validity of this cache is determined by first computing a checksum of the base configuration data (see - BB_HASHCONFIG_WHITELIST) + BB_HASHCONFIG_WHITELIST) and then checking if the checksum matches. If that checksum matches what is in the cache and the recipe and class files have not changed, Bitbake is able to use @@ -384,9 +384,9 @@ the recipe can be known. Each recipe's PROVIDES list is created implicitly through the recipe's - PN variable + PN variable and explicitly through the recipe's - PROVIDES + PROVIDES variable, which is optional. @@ -427,7 +427,7 @@ PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" The default - PREFERRED_PROVIDER + PREFERRED_PROVIDER is the provider with the same name as the target. Bitbake iterates through each target it needs to build and resolves them and their dependencies using this process. @@ -439,10 +439,10 @@ BitBake defaults to the highest version of a provider. Version comparisons are made using the same method as Debian. You can use the - PREFERRED_VERSION + PREFERRED_VERSION variable to specify a particular version. You can influence the order by using the - DEFAULT_PREFERENCE + DEFAULT_PREFERENCE variable. @@ -464,7 +464,7 @@ BitBake defaults to selecting the most recent version, unless otherwise specified. If the recipe in question has a - DEFAULT_PREFERENCE + DEFAULT_PREFERENCE set lower than the other recipes (default is 0), then it will not be selected. This allows the person or persons maintaining @@ -475,9 +475,9 @@ If the first recipe is named a_1.1.bb, then the - PN variable + PN variable will be set to “a”, and the - PV + PV variable will be set to 1.1. @@ -532,11 +532,11 @@ Dependencies are defined through several variables. You can find information about variables BitBake uses in - the Variables Glossary + the Variables Glossary near the end of this manual. At a basic level, it is sufficient to know that BitBake uses the - DEPENDS and - RDEPENDS variables when + DEPENDS and + RDEPENDS variables when calculating dependencies. @@ -560,7 +560,7 @@ The build now starts with BitBake forking off threads up to the limit set in the - BB_NUMBER_THREADS + BB_NUMBER_THREADS variable. BitBake continues to fork threads as long as there are tasks ready to run, those tasks have all their dependencies met, and the thread threshold has not been @@ -574,7 +574,7 @@ As each task completes, a timestamp is written to the directory specified by the - STAMP variable. + STAMP variable. On subsequent runs, BitBake looks in the build directory within tmp/stamps and does not rerun tasks that are already completed unless a timestamp is found to be invalid. @@ -618,7 +618,7 @@ Tasks can be either a shell task or a Python task. For shell tasks, BitBake writes a shell script to - ${T}/run.do_taskname.pid + ${T}/run.do_taskname.pid and then executes the script. The generated shell script contains all the exported variables, and the shell functions with all variables expanded. @@ -645,10 +645,10 @@ behavior: - BB_SCHEDULER + BB_SCHEDULER - BB_SCHEDULERS + BB_SCHEDULERS It is possible to have functions run before and after a task's main @@ -684,7 +684,7 @@ The simplistic approach for excluding the working directory is to set it to some fixed value and create the checksum for the "run" script. BitBake goes one step better and uses the - BB_HASHBASE_WHITELIST + BB_HASHBASE_WHITELIST variable to define a list of variables that should never be included when generating the signatures. @@ -795,7 +795,7 @@ This results in any metadata change that changes the task hash, automatically causing the task to be run again. This removes the need to bump - PR + PR values, and changes to metadata automatically ripple across the build. @@ -884,7 +884,7 @@ BitBake first calls the function defined by the - BB_HASHCHECK_FUNCTION + BB_HASHCHECK_FUNCTION variable with a list of tasks and corresponding hashes it wants to build. This function is designed to be fast and returns a list @@ -908,7 +908,7 @@ For example, it is pointless to obtain a compiler if you already have the compiled binary. To handle this, BitBake calls the - BB_SETSCENE_DEPVALID + BB_SETSCENE_DEPVALID function for each successful setscene task to know whether or not it needs to obtain the dependencies of that task. @@ -916,7 +916,7 @@ Finally, after all the setscene tasks have executed, BitBake calls the function listed in - BB_SETSCENE_VERIFY_FUNCTION2 + BB_SETSCENE_VERIFY_FUNCTION2 with the list of tasks BitBake thinks has been "covered". The metadata can then ensure that this list is correct and can inform BitBake that it wants specific tasks to be run regardless diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 92b2c3d1be..3acd7c403e 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -44,7 +44,7 @@ This code sets up an instance of the fetch class. The instance uses a space-separated list of URLs from the - SRC_URI + SRC_URI variable and then calls the download method to download the files. @@ -78,7 +78,7 @@ Pre-mirror Sites: BitBake first uses pre-mirrors to try and find source files. These locations are defined using the - PREMIRRORS + PREMIRRORS variable. Source URI: @@ -88,7 +88,7 @@ Mirror Sites: If fetch failures occur, BitBake next uses mirror locations as defined by the - MIRRORS + MIRRORS variable. @@ -144,7 +144,7 @@ Any source files that are not local (i.e. downloaded from the Internet) are placed into the download directory, which is specified by the - DL_DIR + DL_DIR variable. @@ -184,11 +184,11 @@ If - BB_STRICT_CHECKSUM + BB_STRICT_CHECKSUM is set, any download without a checksum triggers an error message. The - BB_NO_NETWORK + BB_NO_NETWORK variable can be used to make any attempted network access a fatal error, which is useful for checking that mirrors are complete as well as other things. @@ -265,11 +265,11 @@ The filename you specify within the URL can be either an absolute or relative path to a file. If the filename is relative, the contents of the - FILESPATH + FILESPATH variable is used in the same way PATH is used to find executables. If the file cannot be found, it is assumed that it is available in - DL_DIR + DL_DIR by the time the download() method is called. @@ -304,7 +304,7 @@ allows the name of the downloaded file to be specified. Specifying the name of the downloaded file is useful for avoiding collisions in - DL_DIR + DL_DIR when dealing with multiple files that have the same name. @@ -355,7 +355,7 @@ A special value of "now" causes the checkout to be updated on every build. - CVSDIR: + CVSDIR: Specifies where a temporary checkout is saved. The location is often DL_DIR/cvs. @@ -395,7 +395,7 @@ "date": Specifies a date. If no "date" is specified, the - SRCDATE + SRCDATE of the configuration is used to checkout a specific date. The special value of "now" causes the checkout to be updated on every build. @@ -406,7 +406,7 @@ to which the module is unpacked. You are forcing the module into a special directory relative to - CVSDIR. + CVSDIR. "rsh" Used in conjunction with the "method" parameter. @@ -448,7 +448,7 @@ FETCHCMD_svn, which defaults to "svn". The fetcher's temporary working directory is set by - SVNDIR, + SVNDIR, which is usually DL_DIR/svn. @@ -509,7 +509,7 @@ source control system. The fetcher works by creating a bare clone of the remote into - GITDIR, + GITDIR, which is usually DL_DIR/git2. This bare clone is then cloned into the work directory during the unpack stage when a specific tree is checked out. @@ -612,7 +612,7 @@ This fetcher submodule inherits from the Git fetcher and extends that fetcher's behavior by fetching a repository's submodules. - SRC_URI + SRC_URI is passed to the Git fetcher as described in the "Git Fetcher (git://)" section. @@ -647,9 +647,9 @@ To use this fetcher, make sure your recipe has proper - SRC_URI, - SRCREV, and - PV settings. + SRC_URI, + SRCREV, and + PV settings. Here is an example: SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" @@ -734,15 +734,15 @@ FETCHCMD_p4, which defaults to "p4". The fetcher's temporary working directory is set by - P4DIR, + P4DIR, which defaults to "DL_DIR/p4". To use this fetcher, make sure your recipe has proper - SRC_URI, - SRCREV, and - PV values. + SRC_URI, + SRCREV, and + PV values. The p4 executable is able to use the config file defined by your system's P4CONFIG environment variable in order to define the Perforce server URL and port, username, and @@ -793,9 +793,9 @@ google-repo source control system. The fetcher works by initiating and syncing sources of the repository into - REPODIR, + REPODIR, which is usually - DL_DIR/repo. + DL_DIR/repo. diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml index 9076f0fcd4..39066e4b15 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml @@ -194,7 +194,7 @@ When you run BitBake, it begins looking for metadata files. The - BBPATH + BBPATH variable is what tells BitBake where to look for those files. BBPATH is not set and you need to set it. Without BBPATH, Bitbake cannot @@ -273,14 +273,14 @@ some editor to create the bitbake.conf so that it contains the following: - PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}" + PN = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}" - TMPDIR = "${TOPDIR}/tmp" - CACHE = "${TMPDIR}/cache" - STAMP = "${TMPDIR}/${PN}/stamps" - T = "${TMPDIR}/${PN}/work" - B = "${TMPDIR}/${PN}" + TMPDIR = "${TOPDIR}/tmp" + CACHE = "${TMPDIR}/cache" + STAMP = "${TMPDIR}/${PN}/stamps" + T = "${TMPDIR}/${PN}/work" + B = "${TMPDIR}/${PN}" Without a value for PN, the @@ -402,12 +402,12 @@ Move to the conf directory and create a layer.conf file that has the following: - BBPATH .= ":${LAYERDIR}" + BBPATH .= ":${LAYERDIR}" - BBFILES += "${LAYERDIR}/*.bb" + BBFILES += "${LAYERDIR}/*.bb" - BBFILE_COLLECTIONS += "mylayer" - BBFILE_PATTERN_mylayer := "^${LAYERDIR_RE}/" + BBFILE_COLLECTIONS += "mylayer" + BBFILE_PATTERN_mylayer := "^${LAYERDIR_RE}/" For information on these variables, click the links to go to the definitions in the glossary. @@ -416,9 +416,9 @@ a recipe file named printhello.bb that has the following: - DESCRIPTION = "Prints Hello World" - PN = 'printhello' - PV = '1' + DESCRIPTION = "Prints Hello World" + PN = 'printhello' + PV = '1' python do_build() { bb.plain("********************"); diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml index f7d312a32b..02058a6f62 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml @@ -781,7 +781,7 @@ target, you must also enable BitBake to perform multiple configuration builds. Enabling is accomplished by setting the - BBMULTICONFIG + BBMULTICONFIG variable in the local.conf configuration file. As an example, suppose you had configuration files diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml index 2490f6e4ba..d00f8a545f 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml @@ -595,7 +595,7 @@ BitBake uses - OVERRIDES + OVERRIDES to control what variables are overridden after BitBake parses recipes and configuration files. This section describes how you can use @@ -705,7 +705,7 @@ Internally, this is implemented by prepending the task (e.g. "task-compile:") to the value of - OVERRIDES + OVERRIDES for the local datastore of the do_compile task. @@ -868,7 +868,7 @@ BitBake uses the - BBPATH + BBPATH variable to locate needed include and class files. Additionally, BitBake searches the current directory for include and require @@ -1086,7 +1086,7 @@ When creating a configuration file (.conf), you can use the - INHERIT + INHERIT configuration directive to inherit a class. BitBake only supports this directive when used within a configuration file. @@ -1370,7 +1370,7 @@ BitBake-style Python functions generate a separate - ${T}/run.function-name.pid + ${T}/run.function-name.pid script that is executed to run the function, and also generate a log file in ${T}/log.function-name.pid @@ -1773,7 +1773,7 @@ things exported or listed in its whitelist to ensure that the build environment is reproducible and consistent. You can prevent this "cleaning" by setting the - BB_PRESERVE_ENV + BB_PRESERVE_ENV variable. Consequently, if you do want something to get passed into the @@ -1783,9 +1783,9 @@ Tell BitBake to load what you want from the environment into the datastore. You can do so through the - BB_ENV_WHITELIST + BB_ENV_WHITELIST and - BB_ENV_EXTRAWHITE + BB_ENV_EXTRAWHITE variables. For example, assume you want to prevent the build system from accessing your $HOME/.ccache @@ -1824,7 +1824,7 @@ from the original execution environment. Bitbake saves a copy of the original environment into a special variable named - BB_ORIGENV. + BB_ORIGENV. @@ -1883,7 +1883,7 @@ [depends]: Controls inter-task dependencies. See the - DEPENDS + DEPENDS variable and the "Inter-Task Dependencies" section for more information. @@ -1891,7 +1891,7 @@ [deptask]: Controls task build-time dependencies. See the - DEPENDS + DEPENDS variable and the "Build Dependencies" section for more information. @@ -1937,7 +1937,7 @@ of cores but certain tasks need to be rate-limited due to various kinds of resource constraints (e.g. to avoid network throttling). number_threads works similarly to the - BB_NUMBER_THREADS + BB_NUMBER_THREADS variable but is task-specific. Set the value globally. @@ -1971,9 +1971,9 @@ [rdepends]: Controls inter-task runtime dependencies. See the - RDEPENDS + RDEPENDS variable, the - RRECOMMENDS + RRECOMMENDS variable, and the "Inter-Task Dependencies" section for more information. @@ -1981,9 +1981,9 @@ [rdeptask]: Controls task runtime dependencies. See the - RDEPENDS + RDEPENDS variable, the - RRECOMMENDS + RRECOMMENDS variable, and the "Runtime Dependencies" section for more information. @@ -1996,9 +1996,9 @@ [recrdeptask]: Controls task recursive runtime dependencies. See the - RDEPENDS + RDEPENDS variable, the - RRECOMMENDS + RRECOMMENDS variable, and the "Recursive Dependencies" section for more information. @@ -2127,7 +2127,7 @@ Any given datastore only has one such event executed against it, however. If - BB_INVALIDCONF + BB_INVALIDCONF is set in the datastore by the event handler, the configuration is reparsed and a new event triggered, allowing the metadata to update configuration. @@ -2256,17 +2256,17 @@ from a single recipe file multiple incarnations of that recipe file where all incarnations are buildable. These features are enabled through the - BBCLASSEXTEND + BBCLASSEXTEND and - BBVERSIONS + BBVERSIONS variables. The mechanism for this class extension is extremely specific to the implementation. Usually, the recipe's - PROVIDES, - PN, and - DEPENDS + PROVIDES, + PN, and + DEPENDS variables would need to be modified by the extension class. For specific examples, see the OE-Core native, nativesdk, @@ -2287,7 +2287,7 @@ project from a single recipe file. You can also specify conditional metadata (using the - OVERRIDES + OVERRIDES mechanism) for a single version, or an optionally named range of versions. Here is an example: @@ -2306,7 +2306,7 @@ into overrides, but it is also made available for the metadata to use in the variable that defines the base recipe versions for use in file:// search paths - (FILESPATH). + (FILESPATH). @@ -2408,7 +2408,7 @@ BitBake uses the - DEPENDS + DEPENDS variable to manage build time dependencies. The [deptask] varflag for tasks signifies the task of each @@ -2429,9 +2429,9 @@ BitBake uses the - PACKAGES, - RDEPENDS, and - RRECOMMENDS + PACKAGES, + RDEPENDS, and + RRECOMMENDS variables to manage runtime dependencies. @@ -2686,7 +2686,7 @@ These checksums are stored in - STAMP. + STAMP. You can examine the checksums using the following BitBake command: $ bitbake-dumpsigs @@ -2708,44 +2708,44 @@ The following list describes related variables: - BB_HASHCHECK_FUNCTION: + BB_HASHCHECK_FUNCTION: Specifies the name of the function to call during the "setscene" part of the task's execution in order to validate the list of task hashes. - BB_SETSCENE_DEPVALID: + BB_SETSCENE_DEPVALID: Specifies a function BitBake calls that determines whether BitBake requires a setscene dependency to be met. - BB_SETSCENE_VERIFY_FUNCTION2: + BB_SETSCENE_VERIFY_FUNCTION2: Specifies a function to call that verifies the list of planned task execution before the main task execution happens. - BB_STAMP_POLICY: + BB_STAMP_POLICY: Defines the mode for comparing timestamps of stamp files. - BB_STAMP_WHITELIST: + BB_STAMP_WHITELIST: Lists stamp files that are looked at when the stamp policy is "whitelist". - BB_TASKHASH: + BB_TASKHASH: Within an executing task, this variable holds the hash of the task as returned by the currently enabled signature generator. - STAMP: + STAMP: The base path to create stamp files. - STAMPCLEAN: + STAMPCLEAN: Again, the base path to create stamp files but can use wildcards for matching a range of files for clean operations. diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml index a84b2bc994..aca6741c21 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml @@ -3,7 +3,7 @@ [ %poky; ] > - + Variables Glossary @@ -34,29 +34,29 @@ - + - A - B - C - D - E - F - G - H - + A + B + C + D + E + F + G + H + I - L - M + L + M - O - P + O + P - R - S - T + R + S + T @@ -65,13 +65,13 @@ - A + A - ASSUME_PROVIDED + ASSUME_PROVIDED Lists recipe names - (PN + (PN values) BitBake does not attempt to build. Instead, BitBake assumes these recipes have already been built. @@ -91,9 +91,9 @@ - B + B - B + B The directory in which BitBake executes functions @@ -102,7 +102,7 @@ - BB_ALLOWED_NETWORKS + BB_ALLOWED_NETWORKS Specifies a space-delimited list of hosts that the fetcher @@ -111,7 +111,7 @@ This host list is only used if - BB_NO_NETWORK + BB_NO_NETWORK is either not set or set to "0". @@ -151,13 +151,13 @@ Using BB_ALLOWED_NETWORKS in conjunction with - PREMIRRORS + PREMIRRORS is very useful. Adding the host you want to use to PREMIRRORS results in the source code being fetched from an allowed location and avoids raising an error when a host that is not allowed is in a - SRC_URI + SRC_URI statement. This is because the fetcher does not attempt to use the host listed in SRC_URI after a @@ -167,7 +167,7 @@ - BB_CONSOLELOG + BB_CONSOLELOG Specifies the path to a log file into which BitBake's user @@ -176,7 +176,7 @@ - BB_CURRENTTASK + BB_CURRENTTASK Contains the name of the currently running task. @@ -186,7 +186,7 @@ - BB_DANGLINGAPPENDS_WARNONLY + BB_DANGLINGAPPENDS_WARNONLY Defines how BitBake handles situations where an append @@ -208,7 +208,7 @@ - BB_DEFAULT_TASK + BB_DEFAULT_TASK The default task to use when none is specified (e.g. @@ -219,7 +219,7 @@ - BB_DISKMON_DIRS + BB_DISKMON_DIRS Monitors disk space and available inodes during the build @@ -245,7 +245,7 @@ build when a threshold is broken. Subsequent warnings are issued as defined by the - BB_DISKMON_WARNINTERVAL variable, + BB_DISKMON_WARNINTERVAL variable, which must be defined. <dir> is: @@ -275,7 +275,7 @@ BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" The first example works only if you also set - the BB_DISKMON_WARNINTERVAL variable. + the BB_DISKMON_WARNINTERVAL variable. This example causes the build system to immediately abort when either the disk space in ${TMPDIR} drops below 1 Gbyte or the available free inodes drops below @@ -309,7 +309,7 @@ - BB_DISKMON_WARNINTERVAL + BB_DISKMON_WARNINTERVAL Defines the disk space and free inode warning intervals. @@ -319,7 +319,7 @@ If you are going to use the BB_DISKMON_WARNINTERVAL variable, you must also use the - BB_DISKMON_DIRS variable + BB_DISKMON_DIRS variable and define its action as "WARN". During the build, subsequent warnings are issued each time disk space or number of free inodes further reduces by @@ -374,7 +374,7 @@ - BB_ENV_WHITELIST + BB_ENV_WHITELIST Specifies the internal whitelist of variables to allow @@ -382,11 +382,11 @@ datastore. If the value of this variable is not specified (which is the default), the following list is used: - BBPATH, - BB_PRESERVE_ENV, - BB_ENV_WHITELIST, + BBPATH, + BB_PRESERVE_ENV, + BB_ENV_WHITELIST, and - BB_ENV_EXTRAWHITE. + BB_ENV_EXTRAWHITE. You must set this variable in the external environment in order for it to work. @@ -395,7 +395,7 @@ - BB_ENV_EXTRAWHITE + BB_ENV_EXTRAWHITE Specifies an additional set of variables to allow through @@ -403,7 +403,7 @@ datastore. This list of variables are on top of the internal list set in - BB_ENV_WHITELIST. + BB_ENV_WHITELIST. You must set this variable in the external environment in order for it to work. @@ -412,22 +412,22 @@ - BB_FETCH_PREMIRRORONLY + BB_FETCH_PREMIRRORONLY When set to "1", causes BitBake's fetcher module to only search - PREMIRRORS + PREMIRRORS for files. BitBake will not search the main - SRC_URI + SRC_URI or - MIRRORS. + MIRRORS. - BB_FILENAME + BB_FILENAME Contains the filename of the recipe that owns the currently @@ -440,12 +440,12 @@ - BB_GENERATE_MIRROR_TARBALLS + BB_GENERATE_MIRROR_TARBALLS Causes tarballs of the Git repositories, including the Git metadata, to be placed in the - DL_DIR + DL_DIR directory. Anyone wishing to create a source mirror would want to enable this variable. @@ -461,7 +461,7 @@ - BB_HASHCONFIG_WHITELIST + BB_HASHCONFIG_WHITELIST Lists variables that are excluded from base configuration @@ -485,7 +485,7 @@ - BB_HASHBASE_WHITELIST + BB_HASHBASE_WHITELIST Lists variables that are excluded from checksum and @@ -500,7 +500,7 @@ - BB_HASHCHECK_FUNCTION + BB_HASHCHECK_FUNCTION Specifies the name of the function to call during the @@ -524,7 +524,7 @@ - BB_INVALIDCONF + BB_INVALIDCONF Used in combination with the @@ -539,11 +539,11 @@ - BB_LOGFMT + BB_LOGFMT Specifies the name of the log files saved into - ${T}. + ${T}. By default, the BB_LOGFMT variable is undefined and the log file names get created using the following form: @@ -556,7 +556,7 @@ - BB_NICE_LEVEL + BB_NICE_LEVEL Allows BitBake to run at a specific priority @@ -564,13 +564,13 @@ System permissions usually mean that BitBake can reduce its priority but not raise it again. See - BB_TASK_NICE_LEVEL + BB_TASK_NICE_LEVEL for additional information. - BB_NO_NETWORK + BB_NO_NETWORK Disables network access in the BitBake fetcher modules. @@ -587,7 +587,7 @@ - BB_NUMBER_THREADS + BB_NUMBER_THREADS The maximum number of tasks BitBake should run in parallel @@ -599,7 +599,7 @@ - BB_NUMBER_PARSE_THREADS + BB_NUMBER_PARSE_THREADS Sets the number of threads BitBake uses when parsing. @@ -609,7 +609,7 @@ - BB_ORIGENV + BB_ORIGENV Contains a copy of the original external environment in @@ -625,7 +625,7 @@ - BB_PRESERVE_ENV + BB_PRESERVE_ENV Disables whitelisting and instead allows all variables @@ -639,12 +639,12 @@ - BB_RUNFMT + BB_RUNFMT Specifies the name of the executable script files (i.e. run files) saved into - ${T}. + ${T}. By default, the BB_RUNFMT variable is undefined and the run file names get created using the following form: @@ -657,7 +657,7 @@ - BB_RUNTASK + BB_RUNTASK Contains the name of the currently executing task. @@ -669,7 +669,7 @@ - BB_SCHEDULER + BB_SCHEDULER Selects the name of the scheduler to use for the @@ -695,7 +695,7 @@ - BB_SCHEDULERS + BB_SCHEDULERS Defines custom schedulers to import. @@ -705,13 +705,13 @@ For information how to select a scheduler, see the - BB_SCHEDULER + BB_SCHEDULER variable. - BB_SETSCENE_DEPVALID + BB_SETSCENE_DEPVALID Specifies a function BitBake calls that determines @@ -731,7 +731,7 @@ - BB_SETSCENE_VERIFY_FUNCTION2 + BB_SETSCENE_VERIFY_FUNCTION2 Specifies a function to call that verifies the list of @@ -752,7 +752,7 @@ - BB_SIGNATURE_EXCLUDE_FLAGS + BB_SIGNATURE_EXCLUDE_FLAGS Lists variable flags (varflags) @@ -771,7 +771,7 @@ - BB_SIGNATURE_HANDLER + BB_SIGNATURE_HANDLER Defines the name of the signature handler BitBake uses. @@ -790,7 +790,7 @@ - BB_SRCREV_POLICY + BB_SRCREV_POLICY Defines the behavior of the fetcher when it interacts with @@ -817,7 +817,7 @@ - BB_STAMP_POLICY + BB_STAMP_POLICY Defines the mode used for how timestamps of stamp files @@ -836,7 +836,7 @@ whitelist - Identical to "full" mode except timestamp comparisons are made for recipes listed in the - BB_STAMP_WHITELIST + BB_STAMP_WHITELIST variable. @@ -848,19 +848,19 @@ - BB_STAMP_WHITELIST + BB_STAMP_WHITELIST Lists files whose stamp file timestamps are compared when the stamp policy mode is set to "whitelist". For information on stamp policies, see the - BB_STAMP_POLICY + BB_STAMP_POLICY variable. - BB_STRICT_CHECKSUM + BB_STRICT_CHECKSUM Sets a more strict checksum mechanism for non-local URLs. @@ -871,7 +871,7 @@ - BB_TASK_IONICE_LEVEL + BB_TASK_IONICE_LEVEL Allows adjustment of a task's Input/Output priority. @@ -882,7 +882,7 @@ variable to adjust the I/O priority of these tasks. This variable works similarly to the - BB_TASK_NICE_LEVEL + BB_TASK_NICE_LEVEL variable except with a task's I/O priorities. @@ -921,7 +921,7 @@ - BB_TASK_NICE_LEVEL + BB_TASK_NICE_LEVEL Allows specific tasks to change their priority @@ -940,7 +940,7 @@ - BB_TASKHASH + BB_TASKHASH Within an executing task, this variable holds the hash @@ -950,7 +950,7 @@ - BB_VERBOSE_LOGS + BB_VERBOSE_LOGS Controls how verbose BitBake is during builds. @@ -960,7 +960,7 @@ - BB_WORKERCONTEXT + BB_WORKERCONTEXT Specifies if the current context is executing a task. @@ -973,7 +973,7 @@ - BBCLASSEXTEND + BBCLASSEXTEND Allows you to extend a recipe so that it builds variants @@ -1009,7 +1009,7 @@ _class-native. For example, to generate a native version of a recipe, a - DEPENDS + DEPENDS on "foo" is rewritten to a DEPENDS on "foo-native". @@ -1028,7 +1028,7 @@ - BBDEBUG + BBDEBUG Sets the BitBake debug output level to a specific value @@ -1042,7 +1042,7 @@ - BBFILE_COLLECTIONS + BBFILE_COLLECTIONS Lists the names of configured layers. These names are used to find the other BBFILE_* @@ -1053,10 +1053,10 @@ - BBFILE_PATTERN + BBFILE_PATTERN Variable that expands to match files from - BBFILES + BBFILES in a particular layer. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer (e.g. @@ -1064,7 +1064,7 @@ - BBFILE_PRIORITY + BBFILE_PRIORITY Assigns the priority for recipe files in each layer. This variable is useful in situations where the same recipe appears in @@ -1074,7 +1074,7 @@ letting you control the precedence for the multiple layers. The precedence established through this variable stands regardless of a recipe's version - (PV variable). + (PV variable). For example, a layer that has a recipe with a higher PV value but for which the BBFILE_PRIORITY is set to have a lower precedence still has a lower precedence. @@ -1083,7 +1083,7 @@ For example, the value 6 has a higher precedence than the value 5. If not specified, the BBFILE_PRIORITY variable is set based on layer dependencies (see the - LAYERDEPENDS variable for + LAYERDEPENDS variable for more information. The default priority, if unspecified for a layer with no dependencies, is the lowest defined priority + 1 @@ -1095,7 +1095,7 @@ - BBFILES + BBFILES A space-separated list of recipe files BitBake uses to @@ -1113,7 +1113,7 @@ - BBINCLUDED + BBINCLUDED Contains a space-separated list of all of all files that @@ -1123,7 +1123,7 @@ - BBINCLUDELOGS + BBINCLUDELOGS If set to a value, enables printing the task log when @@ -1132,11 +1132,11 @@ - BBINCLUDELOGS_LINES + BBINCLUDELOGS_LINES If - BBINCLUDELOGS + BBINCLUDELOGS is set, specifies the maximum number of lines from the task log file to print when reporting a failed task. If you do not set BBINCLUDELOGS_LINES, @@ -1145,7 +1145,7 @@ - BBLAYERS + BBLAYERS Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration @@ -1166,7 +1166,7 @@ - BBLAYERS_FETCH_DIR + BBLAYERS_FETCH_DIR Sets the base location where layers are stored. @@ -1178,7 +1178,7 @@ - BBMASK + BBMASK Prevents BitBake from processing recipes and recipe @@ -1236,7 +1236,7 @@ - BBMULTICONFIG + BBMULTICONFIG BBMULTICONFIG[doc] = "Enables BitBake to perform multiple configuration builds and lists each separate configuration (multiconfig)." @@ -1275,7 +1275,7 @@ - BBPATH + BBPATH Used by BitBake to locate class @@ -1302,7 +1302,7 @@ - BBSERVER + BBSERVER Points to the server that runs memory-resident BitBake. @@ -1312,7 +1312,7 @@ - BBTARGETS + BBTARGETS Allows you to use a configuration file to add to the list @@ -1321,14 +1321,14 @@ - BBVERSIONS + BBVERSIONS Allows a single recipe to build multiple versions of a project from a single recipe file. You also able to specify conditional metadata using the - OVERRIDES + OVERRIDES mechanism for a single version or for an optionally named range of versions. @@ -1342,7 +1342,7 @@ - BITBAKE_UI + BITBAKE_UI Used to specify the UI module to use when running BitBake. @@ -1356,7 +1356,7 @@ - BUILDNAME + BUILDNAME A name assigned to the build. @@ -1366,7 +1366,7 @@ - BZRDIR + BZRDIR The directory in which files checked out of a Bazaar @@ -1377,9 +1377,9 @@ - C + C - CACHE + CACHE Specifies the directory BitBake uses to store a cache @@ -1389,7 +1389,7 @@ - CVSDIR + CVSDIR The directory in which files checked out under the @@ -1400,9 +1400,9 @@ - D + D - DEFAULT_PREFERENCE + DEFAULT_PREFERENCE Specifies a weak bias for recipe selection priority. @@ -1413,20 +1413,20 @@ piece of software. Using the variable in this way causes the stable version of the recipe to build by default in the absence of - PREFERRED_VERSION + PREFERRED_VERSION being used to build the development version. The bias provided by DEFAULT_PREFERENCE is weak and is overridden by - BBFILE_PRIORITY + BBFILE_PRIORITY if that variable is different between two layers that contain different versions of the same recipe. - DEPENDS + DEPENDS Lists a recipe's build-time dependencies @@ -1451,13 +1451,13 @@ For information on runtime dependencies, see the - RDEPENDS + RDEPENDS variable. - DESCRIPTION + DESCRIPTION A long description for the recipe. @@ -1465,7 +1465,7 @@ - DL_DIR + DL_DIR The central download directory used by the build process to @@ -1474,7 +1474,7 @@ suitable for mirroring for everything except Git repositories. If you want tarballs of Git repositories, use the - BB_GENERATE_MIRROR_TARBALLS + BB_GENERATE_MIRROR_TARBALLS variable. @@ -1482,9 +1482,9 @@ - E + E - EXCLUDE_FROM_WORLD + EXCLUDE_FROM_WORLD Directs BitBake to exclude a recipe from world builds (i.e. @@ -1512,9 +1512,9 @@ - F + F - FAKEROOT + FAKEROOT Contains the command to use when running a shell script @@ -1527,19 +1527,19 @@ - FAKEROOTBASEENV + FAKEROOTBASEENV Lists environment variables to set when executing the command defined by - FAKEROOTCMD + FAKEROOTCMD that starts the bitbake-worker process in the fakeroot environment. - FAKEROOTCMD + FAKEROOTCMD Contains the command that starts the bitbake-worker @@ -1548,7 +1548,7 @@ - FAKEROOTDIRS + FAKEROOTDIRS Lists directories to create before running a task in @@ -1557,33 +1557,33 @@ - FAKEROOTENV + FAKEROOTENV Lists environment variables to set when running a task in the fakeroot environment. For additional information on environment variables and the fakeroot environment, see the - FAKEROOTBASEENV + FAKEROOTBASEENV variable. - FAKEROOTNOENV + FAKEROOTNOENV Lists environment variables to set when running a task that is not in the fakeroot environment. For additional information on environment variables and the fakeroot environment, see the - FAKEROOTENV + FAKEROOTENV variable. - FETCHCMD + FETCHCMD Defines the command the BitBake fetcher module @@ -1595,7 +1595,7 @@ - FILE + FILE Points at the current file. @@ -1607,7 +1607,7 @@ - FILESPATH + FILESPATH Specifies directories BitBake uses when searching for @@ -1625,9 +1625,9 @@ - G + G - GITDIR + GITDIR The directory in which a local copy of a Git repository @@ -1639,9 +1639,9 @@ - H + H - HGDIR + HGDIR The directory in which files checked out of a Mercurial @@ -1650,7 +1650,7 @@ - HOMEPAGE + HOMEPAGE Website where more information about the software the recipe is building can be found. @@ -1659,9 +1659,9 @@ - I + I - INHERIT + INHERIT Causes the named class or classes to be inherited globally. @@ -1691,15 +1691,15 @@ --> - L + L - LAYERDEPENDS + LAYERDEPENDS Lists the layers, separated by spaces, upon which this recipe depends. Optionally, you can specify a specific layer version for a dependency by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" to be compared against - LAYERVERSION_anotherlayer + LAYERVERSION_anotherlayer in this case). BitBake produces an error if any dependency is missing or the version numbers do not match exactly (if specified). @@ -1710,7 +1710,7 @@ - LAYERDIR + LAYERDIR When used inside the layer.conf configuration file, this variable provides the path of the current layer. @@ -1719,22 +1719,22 @@ - LAYERDIR_RE + LAYERDIR_RE When used inside the layer.conf configuration file, this variable provides the path of the current layer, escaped for use in a regular expression - (BBFILE_PATTERN). + (BBFILE_PATTERN). This variable is not available outside of layer.conf and references are expanded immediately when parsing of the file completes. - LAYERVERSION + LAYERVERSION Optionally specifies the version of a layer as a single number. You can use this variable within - LAYERDEPENDS + LAYERDEPENDS for another layer in order to depend on a specific version of the layer. @@ -1744,7 +1744,7 @@ - LICENSE + LICENSE The list of source licenses for the recipe. @@ -1754,9 +1754,9 @@ - M + M - MIRRORS + MIRRORS Specifies additional paths from which BitBake gets source code. @@ -1764,14 +1764,14 @@ tries the local download directory. If that location fails, the build system tries locations defined by - PREMIRRORS, + PREMIRRORS, the upstream source, and then locations specified by MIRRORS in that order. - MULTI_PROVIDER_WHITELIST + MULTI_PROVIDER_WHITELIST Allows you to suppress BitBake warnings caused when @@ -1804,9 +1804,9 @@ --> - O + O - OVERRIDES + OVERRIDES BitBake uses OVERRIDES to control @@ -1829,9 +1829,9 @@ - P + P - P4DIR + P4DIR The directory in which a local copy of a Perforce depot @@ -1840,14 +1840,14 @@ - PACKAGES + PACKAGES The list of packages the recipe creates. - PACKAGES_DYNAMIC + PACKAGES_DYNAMIC A promise that your recipe satisfies runtime dependencies @@ -1856,7 +1856,7 @@ does not actually satisfy the dependencies, it only states that they should be satisfied. For example, if a hard, runtime dependency - (RDEPENDS) + (RDEPENDS) of another package is satisfied during the build through the PACKAGES_DYNAMIC variable, but a package with the module name is never actually @@ -1865,7 +1865,7 @@ - PE + PE The epoch of the recipe. @@ -1877,7 +1877,7 @@ - PERSISTENT_DIR + PERSISTENT_DIR Specifies the directory BitBake uses to store data that @@ -1889,7 +1889,7 @@ - PF + PF Specifies the recipe or package name and includes all version and revision @@ -1899,27 +1899,27 @@ - PN + PN The recipe name. - PR + PR The revision of the recipe. - PREFERRED_PROVIDER + PREFERRED_PROVIDER Determines which recipe should be given preference when multiple recipes provide the same item. You should always suffix the variable with the name of the provided item, and you should set it to the - PN + PN of the recipe to which you want to give precedence. Some examples: @@ -1931,14 +1931,14 @@ - PREFERRED_PROVIDERS + PREFERRED_PROVIDERS Determines which recipe should be given preference for cases where multiple recipes provide the same item. Functionally, PREFERRED_PROVIDERS is identical to - PREFERRED_PROVIDER. + PREFERRED_PROVIDER. However, the PREFERRED_PROVIDERS variable lets you define preferences for multiple situations using the following form: @@ -1954,15 +1954,15 @@ - PREFERRED_VERSION + PREFERRED_VERSION If there are multiple versions of recipes available, this variable determines which recipe should be given preference. You must always suffix the variable with the - PN + PN you want to select, and you should set - PV + PV accordingly for precedence. @@ -1989,7 +1989,7 @@ - PREMIRRORS + PREMIRRORS Specifies additional paths from which BitBake gets source code. @@ -1998,7 +1998,7 @@ If that location fails, the build system tries locations defined by PREMIRRORS, the upstream source, and then locations specified by - MIRRORS + MIRRORS in that order. @@ -2022,20 +2022,20 @@ - PROVIDES + PROVIDES A list of aliases by which a particular recipe can be known. By default, a recipe's own - PN + PN is implicitly already in its PROVIDES list. If a recipe uses PROVIDES, the additional aliases are synonyms for the recipe and can be useful satisfying dependencies of other recipes during the build as specified by - DEPENDS. + DEPENDS. @@ -2059,7 +2059,7 @@ virtual target in PROVIDES. Recipes that depend on the functionality in question can include the virtual target in - DEPENDS + DEPENDS to leave the choice of provider open. @@ -2072,11 +2072,11 @@ - PRSERV_HOST + PRSERV_HOST The network based - PR + PR service host and port. @@ -2094,7 +2094,7 @@ - PV + PV The version of the recipe. @@ -2108,9 +2108,9 @@ --> - R + R - RDEPENDS + RDEPENDS Lists a package's runtime dependencies (i.e. other packages) @@ -2165,13 +2165,13 @@ For information on build-time dependencies, see the - DEPENDS + DEPENDS variable. - REPODIR + REPODIR The directory in which a local copy of a @@ -2181,14 +2181,14 @@ - RPROVIDES + RPROVIDES A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target (as specified by - RDEPENDS). + RDEPENDS). As with all package-controlling variables, you must always @@ -2201,7 +2201,7 @@ - RRECOMMENDS + RRECOMMENDS A list of packages that extends the usability of a package @@ -2210,7 +2210,7 @@ packages in order to successfully build, but needs them for the extended usability. To specify runtime dependencies for packages, see the - RDEPENDS + RDEPENDS variable. @@ -2243,15 +2243,15 @@ - S + S - SECTION + SECTION The section in which packages should be categorized. - SRC_URI + SRC_URI The list of source files - local or remote. @@ -2272,7 +2272,7 @@ the metadata, from the local machine. The path is relative to the - FILESPATH + FILESPATH variable. bzr:// - Fetches files from a Bazaar revision control repository. @@ -2322,7 +2322,7 @@ - SRCDATE + SRCDATE The date of the source code used to build the package. @@ -2331,7 +2331,7 @@ - SRCREV + SRCREV The revision of the source code used to build the package. @@ -2344,13 +2344,13 @@ - SRCREV_FORMAT + SRCREV_FORMAT Helps construct valid - SRCREV + SRCREV values when multiple source controlled URLs are used in - SRC_URI. + SRC_URI. @@ -2371,7 +2371,7 @@ - STAMP + STAMP Specifies the base path used to create recipe stamp files. @@ -2381,12 +2381,12 @@ - STAMPCLEAN + STAMPCLEAN Specifies the base path used to create recipe stamp files. Unlike the - STAMP + STAMP variable, STAMPCLEAN can contain wildcards to match the range of files a clean operation should remove. @@ -2396,7 +2396,7 @@ - SUMMARY + SUMMARY A short summary for the recipe, which is 72 characters or less. @@ -2404,7 +2404,7 @@ - SVNDIR + SVNDIR The directory in which files checked out of a Subversion @@ -2415,9 +2415,9 @@ - T + T - T + T Points to a directory were BitBake places temporary files, which consist mostly of task logs and @@ -2426,7 +2426,7 @@ - TOPDIR + TOPDIR Points to the build directory.