summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-09-22 18:12:11 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-09-24 17:44:56 +0100
commite2ead243cdedfd34793e3a40b9af0116a7b0b0cd (patch)
treef6e9a988a0c9ba607c3b982a26778748333fd4b8
parent1bdbc6c9262829db2761758efbfa3299f38cd967 (diff)
downloadpoky-e2ead243cdedfd34793e3a40b9af0116a7b0b0cd.tar.gz
ref-manual: structure.rst: add more subsection levels
To better reflect the subdirectory structure, as suggested in [YOCTO #14543] (From yocto-docs rev: a35d1b546c219407bc93c87789a7147a9ade270e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/structure.rst40
1 files changed, 20 insertions, 20 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index fa65b687cd..429f81e14c 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -373,14 +373,14 @@ remove the ``build/sstate-cache`` directory.
373.. _structure-build-tmp-buildstats: 373.. _structure-build-tmp-buildstats:
374 374
375``build/tmp/buildstats/`` 375``build/tmp/buildstats/``
376------------------------- 376~~~~~~~~~~~~~~~~~~~~~~~~~
377 377
378This directory stores the build statistics. 378This directory stores the build statistics.
379 379
380.. _structure-build-tmp-cache: 380.. _structure-build-tmp-cache:
381 381
382``build/tmp/cache/`` 382``build/tmp/cache/``
383-------------------- 383~~~~~~~~~~~~~~~~~~~~
384 384
385When BitBake parses the metadata (recipes and configuration files), it 385When BitBake parses the metadata (recipes and configuration files), it
386caches the results in ``build/tmp/cache/`` to speed up future builds. 386caches the results in ``build/tmp/cache/`` to speed up future builds.
@@ -396,7 +396,7 @@ cache is reused. If the file has changed, it is reparsed.
396.. _structure-build-tmp-deploy: 396.. _structure-build-tmp-deploy:
397 397
398``build/tmp/deploy/`` 398``build/tmp/deploy/``
399--------------------- 399~~~~~~~~~~~~~~~~~~~~~
400 400
401This directory contains any "end result" output from the OpenEmbedded 401This directory contains any "end result" output from the OpenEmbedded
402build process. The :term:`DEPLOY_DIR` variable points 402build process. The :term:`DEPLOY_DIR` variable points
@@ -409,7 +409,7 @@ Project Overview and Concepts Manual.
409.. _structure-build-tmp-deploy-deb: 409.. _structure-build-tmp-deploy-deb:
410 410
411``build/tmp/deploy/deb/`` 411``build/tmp/deploy/deb/``
412------------------------- 412^^^^^^^^^^^^^^^^^^^^^^^^^
413 413
414This directory receives any ``.deb`` packages produced by the build 414This directory receives any ``.deb`` packages produced by the build
415process. The packages are sorted into feeds for different architecture 415process. The packages are sorted into feeds for different architecture
@@ -418,7 +418,7 @@ types.
418.. _structure-build-tmp-deploy-rpm: 418.. _structure-build-tmp-deploy-rpm:
419 419
420``build/tmp/deploy/rpm/`` 420``build/tmp/deploy/rpm/``
421------------------------- 421^^^^^^^^^^^^^^^^^^^^^^^^^
422 422
423This directory receives any ``.rpm`` packages produced by the build 423This directory receives any ``.rpm`` packages produced by the build
424process. The packages are sorted into feeds for different architecture 424process. The packages are sorted into feeds for different architecture
@@ -427,14 +427,14 @@ types.
427.. _structure-build-tmp-deploy-ipk: 427.. _structure-build-tmp-deploy-ipk:
428 428
429``build/tmp/deploy/ipk/`` 429``build/tmp/deploy/ipk/``
430------------------------- 430^^^^^^^^^^^^^^^^^^^^^^^^^
431 431
432This directory receives ``.ipk`` packages produced by the build process. 432This directory receives ``.ipk`` packages produced by the build process.
433 433
434.. _structure-build-tmp-deploy-licenses: 434.. _structure-build-tmp-deploy-licenses:
435 435
436``build/tmp/deploy/licenses/`` 436``build/tmp/deploy/licenses/``
437------------------------------ 437^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
438 438
439This directory receives package licensing information. For example, the 439This directory receives package licensing information. For example, the
440directory contains sub-directories for ``bash``, ``busybox``, and 440directory contains sub-directories for ``bash``, ``busybox``, and
@@ -447,7 +447,7 @@ section in the Yocto Project Development Tasks Manual.
447.. _structure-build-tmp-deploy-images: 447.. _structure-build-tmp-deploy-images:
448 448
449``build/tmp/deploy/images/`` 449``build/tmp/deploy/images/``
450---------------------------- 450^^^^^^^^^^^^^^^^^^^^^^^^^^^^
451 451
452This directory is populated with the basic output objects of the build 452This directory is populated with the basic output objects of the build
453(think of them as the "generated artifacts" of the build process), 453(think of them as the "generated artifacts" of the build process),
@@ -474,7 +474,7 @@ the kernel files::
474.. _structure-build-tmp-deploy-sdk: 474.. _structure-build-tmp-deploy-sdk:
475 475
476``build/tmp/deploy/sdk/`` 476``build/tmp/deploy/sdk/``
477------------------------- 477^^^^^^^^^^^^^^^^^^^^^^^^^
478 478
479The OpenEmbedded build system creates this directory to hold toolchain 479The OpenEmbedded build system creates this directory to hold toolchain
480installer scripts which, when executed, install the sysroot that matches 480installer scripts which, when executed, install the sysroot that matches
@@ -486,7 +486,7 @@ Software Development Kit (eSDK) manual.
486.. _structure-build-tmp-sstate-control: 486.. _structure-build-tmp-sstate-control:
487 487
488``build/tmp/sstate-control/`` 488``build/tmp/sstate-control/``
489----------------------------- 489~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
490 490
491The OpenEmbedded build system uses this directory for the shared state 491The OpenEmbedded build system uses this directory for the shared state
492manifest files. The shared state code uses these files to record the 492manifest files. The shared state code uses these files to record the
@@ -499,7 +499,7 @@ another.
499.. _structure-build-tmp-sysroots-components: 499.. _structure-build-tmp-sysroots-components:
500 500
501``build/tmp/sysroots-components/`` 501``build/tmp/sysroots-components/``
502---------------------------------- 502~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503 503
504This directory is the location of the sysroot contents that the task 504This directory is the location of the sysroot contents that the task
505:ref:`ref-tasks-prepare_recipe_sysroot` 505:ref:`ref-tasks-prepare_recipe_sysroot`
@@ -514,7 +514,7 @@ should be automatic, and recipes should not directly reference
514.. _structure-build-tmp-sysroots: 514.. _structure-build-tmp-sysroots:
515 515
516``build/tmp/sysroots/`` 516``build/tmp/sysroots/``
517----------------------- 517~~~~~~~~~~~~~~~~~~~~~~~
518 518
519Previous versions of the OpenEmbedded build system used to create a 519Previous versions of the OpenEmbedded build system used to create a
520global shared sysroot per machine along with a native sysroot. Since 520global shared sysroot per machine along with a native sysroot. Since
@@ -532,7 +532,7 @@ recipe-specific :term:`WORKDIR` directories. Thus, the
532.. _structure-build-tmp-stamps: 532.. _structure-build-tmp-stamps:
533 533
534``build/tmp/stamps/`` 534``build/tmp/stamps/``
535--------------------- 535~~~~~~~~~~~~~~~~~~~~~
536 536
537This directory holds information that BitBake uses for accounting 537This directory holds information that BitBake uses for accounting
538purposes to track what tasks have run and when they have run. The 538purposes to track what tasks have run and when they have run. The
@@ -552,7 +552,7 @@ section in the Yocto Project Overview and Concepts Manual.
552.. _structure-build-tmp-log: 552.. _structure-build-tmp-log:
553 553
554``build/tmp/log/`` 554``build/tmp/log/``
555------------------ 555~~~~~~~~~~~~~~~~~~
556 556
557This directory contains general logs that are not otherwise placed using 557This directory contains general logs that are not otherwise placed using
558the package's :term:`WORKDIR`. Examples of logs are the output from the 558the package's :term:`WORKDIR`. Examples of logs are the output from the
@@ -562,7 +562,7 @@ necessarily mean this directory is created.
562.. _structure-build-tmp-work: 562.. _structure-build-tmp-work:
563 563
564``build/tmp/work/`` 564``build/tmp/work/``
565------------------- 565~~~~~~~~~~~~~~~~~~~
566 566
567This directory contains architecture-specific work sub-directories for 567This directory contains architecture-specific work sub-directories for
568packages built by BitBake. All tasks execute from the appropriate work 568packages built by BitBake. All tasks execute from the appropriate work
@@ -594,7 +594,7 @@ install" places its output that is then split into sub-packages within
594.. _structure-build-tmp-work-tunearch-recipename-version: 594.. _structure-build-tmp-work-tunearch-recipename-version:
595 595
596``build/tmp/work/tunearch/recipename/version/`` 596``build/tmp/work/tunearch/recipename/version/``
597----------------------------------------------- 597^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
598 598
599The recipe work directory --- ``${WORKDIR}``. 599The recipe work directory --- ``${WORKDIR}``.
600 600
@@ -652,7 +652,7 @@ Here are key subdirectories within each recipe work directory:
652.. _structure-build-work-shared: 652.. _structure-build-work-shared:
653 653
654``build/tmp/work-shared/`` 654``build/tmp/work-shared/``
655-------------------------- 655~~~~~~~~~~~~~~~~~~~~~~~~~~
656 656
657For efficiency, the OpenEmbedded build system creates and uses this 657For efficiency, the OpenEmbedded build system creates and uses this
658directory to hold recipes that share a work directory with other 658directory to hold recipes that share a work directory with other
@@ -702,7 +702,7 @@ distribution configuration file.
702.. _structure-meta-conf-machine: 702.. _structure-meta-conf-machine:
703 703
704``meta/conf/machine/`` 704``meta/conf/machine/``
705---------------------- 705~~~~~~~~~~~~~~~~~~~~~~
706 706
707This directory contains all the machine configuration files. If you set 707This directory contains all the machine configuration files. If you set
708``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a 708``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a
@@ -713,7 +713,7 @@ support for a new machine to the Yocto Project, look in this directory.
713.. _structure-meta-conf-distro: 713.. _structure-meta-conf-distro:
714 714
715``meta/conf/distro/`` 715``meta/conf/distro/``
716--------------------- 716~~~~~~~~~~~~~~~~~~~~~
717 717
718The contents of this directory controls any distribution-specific 718The contents of this directory controls any distribution-specific
719configurations. For the Yocto Project, the ``defaultsetup.conf`` is the 719configurations. For the Yocto Project, the ``defaultsetup.conf`` is the
@@ -725,7 +725,7 @@ file mainly inherits its configuration from Poky.
725.. _structure-meta-conf-machine-sdk: 725.. _structure-meta-conf-machine-sdk:
726 726
727``meta/conf/machine-sdk/`` 727``meta/conf/machine-sdk/``
728-------------------------- 728~~~~~~~~~~~~~~~~~~~~~~~~~~
729 729
730The OpenEmbedded build system searches this directory for configuration 730The OpenEmbedded build system searches this directory for configuration
731files that correspond to the value of 731files that correspond to the value of