documentation/ref-manual/structure.rst

20    The OpenEmbedded build system does not support file or directory
52 .. _structure-core-build:
54 ``build/``
58 generated by the OpenEmbedded build system in its standard configuration
59 where the source tree is combined with the output. The :term:`Build Directory`
61 the OpenEmbedded build environment setup script (i.e.
68 (commonly described as an "out of tree" build), see the
115 OpenEmbedded selftests to verify the behavior of the build system. You
142 ``oe-init-build-env``
145 This script sets up the OpenEmbedded build environment. Running this
153 :term:`Build Directory` is created, your working
154 directory becomes the Build Directory, and you are presented with some
156 possible targets to build. Here is an example::
158    $ source oe-init-build-env
172 The default output of the ``oe-init-build-env`` script is from the
182 By default, running this script without a Build Directory argument
183 creates the ``build/`` directory in your current working directory. If
184 you provide a Build Directory argument when you ``source`` the script,
185 you direct the OpenEmbedded build system to create a Build Directory of
186 your choice. For example, the following command creates a Build
189    $ source oe-init-build-env ~/mybuilds
191 The OpenEmbedded build system uses the template configuration files, which
200    The OpenEmbedded build system does not support file or directory
201    names that contain spaces. If you attempt to run the ``oe-init-build-env``
214 .. _structure-build:
216 The Build Directory - ``build/``
219 The OpenEmbedded build system creates the :term:`Build Directory`
220 when you run the build environment setup
221 script :ref:`structure-core-script`. If you do not give the Build
223 defaults to ``build/``.
225 For subsequent parsing and processing, the name of the Build directory
228 .. _structure-build-buildhistory:
230 ``build/buildhistory/``
233 The OpenEmbedded build system creates this directory when you enable
234 build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory
235 organizes build information into image, packages, and SDK
236 subdirectories. For information on the build history feature, see the
237 ":ref:`dev-manual/common-tasks:maintaining build output quality`"
240 .. _structure-build-conf-local.conf:
242 ``build/conf/local.conf``
246 your build environment. The ``local.conf`` file contains documentation
258 If ``local.conf`` is not present when you start the build, the
259 OpenEmbedded build system creates it from ``local.conf.sample`` when you
260 ``source`` the top-level build environment setup script
269 build environment from any layer by setting the variable in the
270 top-level build environment setup script as follows::
274 Once the build process gets the sample
286 .. _structure-build-conf-bblayers.conf:
288 ``build/conf/bblayers.conf``
297 If ``bblayers.conf`` is not present when you start the build, the
298 OpenEmbedded build system creates it from ``bblayers.conf.sample`` when
299 you ``source`` the top-level build environment setup script (i.e.
308 implies that you can base your build from any layer by setting the
309 variable in the top-level build environment setup script as follows::
313 Once the build process gets the sample file, it uses ``sed`` to substitute final
323 .. _structure-build-conf-sanity_info:
325 ``build/cache/sanity_info``
329 the build.
331 .. _structure-build-downloads:
333 ``build/downloads/``
341 .. _structure-build-sstate-cache:
343 ``build/sstate-cache/``
351 .. _structure-build-tmp:
353 ``build/tmp/``
356 The OpenEmbedded build system creates and uses this directory for all
357 the build system's output. The :term:`TMPDIR` variable
361 to clean up a build and start it from scratch (other than the
364 remove the ``build/sstate-cache`` directory.
366 .. _structure-build-tmp-buildstats:
368 ``build/tmp/buildstats/``
371 This directory stores the build statistics.
373 .. _structure-build-tmp-cache:
375 ``build/tmp/cache/``
379 caches the results in ``build/tmp/cache/`` to speed up future builds.
389 .. _structure-build-tmp-deploy:
391 ``build/tmp/deploy/``
395 build process. The :term:`DEPLOY_DIR` variable points
402 .. _structure-build-tmp-deploy-deb:
404 ``build/tmp/deploy/deb/``
407 This directory receives any ``.deb`` packages produced by the build
411 .. _structure-build-tmp-deploy-rpm:
413 ``build/tmp/deploy/rpm/``
416 This directory receives any ``.rpm`` packages produced by the build
420 .. _structure-build-tmp-deploy-ipk:
422 ``build/tmp/deploy/ipk/``
425 This directory receives ``.ipk`` packages produced by the build process.
427 .. _structure-build-tmp-deploy-licenses:
429 ``build/tmp/deploy/licenses/``
440 .. _structure-build-tmp-deploy-images:
442 ``build/tmp/deploy/images/``
445 This directory is populated with the basic output objects of the build
446 (think of them as the "generated artifacts" of the build process),
448 more. If you want to flash the resulting image from a build onto a
456 delete them they will not be automatically re-created when you build the
467 .. _structure-build-tmp-deploy-sdk:
469 ``build/tmp/deploy/sdk/``
472 The OpenEmbedded build system creates this directory to hold toolchain
479 .. _structure-build-tmp-sstate-control:
481 ``build/tmp/sstate-control/``
484 The OpenEmbedded build system uses this directory for the shared state
488 installed. The build system also uses the manifests to detect and
492 .. _structure-build-tmp-sysroots-components:
494 ``build/tmp/sysroots-components/``
505 ``build/tmp/sysroots-components``.
507 .. _structure-build-tmp-sysroots:
509 ``build/tmp/sysroots/``
512 Previous versions of the OpenEmbedded build system used to create a
516 ``build/tmp/sysroots/`` directory is unused.
520    The ``build/tmp/sysroots/`` directory can still be populated using the
521    ``bitbake build-sysroots`` command and can be used for compatibility in some
525 .. _structure-build-tmp-stamps:
527 ``build/tmp/stamps/``
545 .. _structure-build-tmp-log:
547 ``build/tmp/log/``
552 ``do_check_pkg`` or ``do_distro_check`` tasks. Running a build does not
555 .. _structure-build-tmp-work:
557 ``build/tmp/work/``
573 unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
576 the ``linux-qemux86-standard-build`` directory, standard Quilt
587 .. _structure-build-tmp-work-tunearch-recipename-version:
589 ``build/tmp/work/tunearch/recipename/version/``
595 ":ref:`structure-build-tmp-sysroots`" section,
597 build system builds each recipe in its own work directory (i.e.
599 constructed using the architecture of the given build (e.g.
637    the recipe needs to build (e.g. the compiler, Autoconf, libtool, and
640 -  ``${WORKDIR}/build``: This subdirectory applies only to recipes that
641    support builds where the source is separate from the build artifacts.
642    The OpenEmbedded build system uses this directory as a separate build
645 .. _structure-build-work-shared:
647 ``build/tmp/work-shared/``
650 For efficiency, the OpenEmbedded build system creates and uses this
701 ``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a
723 The OpenEmbedded build system searches this directory for configuration
737 by the build system. The text files contain minimal device information
746 build process.
769 This directory contains what is needed to build a basic working Linux
777 This directory contains tools that are primarily used by the build