summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-29 15:49:33 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-30 10:18:39 +0100
commit5192dfee9a1d17db53955b17131cf18de38f349c (patch)
tree20c36eaf47a074abd5ad5e58a3657e51056aa32d /documentation
parente67466827b9371f72935f1908a4e2a2ffe012f63 (diff)
downloadpoky-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.xml58
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 @@
323 <para> 323 <para>
324 The OpenEmbedded build system creates the 324 The OpenEmbedded build system creates the
325 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 325 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
326 during the build. 326 when you run one of the build environment setup scripts (i.e.
327 By default, this directory is named <filename>build</filename>. 327 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
328 or
329 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
328 </para> 330 </para>
329 331
332 <para>
333 If you do not give the Build Directory a specific name when you run
334 a setup script, the name defaults to <filename>build</filename>.
335 </para>
336
337 <para>
338 The
339 <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable
340 points to the Build Directory.
341 </para>
342
343 <section id='structure-build-buildhistory'>
344 <title><filename>build/buildhistory</filename></title>
345
346 <para>
347 The OpenEmbedded build system creates this directory when you
348 enable the build history feature.
349 The directory tracks build information into image, packages, and
350 SDK subdirectories.
351 For information on the build history feature, see the
352 "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
353 section.
354 </para>
355 </section>
356
330 <section id='structure-build-conf-local.conf'> 357 <section id='structure-build-conf-local.conf'>
331 <title><filename>build/conf/local.conf</filename></title> 358 <title><filename>build/conf/local.conf</filename></title>
332 359
@@ -488,10 +515,18 @@
488 <title><filename>build/tmp/</filename></title> 515 <title><filename>build/tmp/</filename></title>
489 516
490 <para> 517 <para>
491 This directory receives all of the OpenEmbedded build system's output. 518 The OpenEmbedded build system creates and uses this directory
519 for all the build system's output.
520 The
521 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
522 variable points to this directory.
523 </para>
524
525 <para>
492 BitBake creates this directory if it does not exist. 526 BitBake creates this directory if it does not exist.
493 As a last resort, to clean up a build and start it from scratch (other than the downloads), 527 As a last resort, to clean up a build and start it from scratch
494 you can remove everything in the <filename>tmp</filename> directory or get rid of the 528 (other than the downloads), you can remove everything in the
529 <filename>tmp</filename> directory or get rid of the
495 directory completely. 530 directory completely.
496 If you do, you should also completely remove the 531 If you do, you should also completely remove the
497 <filename>build/sstate-cache</filename> directory. 532 <filename>build/sstate-cache</filename> directory.
@@ -607,6 +642,19 @@
607 </para> 642 </para>
608 </section> 643 </section>
609 644
645 <section id='structure-build-tmp-deploy-sdk'>
646 <title><filename>build/tmp/deploy/sdk/</filename></title>
647
648 <para>
649 The OpenEmbedded build system creates this directory to hold
650 toolchain installer scripts, which when executed, install the
651 sysroot that matches your target hardware.
652 You can find out more about these installers in the
653 "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
654 section in the Yocto Project Application Developer's Guide.
655 </para>
656 </section>
657
610 <section id='structure-build-tmp-sysroots'> 658 <section id='structure-build-tmp-sysroots'>
611 <title><filename>build/tmp/sysroots/</filename></title> 659 <title><filename>build/tmp/sysroots/</filename></title>
612 660