diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0bc0be2164..c3df1c2958 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -132,6 +132,44 @@ environment might find helpful. Some terms are universal but are included here just in case: + The Yocto Project Files: + This term refers to the directory structure created as a result of downloading + and unpacking a Yocto Project release tarball or setting up a Git repository + by cloning git://git.yoctoproject.org/poky. + The Yocto Project files contain BitBake, Documentation, metadata and + other files that all support the development environment. + Consequently, you must have the Yocto Project files in place on your development + system in order to do any development using the Yocto Project. + The name of the top-level directory of the Yocto Project file structure + is derived from the Yocto Project release tarball. + For example, downloading and unpacking poky-edison-6.0.tar.bz2 + results in a Yocto Project source tree whose Yocto Project source directory is named + poky-edison-6.0. + If you create a Git repository, then you can name the repository anything you like. + You can find instruction on how to set up the Yocto Project files on your + host development system by reading + the + "Getting + Setup" section in + + The Yocto Project Development Manual. + Yocto Project Build Tree: + This term refers to the area where the Yocto Project builds images. + The area is created when you source the Yocto Project setup + environment script that is found in the Yocto Project files area. + (e.g. oe-init-build-env). + You can create the Yocto Project build tree anywhere you want on your + development system. + Here is an example that creates the tree in mybuilds + and names the Yocto Project build directory YP-6.0: + + $ source poky-edison-6.0/oe-init-build-env $HOME/mybuilds/YP-6.0 + + If you don't specifically name the build directory, BitBake creates it + in the current directory and uses the name build. + Also, if you supply an existing directory, then BitBake uses that + directory as the Yocto Project build directory and populates the build tree + beneath it. Image - An image is the result produced when BitBake processes a given collection of recipes and related metadata. Images are the binary output that runs on specific hardware and for specific