From 5eeb8e08cfa13398f4bd84ad4da8cd0136606e6a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 6 Nov 2013 10:18:20 -0800 Subject: [PATCH] ref-manual: Updated bitbake/ section to remove wrapper script Robert P. J. Day noted that the bitbake command no longer uses a wrapper as the section indicated. I have removed this reference. Reported-by: Robert P. J. Day (From yocto-docs rev: ccdcf3d80f2e684877265d2dde8606ddeed4dfd2) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-structure.xml | 140 +++++++++++---------- 1 file changed, 72 insertions(+), 68 deletions(-) diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 13803f5a41..087246171b 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -39,23 +39,27 @@ This directory includes a copy of BitBake for ease of use. - The copy usually matches the current stable BitBake release from the BitBake project. + The copy usually matches the current stable BitBake release from + the BitBake project. BitBake, a Metadata - interpreter, reads the Yocto Project metadata and runs the tasks + interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. - Failures are usually from the metadata and not from BitBake itself. + Failures are usually from the Metadata and not from BitBake itself. Consequently, most users do not need to worry about BitBake. - When you run the bitbake command, the wrapper script in - scripts/ is executed to run the main BitBake executable, - which resides in the bitbake/bin/ directory. - Sourcing the &OE_INIT_FILE; - script places the scripts and bitbake/bin - directories (in that order) into the shell's PATH environment - variable. + When you run the bitbake command, the + main BitBake executable, which resides in the + bitbake/bin/ directory, starts. + Sourcing an environment setup script (e.g. + &OE_INIT_FILE; + or + oe-init-build-env-memres) + places the scripts and + bitbake/bin directories (in that order) into + the shell's PATH environment variable. @@ -74,7 +78,7 @@ the source tree is combined with the output. The Build Directory is created initially when you source - the OpenEmbedded build environment setup script + the OpenEmbedded build environment setup script (i.e. &OE_INIT_FILE; or @@ -185,9 +189,9 @@ <filename>&OE_INIT_FILE;</filename> - This script is one of two scripts that set up the OpenEmbedded build + This script is one of two scripts that set up the OpenEmbedded build environment. - For information on the other script, see the + For information on the other script, see the "oe-init-build-env-memres" section. @@ -196,7 +200,7 @@ Running this script with the source command in a shell makes changes to PATH and sets other core BitBake variables based on the current working directory. - You need to run an environment setup script before running BitBake + You need to run an environment setup script before running BitBake commands. The script uses other scripts within the scripts directory to do the bulk of the work. @@ -231,11 +235,11 @@ <filename>oe-init-build-env-memres</filename> - This script is one of two scripts that set up the OpenEmbedded build + This script is one of two scripts that set up the OpenEmbedded build environment. - Setting up the environment with this script uses a + Setting up the environment with this script uses a memory-resident BitBake. - For information on the other setup script, see the + For information on the other setup script, see the "&OE_INIT_FILE;" section. @@ -252,14 +256,14 @@ Running this script with the source command in a shell makes changes to PATH and sets other core BitBake variables based on the current working directory. - One of these variables is the + One of these variables is the BBSERVER - variable, which allows the OpenEmbedded build system to locate + variable, which allows the OpenEmbedded build system to locate the server that is running BitBake. - You need to run an environment setup script before running BitBake + You need to run an environment setup script before running BitBake commands. Following is the script syntax: @@ -289,14 +293,14 @@ $ source oe-init-build-env-memres ~/mybuilds - The OpenEmbedded build system does not support file or + The OpenEmbedded build system does not support file or directory names that contain spaces. - If you attempt to run the + If you attempt to run the oe-init-build-env-memres script - from a Source Directory that contains spaces in either the - filenames or directory names, the script returns an error + from a Source Directory that contains spaces in either the + filenames or directory names, the script returns an error indicating no such file or directory. - Be sure to use a Source Directory free of names containing + Be sure to use a Source Directory free of names containing spaces. @@ -334,68 +338,68 @@ <filename>build/conf/local.conf</filename> - This configuration file contains all the local user configurations + This configuration file contains all the local user configurations for your build environment. - The local.conf file contains documentation on + The local.conf file contains documentation on the various configuration options. - Any variable set here overrides any variable set elsewhere within - the environment unless that variable is hard-coded within a file + Any variable set here overrides any variable set elsewhere within + the environment unless that variable is hard-coded within a file (e.g. by using '=' instead of '?='). - Some variables are hard-coded for various reasons but these + Some variables are hard-coded for various reasons but these variables are relatively rare. - Edit this file to set the + Edit this file to set the MACHINE for which you want to build, which package types you wish to use (PACKAGE_CLASSES), the location from which you want to downloaded files (DL_DIR), and how you want your host machine to use resources - (BB_NUMBER_THREADS + (BB_NUMBER_THREADS and PARALLEL_MAKE). - If local.conf is not present when you - start the build, the OpenEmbedded build system creates it from + If local.conf is not present when you + start the build, the OpenEmbedded build system creates it from local.conf.sample when - you source the top-level build environment + you source the top-level build environment setup script (i.e. &OE_INIT_FILE; - or + or oe-init-build-env-memres). - The source local.conf.sample file used + The source local.conf.sample file used depends on the $TEMPLATECONF script variable, which defaults to /meta-yocto/conf - when you are building from the Yocto Project development - environment and defaults to /meta/conf when + when you are building from the Yocto Project development + environment and defaults to /meta/conf when you are building from the OpenEmbedded Core environment. - Because the script variable points to the source of the - local.conf.sample file, this implies that - you can configure your build environment from any layer by setting - the variable in the top-level build environment setup script as + Because the script variable points to the source of the + local.conf.sample file, this implies that + you can configure your build environment from any layer by setting + the variable in the top-level build environment setup script as follows: TEMPLATECONF=<your_layer>/conf - Once the build process gets the sample file, it uses - sed to substitute final - ${OEROOT} + Once the build process gets the sample file, it uses + sed to substitute final + ${OEROOT} values for all ##OEROOT## values. You can see how the TEMPLATECONF variable - is used by looking at the - /scripts/oe-setup-builddir script in the + is used by looking at the + /scripts/oe-setup-builddir script in the Source Directory. - You can find the Yocto Project version of the - local.conf.sample file in the - /meta-yocto/conf directory. + You can find the Yocto Project version of the + local.conf.sample file in the + /meta-yocto/conf directory. @@ -408,48 +412,48 @@ layers, which are directory trees, traversed (or walked) by BitBake. The bblayers.conf file uses the - BBLAYERS + BBLAYERS variable to list the layers BitBake tries to find, and uses the BBLAYERS_NON_REMOVABLE variable to list layers that must not be removed. - If bblayers.conf is not present when you - start the build, the OpenEmbedded build system creates it from + If bblayers.conf is not present when you + start the build, the OpenEmbedded build system creates it from bblayers.conf.sample when - you source the top-level build environment + you source the top-level build environment setup script (i.e. &OE_INIT_FILE; - or + or oe-init-build-env-memres). - The source bblayers.conf.sample file used + The source bblayers.conf.sample file used depends on the $TEMPLATECONF script variable, which defaults to /meta-yocto/conf - when you are building from the Yocto Project development - environment and defaults to /meta/conf when + when you are building from the Yocto Project development + environment and defaults to /meta/conf when you are building from the OpenEmbedded Core environment. - Because the script variable points to the source of the - bblayers.conf.sample file, this implies that + Because the script variable points to the source of the + bblayers.conf.sample file, this implies that you can base your build from any layer by setting the variable in the top-level build environment setup script as follows: TEMPLATECONF=<your_layer>/conf - Once the build process gets the sample file, it uses - sed to substitute final - ${OEROOT} + Once the build process gets the sample file, it uses + sed to substitute final + ${OEROOT} values for all ##OEROOT## values. You can see how the TEMPLATECONF variable - /scripts/oe-setup-builddir script in the + /scripts/oe-setup-builddir script in the Source Directory. - You can find the Yocto Project version of the - bblayers.conf.sample file in the - /meta-yocto/conf directory. + You can find the Yocto Project version of the + bblayers.conf.sample file in the + /meta-yocto/conf directory.