summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 09:53:06 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-03 12:04:20 +0000
commit986e2902d9c7e040bc6d78398bef065f32a4b30d (patch)
tree5074fc8fc357cc31dde2f5c264760ad513ecc199 /documentation/ref-manual
parente59787249e90b017d970818643cb1bd1d08f28a7 (diff)
downloadpoky-986e2902d9c7e040bc6d78398bef065f32a4b30d.tar.gz
ref-manual: replace labels with references to section title
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.rst16
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst4
-rw-r--r--documentation/ref-manual/ref-features.rst2
-rw-r--r--documentation/ref-manual/ref-structure.rst6
-rw-r--r--documentation/ref-manual/ref-tasks.rst30
-rw-r--r--documentation/ref-manual/ref-variables.rst74
-rw-r--r--documentation/ref-manual/resources.rst2
7 files changed, 67 insertions, 67 deletions
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 249b58e60c..62876194d1 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -86,7 +86,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``,
86should usually be enough to define a few standard variables and then 86should usually be enough to define a few standard variables and then
87simply ``inherit autotools``. These classes can also work with software 87simply ``inherit autotools``. These classes can also work with software
88that emulates Autotools. For more information, see the 88that emulates Autotools. For more information, see the
89":ref:`new-recipe-autotooled-package`" section 89":ref:`dev-manual/dev-manual-common-tasks:autotooled package`" section
90in the Yocto Project Development Tasks Manual. 90in the Yocto Project Development Tasks Manual.
91 91
92By default, the ``autotools*`` classes use out-of-tree builds (i.e. 92By default, the ``autotools*`` classes use out-of-tree builds (i.e.
@@ -458,7 +458,7 @@ staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``.
458==================== 458====================
459 459
460The ``devshell`` class adds the ``do_devshell`` task. Distribution 460The ``devshell`` class adds the ``do_devshell`` task. Distribution
461policy dictates whether to include this class. See the ":ref:`platdev-appdev-devshell`" 461policy dictates whether to include this class. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`"
462section in the Yocto Project Development Tasks Manual for more 462section in the Yocto Project Development Tasks Manual for more
463information about using ``devshell``. 463information about using ``devshell``.
464 464
@@ -927,10 +927,10 @@ then one or more image files are created.
927 install into the image. 927 install into the image.
928 928
929For information on customizing images, see the 929For information on customizing images, see the
930":ref:`usingpoky-extend-customimage`" section 930":ref:`dev-manual/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:`images-dev-environment`" section in the 933":ref:`overview-manual/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:
@@ -1344,7 +1344,7 @@ packages such as ``kernel-vmlinux``.
1344The ``kernel`` class contains logic that allows you to embed an initial 1344The ``kernel`` class contains logic that allows you to embed an initial
1345RAM filesystem (initramfs) image when you build the kernel image. For 1345RAM filesystem (initramfs) image when you build the kernel image. For
1346information on how to build an initramfs, see the 1346information on how to build an initramfs, see the
1347":ref:`building-an-initramfs-image`" section in 1347":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in
1348the Yocto Project Development Tasks Manual. 1348the Yocto Project Development Tasks Manual.
1349 1349
1350Various other classes are used by the ``kernel`` and ``module`` classes 1350Various other classes are used by the ``kernel`` and ``module`` classes
@@ -1620,7 +1620,7 @@ different target optimizations or target architectures and installing
1620them side-by-side in the same image. 1620them side-by-side in the same image.
1621 1621
1622For more information on using the Multilib feature, see the 1622For more information on using the Multilib feature, see the
1623":ref:`combining-multiple-versions-library-files-into-one-image`" 1623":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`"
1624section in the Yocto Project Development Tasks Manual. 1624section in the Yocto Project Development Tasks Manual.
1625 1625
1626.. _ref-classes-native: 1626.. _ref-classes-native:
@@ -1921,7 +1921,7 @@ so forth). It is highly recommended that all package group recipes
1921inherit this class. 1921inherit this class.
1922 1922
1923For information on how to use this class, see the 1923For information on how to use this class, see the
1924":ref:`usingpoky-extend-customimage-customtasks`" 1924":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom package groups`"
1925section in the Yocto Project Development Tasks Manual. 1925section in the Yocto Project Development Tasks Manual.
1926 1926
1927Previously, this class was called the ``task`` class. 1927Previously, this class was called the ``task`` class.
@@ -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:`image-generation-dev-environment`" 2271":ref:`overview-manual/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:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 3f95f8d702..93fd1465f9 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -413,7 +413,7 @@ Upgrading a Recipe
413As software matures, upstream recipes are upgraded to newer versions. As 413As software matures, upstream recipes are upgraded to newer versions. As
414a developer, you need to keep your local recipes up-to-date with the 414a developer, you need to keep your local recipes up-to-date with the
415upstream version releases. Several methods exist by which you can 415upstream version releases. Several methods exist by which you can
416upgrade recipes. You can read about them in the ":ref:`gs-upgrading-recipes`" 416upgrade recipes. You can read about them in the ":ref:`dev-manual/dev-manual-common-tasks:upgrading recipes`"
417section of the Yocto Project Development Tasks Manual. This section 417section of the Yocto Project Development Tasks Manual. This section
418overviews the ``devtool upgrade`` command. 418overviews the ``devtool upgrade`` command.
419 419
@@ -441,7 +441,7 @@ You can read more on the ``devtool upgrade`` workflow in the
441":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" 441":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`"
442section in the Yocto Project Application Development and the Extensible 442section in the Yocto Project Application Development and the Extensible
443Software Development Kit (eSDK) manual. You can also see an example of 443Software Development Kit (eSDK) manual. You can also see an example of
444how to use ``devtool upgrade`` in the ":ref:`gs-using-devtool-upgrade`" 444how to use ``devtool upgrade`` in the ":ref:`dev-manual/dev-manual-common-tasks:using \`\`devtool upgrade\`\``"
445section in the Yocto Project Development Tasks Manual. 445section in the Yocto Project Development Tasks Manual.
446 446
447.. _devtool-resetting-a-recipe: 447.. _devtool-resetting-a-recipe:
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index f28ad2bb4c..a16460e91c 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -273,7 +273,7 @@ these valid features is as follows:
273 273
274- *tools-debug:* Installs debugging tools such as ``strace`` and 274- *tools-debug:* Installs debugging tools such as ``strace`` and
275 ``gdb``. For information on GDB, see the 275 ``gdb``. For information on GDB, see the
276 ":ref:`platdev-gdb-remotedebug`" section 276 ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
277 in the Yocto Project Development Tasks Manual. For information on 277 in the Yocto Project Development Tasks Manual. For information on
278 tracing and profiling, see the :doc:`../profile-manual/profile-manual`. 278 tracing and profiling, see the :doc:`../profile-manual/profile-manual`.
279 279
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index db1ea97979..5d17f0e5c4 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:`images-dev-environment`" and 402":ref:`overview-manual/overview-manual-concepts:images`" and
403":ref:`sdk-dev-environment`" sections in the Yocto 403":ref:`overview-manual/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:
@@ -577,7 +577,7 @@ built within the Yocto Project. For this package, a work directory of
577``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred 577``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
578to as the ``WORKDIR``, is created. Within this directory, the source is 578to as the ``WORKDIR``, is created. Within this directory, the source is
579unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. 579unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
580(See the ":ref:`using-a-quilt-workflow`" section in 580(See the ":ref:`dev-manual/dev-manual-common-tasks:using quilt in your workflow`" section in
581the Yocto Project Development Tasks Manual for more information.) Within 581the Yocto Project Development Tasks Manual for more information.) Within
582the ``linux-qemux86-standard-build`` directory, standard Quilt 582the ``linux-qemux86-standard-build`` directory, standard Quilt
583directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and 583directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 88b285d769..299e8f7d66 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:`image-generation-dev-environment`" 143For more information on image creation, see the ":ref:`overview-manual/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:`image-generation-dev-environment`" 162":ref:`overview-manual/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:
@@ -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:`package-feeds-dev-environment`" section in 240":ref:`overview-manual/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:`package-feeds-dev-environment`" section in 251":ref:`overview-manual/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:`package-feeds-dev-environment`" section in 262":ref:`overview-manual/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:`package-feeds-dev-environment`" section in 273":ref:`overview-manual/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,9 +349,9 @@ 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:`patching-dev-environment`" section in 352":ref:`overview-manual/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:`new-recipe-patching-code`" section in the 354":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in the
355Yocto Project Development Tasks Manual. 355Yocto Project Development Tasks Manual.
356 356
357.. _ref-tasks-populate_lic: 357.. _ref-tasks-populate_lic:
@@ -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:`sdk-generation-dev-environment`" 371":ref:`overview-manual/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:`sdk-generation-dev-environment`" 381SDK (eSDK). See the ":ref:`overview-manual/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:`source-fetching-dev-environment`" 437":ref:`overview-manual/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
@@ -567,7 +567,7 @@ scratch is guaranteed.
567Starts a shell in which an interactive Python interpreter allows you to 567Starts a shell in which an interactive Python interpreter allows you to
568interact with the BitBake build environment. From within this shell, you 568interact with the BitBake build environment. From within this shell, you
569can directly examine and set bits from the data store and execute 569can directly examine and set bits from the data store and execute
570functions as if within the BitBake environment. See the ":ref:`platdev-appdev-devpyshell`" section in 570functions as if within the BitBake environment. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development python shell`" section in
571the Yocto Project Development Tasks Manual for more information about 571the Yocto Project Development Tasks Manual for more information about
572using ``devpyshell``. 572using ``devpyshell``.
573 573
@@ -577,7 +577,7 @@ using ``devpyshell``.
577--------------- 577---------------
578 578
579Starts a shell whose environment is set up for development, debugging, 579Starts a shell whose environment is set up for development, debugging,
580or both. See the ":ref:`platdev-appdev-devshell`" section in the 580or both. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in the
581Yocto Project Development Tasks Manual for more information about using 581Yocto Project Development Tasks Manual for more information about using
582``devshell``. 582``devshell``.
583 583
@@ -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:`package-feeds-dev-environment` area. 596Creates or updates the index in the :ref:`overview-manual/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:`image-generation-dev-environment`" 634See the ":ref:`overview-manual/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-variables.rst b/documentation/ref-manual/ref-variables.rst
index 56aeb583ac..b24e1fa39e 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -746,7 +746,7 @@ system and gives an overview of their function and contents.
746 746
747 For information on how to use ``BBMULTICONFIG`` in an environment 747 For information on how to use ``BBMULTICONFIG`` in an environment
748 that supports building targets with multiple configurations, see the 748 that supports building targets with multiple configurations, see the
749 ":ref:`dev-building-images-for-multiple-targets-using-multiple-configurations`" 749 ":ref:`dev-manual/dev-manual-common-tasks:building images for multiple targets using multiple configurations`"
750 section in the Yocto Project Development Tasks Manual. 750 section in the Yocto Project Development Tasks Manual.
751 751
752 :term:`BBPATH` 752 :term:`BBPATH`
@@ -1299,7 +1299,7 @@ system and gives an overview of their function and contents.
1299 will be the aggregate of all of them. 1299 will be the aggregate of all of them.
1300 1300
1301 For information on creating an initramfs, see the 1301 For information on creating an initramfs, see the
1302 ":ref:`building-an-initramfs-image`" section 1302 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
1303 in the Yocto Project Development Tasks Manual. 1303 in the Yocto Project Development Tasks Manual.
1304 1304
1305 :term:`CONFIG_SITE` 1305 :term:`CONFIG_SITE`
@@ -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:`Images <images-dev-environment>`", ":ref:`Package 1675 ":ref:`overview-manual/overview-manual-concepts:images`",
1676 Feeds <package-feeds-dev-environment>`", and 1676 ":ref:`overview-manual/overview-manual-concepts:package feeds`", and
1677 ":ref:`sdk-dev-environment`" sections all in the 1677 ":ref:`overview-manual/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`
@@ -1695,8 +1695,8 @@ system and gives an overview of their function and contents.
1695 ``DEPLOY_DIR_DEB`` variable to make sure the 1695 ``DEPLOY_DIR_DEB`` variable to make sure the
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 ":ref:`Package 1698 information on how packaging works, see the
1699 Feeds <package-feeds-dev-environment>`" section 1699 ":ref:`overview-manual/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:`Images <images-dev-environment>`" and 1713 ":ref:`overview-manual/overview-manual-concepts:images`" and
1714 ":ref:`sdk-dev-environment`" sections both in 1714 ":ref:`overview-manual/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`
@@ -1731,8 +1731,8 @@ system and gives an overview of their function and contents.
1731 ``DEPLOY_DIR_IPK`` variable to make sure the 1731 ``DEPLOY_DIR_IPK`` variable to make sure the
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 ":ref:`Package 1734 on how packaging works, see the
1735 Feeds <package-feeds-dev-environment>`" section 1735 ":ref:`overview-manual/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`
@@ -1752,8 +1752,8 @@ system and gives an overview of their function and contents.
1752 ``DEPLOY_DIR_RPM`` variable to make sure the 1752 ``DEPLOY_DIR_RPM`` variable to make sure the
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 ":ref:`Package 1755 on how packaging works, see the
1756 Feeds <package-feeds-dev-environment>`" section 1756 ":ref:`overview-manual/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`
@@ -1773,8 +1773,8 @@ system and gives an overview of their function and contents.
1773 ``DEPLOY_DIR_TAR`` variable to make sure the 1773 ``DEPLOY_DIR_TAR`` variable to make sure the
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 ":ref:`Package 1776 on how packaging works, see the
1777 Feeds <package-feeds-dev-environment>`" section 1777 ":ref:`overview-manual/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`
@@ -2194,7 +2194,7 @@ system and gives an overview of their function and contents.
2194 Project, see the ":ref:`ref-features-image`" section. 2194 Project, see the ":ref:`ref-features-image`" section.
2195 2195
2196 For an example that shows how to customize your image by using this 2196 For an example that shows how to customize your image by using this
2197 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2197 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
2198 section in the Yocto Project Development Tasks Manual. 2198 section in the Yocto Project Development Tasks Manual.
2199 2199
2200 :term:`EXTRA_IMAGECMD` 2200 :term:`EXTRA_IMAGECMD`
@@ -2509,9 +2509,9 @@ 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:`patching-dev-environment`" section 2512 ":ref:`overview-manual/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:`new-recipe-patching-code`" section in 2514 ":ref:`dev-manual/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
2516 :ref:`ref-tasks-patch` task as well. 2516 :ref:`ref-tasks-patch` task as well.
2517 2517
@@ -3000,7 +3000,7 @@ system and gives an overview of their function and contents.
3000 the ":ref:`ref-features-image`" section. 3000 the ":ref:`ref-features-image`" section.
3001 3001
3002 For an example that shows how to customize your image by using this 3002 For an example that shows how to customize your image by using this
3003 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 3003 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
3004 section in the Yocto Project Development Tasks Manual. 3004 section in the Yocto Project Development Tasks Manual.
3005 3005
3006 :term:`IMAGE_FSTYPES` 3006 :term:`IMAGE_FSTYPES`
@@ -3058,7 +3058,7 @@ system and gives an overview of their function and contents.
3058 allows the initial RAM filesystem (initramfs) recipe to use a 3058 allows the initial RAM filesystem (initramfs) recipe to use a
3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``. 3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``.
3060 For information on creating an initramfs, see the 3060 For information on creating an initramfs, see the
3061 ":ref:`building-an-initramfs-image`" 3061 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`"
3062 section in the Yocto Project Development Tasks Manual. 3062 section in the Yocto Project Development Tasks Manual.
3063 3063
3064 - Using ``IMAGE_INSTALL`` with the 3064 - Using ``IMAGE_INSTALL`` with 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:`image-generation-dev-environment`" 3129 information on how the image is created in the ":ref:`overview-manual/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`
@@ -3554,7 +3554,7 @@ system and gives an overview of their function and contents.
3554 :term:`INITRAMFS_IMAGE_BUNDLE` 3554 :term:`INITRAMFS_IMAGE_BUNDLE`
3555 variable, which allows the generated image to be bundled inside the 3555 variable, which allows the generated image to be bundled inside the
3556 kernel image. Additionally, for information on creating an initramfs 3556 kernel image. Additionally, for information on creating an initramfs
3557 image, see the ":ref:`building-an-initramfs-image`" section 3557 image, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
3558 in the Yocto Project Development Tasks Manual. 3558 in the Yocto Project Development Tasks Manual.
3559 3559
3560 :term:`INITRAMFS_IMAGE_BUNDLE` 3560 :term:`INITRAMFS_IMAGE_BUNDLE`
@@ -3602,7 +3602,7 @@ system and gives an overview of their function and contents.
3602 See the 3602 See the
3603 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` 3603 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`
3604 file for additional information. Also, for information on creating an 3604 file for additional information. Also, for information on creating an
3605 initramfs, see the ":ref:`building-an-initramfs-image`" section 3605 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
3606 in the Yocto Project Development Tasks Manual. 3606 in the Yocto Project Development Tasks Manual.
3607 3607
3608 :term:`INITRAMFS_LINK_NAME` 3608 :term:`INITRAMFS_LINK_NAME`
@@ -4240,7 +4240,7 @@ system and gives an overview of their function and contents.
4240 This variable must be defined for all recipes (unless 4240 This variable must be defined for all recipes (unless
4241 :term:`LICENSE` is set to "CLOSED"). 4241 :term:`LICENSE` is set to "CLOSED").
4242 4242
4243 For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`" 4243 For more information, see the ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`"
4244 section in the Yocto Project Development Tasks Manual. 4244 section in the Yocto Project Development Tasks Manual.
4245 4245
4246 :term:`LICENSE` 4246 :term:`LICENSE`
@@ -4890,7 +4890,7 @@ system and gives an overview of their function and contents.
4890 Controls how the OpenEmbedded build system spawns interactive 4890 Controls how the OpenEmbedded build system spawns interactive
4891 terminals on the host development system (e.g. using the BitBake 4891 terminals on the host development system (e.g. using the BitBake
4892 command with the ``-c devshell`` command-line option). For more 4892 command with the ``-c devshell`` command-line option). For more
4893 information, see the ":ref:`platdev-appdev-devshell`" section in 4893 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in
4894 the Yocto Project Development Tasks Manual. 4894 the Yocto Project Development Tasks Manual.
4895 4895
4896 You can use the following values for the ``OE_TERMINAL`` variable: 4896 You can use the following values for the ``OE_TERMINAL`` variable:
@@ -4959,7 +4959,7 @@ system and gives an overview of their function and contents.
4959 4959
4960 An easy way to see what overrides apply is to search for ``OVERRIDES`` 4960 An easy way to see what overrides apply is to search for ``OVERRIDES``
4961 in the output of the ``bitbake -e`` command. See the 4961 in the output of the ``bitbake -e`` command. See the
4962 ":ref:`dev-debugging-viewing-variable-values`" section in the Yocto 4962 ":ref:`dev-manual/dev-manual-common-tasks:viewing variable values`" section in the Yocto
4963 Project Development Tasks Manual for more information. 4963 Project Development Tasks Manual for more information.
4964 4964
4965 :term:`P` 4965 :term:`P`
@@ -5079,7 +5079,7 @@ system and gives an overview of their function and contents.
5079 separate ``*-src`` pkg. This is the default behavior. 5079 separate ``*-src`` pkg. This is the default behavior.
5080 5080
5081 You can find out more about debugging using GDB by reading the 5081 You can find out more about debugging using GDB by reading the
5082 ":ref:`platdev-gdb-remotedebug`" section 5082 ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
5083 in the Yocto Project Development Tasks Manual. 5083 in the Yocto Project Development Tasks Manual.
5084 5084
5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` 5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
@@ -5243,7 +5243,7 @@ system and gives an overview of their function and contents.
5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` 5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
5244 image. When working with an initial RAM filesystem (initramfs) image, 5244 image. When working with an initial RAM filesystem (initramfs) image,
5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an 5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an
5246 initramfs, see the ":ref:`building-an-initramfs-image`" section 5246 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
5247 in the Yocto Project Development Tasks Manual. 5247 in the Yocto Project Development Tasks Manual.
5248 5248
5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY` 5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY`
@@ -5691,7 +5691,7 @@ 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-checksums>` along with the 5694 :ref:`input checksums <overview-manual/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/overview-manual-concepts:shared state cache`
5697 mechanisms. 5697 mechanisms.
@@ -5738,7 +5738,7 @@ system and gives an overview of their function and contents.
5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
5739 5739
5740 For more 5740 For more
5741 information, see the ":ref:`metadata-virtual-providers`" 5741 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using virtual providers`"
5742 section in the Yocto Project Development Tasks Manual. 5742 section in the Yocto Project Development Tasks Manual.
5743 5743
5744 .. note:: 5744 .. note::
@@ -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 <patching-dev-environment>` files). 7026 :ref:`patch <overview-manual/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
@@ -7200,7 +7200,7 @@ system and gives an overview of their function and contents.
7200 For information on limitations when inheriting the latest revision 7200 For information on limitations when inheriting the latest revision
7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable 7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable
7202 description and the 7202 description and the
7203 ":ref:`automatically-incrementing-a-binary-package-revision-number`" 7203 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`"
7204 section, which is in the Yocto Project Development Tasks Manual. 7204 section, which is in the Yocto Project Development Tasks Manual.
7205 7205
7206 :term:`SSTATE_DIR` 7206 :term:`SSTATE_DIR`
@@ -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:`configuration-compilation-and-staging-dev-environment`" 7319 ":ref:`overview-manual/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
@@ -8042,7 +8042,7 @@ system and gives an overview of their function and contents.
8042 You can provide the following arguments with ``TEST_TARGET``: 8042 You can provide the following arguments with ``TEST_TARGET``:
8043 8043
8044 - *"qemu":* Boots a QEMU image and runs the tests. See the 8044 - *"qemu":* Boots a QEMU image and runs the tests. See the
8045 ":ref:`qemu-image-enabling-tests`" section 8045 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on qemu`" section
8046 in the Yocto Project Development Tasks Manual for more 8046 in the Yocto Project Development Tasks Manual for more
8047 information. 8047 information.
8048 8048
@@ -8058,7 +8058,7 @@ system and gives an overview of their function and contents.
8058 ``meta/lib/oeqa/controllers/simpleremote.py``. 8058 ``meta/lib/oeqa/controllers/simpleremote.py``.
8059 8059
8060 For information on running tests on hardware, see the 8060 For information on running tests on hardware, see the
8061 ":ref:`hardware-image-enabling-tests`" 8061 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on hardware`"
8062 section in the Yocto Project Development Tasks Manual. 8062 section in the Yocto Project Development Tasks Manual.
8063 8063
8064 :term:`TEST_TARGET_IP` 8064 :term:`TEST_TARGET_IP`
@@ -8554,13 +8554,13 @@ system and gives an overview of their function and contents.
8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a 8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
8555 statically populated ``/dev`` directory. 8555 statically populated ``/dev`` directory.
8556 8556
8557 See the ":ref:`selecting-dev-manager`" section in 8557 See the ":ref:`dev-manual/dev-manual-common-tasks:selecting a device manager`" section in
8558 the Yocto Project Development Tasks Manual for information on how to 8558 the Yocto Project Development Tasks Manual for information on how to
8559 use this variable. 8559 use this variable.
8560 8560
8561 :term:`USE_VT` 8561 :term:`USE_VT`
8562 When using 8562 When using
8563 :ref:`SysVinit <new-recipe-enabling-system-services>`, 8563 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`,
8564 determines whether or not to run a 8564 determines whether or not to run a
8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any 8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
8566 virtual terminals in order to enable logging in through those 8566 virtual terminals in order to enable logging in through those
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 2ef182fb1c..c172aab259 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes
23to the project either by creating and sending pull requests, or by 23to the project either by creating and sending pull requests, or by
24submitting patches through email. For information on how to do both as 24submitting patches through email. For information on how to do both as
25well as information on how to identify the maintainer for each area of 25well as information on how to identify the maintainer for each area of
26code, see the ":ref:`how-to-submit-a-change`" section in the 26code, see the ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" section in the
27Yocto Project Development Tasks Manual. 27Yocto Project Development Tasks Manual.
28 28
29.. _resources-bugtracker: 29.. _resources-bugtracker: