diff options
| author | Quentin Schulz <foss@0leil.net> | 2020-10-05 20:37:23 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-10-20 11:12:06 +0100 |
| commit | 8dd785f120ab73ec78ebcc4c8dd65141b7472885 (patch) | |
| tree | 2775567bdd4e674578851f074c7dac828293725b /documentation/ref-manual/ref-structure.rst | |
| parent | e2a2c80de07ede2a6fc4ee595ad1587c0812d99c (diff) | |
| download | poky-8dd785f120ab73ec78ebcc4c8dd65141b7472885.tar.gz | |
docs: ref-manual: indentation, links and highlights fixes
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: f5688a74cd9d100dee270edb9a33c02015cfabda)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-structure.rst')
| -rw-r--r-- | documentation/ref-manual/ref-structure.rst | 55 |
1 files changed, 20 insertions, 35 deletions
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index ef07354ec1..ff5d863736 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst | |||
| @@ -282,17 +282,10 @@ file, it uses ``sed`` to substitute final | |||
| 282 | 282 | ||
| 283 | .. note:: | 283 | .. note:: |
| 284 | 284 | ||
| 285 | You can see how the | 285 | You can see how the ``TEMPLATECONF`` variable is used by looking at the |
| 286 | TEMPLATECONF | 286 | ``scripts/oe-setup-builddir``` script in the :term:`Source Directory`. |
| 287 | variable is used by looking at the | 287 | You can find the Yocto Project version of the ``local.conf.sample`` file in |
| 288 | scripts/oe-setup-builddir | 288 | the ``meta-poky/conf`` directory. |
| 289 | script in the | ||
| 290 | Source Directory | ||
| 291 | . You can find the Yocto Project version of the | ||
| 292 | local.conf.sample | ||
| 293 | file in the | ||
| 294 | meta-poky/conf | ||
| 295 | directory. | ||
| 296 | 289 | ||
| 297 | .. _structure-build-conf-bblayers.conf: | 290 | .. _structure-build-conf-bblayers.conf: |
| 298 | 291 | ||
| @@ -327,16 +320,9 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final | |||
| 327 | 320 | ||
| 328 | .. note:: | 321 | .. note:: |
| 329 | 322 | ||
| 330 | You can see how the | 323 | You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir`` |
| 331 | TEMPLATECONF | 324 | script in the :term:`Source Directory`. You can find the Yocto Project |
| 332 | variable | 325 | version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/`` |
| 333 | scripts/oe-setup-builddir | ||
| 334 | script in the | ||
| 335 | Source Directory | ||
| 336 | . You can find the Yocto Project version of the | ||
| 337 | bblayers.conf.sample | ||
| 338 | file in the | ||
| 339 | meta-poky/conf/ | ||
| 340 | directory. | 326 | directory. |
| 341 | 327 | ||
| 342 | .. _structure-build-conf-sanity_info: | 328 | .. _structure-build-conf-sanity_info: |
| @@ -531,19 +517,16 @@ should be automatic, and recipes should not directly reference | |||
| 531 | 517 | ||
| 532 | Previous versions of the OpenEmbedded build system used to create a | 518 | Previous versions of the OpenEmbedded build system used to create a |
| 533 | global shared sysroot per machine along with a native sysroot. Beginning | 519 | global shared sysroot per machine along with a native sysroot. Beginning |
| 534 | with the DISTRO version of the Yocto Project, sysroots exist in | 520 | with the 2.3 version of the Yocto Project, sysroots exist in |
| 535 | recipe-specific :term:`WORKDIR` directories. Thus, the | 521 | recipe-specific :term:`WORKDIR` directories. Thus, the |
| 536 | ``build/tmp/sysroots/`` directory is unused. | 522 | ``build/tmp/sysroots/`` directory is unused. |
| 537 | 523 | ||
| 538 | .. note:: | 524 | .. note:: |
| 539 | 525 | ||
| 540 | The | 526 | The ``build/tmp/sysroots/`` directory can still be populated using the |
| 541 | build/tmp/sysroots/ | 527 | ``bitbake build-sysroots`` command and can be used for compatibility in some |
| 542 | directory can still be populated using the | 528 | cases. However, in general it is not recommended to populate this directory. |
| 543 | bitbake build-sysroots | 529 | Individual recipe-specific sysroots should be used. |
| 544 | command and can be used for compatibility in some cases. However, in | ||
| 545 | general it is not recommended to populate this directory. Individual | ||
| 546 | recipe-specific sysroots should be used. | ||
| 547 | 530 | ||
| 548 | .. _structure-build-tmp-stamps: | 531 | .. _structure-build-tmp-stamps: |
| 549 | 532 | ||
| @@ -554,8 +537,11 @@ This directory holds information that BitBake uses for accounting | |||
| 554 | purposes to track what tasks have run and when they have run. The | 537 | purposes to track what tasks have run and when they have run. The |
| 555 | directory is sub-divided by architecture, package name, and version. | 538 | directory is sub-divided by architecture, package name, and version. |
| 556 | Following is an example: | 539 | Following is an example: |
| 557 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do Although | 540 | :: |
| 558 | the files in the directory are empty of data, BitBake uses the filenames | 541 | |
| 542 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do | ||
| 543 | |||
| 544 | Although the files in the directory are empty of data, BitBake uses the filenames | ||
| 559 | and timestamps for tracking purposes. | 545 | and timestamps for tracking purposes. |
| 560 | 546 | ||
| 561 | For information on how BitBake uses stamp files to determine if a task | 547 | For information on how BitBake uses stamp files to determine if a task |
| @@ -613,13 +599,12 @@ install" places its output that is then split into sub-packages within | |||
| 613 | The recipe work directory - ``${WORKDIR}``. | 599 | The recipe work directory - ``${WORKDIR}``. |
| 614 | 600 | ||
| 615 | As described earlier in the | 601 | As described earlier in the |
| 616 | "```build/tmp/sysroots/`` <#structure-build-tmp-sysroots>`__" section, | 602 | ":ref:`structure-build-tmp-sysroots`" section, |
| 617 | beginning with the DISTRO release of the Yocto Project, the OpenEmbedded | 603 | beginning with the 2.3 release of the Yocto Project, the OpenEmbedded |
| 618 | build system builds each recipe in its own work directory (i.e. | 604 | build system builds each recipe in its own work directory (i.e. |
| 619 | :term:`WORKDIR`). The path to the work directory is | 605 | :term:`WORKDIR`). The path to the work directory is |
| 620 | constructed using the architecture of the given build (e.g. | 606 | constructed using the architecture of the given build (e.g. |
| 621 | :term:`TUNE_PKGARCH`, | 607 | :term:`TUNE_PKGARCH`, :term:`MACHINE_ARCH`, or "allarch"), the recipe |
| 622 | :term:`MACHINE_ARCH`, or "allarch"), the recipe | ||
| 623 | name, and the version of the recipe (i.e. | 608 | name, and the version of the recipe (i.e. |
| 624 | :term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). | 609 | :term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). |
| 625 | 610 | ||
