diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-03-29 15:49:33 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-03-30 10:18:39 +0100 |
commit | 5192dfee9a1d17db53955b17131cf18de38f349c (patch) | |
tree | 20c36eaf47a074abd5ad5e58a3657e51056aa32d /documentation | |
parent | e67466827b9371f72935f1908a4e2a2ffe012f63 (diff) | |
download | openembedded-core-contrib-5192dfee9a1d17db53955b17131cf18de38f349c.tar.gz |
ref-manual: Edits to the "Source Directory Structure" chapter.
Added the buildhistory directory. Added the deploy/sdk directory.
Beefed up the tmp and build directory descriptions.
(From yocto-docs rev: 3ac9435a48b6da730e640b204ba3f41daebc39e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 58 |
1 files changed, 53 insertions, 5 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 60f547d57c..ec89840fd9 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml @@ -323,10 +323,37 @@ <para> The OpenEmbedded build system creates the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> - during the build. - By default, this directory is named <filename>build</filename>. + when you run one of the build environment setup scripts (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). </para> + <para> + If you do not give the Build Directory a specific name when you run + a setup script, the name defaults to <filename>build</filename>. + </para> + + <para> + The + <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable + points to the Build Directory. + </para> + + <section id='structure-build-buildhistory'> + <title><filename>build/buildhistory</filename></title> + + <para> + The OpenEmbedded build system creates this directory when you + enable the build history feature. + The directory tracks build information into image, packages, and + SDK subdirectories. + For information on the build history feature, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para> + </section> + <section id='structure-build-conf-local.conf'> <title><filename>build/conf/local.conf</filename></title> @@ -488,10 +515,18 @@ <title><filename>build/tmp/</filename></title> <para> - This directory receives all of the OpenEmbedded build system's output. + The OpenEmbedded build system creates and uses this directory + for all the build system's output. + The + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + variable points to this directory. + </para> + + <para> BitBake creates this directory if it does not exist. - As a last resort, to clean up a build and start it from scratch (other than the downloads), - you can remove everything in the <filename>tmp</filename> directory or get rid of the + As a last resort, to clean up a build and start it from scratch + (other than the downloads), you can remove everything in the + <filename>tmp</filename> directory or get rid of the directory completely. If you do, you should also completely remove the <filename>build/sstate-cache</filename> directory. @@ -607,6 +642,19 @@ </para> </section> + <section id='structure-build-tmp-deploy-sdk'> + <title><filename>build/tmp/deploy/sdk/</filename></title> + + <para> + The OpenEmbedded build system creates this directory to hold + toolchain installer scripts, which when executed, install the + sysroot that matches your target hardware. + You can find out more about these installers in the + "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" + section in the Yocto Project Application Developer's Guide. + </para> + </section> + <section id='structure-build-tmp-sysroots'> <title><filename>build/tmp/sysroots/</filename></title> |