diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index b4e1e3e9f2..5db2837963 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -99,11 +99,9 @@ BBLAYERS variable in the conf/bblayers.conf file found in the Build Directory, - which is established after you run one of the OpenEmbedded build environment - setup scripts (i.e. - &OE_INIT_FILE; - and - oe-init-build-env-memres). + which is established after you run the OpenEmbedded build environment + setup script (i.e. + &OE_INIT_FILE;). Adding the root allows the OpenEmbedded build system to recognize the BSP definition and from it build an image. Here is an example: @@ -282,13 +280,6 @@ Source Directory. After the script runs, your current working directory is set to the build directory. - - For information on running a memory-resident - BitBake, - see the - oe-init-build-env-memres - setup script. - @@ -1018,8 +1009,7 @@ your image. You need to get the build environment ready by sourcing an environment setup script - (i.e. oe-init-build-env or - oe-init-build-env-memres) + (i.e. oe-init-build-env) and you need to be sure two key configuration files are configured appropriately: the conf/local.conf and the diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 64af8d700a..0c2e60f006 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1535,9 +1535,7 @@ Build Directory and have sourced the build environment setup script (i.e. - oe-init-build-env - or - oe-init-build-env-memres). + oe-init-build-env). Here is the basic recipetool syntax: Running recipetool -h or @@ -1718,10 +1716,8 @@ - Assuming you have sourced a build environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres) + Assuming you have sourced the build environment setup script (i.e. + &OE_INIT_FILE;) and you are in the Build Directory, use BitBake to process your recipe. @@ -4959,11 +4955,9 @@ - You must have sourced one of the build environment - setup scripts (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres) + You must have sourced the build environment + setup script (i.e. + &OE_INIT_FILE;) found in the Build Directory. @@ -5052,8 +5046,6 @@ artifacts ready and available. Additionally, the environment must be set up using the &OE_INIT_FILE; - or - oe-init-build-env-memres script found in the Build Directory. @@ -6195,8 +6187,6 @@ Some notes from Cal: environment, you must launch it using BitBake. Thus, the environment must be set up using the &OE_INIT_FILE; - or - oe-init-build-env-memres script found in the Build Directory. You must also be sure of the state of your build in the @@ -7062,12 +7052,10 @@ Some notes from Cal: Aside from the *.sample configuration files, the conf-notes.txt also resides in the default meta-poky/conf directory. - The scripts that set up the build environment + The script that sets up the build environment (i.e. - &OE_INIT_FILE; - and - oe-init-build-env-memres) - use this file to display BitBake targets as part of the script + &OE_INIT_FILE;) + uses this file to display BitBake targets as part of the script output. Customizing this conf-notes.txt file is a good way to make sure your list of custom targets appears diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml index ed4040ca60..d127c4f510 100644 --- a/documentation/dev-manual/dev-manual-qemu.xml +++ b/documentation/dev-manual/dev-manual-qemu.xml @@ -43,9 +43,7 @@ repository or you downloaded and unpacked a Yocto Project release tarball, you can source the build environment script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres): + &OE_INIT_FILE;): $ cd ~/poky $ source oe-init-build-env diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index bcb49fbf03..a62825122f 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -707,11 +707,9 @@ Initialize the Build Environment: - Initialize the build environment by sourcing a build + Initialize the build environment by sourcing the build environment script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). Make Sure Your local.conf diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 9ef1138589..0f5e09cd47 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -72,9 +72,7 @@ Before building an extensible SDK, you need to initialize the BitBake build environment by sourcing a build environment script - (i.e. oe-init-build-env - or - oe-init-build-env-memres): + (i.e. oe-init-build-env): $ cd ~/poky $ source oe-init-build-env diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 55a6a89ad7..62754a9711 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -699,9 +699,7 @@ When you use BitBake to build an image, all the build output goes into the directory created when you run the build environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). By default, this Build Directory is named build but can be named diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 893a50fc3c..14d5c80029 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -546,9 +546,7 @@ On the machine that is able to run BitBake, be sure you have set up your build environment with the setup script - (&OE_INIT_FILE; - or - oe-init-build-env-memres). + (&OE_INIT_FILE;). Run the BitBake command to build the tarball: @@ -711,9 +709,7 @@ system for builds. The area is created when you source the setup environment script that is found in the Source Directory - (i.e. &OE_INIT_FILE; - or - oe-init-build-env-memres). + (i.e. &OE_INIT_FILE;). The TOPDIR variable points to the Build Directory. diff --git a/documentation/ref-manual/ref-development-environment.xml b/documentation/ref-manual/ref-development-environment.xml index 36de2d0a72..112e7f9ea8 100644 --- a/documentation/ref-manual/ref-development-environment.xml +++ b/documentation/ref-manual/ref-development-environment.xml @@ -1221,9 +1221,7 @@ configuration files when you source the build environment script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). @@ -1242,8 +1240,7 @@ Because the Poky repository is fundamentally an aggregation of existing repositories, some users might be familiar with running - the &OE_INIT_FILE; or - oe-init-build-env-memres script in the context + the &OE_INIT_FILE; script in the context of separate OpenEmbedded-Core and BitBake repositories rather than a single Poky repository. This discussion assumes the script is executed from within a cloned diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 3948c64377..e1c6ee0a8b 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -54,10 +54,8 @@ 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) + Sourcing the environment setup script (i.e. + &OE_INIT_FILE;) places the scripts and bitbake/bin directories (in that order) into the shell's PATH environment variable. @@ -81,9 +79,7 @@ is created initially when you source the OpenEmbedded build environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). @@ -94,10 +90,8 @@ the setup script. For information on separating output from your local Source Directory files, see the - "&OE_INIT_FILE; - and - "oe-init-build-env-memres" - sections. + "&OE_INIT_FILE;" + section. @@ -177,9 +171,7 @@ This directory contains various integration scripts that implement extra functionality in the Yocto Project environment (e.g. QEMU scripts). The &OE_INIT_FILE; - and - oe-init-build-env-memres - scripts append this directory to the shell's + script appends this directory to the shell's PATH environment variable. @@ -194,14 +186,7 @@ <filename>&OE_INIT_FILE;</filename> - This script is one of two scripts that set up the OpenEmbedded build - environment. - For information on the other script, see the - "oe-init-build-env-memres" - section. - - - + This script sets up the OpenEmbedded build environment. 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. @@ -280,157 +265,6 @@ -
- <filename>oe-init-build-env-memres</filename> - - - This script is one of two scripts that set up the OpenEmbedded - build environment. - Aside from setting up the environment, this script starts a - memory-resident BitBake server. - For information on the other setup script, see the - "&OE_INIT_FILE;" - section. - - - - Memory-resident BitBake resides in memory until you specifically - remove it using the following BitBake command: - - $ bitbake -m - - - - - 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 - BBSERVER - variable, which allows the OpenEmbedded build system to locate - the server that is running BitBake. - - - - You need to run an environment setup script before using BitBake - commands. - Following is the script syntax: - - $ source oe-init-build-env-memres port_number build_dir - - Following are some considerations when sourcing this script: - - - The script uses other scripts within the - scripts directory to do the bulk of - the work. - - - If you do not provide a port number with the script, the - BitBake server starts at a randomly selected port. - - - The script's parameters are positionally dependent. - Consequently, you cannot run the script and provide a - Build Directory - name without also providing a port number. - In other words, the following syntax is illegal: - - $ source oe-initbuild-env-memres build_dir - - - The previous restriction might be resolved in the - future. - See - Bug 7555 - for more information. - - - - - - - When you run this script, your Yocto Project environment is set - up, a Build Directory is created, your working directory becomes - the Build Directory, and you are presented with a list of common - BitBake targets. - Here is an example: - - $ source oe-init-build-env-memres - No port specified, using dynamically selected port - - ### Shell environment set up for builds. ### - - You can now run 'bitbake <target>' - - Common targets are: - core-image-minimal - core-image-sato - meta-toolchain - meta-ide-support - - You can also run generated qemu images with a command like 'runqemu qemux86' - Bitbake server address: 127.0.0.1, server port: 53995 - Bitbake server started on demand as needed, use bitbake -m to shut it down - - The script gets its default list of common targets from the - conf-notes.txt file, which is found in the - meta-poky directory within the - Source Directory. - Should you have custom distributions, it is very easy to modify - this configuration file to include your targets for your - distribution. - See the - "Creating a Custom Template Configuration Directory" - section in the Yocto Project Development Manual for more - information. - - - - By default, running this script without a - Build Directory - argument creates a build directory named - build. - If you provide a Build Directory argument and port number when you - source the script, the Build Directory is - created using that name. - For example, the following command starts the BitBake server using - port 53995 and creates a Build Directory named - mybuilds that is outside of the - Source Directory: - - $ source oe-init-build-env-memres 53995 ~/mybuilds - - The oe-init-build-env-memres script starts a - memory resident BitBake server. - This BitBake instance uses the - bitbake-cookerdaemon.log file, which is - located in the Build Directory. - - - - The OpenEmbedded build system uses the template configuration - files, which are found by default in the - meta-poky/conf directory in the - Source Directory. - See the - "Creating a Custom Template Configuration Directory" - section in the Yocto Project Development Manual for more - information. - - The OpenEmbedded build system does not support file or - directory names that contain spaces. - 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 - indicating no such file or directory. - Be sure to use a Source Directory free of names containing - spaces. - - -
-
<filename>LICENSE, README, and README.hardware</filename> @@ -446,10 +280,8 @@ The OpenEmbedded build system creates the Build Directory - when you run one of the build environment setup scripts (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + when you run the build environment setup scripts (i.e. + &OE_INIT_FILE;). @@ -507,9 +339,7 @@ local.conf.sample when you source the top-level build environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). @@ -561,9 +391,7 @@ bblayers.conf.sample when you source the top-level build environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index e34cfbcffb..8b1ca83938 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -1299,29 +1299,29 @@ BBSERVER - BBSERVER[doc] = "Points to the server that runs memory-resident BitBake." + BBSERVER[doc] = "Points to the BitBake remote server." - Points to the server that runs memory-resident BitBake. - This variable is set by the - oe-init-build-env-memres - setup script and should not be hand-edited. - The variable is only used when you employ memory-resident - BitBake. - The setup script exports the value as follows: + If defined in the BitBake environment, + BBSERVER points to the BitBake + remote server. + + + + Use the following format to export the variable to the + BitBake environment: - export BBSERVER=localhost:$port + export BBSERVER=localhost:$port" - For more information on how the - BBSERVER is used, see the - oe-init-build-env-memres script, which - is located in the - Source Directory. + By default, BBSERVER also appears in + BB_HASHBASE_WHITELIST. + Consequently, BBSERVER is excluded + from checksum and dependency data. @@ -1736,11 +1736,9 @@ Build Directory. You can define this directory indirectly through the &OE_INIT_FILE; - and - oe-init-build-env-memres - scripts by passing in a Build Directory path when you run - the scripts. - If you run the scripts and do not provide a Build Directory + script by passing in a Build Directory path when you run + the script. + If you run the script and do not provide a Build Directory path, the BUILDDIR defaults to build in the current directory. @@ -6626,7 +6624,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" recipe in the Source Directory for an example initramfs recipe. - To select this sample recipe as the one bulit + To select this sample recipe as the one built to provide the initramfs image, set INITRAMFS_IMAGE to "core-image-minimal-initramfs". @@ -9026,19 +9024,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The directory from which the top-level build environment setup script is sourced. - The Yocto Project makes two top-level build environment - setup scripts available: - &OE_INIT_FILE; - and - oe-init-build-env-memres. - When you run one of these scripts, the + The Yocto Project provides a top-level build environment + setup script: + &OE_INIT_FILE;. + When you run this script, the OEROOT variable resolves to the directory that contains the script. For additional information on how this variable is used, - see the initialization scripts. + see the initialization script. @@ -15089,10 +15085,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The top-level Build Directory. BitBake automatically sets this variable when you - initialize your build environment using either - &OE_INIT_FILE; - or - oe-init-build-env-memres. + initialize your build environment using + &OE_INIT_FILE;. diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index c323d38318..a963268347 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -42,11 +42,9 @@ The first thing you need to do is set up the OpenEmbedded build - environment by sourcing an environment setup script + environment by sourcing the environment setup script (i.e. - &OE_INIT_FILE; - or - oe-init-build-env-memres). + &OE_INIT_FILE;). Here is an example: $ source &OE_INIT_FILE; [build_dir] diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml index 1317a79ea8..587526f65f 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.xml +++ b/documentation/sdk-manual/sdk-appendix-customizing.xml @@ -148,9 +148,7 @@ If your OpenEmbedded build system setup uses a different environment setup script other than - &OE_INIT_FILE; - or - oe-init-build-env-memres, + &OE_INIT_FILE;, then you must set OE_INIT_ENV_SCRIPT to point to the environment setup script you use. diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml index eb57938a42..6fbd7fd1cd 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.xml +++ b/documentation/sdk-manual/sdk-appendix-obtain.xml @@ -142,13 +142,6 @@ Source Directory. After the script runs, your current working directory is set to the build directory. - - For information on running a memory-resident - BitBake, - see the - oe-init-build-env-memres - setup script. - Make Sure You Are Building an Installer for the Correct Machine: diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index a2c183341a..151e8f07d0 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -602,13 +602,6 @@ is set to the Build Directory. Later, when the build completes, the Build Directory contains all the files created during the build. - - For information on running a memory-resident - BitBake, - see the - oe-init-build-env-memres - setup script. - Examine Your Local Configuration File: