diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index c781286df3..9f993d21e3 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -5163,6 +5163,171 @@ +
+ Building + + + This section describes various build procedures. + For example, the steps needed for a simple build, a target that + uses multiple configurations, building an image for more than + one machine, and so forth. + + +
+ Building a Simple Image + + + In the development environment, you need to build an image + whenever you change hardware support, add or change system + libraries, or add or change services that have dependencies. + Several methods exist that allow you to build an image within + the Yocto Project. + This section presents the basic steps you need to build a + simple image using BitBake from a build host running Linux. + Notes + + + For information on how to build an image using + Toaster, + see the + Toaster User Manual. + + + For information on how to use + devtool to build images, see + the + "Using devtool in Your SDK Workflow" + section in the Yocto Project Application + Development and the Extensible Software Development + Kit (eSDK) manual. + + + For a quick example on how to build an image using + the OpenEmbedded build system, see the + Yocto Project Quick Build + document. + + + + + + + The build process creates an entire Linux distribution from + source and places it in your + Build Directory + under tmp/deploy/images. + For detailed information on the build process using BitBake, + see the + "Images" + section in the Yocto Project Overview and Concepts Manual. + + + + The following figure and list overviews the build process: + + + + Set up Your Host Development System to Support + Development Using the Yocto Project: + See the + "Setting Up to Use the Yocto Project" + section for options on how to get a build host ready to + use the Yocto Project. + + + Initialize the Build Environment: + Initialize the build environment by sourcing the build + environment script (i.e. + &OE_INIT_FILE;): + + $ source &OE_INIT_FILE; [build_dir] + + + When you use the initialization script, the + OpenEmbedded build system uses + build as the default Build + Directory in your current work directory. + You can use a build_dir + argument with the script to specify a different build + directory. + Tip + A common practice is to use a different Build + Directory for different targets. + For example, ~/build/x86 for a + qemux86 target, and + ~/build/arm for a + qemuarm target. + + + + Make Sure Your local.conf + File is Correct: + Ensure the conf/local.conf + configuration file, which is found in the Build + Directory, is set up how you want it. + This file defines many aspects of the build environment + including the target machine architecture through the + MACHINE variable, + the packaging format used during the build + (PACKAGE_CLASSES), + and a centralized tarball download directory through the + DL_DIR variable. + + + Build the Image: + Build the image using the bitbake + command: + + $ bitbake target + + + For information on BitBake, see the + BitBake User Manual. + + The target is the name of the + recipe you want to build. + Common targets are the images in + meta/recipes-core/images, + meta/recipes-sato/images, and so + forth all found in the + Source Directory. + Or, the target can be the name of a recipe for a + specific piece of software such as BusyBox. + For more details about the images the OpenEmbedded build + system supports, see the + "Images" + chapter in the Yocto Project Reference Manual. + + As an example, the following command builds the + core-image-minimal image: + + $ bitbake core-image-minimal + + Once an image has been built, it often needs to be + installed. + The images and kernels built by the OpenEmbedded + build system are placed in the Build Directory in + tmp/deploy/images. + For information on how to run pre-built images such as + qemux86 and qemuarm, + see the + Yocto Project Application Development and the Extensible Software Development Kit (eSDK) + manual. + For information about how to install these images, + see the documentation for your particular board or + machine. + + + +
+
+ + + + + + +
Building Targets with Multiple Configurations diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index a1b502b8eb..201cbe7340 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -1080,146 +1080,6 @@
-
- Building an Image - - - In the development environment, you need to build an image whenever - you change hardware support, add or change system libraries, or add - or change services that have dependencies. - Several methods exist that allow you to build an image within the - Yocto Project. - This section shows you how to build an image using BitBake from a - Linux host. - Notes - - - For information on how to build an image using - Toaster, - see the - Toaster User Manual. - - - For information on how to use - devtool to build images, see the - "Using devtool in Your SDK Workflow" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - - - For a quick example on how to build an image using the - OpenEmbedded build system, see the - Yocto Project Quick Build - document. - - - - - - - The build process creates an entire Linux distribution from source - and places it in your - Build Directory - under tmp/deploy/images. - For detailed information on the build process using BitBake, see the - "Images" - section in the Yocto Project Overview and Concepts Manual. - - - - The following figure and list overviews the build process: - - - - Set up Your Host Development System to Support - Development Using the Yocto Project: - See the - "Setting Up to Use the Yocto Project" - section for options on how to get a build host ready to use - the Yocto Project. - - - Initialize the Build Environment: - Initialize the build environment by sourcing the build - environment script (i.e. - &OE_INIT_FILE;): - - $ source &OE_INIT_FILE; [build_dir] - - - When you use the initialization script, the - OpenEmbedded build system uses build as - the default Build Directory in your current work directory. - You can use a build_dir argument - with the script to specify a different build directory. - Tip - A common practice is to use a different Build Directory for - different targets. - For example, ~/build/x86 for a - qemux86 target, and - ~/build/arm for a - qemuarm target. - - - - Make Sure Your local.conf - File is Correct: - Ensure the conf/local.conf configuration - file, which is found in the Build Directory, - is set up how you want it. - This file defines many aspects of the build environment - including the target machine architecture through the - MACHINE variable, - the packaging format used during the build - (PACKAGE_CLASSES), - and a centralized tarball download directory through the - DL_DIR variable. - - - Build the Image: - Build the image using the bitbake command: - - $ bitbake target - - - For information on BitBake, see the - BitBake User Manual. - - The target is the name of the - recipe you want to build. - Common targets are the images in - meta/recipes-core/images, - meta/recipes-sato/images, etc. all found - in the - Source Directory. - Or, the target can be the name of a recipe for a specific - piece of software such as BusyBox. - For more details about the images the OpenEmbedded build - system supports, see the - "Images" - chapter in the Yocto Project Reference Manual. - - As an example, the following command builds the - core-image-minimal image: - - $ bitbake core-image-minimal - - Once an image has been built, it often needs to be installed. - The images and kernels built by the OpenEmbedded build system - are placed in the Build Directory in - tmp/deploy/images. - For information on how to run pre-built images such as - qemux86 and qemuarm, - see the - Yocto Project Application Development and the Extensible Software Development Kit (eSDK) - manual. - For information about how to install these images, see the - documentation for your particular board or machine. - - - -
-
Speeding Up the Build diff --git a/documentation/overview-manual/overview-manual-development-environment.xml b/documentation/overview-manual/overview-manual-development-environment.xml index b98d985a09..bba93ccefa 100644 --- a/documentation/overview-manual/overview-manual-development-environment.xml +++ b/documentation/overview-manual/overview-manual-development-environment.xml @@ -131,7 +131,7 @@ and the Yocto Project. For a general flow of the build procedures, see the - "Building an Image" + "Building a Simple Image" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/sdk-manual/sdk-appendix-neon.xml b/documentation/sdk-manual/sdk-appendix-neon.xml index 13122c67c5..f648047ef3 100644 --- a/documentation/sdk-manual/sdk-appendix-neon.xml +++ b/documentation/sdk-manual/sdk-appendix-neon.xml @@ -455,7 +455,7 @@ If the architecture you need is not listed in the menu, you will need to build the image. See the - "Building an Image" + "Building a Simple Image" section of the Yocto Project Development Tasks Manual for more information. You can also see the diff --git a/documentation/sdk-manual/sdk-eclipse-project.xml b/documentation/sdk-manual/sdk-eclipse-project.xml index d6b10cb636..5ad9c45ae7 100644 --- a/documentation/sdk-manual/sdk-eclipse-project.xml +++ b/documentation/sdk-manual/sdk-eclipse-project.xml @@ -705,7 +705,7 @@ in the menu, you will need to build the image. See the - "Building an Image" + "Building a Simple Image" section of the Yocto Project Development Tasks Manual for more information. You can also see the