documentation/ref-manual/structure.rst

4 Source Directory Structure
7 The :term:`Source Directory` consists of numerous files,
10 describes the Source Directory and gives information about those files
13 For information on how to establish a local Source Directory on your
20    The OpenEmbedded build system does not support file or directory
21    names that contain spaces. Be sure that the Source Directory you use
29 This section describes the top-level components of the :term:`Source Directory`.
36 This directory includes a copy of BitBake for ease of use. The copy
44 resides in the ``bitbake/bin/`` directory) starts. Sourcing the
57 This directory contains user configuration files and the output
59 where the source tree is combined with the output. The :term:`Build Directory`
65 directory separate from the :term:`Source Directory` by
66 providing a directory name when you ``source`` the setup script. For
67 information on separating output from your local Source Directory files
76 This directory holds the source for the Yocto Project documentation as
80 ``ref-manual/`` directory.
87 This directory contains the minimal, underlying OpenEmbedded-Core
88 metadata. The directory holds recipes, common classes, and machine
97 Designed above the ``meta/`` content, this directory adds just enough
105 This directory contains the Yocto Project reference hardware Board
114 This directory adds additional recipes and append files used by the
124 This directory contains template recipes for BSP and kernel development.
131 This directory contains various integration scripts that implement extra
133 :ref:`structure-core-script` script prepends this directory to the
136 The ``scripts`` directory has useful scripts that assist in contributing
148 directory. You need to run an environment setup script before running
150 directory to do the bulk of the work.
153 :term:`Build Directory` is created, your working
154 directory becomes the Build Directory, and you are presented with some
173 ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory
174 within the :term:`Source Directory`. If you design a
178 ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`"
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
187 Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`::
192 are found by default in the ``meta-poky/conf/`` directory in the Source
193 Directory. See the
194 ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`"
200    The OpenEmbedded build system does not support file or directory
202    script from a Source Directory that contains spaces in either the
203    filenames or directory names, the script returns an error indicating
204    no such file or directory. Be sure to use a Source Directory free of
216 The Build Directory - ``build/``
219 The OpenEmbedded build system creates the :term:`Build Directory`
222 Directory a specific name when you run the setup script, the name
225 For subsequent parsing and processing, the name of the Build directory
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
282    ``scripts/oe-setup-builddir`` script in the :term:`Source Directory`.
284    the ``meta-poky/conf`` directory.
293 which are directory trees, traversed (or walked) by BitBake. The
319    script in the :term:`Source Directory`. You can find the Yocto Project
321    directory.
336 This directory contains downloaded upstream source tarballs. You can
337 reuse the directory for multiple builds or move the directory to another
338 location. You can control the location of this directory through the
346 This directory contains the shared state cache. You can reuse the
347 directory for multiple builds or move the directory to another location.
348 You can control the location of this directory through the
356 The OpenEmbedded build system creates and uses this directory for all
358 points to this directory.
360 BitBake creates this directory if it does not exist. As a last resort,
362 downloads), you can remove everything in the ``tmp`` directory or get
363 rid of the directory completely. If you do, you should also completely
364 remove the ``build/sstate-cache`` directory.
371 This directory stores the build statistics.
394 This directory contains any "end result" output from the OpenEmbedded
396 to this directory. For more detail on the contents of the ``deploy``
397 directory, see the
407 This directory receives any ``.deb`` packages produced by the build
416 This directory receives any ``.rpm`` packages produced by the build
425 This directory receives ``.ipk`` packages produced by the build process.
432 This directory receives package licensing information. For example, the
433 directory contains sub-directories for ``bash``, ``busybox``, and
445 This directory is populated with the basic output objects of the build
451 Be careful when deleting files in this directory. You can safely delete
452 old images from this directory (e.g. ``core-image-*``). However, the
472 The OpenEmbedded build system creates this directory to hold toolchain
484 The OpenEmbedded build system uses this directory for the shared state
497 This directory is the location of the sysroot contents that the task
500 in :term:`DEPENDS`. Population of this directory is
503 unusual circumstances, handling of the ``sysroots-components`` directory
516 ``build/tmp/sysroots/`` directory is unused.
520    The ``build/tmp/sysroots/`` directory can still be populated using the
522    cases. However, in general it is not recommended to populate this directory.
530 This directory holds information that BitBake uses for accounting
532 directory is sub-divided by architecture, package name, and version.
537 Although the files in the directory are empty of data, BitBake uses the filenames
550 This directory contains general logs that are not otherwise placed using
553 necessarily mean this directory is created.
560 This directory contains architecture-specific work sub-directories for
562 directory. For example, the source for a particular package is unpacked,
563 patched, configured and compiled all within its own work directory.
564 Within the work directory, organization is based on the package group
568 It is worth considering the structure of a typical work directory. As an
570 built within the Yocto Project. For this package, a work directory of
572 to as the :term:`WORKDIR`, is created. Within this directory, the source is
576 the ``linux-qemux86-standard-build`` directory, standard Quilt
581 important directory is ``WORKDIR/temp/``, which has log files for each
583 task (``run.do_*.pid``). The ``WORKDIR/image/`` directory is where "make
592 The recipe work directory - ``${WORKDIR}``.
597 build system builds each recipe in its own work directory (i.e.
598 :term:`WORKDIR`). The path to the work directory is
604 Here are key subdirectories within each recipe work directory:
630 -  ``${WORKDIR}/recipe-sysroot``: A directory populated with the target
631    dependencies of the recipe. This directory looks like the target
635 -  ``${WORKDIR}/recipe-sysroot-native``: A directory populated with the
636    native dependencies of the recipe. This directory contains the tools
642    The OpenEmbedded build system uses this directory as a separate build
643    directory (i.e. ``${``\ :term:`B`\ ``}``).
651 directory to hold recipes that share a work directory with other
668 This directory contains the ``*.bbclass`` files. Class files are used to
687 This directory contains the core set of configuration files that start
700 This directory contains all the machine configuration files. If you set
702 ``qemux86.conf`` file in this directory. The ``include`` directory
704 support for a new machine to the Yocto Project, look in this directory.
711 The contents of this directory controls any distribution-specific
713 main file here. This directory includes the versions and the :term:`SRCDATE`
723 The OpenEmbedded build system searches this directory for configuration
736 This directory contains common license files and several text files used
745 This directory contains OpenEmbedded Python library code used during the
753 This directory contains anything linking to specific hardware or
761 This directory contains libraries and applications related to
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
785 This directory contains non-essential applications that add features
786 compared to the alternatives in core. You might need this directory for
794 This directory contains all things related to the GTK+ application
802 This directory contains X and other graphically related system
810 This directory contains the kernel and generic applications and
818 This directory contains codecs and support utilities for audio, images
826 This directory contains package and image recipes for using and testing
834 This directory contains the Sato demo/reference UI/UX and its associated
842 This directory contains recipes used by other recipes, but that are not
850 This directory contains a list of cached results for various
853 live system, the information in this directory is passed to "autoconf"