summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/faq.rst2
-rw-r--r--documentation/ref-manual/migration-1.7.rst2
-rw-r--r--documentation/ref-manual/migration-2.3.rst2
-rw-r--r--documentation/ref-manual/ref-classes.rst12
-rw-r--r--documentation/ref-manual/ref-release-process.rst2
-rw-r--r--documentation/ref-manual/ref-structure.rst6
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst2
-rw-r--r--documentation/ref-manual/ref-tasks.rst36
-rw-r--r--documentation/ref-manual/ref-terms.rst6
-rw-r--r--documentation/ref-manual/ref-variables.rst46
10 files changed, 58 insertions, 58 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 5b9fcc1912..cc6b3aee1b 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -198,7 +198,7 @@ and also any configuration information about how that package was
198configured and built. 198configured and built.
199 199
200You can find more information on licensing in the 200You can find more information on licensing in the
201":ref:`overview-manual/overview-manual-development-environment:licensing`" 201":ref:`overview-manual/development-environment:licensing`"
202section in the Yocto 202section in the Yocto
203Project Overview and Concepts Manual and also in the 203Project Overview and Concepts Manual and also in the
204":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" 204":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst
index 85894d9df7..177d40900f 100644
--- a/documentation/ref-manual/migration-1.7.rst
+++ b/documentation/ref-manual/migration-1.7.rst
@@ -26,7 +26,7 @@ QEMU, you should now have these lines in ``local.conf``:
26Minimum Git version 26Minimum Git version
27------------------- 27-------------------
28 28
29The minimum :ref:`overview-manual/overview-manual-development-environment:git` 29The minimum :ref:`overview-manual/development-environment:git`
30version required on the 30version required on the
31build host is now 1.7.8 because the ``--list`` option is now required by 31build host is now 1.7.8 because the ``--list`` option is now required by
32BitBake's Git fetcher. As always, if your host distribution does not 32BitBake's Git fetcher. As always, if your host distribution does not
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index 9e95f45e1f..6984ff91e8 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -51,7 +51,7 @@ Consider the following:
51 :term:`SYSROOT_PREPROCESS_FUNCS`. 51 :term:`SYSROOT_PREPROCESS_FUNCS`.
52 52
53 For an example, see the ``pixbufcache`` class in ``meta/classes/`` in 53 For an example, see the ``pixbufcache`` class in ``meta/classes/`` in
54 the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`. 54 the :ref:`overview-manual/development-environment:yocto project source repositories`.
55 55
56 .. note:: 56 .. note::
57 57
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 914ca42324..900341e5ac 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -406,7 +406,7 @@ cross-compilation tools.
406 406
407The ``cross-canadian`` class provides support for the recipes that build 407The ``cross-canadian`` class provides support for the recipes that build
408the Canadian Cross-compilation tools for SDKs. See the 408the Canadian Cross-compilation tools for SDKs. See the
409":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`" 409":ref:`overview-manual/concepts:cross-development toolchain generation`"
410section in the Yocto Project Overview and Concepts Manual for more 410section in the Yocto Project Overview and Concepts Manual for more
411discussion on these cross-compilation tools. 411discussion on these cross-compilation tools.
412 412
@@ -417,7 +417,7 @@ discussion on these cross-compilation tools.
417 417
418The ``crosssdk`` class provides support for the recipes that build the 418The ``crosssdk`` class provides support for the recipes that build the
419cross-compilation tools used for building SDKs. See the 419cross-compilation tools used for building SDKs. See the
420":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`" 420":ref:`overview-manual/concepts:cross-development toolchain generation`"
421section in the Yocto Project Overview and Concepts Manual for more 421section in the Yocto Project Overview and Concepts Manual for more
422discussion on these cross-compilation tools. 422discussion on these cross-compilation tools.
423 423
@@ -930,7 +930,7 @@ For information on customizing images, see the
930":ref:`dev-manual/common-tasks:customizing images`" section 930":ref:`dev-manual/common-tasks:customizing images`" section
931in the Yocto Project Development Tasks Manual. For information on how 931in the Yocto Project Development Tasks Manual. For information on how
932images are created, see the 932images are created, see the
933":ref:`overview-manual/overview-manual-concepts:images`" section in the 933":ref:`overview-manual/concepts:images`" section in the
934Yocto Project Overview and Concpets Manual. 934Yocto Project Overview and Concpets Manual.
935 935
936.. _ref-classes-image-buildinfo: 936.. _ref-classes-image-buildinfo:
@@ -2039,7 +2039,7 @@ These classes are inherited by and used with the ``populate_sdk_base``
2039class. 2039class.
2040 2040
2041For more information on the cross-development toolchain generation, see 2041For more information on the cross-development toolchain generation, see
2042the ":ref:`overview-manual/overview-manual-concepts:cross-development toolchain generation`" 2042the ":ref:`overview-manual/concepts:cross-development toolchain generation`"
2043section in the Yocto Project Overview and Concepts Manual. For 2043section in the Yocto Project Overview and Concepts Manual. For
2044information on advantages gained when building a cross-development 2044information on advantages gained when building a cross-development
2045toolchain using the :ref:`ref-tasks-populate_sdk` 2045toolchain using the :ref:`ref-tasks-populate_sdk`
@@ -2268,7 +2268,7 @@ The root filesystem is created from packages using one of the
2268:term:`PACKAGE_CLASSES` variable. 2268:term:`PACKAGE_CLASSES` variable.
2269 2269
2270For information on how root filesystem images are created, see the 2270For information on how root filesystem images are created, see the
2271":ref:`overview-manual/overview-manual-concepts:image generation`" 2271":ref:`overview-manual/concepts:image generation`"
2272section in the Yocto Project Overview and Concepts Manual. 2272section in the Yocto Project Overview and Concepts Manual.
2273 2273
2274.. _ref-classes-sanity: 2274.. _ref-classes-sanity:
@@ -2375,7 +2375,7 @@ default, the class is enabled through the
2375:term:`INHERIT_DISTRO` variable's default value. 2375:term:`INHERIT_DISTRO` variable's default value.
2376 2376
2377For more information on sstate, see the 2377For more information on sstate, see the
2378":ref:`overview-manual/overview-manual-concepts:shared state cache`" 2378":ref:`overview-manual/concepts:shared state cache`"
2379section in the Yocto Project Overview and Concepts Manual. 2379section in the Yocto Project Overview and Concepts Manual.
2380 2380
2381.. _ref-classes-staging: 2381.. _ref-classes-staging:
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index 54cd9510f6..20be09a4ff 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -50,7 +50,7 @@ Major Release Codenames
50======================= 50=======================
51 51
52Each major release receives a codename that identifies the release in 52Each major release receives a codename that identifies the release in
53the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`. 53the :ref:`overview-manual/development-environment:yocto project source repositories`.
54The concept is that branches of :term:`Metadata` with the same 54The concept is that branches of :term:`Metadata` with the same
55codename are likely to be compatible and thus work together. 55codename are likely to be compatible and thus work together.
56 56
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index b681e8233f..606a77c7fa 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -399,8 +399,8 @@ This directory contains any "end result" output from the OpenEmbedded
399build process. The :term:`DEPLOY_DIR` variable points 399build process. The :term:`DEPLOY_DIR` variable points
400to this directory. For more detail on the contents of the ``deploy`` 400to this directory. For more detail on the contents of the ``deploy``
401directory, see the 401directory, see the
402":ref:`overview-manual/overview-manual-concepts:images`" and 402":ref:`overview-manual/concepts:images`" and
403":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections in the Yocto 403":ref:`overview-manual/concepts:application development sdk`" sections in the Yocto
404Project Overview and Concepts Manual. 404Project Overview and Concepts Manual.
405 405
406.. _structure-build-tmp-deploy-deb: 406.. _structure-build-tmp-deploy-deb:
@@ -545,7 +545,7 @@ and timestamps for tracking purposes.
545 545
546For information on how BitBake uses stamp files to determine if a task 546For information on how BitBake uses stamp files to determine if a task
547should be rerun, see the 547should be rerun, see the
548":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`" 548":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
549section in the Yocto Project Overview and Concepts Manual. 549section in the Yocto Project Overview and Concepts Manual.
550 550
551.. _structure-build-tmp-log: 551.. _structure-build-tmp-log:
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index d162c9bad2..66afb08102 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -15,7 +15,7 @@ Yocto Project.
15 15
16For introductory information on the Yocto Project, see the 16For introductory information on the Yocto Project, see the
17:yocto_home:`Yocto Project Website <>` and the 17:yocto_home:`Yocto Project Website <>` and the
18":ref:`overview-manual/overview-manual-development-environment:the yocto project development environment`" 18":ref:`overview-manual/development-environment:the yocto project development environment`"
19chapter in the Yocto Project Overview and Concepts Manual. 19chapter in the Yocto Project Overview and Concepts Manual.
20 20
21If you want to use the Yocto Project to quickly build an image without 21If you want to use the Yocto Project to quickly build an image without
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 768c10eebd..8b9e0c2d89 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -140,7 +140,7 @@ The ``do_image`` task performs pre-processing on the image through the
140:term:`IMAGE_PREPROCESS_COMMAND` and 140:term:`IMAGE_PREPROCESS_COMMAND` and
141dynamically generates supporting ``do_image_*`` tasks as needed. 141dynamically generates supporting ``do_image_*`` tasks as needed.
142 142
143For more information on image creation, see the ":ref:`overview-manual/overview-manual-concepts:image generation`" 143For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
144section in the Yocto Project Overview and Concepts Manual. 144section in the Yocto Project Overview and Concepts Manual.
145 145
146.. _ref-tasks-image-complete: 146.. _ref-tasks-image-complete:
@@ -159,7 +159,7 @@ through the
159:term:`IMAGE_POSTPROCESS_COMMAND`. 159:term:`IMAGE_POSTPROCESS_COMMAND`.
160 160
161For more information on image creation, see the 161For more information on image creation, see the
162":ref:`overview-manual/overview-manual-concepts:image generation`" 162":ref:`overview-manual/concepts:image generation`"
163section in the Yocto Project Overview and Concepts Manual. 163section in the Yocto Project Overview and Concepts Manual.
164 164
165.. _ref-tasks-install: 165.. _ref-tasks-install:
@@ -174,7 +174,7 @@ compilation directory. The ``do_install`` task, as well as other tasks
174that either directly or indirectly depend on the installed files (e.g. 174that either directly or indirectly depend on the installed files (e.g.
175:ref:`ref-tasks-package`, ``do_package_write_*``, and 175:ref:`ref-tasks-package`, ``do_package_write_*``, and
176:ref:`ref-tasks-rootfs`), run under 176:ref:`ref-tasks-rootfs`), run under
177:ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. 177:ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
178 178
179.. note:: 179.. note::
180 180
@@ -218,7 +218,7 @@ The ``do_package`` task, in conjunction with the
218:ref:`ref-tasks-packagedata` task, also saves some 218:ref:`ref-tasks-packagedata` task, also saves some
219important package metadata. For additional information, see the 219important package metadata. For additional information, see the
220:term:`PKGDESTWORK` variable and the 220:term:`PKGDESTWORK` variable and the
221":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 221":ref:`overview-manual/concepts:automatically added runtime dependencies`"
222section in the Yocto Project Overview and Concepts Manual. 222section in the Yocto Project Overview and Concepts Manual.
223 223
224.. _ref-tasks-package_qa: 224.. _ref-tasks-package_qa:
@@ -237,7 +237,7 @@ see the :ref:`insane <ref-classes-insane>` class.
237Creates Debian packages (i.e. ``*.deb`` files) and places them in the 237Creates Debian packages (i.e. ``*.deb`` files) and places them in the
238``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in 238``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
239the package feeds area. For more information, see the 239the package feeds area. For more information, see the
240":ref:`overview-manual/overview-manual-concepts:package feeds`" section in 240":ref:`overview-manual/concepts:package feeds`" section in
241the Yocto Project Overview and Concepts Manual. 241the Yocto Project Overview and Concepts Manual.
242 242
243.. _ref-tasks-package_write_ipk: 243.. _ref-tasks-package_write_ipk:
@@ -248,7 +248,7 @@ the Yocto Project Overview and Concepts Manual.
248Creates IPK packages (i.e. ``*.ipk`` files) and places them in the 248Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
249``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in 249``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
250the package feeds area. For more information, see the 250the package feeds area. For more information, see the
251":ref:`overview-manual/overview-manual-concepts:package feeds`" section in 251":ref:`overview-manual/concepts:package feeds`" section in
252the Yocto Project Overview and Concepts Manual. 252the Yocto Project Overview and Concepts Manual.
253 253
254.. _ref-tasks-package_write_rpm: 254.. _ref-tasks-package_write_rpm:
@@ -259,7 +259,7 @@ the Yocto Project Overview and Concepts Manual.
259Creates RPM packages (i.e. ``*.rpm`` files) and places them in the 259Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
260``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in 260``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
261the package feeds area. For more information, see the 261the package feeds area. For more information, see the
262":ref:`overview-manual/overview-manual-concepts:package feeds`" section in 262":ref:`overview-manual/concepts:package feeds`" section in
263the Yocto Project Overview and Concepts Manual. 263the Yocto Project Overview and Concepts Manual.
264 264
265.. _ref-tasks-package_write_tar: 265.. _ref-tasks-package_write_tar:
@@ -270,7 +270,7 @@ the Yocto Project Overview and Concepts Manual.
270Creates tarballs and places them in the 270Creates tarballs and places them in the
271``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in 271``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
272the package feeds area. For more information, see the 272the package feeds area. For more information, see the
273":ref:`overview-manual/overview-manual-concepts:package feeds`" section in 273":ref:`overview-manual/concepts:package feeds`" section in
274the Yocto Project Overview and Concepts Manual. 274the Yocto Project Overview and Concepts Manual.
275 275
276.. _ref-tasks-packagedata: 276.. _ref-tasks-packagedata:
@@ -349,7 +349,7 @@ patch files end with either ``.patch`` or ``.diff``, every file would be
349applied as a patch by default except for the ``patch_file5`` patch. 349applied as a patch by default except for the ``patch_file5`` patch.
350 350
351You can find out more about the patching process in the 351You can find out more about the patching process in the
352":ref:`overview-manual/overview-manual-concepts:patching`" section in 352":ref:`overview-manual/concepts:patching`" section in
353the Yocto Project Overview and Concepts Manual and the 353the Yocto Project Overview and Concepts Manual and the
354":ref:`dev-manual/common-tasks:patching code`" section in the 354":ref:`dev-manual/common-tasks:patching code`" section in the
355Yocto Project Development Tasks Manual. 355Yocto Project Development Tasks Manual.
@@ -368,7 +368,7 @@ the image is constructed.
368------------------- 368-------------------
369 369
370Creates the file and directory structure for an installable SDK. See the 370Creates the file and directory structure for an installable SDK. See the
371":ref:`overview-manual/overview-manual-concepts:sdk generation`" 371":ref:`overview-manual/concepts:sdk generation`"
372section in the Yocto Project Overview and Concepts Manual for more 372section in the Yocto Project Overview and Concepts Manual for more
373information. 373information.
374 374
@@ -378,7 +378,7 @@ information.
378----------------------- 378-----------------------
379 379
380Creates the file and directory structure for an installable extensible 380Creates the file and directory structure for an installable extensible
381SDK (eSDK). See the ":ref:`overview-manual/overview-manual-concepts:sdk generation`" 381SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
382section in the Yocto Project Overview and Concepts Manual for more 382section in the Yocto Project Overview and Concepts Manual for more
383information. 383information.
384 384
@@ -434,7 +434,7 @@ Unpacks the source code into a working directory pointed to by
434``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` 434``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
435variable also plays a role in where unpacked source files ultimately 435variable also plays a role in where unpacked source files ultimately
436reside. For more information on how source files are unpacked, see the 436reside. For more information on how source files are unpacked, see the
437":ref:`overview-manual/overview-manual-concepts:source fetching`" 437":ref:`overview-manual/concepts:source fetching`"
438section in the Yocto Project Overview and Concepts Manual and also see 438section in the Yocto Project Overview and Concepts Manual and also see
439the ``WORKDIR`` and ``S`` variable descriptions. 439the ``WORKDIR`` and ``S`` variable descriptions.
440 440
@@ -500,7 +500,7 @@ You can run this task using BitBake as follows:
500 $ bitbake -c clean recipe 500 $ bitbake -c clean recipe
501 501
502Running this task does not remove the 502Running this task does not remove the
503:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>` cache files. 503:ref:`sstate <overview-manual/concepts:shared state cache>` cache files.
504Consequently, if no changes have been made and the recipe is rebuilt 504Consequently, if no changes have been made and the recipe is rebuilt
505after cleaning, output files are simply restored from the sstate cache. 505after cleaning, output files are simply restored from the sstate cache.
506If you want to remove the sstate cache files for the recipe, you need to 506If you want to remove the sstate cache files for the recipe, you need to
@@ -513,7 +513,7 @@ use the :ref:`ref-tasks-cleansstate` task instead
513--------------- 513---------------
514 514
515Removes all output files, shared state 515Removes all output files, shared state
516(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, and 516(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, and
517downloaded source files for a target (i.e. the contents of 517downloaded source files for a target (i.e. the contents of
518:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is 518:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is
519identical to the :ref:`ref-tasks-cleansstate` task 519identical to the :ref:`ref-tasks-cleansstate` task
@@ -534,10 +534,10 @@ task.
534------------------ 534------------------
535 535
536Removes all output files and shared state 536Removes all output files and shared state
537(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a 537(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a
538target. Essentially, the ``do_cleansstate`` task is identical to the 538target. Essentially, the ``do_cleansstate`` task is identical to the
539:ref:`ref-tasks-clean` task with the added removal of 539:ref:`ref-tasks-clean` task with the added removal of
540shared state (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) 540shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`)
541cache. 541cache.
542 542
543You can run this task using BitBake as follows: 543You can run this task using BitBake as follows:
@@ -593,7 +593,7 @@ Lists all defined tasks for a target.
593``do_package_index`` 593``do_package_index``
594-------------------- 594--------------------
595 595
596Creates or updates the index in the :ref:`overview-manual/overview-manual-concepts:package feeds` area. 596Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area.
597 597
598.. note:: 598.. note::
599 599
@@ -631,7 +631,7 @@ has some more information about these types of images.
631------------- 631-------------
632 632
633Creates the root filesystem (file and directory structure) for an image. 633Creates the root filesystem (file and directory structure) for an image.
634See the ":ref:`overview-manual/overview-manual-concepts:image generation`" 634See the ":ref:`overview-manual/concepts:image generation`"
635section in the Yocto Project Overview and Concepts Manual for more 635section in the Yocto Project Overview and Concepts Manual for more
636information on how the root filesystem is created. 636information on how the root filesystem is created.
637 637
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index ba1930ebda..f41073602d 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -160,7 +160,7 @@ universal, the list includes them just in case:
160 160
161 Creation of these toolchains is simple and automated. For information on 161 Creation of these toolchains is simple and automated. For information on
162 toolchain concepts as they apply to the Yocto Project, see the 162 toolchain concepts as they apply to the Yocto Project, see the
163 ":ref:`overview-manual/overview-manual-concepts:Cross-Development 163 ":ref:`overview-manual/concepts:Cross-Development
164 Toolchain Generation`" section in the Yocto Project Overview and Concepts 164 Toolchain Generation`" section in the Yocto Project Overview and Concepts
165 Manual. You can also find more information on using the relocatable 165 Manual. You can also find more information on using the relocatable
166 toolchain in the :doc:`/sdk-manual/index` manual. 166 toolchain in the :doc:`/sdk-manual/index` manual.
@@ -189,7 +189,7 @@ universal, the list includes them just in case:
189 layers used within Yocto Project. 189 layers used within Yocto Project.
190 190
191 For introductory information on layers, see the 191 For introductory information on layers, see the
192 ":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer 192 ":ref:`overview-manual/yp-intro:The Yocto Project Layer
193 Model`" section in the Yocto Project Overview and Concepts Manual. For 193 Model`" section in the Yocto Project Overview and Concepts Manual. For
194 more detailed information on layers, see the 194 more detailed information on layers, see the
195 ":ref:`dev-manual/common-tasks:Understanding and Creating 195 ":ref:`dev-manual/common-tasks:Understanding and Creating
@@ -366,7 +366,7 @@ universal, the list includes them just in case:
366 366
367 For more information on concepts related to Git repositories, 367 For more information on concepts related to Git repositories,
368 branches, and tags, see the 368 branches, and tags, see the
369 ":ref:`overview-manual/overview-manual-development-environment:repositories, tags, and branches`" 369 ":ref:`overview-manual/development-environment:repositories, tags, and branches`"
370 section in the Yocto Project Overview and Concepts Manual. 370 section in the Yocto Project Overview and Concepts Manual.
371 371
372 :term:`Task` 372 :term:`Task`
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index d98e358173..a8a949b92a 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -1016,7 +1016,7 @@ system and gives an overview of their function and contents.
1016 (SDK). 1016 (SDK).
1017 1017
1018 - *task:* Save output file signatures for 1018 - *task:* Save output file signatures for
1019 :ref:`shared state <overview-manual/overview-manual-concepts:shared state cache>` 1019 :ref:`shared state <overview-manual/concepts:shared state cache>`
1020 (sstate) tasks. 1020 (sstate) tasks.
1021 This saves one file per task and lists the SHA-256 checksums for 1021 This saves one file per task and lists the SHA-256 checksums for
1022 each file staged (i.e. the output of the task). 1022 each file staged (i.e. the output of the task).
@@ -1522,7 +1522,7 @@ system and gives an overview of their function and contents.
1522 .. note:: 1522 .. note::
1523 1523
1524 Tasks that read from or write to this directory should run under 1524 Tasks that read from or write to this directory should run under
1525 :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. 1525 :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
1526 1526
1527 :term:`DATE` 1527 :term:`DATE`
1528 The date the build was started. Dates appear using the year, month, 1528 The date the build was started. Dates appear using the year, month,
@@ -1641,7 +1641,7 @@ system and gives an overview of their function and contents.
1641 - One recipe having another recipe in ``DEPENDS`` does not by 1641 - One recipe having another recipe in ``DEPENDS`` does not by
1642 itself add any runtime dependencies between the packages 1642 itself add any runtime dependencies between the packages
1643 produced by the two recipes. However, as explained in the 1643 produced by the two recipes. However, as explained in the
1644 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 1644 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
1645 section in the Yocto Project Overview and Concepts Manual, 1645 section in the Yocto Project Overview and Concepts Manual,
1646 runtime dependencies will often be added automatically, meaning 1646 runtime dependencies will often be added automatically, meaning
1647 ``DEPENDS`` alone is sufficient for most recipes. 1647 ``DEPENDS`` alone is sufficient for most recipes.
@@ -1672,9 +1672,9 @@ system and gives an overview of their function and contents.
1672 For more information on the structure of the Build Directory, see 1672 For more information on the structure of the Build Directory, see
1673 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. 1673 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
1674 For more detail on the contents of the ``deploy`` directory, see the 1674 For more detail on the contents of the ``deploy`` directory, see the
1675 ":ref:`overview-manual/overview-manual-concepts:images`", 1675 ":ref:`overview-manual/concepts:images`",
1676 ":ref:`overview-manual/overview-manual-concepts:package feeds`", and 1676 ":ref:`overview-manual/concepts:package feeds`", and
1677 ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections all in the 1677 ":ref:`overview-manual/concepts:application development sdk`" sections all in the
1678 Yocto Project Overview and Concepts Manual. 1678 Yocto Project Overview and Concepts Manual.
1679 1679
1680 :term:`DEPLOY_DIR_DEB` 1680 :term:`DEPLOY_DIR_DEB`
@@ -1696,7 +1696,7 @@ system and gives an overview of their function and contents.
1696 :ref:`ref-tasks-package_write_deb` task 1696 :ref:`ref-tasks-package_write_deb` task
1697 writes Debian packages into the appropriate folder. For more 1697 writes Debian packages into the appropriate folder. For more
1698 information on how packaging works, see the 1698 information on how packaging works, see the
1699 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section 1699 ":ref:`overview-manual/concepts:package feeds`" section
1700 in the Yocto Project Overview and Concepts Manual. 1700 in the Yocto Project Overview and Concepts Manual.
1701 1701
1702 :term:`DEPLOY_DIR_IMAGE` 1702 :term:`DEPLOY_DIR_IMAGE`
@@ -1710,8 +1710,8 @@ system and gives an overview of their function and contents.
1710 For more information on the structure of the Build Directory, see 1710 For more information on the structure of the Build Directory, see
1711 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. 1711 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
1712 For more detail on the contents of the ``deploy`` directory, see the 1712 For more detail on the contents of the ``deploy`` directory, see the
1713 ":ref:`overview-manual/overview-manual-concepts:images`" and 1713 ":ref:`overview-manual/concepts:images`" and
1714 ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections both in 1714 ":ref:`overview-manual/concepts:application development sdk`" sections both in
1715 the Yocto Project Overview and Concepts Manual. 1715 the Yocto Project Overview and Concepts Manual.
1716 1716
1717 :term:`DEPLOY_DIR_IPK` 1717 :term:`DEPLOY_DIR_IPK`
@@ -1732,7 +1732,7 @@ system and gives an overview of their function and contents.
1732 :ref:`ref-tasks-package_write_ipk` task 1732 :ref:`ref-tasks-package_write_ipk` task
1733 writes IPK packages into the appropriate folder. For more information 1733 writes IPK packages into the appropriate folder. For more information
1734 on how packaging works, see the 1734 on how packaging works, see the
1735 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section 1735 ":ref:`overview-manual/concepts:package feeds`" section
1736 in the Yocto Project Overview and Concepts Manual. 1736 in the Yocto Project Overview and Concepts Manual.
1737 1737
1738 :term:`DEPLOY_DIR_RPM` 1738 :term:`DEPLOY_DIR_RPM`
@@ -1753,7 +1753,7 @@ system and gives an overview of their function and contents.
1753 :ref:`ref-tasks-package_write_rpm` task 1753 :ref:`ref-tasks-package_write_rpm` task
1754 writes RPM packages into the appropriate folder. For more information 1754 writes RPM packages into the appropriate folder. For more information
1755 on how packaging works, see the 1755 on how packaging works, see the
1756 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section 1756 ":ref:`overview-manual/concepts:package feeds`" section
1757 in the Yocto Project Overview and Concepts Manual. 1757 in the Yocto Project Overview and Concepts Manual.
1758 1758
1759 :term:`DEPLOY_DIR_TAR` 1759 :term:`DEPLOY_DIR_TAR`
@@ -1774,7 +1774,7 @@ system and gives an overview of their function and contents.
1774 :ref:`ref-tasks-package_write_tar` task 1774 :ref:`ref-tasks-package_write_tar` task
1775 writes TAR packages into the appropriate folder. For more information 1775 writes TAR packages into the appropriate folder. For more information
1776 on how packaging works, see the 1776 on how packaging works, see the
1777 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section 1777 ":ref:`overview-manual/concepts:package feeds`" section
1778 in the Yocto Project Overview and Concepts Manual. 1778 in the Yocto Project Overview and Concepts Manual.
1779 1779
1780 :term:`DEPLOYDIR` 1780 :term:`DEPLOYDIR`
@@ -2419,7 +2419,7 @@ system and gives an overview of their function and contents.
2419 2419
2420 The previous statement appears in the 2420 The previous statement appears in the
2421 ``linux-yocto-dev.bbappend`` file, which is found in the 2421 ``linux-yocto-dev.bbappend`` file, which is found in the
2422 :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` in 2422 :ref:`overview-manual/development-environment:yocto project source repositories` in
2423 ``meta-intel/common/recipes-kernel/linux``. Here, the machine 2423 ``meta-intel/common/recipes-kernel/linux``. Here, the machine
2424 override is a special :term:`PACKAGE_ARCH` 2424 override is a special :term:`PACKAGE_ARCH`
2425 definition for multiple ``meta-intel`` machines. 2425 definition for multiple ``meta-intel`` machines.
@@ -2509,7 +2509,7 @@ system and gives an overview of their function and contents.
2509 build system uses files from ``files/defconfig``. 2509 build system uses files from ``files/defconfig``.
2510 2510
2511 You can find out more about the patching process in the 2511 You can find out more about the patching process in the
2512 ":ref:`overview-manual/overview-manual-concepts:patching`" section 2512 ":ref:`overview-manual/concepts:patching`" section
2513 in the Yocto Project Overview and Concepts Manual and the 2513 in the Yocto Project Overview and Concepts Manual and the
2514 ":ref:`dev-manual/common-tasks:patching code`" section in 2514 ":ref:`dev-manual/common-tasks:patching code`" section in
2515 the Yocto Project Development Tasks Manual. See the 2515 the Yocto Project Development Tasks Manual. See the
@@ -3126,7 +3126,7 @@ system and gives an overview of their function and contents.
3126 The location is 3126 The location is
3127 derived using the :term:`DEPLOY_DIR_IMAGE` 3127 derived using the :term:`DEPLOY_DIR_IMAGE`
3128 and :term:`IMAGE_NAME` variables. You can find 3128 and :term:`IMAGE_NAME` variables. You can find
3129 information on how the image is created in the ":ref:`overview-manual/overview-manual-concepts:image generation`" 3129 information on how the image is created in the ":ref:`overview-manual/concepts:image generation`"
3130 section in the Yocto Project Overview and Concepts Manual. 3130 section in the Yocto Project Overview and Concepts Manual.
3131 3131
3132 :term:`IMAGE_NAME` 3132 :term:`IMAGE_NAME`
@@ -5578,7 +5578,7 @@ system and gives an overview of their function and contents.
5578 ${STAGING_DIR_HOST}/pkgdata 5578 ${STAGING_DIR_HOST}/pkgdata
5579 5579
5580 For examples of how this data is used, see the 5580 For examples of how this data is used, see the
5581 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 5581 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
5582 section in the Yocto Project Overview and Concepts Manual and the 5582 section in the Yocto Project Overview and Concepts Manual and the
5583 ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" 5583 ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``"
5584 section in the Yocto Project Development Tasks Manual. For more 5584 section in the Yocto Project Development Tasks Manual. For more
@@ -5691,9 +5691,9 @@ system and gives an overview of their function and contents.
5691 5691
5692 The OpenEmbedded build system does not need the aid of ``PR`` 5692 The OpenEmbedded build system does not need the aid of ``PR``
5693 to know when to rebuild a recipe. The build system uses the task 5693 to know when to rebuild a recipe. The build system uses the task
5694 :ref:`input checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` along with the 5694 :ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the
5695 :ref:`stamp <structure-build-tmp-stamps>` and 5695 :ref:`stamp <structure-build-tmp-stamps>` and
5696 :ref:`overview-manual/overview-manual-concepts:shared state cache` 5696 :ref:`overview-manual/concepts:shared state cache`
5697 mechanisms. 5697 mechanisms.
5698 5698
5699 The ``PR`` variable primarily becomes significant when a package 5699 The ``PR`` variable primarily becomes significant when a package
@@ -5875,7 +5875,7 @@ system and gives an overview of their function and contents.
5875 libplds4.so" 5875 libplds4.so"
5876 5876
5877 For more information, see the 5877 For more information, see the
5878 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 5878 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
5879 section in the Yocto Project Overview and Concepts Manual. 5879 section in the Yocto Project Overview and Concepts Manual.
5880 5880
5881 :term:`PROVIDES` 5881 :term:`PROVIDES`
@@ -6068,7 +6068,7 @@ system and gives an overview of their function and contents.
6068 runtime dependencies are automatically detected and added. Therefore, 6068 runtime dependencies are automatically detected and added. Therefore,
6069 most recipes do not need to set ``RDEPENDS``. For more information, 6069 most recipes do not need to set ``RDEPENDS``. For more information,
6070 see the 6070 see the
6071 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 6071 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
6072 section in the Yocto Project Overview and Concepts Manual. 6072 section in the Yocto Project Overview and Concepts Manual.
6073 6073
6074 The practical effect of the above ``RDEPENDS`` assignment is that 6074 The practical effect of the above ``RDEPENDS`` assignment is that
@@ -7023,7 +7023,7 @@ system and gives an overview of their function and contents.
7023 7023
7024 - ``file://`` - Fetches files, which are usually files shipped 7024 - ``file://`` - Fetches files, which are usually files shipped
7025 with the :term:`Metadata`, from the local machine (e.g. 7025 with the :term:`Metadata`, from the local machine (e.g.
7026 :ref:`patch <overview-manual/overview-manual-concepts:patching>` files). 7026 :ref:`patch <overview-manual/concepts:patching>` files).
7027 The path is relative to the :term:`FILESPATH` 7027 The path is relative to the :term:`FILESPATH`
7028 variable. Thus, the build system searches, in order, from the 7028 variable. Thus, the build system searches, in order, from the
7029 following directories, which are assumed to be a subdirectories of 7029 following directories, which are assumed to be a subdirectories of
@@ -7316,7 +7316,7 @@ system and gives an overview of their function and contents.
7316 see the :ref:`ref-tasks-populate_sysroot` 7316 see the :ref:`ref-tasks-populate_sysroot`
7317 task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`" 7317 task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`"
7318 section in the Yocto Project Development Tasks Manual, the 7318 section in the Yocto Project Development Tasks Manual, the
7319 ":ref:`overview-manual/overview-manual-concepts:configuration, compilation, and staging`" 7319 ":ref:`overview-manual/concepts:configuration, compilation, and staging`"
7320 section in the Yocto Project Overview and Concepts Manual, and the 7320 section in the Yocto Project Overview and Concepts Manual, and the
7321 :term:`SYSROOT_DIRS` variable. 7321 :term:`SYSROOT_DIRS` variable.
7322 7322
@@ -7437,7 +7437,7 @@ system and gives an overview of their function and contents.
7437 7437
7438 For information on how BitBake uses stamp files to determine if a 7438 For information on how BitBake uses stamp files to determine if a
7439 task should be rerun, see the 7439 task should be rerun, see the
7440 ":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`" 7440 ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
7441 section in the Yocto Project Overview and Concepts Manual. 7441 section in the Yocto Project Overview and Concepts Manual.
7442 7442
7443 See :term:`STAMPS_DIR`, 7443 See :term:`STAMPS_DIR`,