diff options
Diffstat (limited to 'documentation/ref-manual')
21 files changed, 111 insertions, 111 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 819b6857d9..5b9fcc1912 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -45,7 +45,7 @@ section for steps on how to update your build tools. | |||
45 | **A:** Support for an additional board is added by creating a Board | 45 | **A:** Support for an additional board is added by creating a Board |
46 | Support Package (BSP) layer for it. For more information on how to | 46 | Support Package (BSP) layer for it. For more information on how to |
47 | create a BSP layer, see the | 47 | create a BSP layer, see the |
48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 48 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
49 | section in the Yocto Project Development Tasks Manual and the | 49 | section in the Yocto Project Development Tasks Manual and the |
50 | :doc:`/bsp-guide/index`. | 50 | :doc:`/bsp-guide/index`. |
51 | 51 | ||
@@ -73,7 +73,7 @@ device. | |||
73 | 73 | ||
74 | **A:** To add a package, you need to create a BitBake recipe. For | 74 | **A:** To add a package, you need to create a BitBake recipe. For |
75 | information on how to create a BitBake recipe, see the | 75 | information on how to create a BitBake recipe, see the |
76 | ":ref:`dev-manual/dev-manual-common-tasks:writing a new recipe`" | 76 | ":ref:`dev-manual/common-tasks:writing a new recipe`" |
77 | section in the Yocto Project Development Tasks Manual. | 77 | section in the Yocto Project Development Tasks Manual. |
78 | 78 | ||
79 | **Q:** Do I have to reflash my entire board with a new Yocto Project | 79 | **Q:** Do I have to reflash my entire board with a new Yocto Project |
@@ -201,7 +201,7 @@ You can find more information on licensing in the | |||
201 | ":ref:`overview-manual/overview-manual-development-environment:licensing`" | 201 | ":ref:`overview-manual/overview-manual-development-environment:licensing`" |
202 | section in the Yocto | 202 | section in the Yocto |
203 | Project Overview and Concepts Manual and also in the | 203 | Project Overview and Concepts Manual and also in the |
204 | ":ref:`dev-manual/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`" |
205 | section in the Yocto Project Development Tasks Manual. | 205 | section in the Yocto Project Development Tasks Manual. |
206 | 206 | ||
207 | **Q:** How do I disable the cursor on my touchscreen device? | 207 | **Q:** How do I disable the cursor on my touchscreen device? |
diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst index daaea0ffa2..0b7e861176 100644 --- a/documentation/ref-manual/migration-1.4.rst +++ b/documentation/ref-manual/migration-1.4.rst | |||
@@ -84,7 +84,7 @@ create an append file for the ``init-ifupdown`` recipe instead, which | |||
84 | you can find in the :term:`Source Directory` at | 84 | you can find in the :term:`Source Directory` at |
85 | ``meta/recipes-core/init-ifupdown``. For information on how to use | 85 | ``meta/recipes-core/init-ifupdown``. For information on how to use |
86 | append files, see the | 86 | append files, see the |
87 | ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" | 87 | ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" |
88 | section in the Yocto Project Development Tasks Manual. | 88 | section in the Yocto Project Development Tasks Manual. |
89 | 89 | ||
90 | .. _migration-1.4-remote-debugging: | 90 | .. _migration-1.4-remote-debugging: |
diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst index 5e1e23f216..b5e4bb1fd1 100644 --- a/documentation/ref-manual/migration-1.5.rst +++ b/documentation/ref-manual/migration-1.5.rst | |||
@@ -246,7 +246,7 @@ A new automated image testing framework has been added through the | |||
246 | framework replaces the older ``imagetest-qemu`` framework. | 246 | framework replaces the older ``imagetest-qemu`` framework. |
247 | 247 | ||
248 | You can learn more about performing automated image tests in the | 248 | You can learn more about performing automated image tests in the |
249 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 249 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
250 | section in the Yocto Project Development Tasks Manual. | 250 | section in the Yocto Project Development Tasks Manual. |
251 | 251 | ||
252 | .. _migration-1.5-build-history: | 252 | .. _migration-1.5-build-history: |
@@ -269,7 +269,7 @@ Following are changes to Build History: | |||
269 | option for each utility for more information on the new syntax. | 269 | option for each utility for more information on the new syntax. |
270 | 270 | ||
271 | For more information on Build History, see the | 271 | For more information on Build History, see the |
272 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 272 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
273 | section in the Yocto Project Development Tasks Manual. | 273 | section in the Yocto Project Development Tasks Manual. |
274 | 274 | ||
275 | .. _migration-1.5-udev: | 275 | .. _migration-1.5-udev: |
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst index 822d5cfa03..f95f45ec9f 100644 --- a/documentation/ref-manual/migration-1.6.rst +++ b/documentation/ref-manual/migration-1.6.rst | |||
@@ -12,7 +12,7 @@ Project 1.6 Release from the prior release. | |||
12 | The :ref:`archiver <ref-classes-archiver>` class has been rewritten | 12 | The :ref:`archiver <ref-classes-archiver>` class has been rewritten |
13 | and its configuration has been simplified. For more details on the | 13 | and its configuration has been simplified. For more details on the |
14 | source archiver, see the | 14 | source archiver, see the |
15 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 15 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" |
16 | section in the Yocto Project Development Tasks Manual. | 16 | section in the Yocto Project Development Tasks Manual. |
17 | 17 | ||
18 | .. _migration-1.6-packaging-changes: | 18 | .. _migration-1.6-packaging-changes: |
@@ -148,7 +148,7 @@ NFS mount, an error occurs. | |||
148 | The ``PRINC`` variable has been deprecated and triggers a warning if | 148 | The ``PRINC`` variable has been deprecated and triggers a warning if |
149 | detected during a build. For :term:`PR` increments on changes, | 149 | detected during a build. For :term:`PR` increments on changes, |
150 | use the PR service instead. You can find out more about this service in | 150 | use the PR service instead. You can find out more about this service in |
151 | the ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" | 151 | the ":ref:`dev-manual/common-tasks:working with a pr service`" |
152 | section in the Yocto Project Development Tasks Manual. | 152 | section in the Yocto Project Development Tasks Manual. |
153 | 153 | ||
154 | .. _migration-1.6-variable-changes-IMAGE_TYPES: | 154 | .. _migration-1.6-variable-changes-IMAGE_TYPES: |
@@ -221,7 +221,7 @@ Package Test (ptest) | |||
221 | 221 | ||
222 | Package Tests (ptest) are built but not installed by default. For | 222 | Package Tests (ptest) are built but not installed by default. For |
223 | information on using Package Tests, see the | 223 | information on using Package Tests, see the |
224 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" | 224 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
225 | section in the Yocto Project Development Tasks Manual. For information on the | 225 | section in the Yocto Project Development Tasks Manual. For information on the |
226 | ``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`" | 226 | ``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`" |
227 | section. | 227 | section. |
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst index c3f9469da1..85894d9df7 100644 --- a/documentation/ref-manual/migration-1.7.rst +++ b/documentation/ref-manual/migration-1.7.rst | |||
@@ -217,7 +217,7 @@ The following miscellaneous change occurred: | |||
217 | should manually remove old "build-id" files from your existing build | 217 | should manually remove old "build-id" files from your existing build |
218 | history repositories to avoid confusion. For information on the build | 218 | history repositories to avoid confusion. For information on the build |
219 | history feature, see the | 219 | history feature, see the |
220 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 220 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
221 | section in the Yocto Project Development Tasks Manual. | 221 | section in the Yocto Project Development Tasks Manual. |
222 | 222 | ||
223 | 223 | ||
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index ada9d2986c..678a767e15 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst | |||
@@ -346,7 +346,7 @@ This release supports generation of GLib Introspective Repository (GIR) | |||
346 | files through GObject introspection, which is the standard mechanism for | 346 | files through GObject introspection, which is the standard mechanism for |
347 | accessing GObject-based software from runtime environments. You can | 347 | accessing GObject-based software from runtime environments. You can |
348 | enable, disable, and test the generation of this data. See the | 348 | enable, disable, and test the generation of this data. See the |
349 | ":ref:`dev-manual/dev-manual-common-tasks:enabling gobject introspection support`" | 349 | ":ref:`dev-manual/common-tasks:enabling gobject introspection support`" |
350 | section in the Yocto Project Development Tasks Manual for more | 350 | section in the Yocto Project Development Tasks Manual for more |
351 | information. | 351 | information. |
352 | 352 | ||
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index c0a8f04195..9e95f45e1f 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst | |||
@@ -366,7 +366,7 @@ The following changes have been made to Wic: | |||
366 | .. note:: | 366 | .. note:: |
367 | 367 | ||
368 | For more information on Wic, see the | 368 | For more information on Wic, see the |
369 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 369 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" |
370 | section in the Yocto Project Development Tasks Manual. | 370 | section in the Yocto Project Development Tasks Manual. |
371 | 371 | ||
372 | - *Default Output Directory Changed:* Wic's default output directory is | 372 | - *Default Output Directory Changed:* Wic's default output directory is |
diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst index 7f1b80938f..9f45ffce76 100644 --- a/documentation/ref-manual/migration-2.5.rst +++ b/documentation/ref-manual/migration-2.5.rst | |||
@@ -266,7 +266,7 @@ The following are additional changes: | |||
266 | will trigger a warning during ``do_rootfs``. | 266 | will trigger a warning during ``do_rootfs``. |
267 | 267 | ||
268 | For more information, see the | 268 | For more information, see the |
269 | ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" | 269 | ":ref:`dev-manual/common-tasks:post-installation scripts`" |
270 | section in the Yocto Project Development Tasks Manual. | 270 | section in the Yocto Project Development Tasks Manual. |
271 | 271 | ||
272 | - The ``elf`` image type has been removed. This image type was removed | 272 | - The ``elf`` image type has been removed. This image type was removed |
diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst index cc7c24c5b1..5d524f3817 100644 --- a/documentation/ref-manual/migration-2.6.rst +++ b/documentation/ref-manual/migration-2.6.rst | |||
@@ -372,7 +372,7 @@ Any failure of a ``pkg_postinst()`` script (including exit 1) triggers | |||
372 | an error during the :ref:`ref-tasks-rootfs` task. | 372 | an error during the :ref:`ref-tasks-rootfs` task. |
373 | 373 | ||
374 | For more information on post-installation behavior, see the | 374 | For more information on post-installation behavior, see the |
375 | ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" | 375 | ":ref:`dev-manual/common-tasks:post-installation scripts`" |
376 | section in the Yocto Project Development Tasks Manual. | 376 | section in the Yocto Project Development Tasks Manual. |
377 | 377 | ||
378 | .. _migration-2.6-python-3-profile-guided-optimizations: | 378 | .. _migration-2.6-python-3-profile-guided-optimizations: |
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index e0cdbe87fa..4147044ea3 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst | |||
@@ -68,7 +68,7 @@ The ``archiver`` class supports releasing source code and other | |||
68 | materials with the binaries. | 68 | materials with the binaries. |
69 | 69 | ||
70 | For more details on the source archiver, see the | 70 | For more details on the source archiver, see the |
71 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 71 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" |
72 | section in the Yocto Project Development Tasks Manual. You can also see | 72 | section in the Yocto Project Development Tasks Manual. You can also see |
73 | the :term:`ARCHIVER_MODE` variable for information | 73 | the :term:`ARCHIVER_MODE` variable for information |
74 | about the variable flags (varflags) that help control archive creation. | 74 | about the variable flags (varflags) that help control archive creation. |
@@ -86,7 +86,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``, | |||
86 | should usually be enough to define a few standard variables and then | 86 | should usually be enough to define a few standard variables and then |
87 | simply ``inherit autotools``. These classes can also work with software | 87 | simply ``inherit autotools``. These classes can also work with software |
88 | that emulates Autotools. For more information, see the | 88 | that emulates Autotools. For more information, see the |
89 | ":ref:`dev-manual/dev-manual-common-tasks:autotooled package`" section | 89 | ":ref:`dev-manual/common-tasks:autotooled package`" section |
90 | in the Yocto Project Development Tasks Manual. | 90 | in the Yocto Project Development Tasks Manual. |
91 | 91 | ||
92 | By default, the ``autotools*`` classes use out-of-tree builds (i.e. | 92 | By default, the ``autotools*`` classes use out-of-tree builds (i.e. |
@@ -236,7 +236,7 @@ The ``buildhistory`` class records a history of build output metadata, | |||
236 | which can be used to detect possible regressions as well as used for | 236 | which can be used to detect possible regressions as well as used for |
237 | analysis of the build output. For more information on using Build | 237 | analysis of the build output. For more information on using Build |
238 | History, see the | 238 | History, see the |
239 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 239 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
240 | section in the Yocto Project Development Tasks Manual. | 240 | section in the Yocto Project Development Tasks Manual. |
241 | 241 | ||
242 | .. _ref-classes-buildstats: | 242 | .. _ref-classes-buildstats: |
@@ -458,7 +458,7 @@ staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. | |||
458 | ==================== | 458 | ==================== |
459 | 459 | ||
460 | The ``devshell`` class adds the ``do_devshell`` task. Distribution | 460 | The ``devshell`` class adds the ``do_devshell`` task. Distribution |
461 | policy dictates whether to include this class. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" | 461 | policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" |
462 | section in the Yocto Project Development Tasks Manual for more | 462 | section in the Yocto Project Development Tasks Manual for more |
463 | information about using ``devshell``. | 463 | information about using ``devshell``. |
464 | 464 | ||
@@ -586,7 +586,7 @@ For more information on the ``externalsrc`` class, see the comments in | |||
586 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. | 586 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. |
587 | For information on how to use the | 587 | For information on how to use the |
588 | ``externalsrc`` class, see the | 588 | ``externalsrc`` class, see the |
589 | ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" | 589 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
590 | section in the Yocto Project Development Tasks Manual. | 590 | section in the Yocto Project Development Tasks Manual. |
591 | 591 | ||
592 | .. _ref-classes-extrausers: | 592 | .. _ref-classes-extrausers: |
@@ -927,7 +927,7 @@ then one or more image files are created. | |||
927 | install into the image. | 927 | install into the image. |
928 | 928 | ||
929 | For information on customizing images, see the | 929 | For information on customizing images, see the |
930 | ":ref:`dev-manual/dev-manual-common-tasks:customizing images`" section | 930 | ":ref:`dev-manual/common-tasks:customizing images`" section |
931 | in the Yocto Project Development Tasks Manual. For information on how | 931 | in the Yocto Project Development Tasks Manual. For information on how |
932 | images are created, see the | 932 | images are created, see the |
933 | ":ref:`overview-manual/overview-manual-concepts:images`" section in the | 933 | ":ref:`overview-manual/overview-manual-concepts:images`" section in the |
@@ -1344,7 +1344,7 @@ packages such as ``kernel-vmlinux``. | |||
1344 | The ``kernel`` class contains logic that allows you to embed an initial | 1344 | The ``kernel`` class contains logic that allows you to embed an initial |
1345 | RAM filesystem (initramfs) image when you build the kernel image. For | 1345 | RAM filesystem (initramfs) image when you build the kernel image. For |
1346 | information on how to build an initramfs, see the | 1346 | information on how to build an initramfs, see the |
1347 | ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in | 1347 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in |
1348 | the Yocto Project Development Tasks Manual. | 1348 | the Yocto Project Development Tasks Manual. |
1349 | 1349 | ||
1350 | Various other classes are used by the ``kernel`` and ``module`` classes | 1350 | Various other classes are used by the ``kernel`` and ``module`` classes |
@@ -1620,7 +1620,7 @@ different target optimizations or target architectures and installing | |||
1620 | them side-by-side in the same image. | 1620 | them side-by-side in the same image. |
1621 | 1621 | ||
1622 | For more information on using the Multilib feature, see the | 1622 | For more information on using the Multilib feature, see the |
1623 | ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" | 1623 | ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" |
1624 | section in the Yocto Project Development Tasks Manual. | 1624 | section in the Yocto Project Development Tasks Manual. |
1625 | 1625 | ||
1626 | .. _ref-classes-native: | 1626 | .. _ref-classes-native: |
@@ -1732,7 +1732,7 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. | |||
1732 | fetcher to have dependencies fetched and packaged automatically. | 1732 | fetcher to have dependencies fetched and packaged automatically. |
1733 | 1733 | ||
1734 | For information on how to create NPM packages, see the | 1734 | For information on how to create NPM packages, see the |
1735 | ":ref:`dev-manual/dev-manual-common-tasks:creating node package manager (npm) packages`" | 1735 | ":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" |
1736 | section in the Yocto Project Development Tasks Manual. | 1736 | section in the Yocto Project Development Tasks Manual. |
1737 | 1737 | ||
1738 | .. _ref-classes-oelint: | 1738 | .. _ref-classes-oelint: |
@@ -1802,7 +1802,7 @@ If you take the optional step to set up a repository (package feed) on | |||
1802 | the development host that can be used by DNF, you can install packages | 1802 | the development host that can be used by DNF, you can install packages |
1803 | from the feed while you are running the image on the target (i.e. | 1803 | from the feed while you are running the image on the target (i.e. |
1804 | runtime installation of packages). For more information, see the | 1804 | runtime installation of packages). For more information, see the |
1805 | ":ref:`dev-manual/dev-manual-common-tasks:using runtime package management`" | 1805 | ":ref:`dev-manual/common-tasks:using runtime package management`" |
1806 | section in the Yocto Project Development Tasks Manual. | 1806 | section in the Yocto Project Development Tasks Manual. |
1807 | 1807 | ||
1808 | The package-specific class you choose can affect build-time performance | 1808 | The package-specific class you choose can affect build-time performance |
@@ -1921,7 +1921,7 @@ so forth). It is highly recommended that all package group recipes | |||
1921 | inherit this class. | 1921 | inherit this class. |
1922 | 1922 | ||
1923 | For information on how to use this class, see the | 1923 | For information on how to use this class, see the |
1924 | ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom package groups`" | 1924 | ":ref:`dev-manual/common-tasks:customizing images using custom package groups`" |
1925 | section in the Yocto Project Development Tasks Manual. | 1925 | section in the Yocto Project Development Tasks Manual. |
1926 | 1926 | ||
1927 | Previously, this class was called the ``task`` class. | 1927 | Previously, this class was called the ``task`` class. |
@@ -2080,7 +2080,7 @@ The ``primport`` class provides functionality for importing | |||
2080 | ================== | 2080 | ================== |
2081 | 2081 | ||
2082 | The ``prserv`` class provides functionality for using a :ref:`PR | 2082 | The ``prserv`` class provides functionality for using a :ref:`PR |
2083 | service <dev-manual/dev-manual-common-tasks:working with a pr service>` in order to | 2083 | service <dev-manual/common-tasks:working with a pr service>` in order to |
2084 | automatically manage the incrementing of the :term:`PR` | 2084 | automatically manage the incrementing of the :term:`PR` |
2085 | variable for each recipe. | 2085 | variable for each recipe. |
2086 | 2086 | ||
@@ -2100,7 +2100,7 @@ runtime tests for recipes that build software that provides these tests. | |||
2100 | This class is intended to be inherited by individual recipes. However, | 2100 | This class is intended to be inherited by individual recipes. However, |
2101 | the class' functionality is largely disabled unless "ptest" appears in | 2101 | the class' functionality is largely disabled unless "ptest" appears in |
2102 | :term:`DISTRO_FEATURES`. See the | 2102 | :term:`DISTRO_FEATURES`. See the |
2103 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" | 2103 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
2104 | section in the Yocto Project Development Tasks Manual for more information | 2104 | section in the Yocto Project Development Tasks Manual for more information |
2105 | on ptest. | 2105 | on ptest. |
2106 | 2106 | ||
@@ -2113,7 +2113,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
2113 | have tests intended to be executed with ``gnome-desktop-testing``. | 2113 | have tests intended to be executed with ``gnome-desktop-testing``. |
2114 | 2114 | ||
2115 | For information on setting up and running ptests, see the | 2115 | For information on setting up and running ptests, see the |
2116 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" | 2116 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
2117 | section in the Yocto Project Development Tasks Manual. | 2117 | section in the Yocto Project Development Tasks Manual. |
2118 | 2118 | ||
2119 | .. _ref-classes-python-dir: | 2119 | .. _ref-classes-python-dir: |
@@ -2199,7 +2199,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows: | |||
2199 | ======================== | 2199 | ======================== |
2200 | 2200 | ||
2201 | The ``report-error`` class supports enabling the :ref:`error reporting | 2201 | The ``report-error`` class supports enabling the :ref:`error reporting |
2202 | tool <dev-manual/dev-manual-common-tasks:using the error reporting tool>`", | 2202 | tool <dev-manual/common-tasks:using the error reporting tool>`", |
2203 | which allows you to submit build error information to a central database. | 2203 | which allows you to submit build error information to a central database. |
2204 | 2204 | ||
2205 | The class collects debug information for recipe, recipe version, task, | 2205 | The class collects debug information for recipe, recipe version, task, |
@@ -2554,7 +2554,7 @@ unless you have set | |||
2554 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". | 2554 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". |
2555 | 2555 | ||
2556 | For more information on ``systemd``, see the | 2556 | For more information on ``systemd``, see the |
2557 | ":ref:`dev-manual/dev-manual-common-tasks:selecting an initialization manager`" | 2557 | ":ref:`dev-manual/common-tasks:selecting an initialization manager`" |
2558 | section in the Yocto Project Development Tasks Manual. | 2558 | section in the Yocto Project Development Tasks Manual. |
2559 | 2559 | ||
2560 | .. _ref-classes-systemd-boot: | 2560 | .. _ref-classes-systemd-boot: |
@@ -2631,7 +2631,7 @@ runs tests on an image after the image is constructed (i.e. | |||
2631 | :term:`TESTIMAGE_AUTO` must be set to "1"). | 2631 | :term:`TESTIMAGE_AUTO` must be set to "1"). |
2632 | 2632 | ||
2633 | For information on how to enable, run, and create new tests, see the | 2633 | For information on how to enable, run, and create new tests, see the |
2634 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 2634 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
2635 | section in the Yocto Project Development Tasks Manual. | 2635 | section in the Yocto Project Development Tasks Manual. |
2636 | 2636 | ||
2637 | .. _ref-classes-testsdk: | 2637 | .. _ref-classes-testsdk: |
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index 83861d271c..11b4cb5d5b 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst | |||
@@ -413,7 +413,7 @@ Upgrading a Recipe | |||
413 | As software matures, upstream recipes are upgraded to newer versions. As | 413 | As software matures, upstream recipes are upgraded to newer versions. As |
414 | a developer, you need to keep your local recipes up-to-date with the | 414 | a developer, you need to keep your local recipes up-to-date with the |
415 | upstream version releases. Several methods exist by which you can | 415 | upstream version releases. Several methods exist by which you can |
416 | upgrade recipes. You can read about them in the ":ref:`dev-manual/dev-manual-common-tasks:upgrading recipes`" | 416 | upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" |
417 | section of the Yocto Project Development Tasks Manual. This section | 417 | section of the Yocto Project Development Tasks Manual. This section |
418 | overviews the ``devtool upgrade`` command. | 418 | overviews 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`" |
442 | section in the Yocto Project Application Development and the Extensible | 442 | section in the Yocto Project Application Development and the Extensible |
443 | Software Development Kit (eSDK) manual. You can also see an example of | 443 | Software Development Kit (eSDK) manual. You can also see an example of |
444 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/dev-manual-common-tasks:using \`\`devtool upgrade\`\``" | 444 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" |
445 | section in the Yocto Project Development Tasks Manual. | 445 | section 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 6c85c24181..cb4b57436d 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst | |||
@@ -156,7 +156,7 @@ metadata: | |||
156 | 156 | ||
157 | - *ptest:* Enables building the package tests where supported by | 157 | - *ptest:* Enables building the package tests where supported by |
158 | individual recipes. For more information on package tests, see the | 158 | individual recipes. For more information on package tests, see the |
159 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" section | 159 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section |
160 | in the Yocto Project Development Tasks Manual. | 160 | in the Yocto Project Development Tasks Manual. |
161 | 161 | ||
162 | - *smbfs:* Include SMB networks client support (for mounting | 162 | - *smbfs:* Include SMB networks client support (for mounting |
@@ -236,7 +236,7 @@ The following image features are available for all images: | |||
236 | 236 | ||
237 | - *read-only-rootfs:* Creates an image whose root filesystem is | 237 | - *read-only-rootfs:* Creates an image whose root filesystem is |
238 | read-only. See the | 238 | read-only. See the |
239 | ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" | 239 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" |
240 | section in the Yocto Project Development Tasks Manual for more | 240 | section in the Yocto Project Development Tasks Manual for more |
241 | information. | 241 | information. |
242 | 242 | ||
@@ -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:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 276 | ":ref:`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/index`. | 278 | tracing and profiling, see the :doc:`/profile-manual/index`. |
279 | 279 | ||
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst index 56ec8562f8..5e9374eae7 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/ref-images.rst | |||
@@ -122,7 +122,7 @@ Following is a list of supported recipes: | |||
122 | deployed to a separate partition so that you can boot into it and use | 122 | deployed to a separate partition so that you can boot into it and use |
123 | it to deploy a second image to be tested. You can find more | 123 | it to deploy a second image to be tested. You can find more |
124 | information about runtime testing in the | 124 | information about runtime testing in the |
125 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 125 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
126 | section in the Yocto Project Development Tasks Manual. | 126 | section in the Yocto Project Development Tasks Manual. |
127 | 127 | ||
128 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root | 128 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root |
@@ -132,7 +132,7 @@ Following is a list of supported recipes: | |||
132 | - ``core-image-weston``: A very basic Wayland image with a terminal. | 132 | - ``core-image-weston``: A very basic Wayland image with a terminal. |
133 | This image provides the Wayland protocol libraries and the reference | 133 | This image provides the Wayland protocol libraries and the reference |
134 | Weston compositor. For more information, see the | 134 | Weston compositor. For more information, see the |
135 | ":ref:`dev-manual/dev-manual-common-tasks:using wayland and weston`" | 135 | ":ref:`dev-manual/common-tasks:using wayland and weston`" |
136 | section in the Yocto Project Development Tasks Manual. | 136 | section in the Yocto Project Development Tasks Manual. |
137 | 137 | ||
138 | - ``core-image-x11``: A very basic X11 image with a terminal. | 138 | - ``core-image-x11``: A very basic X11 image with a terminal. |
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst index 7f6d4ebe1c..bb9c0460f3 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/ref-kickstart.rst | |||
@@ -79,7 +79,7 @@ the ``part`` and ``partition`` commands: | |||
79 | source of the data that populates the partition. The most common | 79 | source of the data that populates the partition. The most common |
80 | value for this option is "rootfs", but you can use any value that | 80 | value for this option is "rootfs", but you can use any value that |
81 | maps to a valid source plugin. For information on the source plugins, | 81 | maps to a valid source plugin. For information on the source plugins, |
82 | see the ":ref:`dev-manual/dev-manual-common-tasks:using the wic plugin interface`" | 82 | see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" |
83 | section in the Yocto Project Development Tasks Manual. | 83 | section in the Yocto Project Development Tasks Manual. |
84 | 84 | ||
85 | If you use ``--source rootfs``, Wic creates a partition as large as | 85 | If you use ``--source rootfs``, Wic creates a partition as large as |
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index ec6d233877..54cd9510f6 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst | |||
@@ -106,7 +106,7 @@ Additionally, because the test strategies are visible to you as a | |||
106 | developer, you can validate your projects. This section overviews the | 106 | developer, you can validate your projects. This section overviews the |
107 | available test infrastructure used in the Yocto Project. For information | 107 | available test infrastructure used in the Yocto Project. For information |
108 | on how to run available tests on your projects, see the | 108 | on how to run available tests on your projects, see the |
109 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 109 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
110 | section in the Yocto Project Development Tasks Manual. | 110 | section in the Yocto Project Development Tasks Manual. |
111 | 111 | ||
112 | The QA/testing infrastructure is woven into the project to the point | 112 | The QA/testing infrastructure is woven into the project to the point |
@@ -128,12 +128,12 @@ consists of the following pieces: | |||
128 | 128 | ||
129 | - :ref:`testimage.bbclass <ref-classes-testimage*>`: This class | 129 | - :ref:`testimage.bbclass <ref-classes-testimage*>`: This class |
130 | performs runtime testing of images after they are built. The tests | 130 | performs runtime testing of images after they are built. The tests |
131 | are usually used with :doc:`QEMU </dev-manual/dev-manual-qemu>` | 131 | are usually used with :doc:`QEMU </dev-manual/qemu>` |
132 | to boot the images and check the combined runtime result boot | 132 | to boot the images and check the combined runtime result boot |
133 | operation and functions. However, the test can also use the IP | 133 | operation and functions. However, the test can also use the IP |
134 | address of a machine to test. | 134 | address of a machine to test. |
135 | 135 | ||
136 | - :ref:`ptest <dev-manual/dev-manual-common-tasks:testing packages with ptest>`: | 136 | - :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`: |
137 | Runs tests against packages produced during the build for a given | 137 | Runs tests against packages produced during the build for a given |
138 | piece of software. The test allows the packages to be be run within a | 138 | piece of software. The test allows the packages to be be run within a |
139 | target image. | 139 | target image. |
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index d3a231554f..b681e8233f 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst | |||
@@ -12,7 +12,7 @@ and directories. | |||
12 | 12 | ||
13 | For information on how to establish a local Source Directory on your | 13 | For information on how to establish a local Source Directory on your |
14 | development system, see the | 14 | development system, see the |
15 | ":ref:`dev-manual/dev-manual-start:locating yocto project source files`" | 15 | ":ref:`dev-manual/start:locating yocto project source files`" |
16 | section in the Yocto Project Development Tasks Manual. | 16 | section in the Yocto Project Development Tasks Manual. |
17 | 17 | ||
18 | .. note:: | 18 | .. note:: |
@@ -176,7 +176,7 @@ within the :term:`Source Directory`. If you design a | |||
176 | custom distribution, you can include your own version of this | 176 | custom distribution, you can include your own version of this |
177 | configuration file to mention the targets defined by your distribution. | 177 | configuration file to mention the targets defined by your distribution. |
178 | See the | 178 | See the |
179 | ":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" | 179 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" |
180 | section in the Yocto Project Development Tasks Manual for more | 180 | section in the Yocto Project Development Tasks Manual for more |
181 | information. | 181 | information. |
182 | 182 | ||
@@ -193,7 +193,7 @@ Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`: | |||
193 | The OpenEmbedded build system uses the template configuration files, which | 193 | The OpenEmbedded build system uses the template configuration files, which |
194 | are found by default in the ``meta-poky/conf/`` directory in the Source | 194 | are found by default in the ``meta-poky/conf/`` directory in the Source |
195 | Directory. See the | 195 | Directory. See the |
196 | ":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" | 196 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" |
197 | section in the Yocto Project Development Tasks Manual for more | 197 | section in the Yocto Project Development Tasks Manual for more |
198 | information. | 198 | information. |
199 | 199 | ||
@@ -236,7 +236,7 @@ The OpenEmbedded build system creates this directory when you enable | |||
236 | build history via the ``buildhistory`` class file. The directory | 236 | build history via the ``buildhistory`` class file. The directory |
237 | organizes build information into image, packages, and SDK | 237 | organizes build information into image, packages, and SDK |
238 | subdirectories. For information on the build history feature, see the | 238 | subdirectories. For information on the build history feature, see the |
239 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 239 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
240 | section in the Yocto Project Development Tasks Manual. | 240 | section in the Yocto Project Development Tasks Manual. |
241 | 241 | ||
242 | .. _structure-build-conf-local.conf: | 242 | .. _structure-build-conf-local.conf: |
@@ -292,7 +292,7 @@ file, it uses ``sed`` to substitute final | |||
292 | ---------------------------- | 292 | ---------------------------- |
293 | 293 | ||
294 | This configuration file defines | 294 | This configuration file defines |
295 | :ref:`layers <dev-manual/dev-manual-common-tasks:understanding and creating layers>`, | 295 | :ref:`layers <dev-manual/common-tasks:understanding and creating layers>`, |
296 | which are directory trees, traversed (or walked) by BitBake. The | 296 | which are directory trees, traversed (or walked) by BitBake. The |
297 | ``bblayers.conf`` file uses the :term:`BBLAYERS` | 297 | ``bblayers.conf`` file uses the :term:`BBLAYERS` |
298 | variable to list the layers BitBake tries to find. | 298 | variable to list the layers BitBake tries to find. |
@@ -438,7 +438,7 @@ directory contains sub-directories for ``bash``, ``busybox``, and | |||
438 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` | 438 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` |
439 | license files with other licensing information. For information on | 439 | license files with other licensing information. For information on |
440 | licensing, see the | 440 | licensing, see the |
441 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 441 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" |
442 | section in the Yocto Project Development Tasks Manual. | 442 | section in the Yocto Project Development Tasks Manual. |
443 | 443 | ||
444 | .. _structure-build-tmp-deploy-images: | 444 | .. _structure-build-tmp-deploy-images: |
@@ -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 |
578 | to as the ``WORKDIR``, is created. Within this directory, the source is | 578 | to as the ``WORKDIR``, is created. Within this directory, the source is |
579 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. | 579 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. |
580 | (See the ":ref:`dev-manual/dev-manual-common-tasks:using quilt in your workflow`" section in | 580 | (See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in |
581 | the Yocto Project Development Tasks Manual for more information.) Within | 581 | the Yocto Project Development Tasks Manual for more information.) Within |
582 | the ``linux-qemux86-standard-build`` directory, standard Quilt | 582 | the ``linux-qemux86-standard-build`` directory, standard Quilt |
583 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and | 583 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and |
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 2c7c1e0754..d162c9bad2 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
@@ -94,7 +94,7 @@ distributions: | |||
94 | interested in hearing about your experience. For information on | 94 | interested in hearing about your experience. For information on |
95 | how to submit a bug, see the Yocto Project | 95 | how to submit a bug, see the Yocto Project |
96 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 96 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
97 | and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" | 97 | and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" |
98 | section in the Yocto Project Development Tasks Manual. | 98 | section in the Yocto Project Development Tasks Manual. |
99 | 99 | ||
100 | 100 | ||
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 9fde9a8378..89731d459c 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst | |||
@@ -351,7 +351,7 @@ applied as a patch by default except for the ``patch_file5`` patch. | |||
351 | You can find out more about the patching process in the | 351 | You can find out more about the patching process in the |
352 | ":ref:`overview-manual/overview-manual-concepts:patching`" section in | 352 | ":ref:`overview-manual/overview-manual-concepts:patching`" section in |
353 | the Yocto Project Overview and Concepts Manual and the | 353 | the Yocto Project Overview and Concepts Manual and the |
354 | ":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in the | 354 | ":ref:`dev-manual/common-tasks:patching code`" section in the |
355 | Yocto Project Development Tasks Manual. | 355 | Yocto Project Development Tasks Manual. |
356 | 356 | ||
357 | .. _ref-tasks-populate_lic: | 357 | .. _ref-tasks-populate_lic: |
@@ -567,7 +567,7 @@ scratch is guaranteed. | |||
567 | Starts a shell in which an interactive Python interpreter allows you to | 567 | Starts a shell in which an interactive Python interpreter allows you to |
568 | interact with the BitBake build environment. From within this shell, you | 568 | interact with the BitBake build environment. From within this shell, you |
569 | can directly examine and set bits from the data store and execute | 569 | can directly examine and set bits from the data store and execute |
570 | functions as if within the BitBake environment. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development python shell`" section in | 570 | functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in |
571 | the Yocto Project Development Tasks Manual for more information about | 571 | the Yocto Project Development Tasks Manual for more information about |
572 | using ``devpyshell``. | 572 | using ``devpyshell``. |
573 | 573 | ||
@@ -577,7 +577,7 @@ using ``devpyshell``. | |||
577 | --------------- | 577 | --------------- |
578 | 578 | ||
579 | Starts a shell whose environment is set up for development, debugging, | 579 | Starts a shell whose environment is set up for development, debugging, |
580 | or both. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in the | 580 | or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the |
581 | Yocto Project Development Tasks Manual for more information about using | 581 | Yocto Project Development Tasks Manual for more information about using |
582 | ``devshell``. | 582 | ``devshell``. |
583 | 583 | ||
@@ -642,7 +642,7 @@ information on how the root filesystem is created. | |||
642 | 642 | ||
643 | Boots an image and performs runtime tests within the image. For | 643 | Boots an image and performs runtime tests within the image. For |
644 | information on automatically testing images, see the | 644 | information on automatically testing images, see the |
645 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 645 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
646 | section in the Yocto Project Development Tasks Manual. | 646 | section in the Yocto Project Development Tasks Manual. |
647 | 647 | ||
648 | .. _ref-tasks-testimage_auto: | 648 | .. _ref-tasks-testimage_auto: |
@@ -655,7 +655,7 @@ after it has been built. This task is enabled when you set | |||
655 | :term:`TESTIMAGE_AUTO` equal to "1". | 655 | :term:`TESTIMAGE_AUTO` equal to "1". |
656 | 656 | ||
657 | For information on automatically testing images, see the | 657 | For information on automatically testing images, see the |
658 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 658 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
659 | section in the Yocto Project Development Tasks Manual. | 659 | section in the Yocto Project Development Tasks Manual. |
660 | 660 | ||
661 | Kernel-Related Tasks | 661 | Kernel-Related Tasks |
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 6f0facf728..ba1930ebda 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
@@ -21,7 +21,7 @@ universal, the list includes them just in case: | |||
21 | 21 | ||
22 | Information in append files extends or overrides the information in the | 22 | Information in append files extends or overrides the information in the |
23 | similarly-named recipe file. For an example of an append file in use, see | 23 | similarly-named recipe file. For an example of an append file in use, see |
24 | the ":ref:`dev-manual/dev-manual-common-tasks:Using .bbappend Files in | 24 | the ":ref:`dev-manual/common-tasks:Using .bbappend Files in |
25 | Your Layer`" section in the Yocto Project Development Tasks Manual. | 25 | Your Layer`" section in the Yocto Project Development Tasks Manual. |
26 | 26 | ||
27 | When you name an append file, you can use the "``%``" wildcard character | 27 | When you name an append file, you can use the "``%``" wildcard character |
@@ -192,7 +192,7 @@ universal, the list includes them just in case: | |||
192 | ":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer | 192 | ":ref:`overview-manual/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/dev-manual-common-tasks:Understanding and Creating | 195 | ":ref:`dev-manual/common-tasks:Understanding and Creating |
196 | Layers`" section in the Yocto Project Development Tasks Manual. For a | 196 | Layers`" section in the Yocto Project Development Tasks Manual. For a |
197 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP | 197 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP |
198 | Layers`" section in the Yocto Project Board Support Packages (BSP) | 198 | Layers`" section in the Yocto Project Board Support Packages (BSP) |
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 8411989b69..65f64b91a5 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -239,7 +239,7 @@ system and gives an overview of their function and contents. | |||
239 | so that it does contain ``${SRCPV}``. | 239 | so that it does contain ``${SRCPV}``. |
240 | 240 | ||
241 | For more information see the | 241 | For more information see the |
242 | ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" | 242 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" |
243 | section in the Yocto Project Development Tasks Manual. | 243 | section in the Yocto Project Development Tasks Manual. |
244 | 244 | ||
245 | :term:`AVAILABLE_LICENSES` | 245 | :term:`AVAILABLE_LICENSES` |
@@ -261,7 +261,7 @@ system and gives an overview of their function and contents. | |||
261 | The list simply presents the tunes that are available. Not all tunes | 261 | The list simply presents the tunes that are available. Not all tunes |
262 | may be compatible with a particular machine configuration, or with | 262 | may be compatible with a particular machine configuration, or with |
263 | each other in a | 263 | each other in a |
264 | :ref:`Multilib <dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image>` | 264 | :ref:`Multilib <dev-manual/common-tasks:combining multiple versions of library files into one image>` |
265 | configuration. | 265 | configuration. |
266 | 266 | ||
267 | To add a tune to the list, be sure to append it with spaces using the | 267 | To add a tune to the list, be sure to append it with spaces using the |
@@ -317,7 +317,7 @@ system and gives an overview of their function and contents. | |||
317 | :term:`BASE_LIB` | 317 | :term:`BASE_LIB` |
318 | The library directory name for the CPU or Application Binary | 318 | The library directory name for the CPU or Application Binary |
319 | Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib | 319 | Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib |
320 | context. See the ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" | 320 | context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" |
321 | section in the Yocto Project Development Tasks Manual for information | 321 | section in the Yocto Project Development Tasks Manual for information |
322 | on Multilib. | 322 | on Multilib. |
323 | 323 | ||
@@ -545,7 +545,7 @@ system and gives an overview of their function and contents. | |||
545 | is not set higher than "20". | 545 | is not set higher than "20". |
546 | 546 | ||
547 | For more information on speeding up builds, see the | 547 | For more information on speeding up builds, see the |
548 | ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" | 548 | ":ref:`dev-manual/common-tasks:speeding up a build`" |
549 | section in the Yocto Project Development Tasks Manual. | 549 | section in the Yocto Project Development Tasks Manual. |
550 | 550 | ||
551 | :term:`BB_SERVER_TIMEOUT` | 551 | :term:`BB_SERVER_TIMEOUT` |
@@ -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-manual/dev-manual-common-tasks:building images for multiple targets using multiple configurations`" | 749 | ":ref:`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` |
@@ -1002,7 +1002,7 @@ system and gives an overview of their function and contents. | |||
1002 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` | 1002 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
1003 | class, this variable specifies the build history features to be | 1003 | class, this variable specifies the build history features to be |
1004 | enabled. For more information on how build history works, see the | 1004 | enabled. For more information on how build history works, see the |
1005 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 1005 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
1006 | section in the Yocto Project Development Tasks Manual. | 1006 | section in the Yocto Project Development Tasks Manual. |
1007 | 1007 | ||
1008 | You can specify these features in the form of a space-separated list: | 1008 | You can specify these features in the form of a space-separated list: |
@@ -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:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section | 1302 | ":ref:`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` |
@@ -1402,7 +1402,7 @@ system and gives an overview of their function and contents. | |||
1402 | newly installed packages to an image, which might be most suitable for | 1402 | newly installed packages to an image, which might be most suitable for |
1403 | read-only filesystems that cannot be upgraded. See the | 1403 | read-only filesystems that cannot be upgraded. See the |
1404 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1404 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1405 | You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" | 1405 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" |
1406 | section in the Yocto Project Development Tasks Manual for | 1406 | section in the Yocto Project Development Tasks Manual for |
1407 | information on providing license text. | 1407 | information on providing license text. |
1408 | 1408 | ||
@@ -1418,7 +1418,7 @@ system and gives an overview of their function and contents. | |||
1418 | newly installed packages to an image, which might be most suitable for | 1418 | newly installed packages to an image, which might be most suitable for |
1419 | read-only filesystems that cannot be upgraded. See the | 1419 | read-only filesystems that cannot be upgraded. See the |
1420 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1420 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1421 | You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" | 1421 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" |
1422 | section in the Yocto Project Development Tasks Manual for | 1422 | section in the Yocto Project Development Tasks Manual for |
1423 | information on providing license text. | 1423 | information on providing license text. |
1424 | 1424 | ||
@@ -2029,7 +2029,7 @@ system and gives an overview of their function and contents. | |||
2029 | When used with the :ref:`report-error <ref-classes-report-error>` | 2029 | When used with the :ref:`report-error <ref-classes-report-error>` |
2030 | class, specifies the path used for storing the debug files created by | 2030 | class, specifies the path used for storing the debug files created by |
2031 | the :ref:`error reporting | 2031 | the :ref:`error reporting |
2032 | tool <dev-manual/dev-manual-common-tasks:using the error reporting tool>`, which | 2032 | tool <dev-manual/common-tasks:using the error reporting tool>`, which |
2033 | allows you to submit build errors you encounter to a central | 2033 | allows you to submit build errors you encounter to a central |
2034 | database. By default, the value of this variable is | 2034 | database. By default, the value of this variable is |
2035 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. | 2035 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. |
@@ -2129,7 +2129,7 @@ system and gives an overview of their function and contents. | |||
2129 | For more information on ``externalsrc.bbclass``, see the | 2129 | For more information on ``externalsrc.bbclass``, see the |
2130 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You | 2130 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You |
2131 | can also find information on how to use this variable in the | 2131 | can also find information on how to use this variable in the |
2132 | ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" | 2132 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
2133 | section in the Yocto Project Development Tasks Manual. | 2133 | section in the Yocto Project Development Tasks Manual. |
2134 | 2134 | ||
2135 | :term:`EXTERNALSRC_BUILD` | 2135 | :term:`EXTERNALSRC_BUILD` |
@@ -2143,7 +2143,7 @@ system and gives an overview of their function and contents. | |||
2143 | For more information on ``externalsrc.bbclass``, see the | 2143 | For more information on ``externalsrc.bbclass``, see the |
2144 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You | 2144 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You |
2145 | can also find information on how to use this variable in the | 2145 | can also find information on how to use this variable in the |
2146 | ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" | 2146 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
2147 | section in the Yocto Project Development Tasks Manual. | 2147 | section in the Yocto Project Development Tasks Manual. |
2148 | 2148 | ||
2149 | :term:`EXTRA_AUTORECONF` | 2149 | :term:`EXTRA_AUTORECONF` |
@@ -2181,7 +2181,7 @@ system and gives an overview of their function and contents. | |||
2181 | useful if you want to develop against the libraries in the image. | 2181 | useful if you want to develop against the libraries in the image. |
2182 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2182 | - "read-only-rootfs" - Creates an image whose root filesystem is |
2183 | read-only. See the | 2183 | read-only. See the |
2184 | ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" | 2184 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" |
2185 | section in the Yocto Project Development Tasks Manual for more | 2185 | section in the Yocto Project Development Tasks Manual for more |
2186 | information | 2186 | information |
2187 | - "tools-debug" - Adds debugging tools such as gdb and strace. | 2187 | - "tools-debug" - Adds debugging tools such as gdb and strace. |
@@ -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:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 2197 | variable, see the ":ref:`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` |
@@ -2511,7 +2511,7 @@ system and gives an overview of their function and contents. | |||
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/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/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 |
2516 | :ref:`ref-tasks-patch` task as well. | 2516 | :ref:`ref-tasks-patch` task as well. |
2517 | 2517 | ||
@@ -2904,7 +2904,7 @@ system and gives an overview of their function and contents. | |||
2904 | the same files into a ``boot`` directory within the target partition. | 2904 | the same files into a ``boot`` directory within the target partition. |
2905 | 2905 | ||
2906 | You can find information on how to use the Wic tool in the | 2906 | You can find information on how to use the Wic tool in the |
2907 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 2907 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" |
2908 | section of the Yocto Project Development Tasks Manual. Reference | 2908 | section of the Yocto Project Development Tasks Manual. Reference |
2909 | material for Wic is located in the | 2909 | material for Wic is located in the |
2910 | ":doc:`/ref-manual/ref-kickstart`" chapter. | 2910 | ":doc:`/ref-manual/ref-kickstart`" chapter. |
@@ -2940,7 +2940,7 @@ system and gives an overview of their function and contents. | |||
2940 | the same files into a ``boot`` directory within the target partition. | 2940 | the same files into a ``boot`` directory within the target partition. |
2941 | 2941 | ||
2942 | You can find information on how to use the Wic tool in the | 2942 | You can find information on how to use the Wic tool in the |
2943 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 2943 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" |
2944 | section of the Yocto Project Development Tasks Manual. Reference | 2944 | section of the Yocto Project Development Tasks Manual. Reference |
2945 | material for Wic is located in the | 2945 | material for Wic is located in the |
2946 | ":doc:`/ref-manual/ref-kickstart`" chapter. | 2946 | ":doc:`/ref-manual/ref-kickstart`" chapter. |
@@ -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:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 3003 | variable, see the ":ref:`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:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" | 3061 | ":ref:`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 |
@@ -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:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section | 3557 | image, see the ":ref:`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 </poky/tree/meta-poky/conf/local.conf.sample.extended>` | 3603 | :yocto_git:`local.conf.sample.extended </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:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section | 3605 | initramfs, see the ":ref:`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` |
@@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents. | |||
4191 | The OpenEmbedded build system produces a warning if the variable | 4191 | The OpenEmbedded build system produces a warning if the variable |
4192 | is not set for any given layer. | 4192 | is not set for any given layer. |
4193 | 4193 | ||
4194 | See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" | 4194 | See the ":ref:`dev-manual/common-tasks:creating your own layer`" |
4195 | section in the Yocto Project Development Tasks Manual. | 4195 | section in the Yocto Project Development Tasks Manual. |
4196 | 4196 | ||
4197 | :term:`LAYERVERSION` | 4197 | :term:`LAYERVERSION` |
@@ -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:`dev-manual/dev-manual-common-tasks:tracking license changes`" | 4243 | For more information, see the ":ref:`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` |
@@ -4306,7 +4306,7 @@ system and gives an overview of their function and contents. | |||
4306 | For related information on providing license text, see the | 4306 | For related information on providing license text, see the |
4307 | :term:`COPY_LIC_DIRS` variable, the | 4307 | :term:`COPY_LIC_DIRS` variable, the |
4308 | :term:`COPY_LIC_MANIFEST` variable, and the | 4308 | :term:`COPY_LIC_MANIFEST` variable, and the |
4309 | ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" | 4309 | ":ref:`dev-manual/common-tasks:providing license text`" |
4310 | section in the Yocto Project Development Tasks Manual. | 4310 | section in the Yocto Project Development Tasks Manual. |
4311 | 4311 | ||
4312 | :term:`LICENSE_FLAGS` | 4312 | :term:`LICENSE_FLAGS` |
@@ -4319,7 +4319,7 @@ system and gives an overview of their function and contents. | |||
4319 | typically used to mark recipes that might require additional licenses | 4319 | typically used to mark recipes that might require additional licenses |
4320 | in order to be used in a commercial product. For more information, | 4320 | in order to be used in a commercial product. For more information, |
4321 | see the | 4321 | see the |
4322 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" | 4322 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" |
4323 | section in the Yocto Project Development Tasks Manual. | 4323 | section in the Yocto Project Development Tasks Manual. |
4324 | 4324 | ||
4325 | :term:`LICENSE_FLAGS_WHITELIST` | 4325 | :term:`LICENSE_FLAGS_WHITELIST` |
@@ -4327,7 +4327,7 @@ system and gives an overview of their function and contents. | |||
4327 | :term:`LICENSE_FLAGS` within a recipe should not | 4327 | :term:`LICENSE_FLAGS` within a recipe should not |
4328 | prevent that recipe from being built. This practice is otherwise | 4328 | prevent that recipe from being built. This practice is otherwise |
4329 | known as "whitelisting" license flags. For more information, see the | 4329 | known as "whitelisting" license flags. For more information, see the |
4330 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" | 4330 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" |
4331 | section in the Yocto Project Development Tasks Manual. | 4331 | section in the Yocto Project Development Tasks Manual. |
4332 | 4332 | ||
4333 | :term:`LICENSE_PATH` | 4333 | :term:`LICENSE_PATH` |
@@ -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:`dev-manual/dev-manual-common-tasks:using a development shell`" section in | 4893 | information, see the ":ref:`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-manual/dev-manual-common-tasks:viewing variable values`" section in the Yocto | 4962 | ":ref:`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` |
@@ -4981,7 +4981,7 @@ system and gives an overview of their function and contents. | |||
4981 | specific by using the package name as a suffix. | 4981 | specific by using the package name as a suffix. |
4982 | 4982 | ||
4983 | You can find out more about applying this variable in the | 4983 | You can find out more about applying this variable in the |
4984 | ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" | 4984 | ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" |
4985 | section in the Yocto Project Development Tasks Manual. | 4985 | section in the Yocto Project Development Tasks Manual. |
4986 | 4986 | ||
4987 | :term:`PACKAGE_ARCH` | 4987 | :term:`PACKAGE_ARCH` |
@@ -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:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 5082 | ":ref:`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:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section | 5246 | initramfs, see the ":ref:`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` |
@@ -5266,7 +5266,7 @@ system and gives an overview of their function and contents. | |||
5266 | ``PACKAGE_WRITE_DEPS``. | 5266 | ``PACKAGE_WRITE_DEPS``. |
5267 | 5267 | ||
5268 | For information on running post-installation scripts, see the | 5268 | For information on running post-installation scripts, see the |
5269 | ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" | 5269 | ":ref:`dev-manual/common-tasks:post-installation scripts`" |
5270 | section in the Yocto Project Development Tasks Manual. | 5270 | section in the Yocto Project Development Tasks Manual. |
5271 | 5271 | ||
5272 | :term:`PACKAGECONFIG` | 5272 | :term:`PACKAGECONFIG` |
@@ -5423,7 +5423,7 @@ system and gives an overview of their function and contents. | |||
5423 | 5423 | ||
5424 | For an example of how to use the ``PACKAGES_DYNAMIC`` variable when | 5424 | For an example of how to use the ``PACKAGES_DYNAMIC`` variable when |
5425 | you are splitting packages, see the | 5425 | you are splitting packages, see the |
5426 | ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" | 5426 | ":ref:`dev-manual/common-tasks:handling optional module packaging`" |
5427 | section in the Yocto Project Development Tasks Manual. | 5427 | section in the Yocto Project Development Tasks Manual. |
5428 | 5428 | ||
5429 | :term:`PACKAGESPLITFUNCS` | 5429 | :term:`PACKAGESPLITFUNCS` |
@@ -5458,7 +5458,7 @@ system and gives an overview of their function and contents. | |||
5458 | the ``do_compile`` task that result in race conditions, you can clear | 5458 | the ``do_compile`` task that result in race conditions, you can clear |
5459 | the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For | 5459 | the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For |
5460 | information on addressing race conditions, see the | 5460 | information on addressing race conditions, see the |
5461 | ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" | 5461 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" |
5462 | section in the Yocto Project Development Tasks Manual. | 5462 | section in the Yocto Project Development Tasks Manual. |
5463 | 5463 | ||
5464 | For single socket systems (i.e. one CPU), you should not have to | 5464 | For single socket systems (i.e. one CPU), you should not have to |
@@ -5468,7 +5468,7 @@ system and gives an overview of their function and contents. | |||
5468 | not set higher than "-j 20". | 5468 | not set higher than "-j 20". |
5469 | 5469 | ||
5470 | For more information on speeding up builds, see the | 5470 | For more information on speeding up builds, see the |
5471 | ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" | 5471 | ":ref:`dev-manual/common-tasks:speeding up a build`" |
5472 | section in the Yocto Project Development Tasks Manual. | 5472 | section in the Yocto Project Development Tasks Manual. |
5473 | 5473 | ||
5474 | :term:`PARALLEL_MAKEINST` | 5474 | :term:`PARALLEL_MAKEINST` |
@@ -5488,7 +5488,7 @@ system and gives an overview of their function and contents. | |||
5488 | the ``do_install`` task that result in race conditions, you can | 5488 | the ``do_install`` task that result in race conditions, you can |
5489 | clear the ``PARALLEL_MAKEINST`` variable within the recipe as a | 5489 | clear the ``PARALLEL_MAKEINST`` variable within the recipe as a |
5490 | workaround. For information on addressing race conditions, see the | 5490 | workaround. For information on addressing race conditions, see the |
5491 | ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" | 5491 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" |
5492 | section in the Yocto Project Development Tasks Manual. | 5492 | section in the Yocto Project Development Tasks Manual. |
5493 | 5493 | ||
5494 | :term:`PATCHRESOLVE` | 5494 | :term:`PATCHRESOLVE` |
@@ -5580,7 +5580,7 @@ system and gives an overview of their function and contents. | |||
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/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/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 |
5585 | information on the shared, global-state directory, see | 5585 | information on the shared, global-state directory, see |
5586 | :term:`STAGING_DIR_HOST`. | 5586 | :term:`STAGING_DIR_HOST`. |
@@ -5713,7 +5713,7 @@ system and gives an overview of their function and contents. | |||
5713 | 5713 | ||
5714 | Because manually managing ``PR`` can be cumbersome and error-prone, | 5714 | Because manually managing ``PR`` can be cumbersome and error-prone, |
5715 | an automated solution exists. See the | 5715 | an automated solution exists. See the |
5716 | ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section | 5716 | ":ref:`dev-manual/common-tasks:working with a pr service`" section |
5717 | in the Yocto Project Development Tasks Manual for more information. | 5717 | in the Yocto Project Development Tasks Manual for more information. |
5718 | 5718 | ||
5719 | :term:`PREFERRED_PROVIDER` | 5719 | :term:`PREFERRED_PROVIDER` |
@@ -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:`dev-manual/dev-manual-common-tasks:using virtual providers`" | 5741 | information, see the ":ref:`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:: |
@@ -5951,7 +5951,7 @@ system and gives an overview of their function and contents. | |||
5951 | 5951 | ||
5952 | You must | 5952 | You must |
5953 | set the variable if you want to automatically start a local :ref:`PR | 5953 | set the variable if you want to automatically start a local :ref:`PR |
5954 | service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can | 5954 | service <dev-manual/common-tasks:working with a pr service>`. You can |
5955 | set ``PRSERV_HOST`` to other values to use a remote PR service. | 5955 | set ``PRSERV_HOST`` to other values to use a remote PR service. |
5956 | 5956 | ||
5957 | 5957 | ||
@@ -5965,7 +5965,7 @@ system and gives an overview of their function and contents. | |||
5965 | 5965 | ||
5966 | :term:`PTEST_ENABLED` | 5966 | :term:`PTEST_ENABLED` |
5967 | Specifies whether or not :ref:`Package | 5967 | Specifies whether or not :ref:`Package |
5968 | Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest) | 5968 | Test <dev-manual/common-tasks:testing packages with ptest>` (ptest) |
5969 | functionality is enabled when building a recipe. You should not set | 5969 | functionality is enabled when building a recipe. You should not set |
5970 | this variable directly. Enabling and disabling building Package Tests | 5970 | this variable directly. Enabling and disabling building Package Tests |
5971 | at build time should be done by adding "ptest" to (or removing it | 5971 | at build time should be done by adding "ptest" to (or removing it |
@@ -7000,7 +7000,7 @@ system and gives an overview of their function and contents. | |||
7000 | various ``SPL_*`` variables used by the OpenEmbedded build system. | 7000 | various ``SPL_*`` variables used by the OpenEmbedded build system. |
7001 | 7001 | ||
7002 | See the BeagleBone machine configuration example in the | 7002 | See the BeagleBone machine configuration example in the |
7003 | ":ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" | 7003 | ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" |
7004 | section in the Yocto Project Board Support Package Developer's Guide | 7004 | section in the Yocto Project Board Support Package Developer's Guide |
7005 | for additional information. | 7005 | for additional information. |
7006 | 7006 | ||
@@ -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:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" | 7203 | ":ref:`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` |
@@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents. | |||
7660 | 7660 | ||
7661 | :term:`SYSVINIT_ENABLED_GETTYS` | 7661 | :term:`SYSVINIT_ENABLED_GETTYS` |
7662 | When using | 7662 | When using |
7663 | :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, | 7663 | :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, |
7664 | specifies a space-separated list of the virtual terminals that should | 7664 | specifies a space-separated list of the virtual terminals that should |
7665 | run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ | 7665 | run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ |
7666 | (allowing login), assuming :term:`USE_VT` is not set to | 7666 | (allowing login), assuming :term:`USE_VT` is not set to |
@@ -7946,7 +7946,7 @@ system and gives an overview of their function and contents. | |||
7946 | file. | 7946 | file. |
7947 | 7947 | ||
7948 | For more information on testing images, see the | 7948 | For more information on testing images, see the |
7949 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 7949 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
7950 | section in the Yocto Project Development Tasks Manual. | 7950 | section in the Yocto Project Development Tasks Manual. |
7951 | 7951 | ||
7952 | :term:`TEST_SERIALCONTROL_CMD` | 7952 | :term:`TEST_SERIALCONTROL_CMD` |
@@ -8022,7 +8022,7 @@ system and gives an overview of their function and contents. | |||
8022 | TEST_SUITES = "test_A test_B" | 8022 | TEST_SUITES = "test_A test_B" |
8023 | 8023 | ||
8024 | For more information on testing images, see the | 8024 | For more information on testing images, see the |
8025 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 8025 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
8026 | section in the Yocto Project Development Tasks Manual. | 8026 | section in the Yocto Project Development Tasks Manual. |
8027 | 8027 | ||
8028 | :term:`TEST_TARGET` | 8028 | :term:`TEST_TARGET` |
@@ -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:`dev-manual/dev-manual-common-tasks:enabling runtime tests on qemu`" section | 8045 | ":ref:`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:`dev-manual/dev-manual-common-tasks:enabling runtime tests on hardware`" | 8061 | ":ref:`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` |
@@ -8096,7 +8096,7 @@ system and gives an overview of their function and contents. | |||
8096 | 8096 | ||
8097 | For more information | 8097 | For more information |
8098 | on enabling, running, and writing these tests, see the | 8098 | on enabling, running, and writing these tests, see the |
8099 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 8099 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
8100 | section in the Yocto Project Development Tasks Manual and the | 8100 | section in the Yocto Project Development Tasks Manual and the |
8101 | ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. | 8101 | ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. |
8102 | 8102 | ||
@@ -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:`dev-manual/dev-manual-common-tasks:selecting a device manager`" section in | 8557 | See the ":ref:`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 <dev-manual/dev-manual-common-tasks:enabling system services>`, | 8563 | :ref:`SysVinit <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 |
@@ -8735,7 +8735,7 @@ system and gives an overview of their function and contents. | |||
8735 | OpenEmbedded build system to create a partitioned image | 8735 | OpenEmbedded build system to create a partitioned image |
8736 | (image\ ``.wic``). For information on how to create a partitioned | 8736 | (image\ ``.wic``). For information on how to create a partitioned |
8737 | image, see the | 8737 | image, see the |
8738 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 8738 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" |
8739 | section in the Yocto Project Development Tasks Manual. For details on | 8739 | section in the Yocto Project Development Tasks Manual. For details on |
8740 | the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. | 8740 | the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. |
8741 | 8741 | ||
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index fd04593d43..77c3678095 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 | |||
23 | to the project either by creating and sending pull requests, or by | 23 | to the project either by creating and sending pull requests, or by |
24 | submitting patches through email. For information on how to do both as | 24 | submitting patches through email. For information on how to do both as |
25 | well as information on how to identify the maintainer for each area of | 25 | well as information on how to identify the maintainer for each area of |
26 | code, see the ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" section in the | 26 | code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the |
27 | Yocto Project Development Tasks Manual. | 27 | Yocto Project Development Tasks Manual. |
28 | 28 | ||
29 | .. _resources-bugtracker: | 29 | .. _resources-bugtracker: |
@@ -47,7 +47,7 @@ A general procedure and guidelines exist for when you use Bugzilla to | |||
47 | submit a bug. For information on how to use Bugzilla to submit a bug | 47 | submit a bug. For information on how to use Bugzilla to submit a bug |
48 | against the Yocto Project, see the following: | 48 | against the Yocto Project, see the following: |
49 | 49 | ||
50 | - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" | 50 | - The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" |
51 | section in the Yocto Project Development Tasks Manual. | 51 | section in the Yocto Project Development Tasks Manual. |
52 | 52 | ||
53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |