diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 6900b0cd8c..38963cc099 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml @@ -91,7 +91,9 @@ If you use BitBake to generate the ADT Installer tarball, you must source the environment setup script - (&OE_INIT_FILE;) + (&OE_INIT_FILE; + or + oe-init-build-env-memres) located in the Source Directory before running the BitBake command that creates the tarball. @@ -549,8 +551,12 @@ Remember, before using any bitbake command, you - must source the &OE_INIT_PATH; script located in - the Source Directory and you must make sure your + must source the build environment setup script + (i.e. + &OE_INIT_FILE; + or + oe-init-build-env-memres) + located in the Source Directory and you must make sure your conf/local.conf variables are correct. In particular, you need to be sure the MACHINE diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 7fa9149d07..ccaf983cfc 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1812,6 +1812,8 @@ environment, you must build the tool 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. The following commands build and invoke menuconfig assuming the diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 3a70398984..85fa3e98ff 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -509,7 +509,9 @@ This term refers to the area used by the OpenEmbedded build 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;). + (i.e. &OE_INIT_FILE; + or + oe-init-build-env-memres). The TOPDIR variable points to the Build Directory. diff --git a/documentation/mega-manual/figures/user-configuration.png b/documentation/mega-manual/figures/user-configuration.png index 5bdff034de..f2b3f8e7fe 100644 Binary files a/documentation/mega-manual/figures/user-configuration.png and b/documentation/mega-manual/figures/user-configuration.png differ diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index 8c3ceb7210..7e8d528897 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml @@ -106,7 +106,11 @@ configuration files. These example files are used as a basis for creating actual configuration files when you source the build environment - script oe-init-build-env. + script + (i.e. + &OE_INIT_FILE; + or + oe-init-build-env-memres). @@ -119,14 +123,15 @@ and bblayers.conf configuration files. These default configuration files are created only if versions do not already exist in the Build Directory at the time you - source the oe-init-build-env script. + source the build environment setup script. Because the Poky repository is fundamentally an aggregation of existing repositories, some users might be familiar with running - the oe-init-build-env script in the context of - separate OpenEmbedded-Core and BitBake repositories rather than a + the &OE_INIT_FILE; or + oe-init-build-env-memres 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 or unpacked version of Poky. diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 71fb03aedb..69b679bbf7 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -682,9 +682,11 @@ Yes - you can easily do this. When you use BitBake to build an image, all the build output - goes into the directory created when you source the + goes into the directory created when you run the + build environment setup script (i.e. &OE_INIT_FILE; - setup script. + or + oe-init-build-env-memres). By default, this Build Directory is named build but can be named anything you want. diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/ref-manual/figures/user-configuration.png index 5bdff034de..f2b3f8e7fe 100644 Binary files a/documentation/ref-manual/figures/user-configuration.png and b/documentation/ref-manual/figures/user-configuration.png differ diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 6ddecd994d..3133e8dc6d 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -74,7 +74,11 @@ the source tree is combined with the output. The Build Directory is created initially when you source - the OpenEmbedded build environment setup script &OE_INIT_FILE;. + the OpenEmbedded build environment setup script + (i.e. + &OE_INIT_FILE; + or + oe-init-build-env-memres). @@ -85,8 +89,10 @@ the setup script. For information on separating output from your local Source Directory files, see the - "&OE_INIT_FILE;" - section. + "&OE_INIT_FILE; + and + "oe-init-build-env-memres" + sections. @@ -143,7 +149,7 @@ which is a Yocto Project build user interface. For more information on the Hob, see the Hob Project - webpage. + web page. @@ -162,7 +168,9 @@ This directory contains various integration scripts that implement extra functionality in the Yocto Project environment (e.g. QEMU scripts). The &OE_INIT_FILE; - script appends this directory to the shell's + and + oe-init-build-env-memres + scripts append this directory to the shell's PATH environment variable. @@ -177,11 +185,19 @@ <filename>&OE_INIT_FILE;</filename> - This script sets up the OpenEmbedded build environment. + 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. + + + 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 this script before running BitBake commands. + 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. @@ -191,7 +207,7 @@ Build Directory argument creates the build directory. If you provide a Build Directory argument when you - source the script, you direct OpenEmbedded + source the script, you direct the OpenEmbedded build system to create a Build Directory of your choice. For example, the following command creates a Build Directory named mybuilds that is outside of the @@ -211,6 +227,81 @@ +
+ <filename>oe-init-build-env-memres</filename> + + + This script is one of two scripts that set up the OpenEmbedded build + environment. + Setting up the environment with this script uses a + memory-resident BitBake. + 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 running BitBake + commands. + Following is the script syntax: + + $ source oe-init-build-env-memres <port_number> <build_dir> + + 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 default + port "12345" is used. + + + + By default, running this script without a + Build Directory + argument creates the build directory. + If you provide a Build Directory argument when you + source the script, you direct the OpenEmbedded + build system to create a Build Directory of your choice. + For example, the following command uses the default port number + "12345" and creates a Build Directory named + mybuilds that is outside of the + Source Directory: + + $ source oe-init-build-env-memres ~/mybuilds + + + 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> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 2414d3b036..cb1a2913fc 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -710,6 +710,28 @@ Core layer for images cannot be removed + BBSERVER + + + 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: + + 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. + + + + BINCONFIG_GLOB @@ -762,13 +784,16 @@ Core layer for images cannot be removed BUILDDIR - Points to the location of the + + Points to the location of the Build Directory. You can define this directory indirectly through the &OE_INIT_FILE; - 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 + 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 path, the BUILDDIR defaults to build in the current directory. diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 76291f4cd3..40413766a2 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -27,8 +27,13 @@ Build Overview - The first thing you need to do is set up the OpenEmbedded build environment by sourcing - the environment setup script as follows: + The first thing you need to do is set up the OpenEmbedded build + environment by sourcing an environment setup script + (i.e. + &OE_INIT_FILE; + or + oe-init-build-env-memres). + Here is an example: $ source &OE_INIT_FILE; [<build_dir>] diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index a7532c082c..2ae217416b 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -464,7 +464,12 @@ 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. + Take some time to examine your local.conf file