diff options
23 files changed, 91 insertions, 92 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 1779f9e208..353d56777b 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -1,8 +1,8 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | 1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK |
2 | 2 | ||
3 | ************************************************ | 3 | ************************************************** |
4 | Board Support Packages (BSP) - Developer's Guide | 4 | Board Support Packages (BSP) --- Developer's Guide |
5 | ************************************************ | 5 | ************************************************** |
6 | 6 | ||
7 | A Board Support Package (BSP) is a collection of information that | 7 | A Board Support Package (BSP) is a collection of information that |
8 | defines how to support a particular hardware device, set of devices, or | 8 | defines how to support a particular hardware device, set of devices, or |
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst index e38a8da25c..eae2d49ba4 100644 --- a/documentation/kernel-dev/advanced.rst +++ b/documentation/kernel-dev/advanced.rst | |||
@@ -182,7 +182,7 @@ the structure: | |||
182 | order to define a base kernel policy or major kernel type to be | 182 | order to define a base kernel policy or major kernel type to be |
183 | reused across multiple BSPs, place the file in ``ktypes`` directory. | 183 | reused across multiple BSPs, place the file in ``ktypes`` directory. |
184 | 184 | ||
185 | These distinctions can easily become blurred - especially as out-of-tree | 185 | These distinctions can easily become blurred --- especially as out-of-tree |
186 | features slowly merge upstream over time. Also, remember that how the | 186 | features slowly merge upstream over time. Also, remember that how the |
187 | description files are placed is a purely logical organization and has no | 187 | description files are placed is a purely logical organization and has no |
188 | impact on the functionality of the kernel Metadata. There is no impact | 188 | impact on the functionality of the kernel Metadata. There is no impact |
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 910318e0f9..7b734a2a39 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst | |||
@@ -117,7 +117,7 @@ upstream Linux kernel development and are managed by the Yocto Project | |||
117 | team's Yocto Linux kernel development strategy. It is the Yocto Project | 117 | team's Yocto Linux kernel development strategy. It is the Yocto Project |
118 | team's policy to not back-port minor features to the released Yocto | 118 | team's policy to not back-port minor features to the released Yocto |
119 | Linux kernel. They only consider back-porting significant technological | 119 | Linux kernel. They only consider back-porting significant technological |
120 | jumps - and, that is done after a complete gap analysis. The reason | 120 | jumps --- and, that is done after a complete gap analysis. The reason |
121 | for this policy is that back-porting any small to medium sized change | 121 | for this policy is that back-porting any small to medium sized change |
122 | from an evolving Linux kernel can easily create mismatches, | 122 | from an evolving Linux kernel can easily create mismatches, |
123 | incompatibilities and very subtle errors. | 123 | incompatibilities and very subtle errors. |
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index 6ba52998de..c50786a36d 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst | |||
@@ -341,39 +341,39 @@ Removed and Renamed Recipes | |||
341 | 341 | ||
342 | The following recipes have been removed: | 342 | The following recipes have been removed: |
343 | 343 | ||
344 | - ``packagegroup-toolset-native`` - This recipe is largely unused. | 344 | - ``packagegroup-toolset-native`` --- this recipe is largely unused. |
345 | 345 | ||
346 | - ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been | 346 | - ``linux-yocto-3.8`` --- support for the Linux yocto 3.8 kernel has been |
347 | dropped. Support for the 3.10 and 3.14 kernels have been added with | 347 | dropped. Support for the 3.10 and 3.14 kernels have been added with |
348 | the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. | 348 | the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. |
349 | 349 | ||
350 | - ``ocf-linux`` - This recipe has been functionally replaced using | 350 | - ``ocf-linux`` --- this recipe has been functionally replaced using |
351 | ``cryptodev-linux``. | 351 | ``cryptodev-linux``. |
352 | 352 | ||
353 | - ``genext2fs`` - ``genext2fs`` is no longer used by the build system | 353 | - ``genext2fs`` --- ``genext2fs`` is no longer used by the build system |
354 | and is unmaintained upstream. | 354 | and is unmaintained upstream. |
355 | 355 | ||
356 | - ``js`` - This provided an ancient version of Mozilla's javascript | 356 | - ``js`` --- this provided an ancient version of Mozilla's javascript |
357 | engine that is no longer needed. | 357 | engine that is no longer needed. |
358 | 358 | ||
359 | - ``zaurusd`` - The recipe has been moved to the ``meta-handheld`` | 359 | - ``zaurusd`` --- the recipe has been moved to the ``meta-handheld`` |
360 | layer. | 360 | layer. |
361 | 361 | ||
362 | - ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe. | 362 | - ``eglibc 2.17`` --- replaced by the ``eglibc 2.19`` recipe. |
363 | 363 | ||
364 | - ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``. | 364 | - ``gcc 4.7.2`` --- replaced by the now stable ``gcc 4.8.2``. |
365 | 365 | ||
366 | - ``external-sourcery-toolchain`` - this recipe is now maintained in | 366 | - ``external-sourcery-toolchain`` --- this recipe is now maintained in |
367 | the ``meta-sourcery`` layer. | 367 | the ``meta-sourcery`` layer. |
368 | 368 | ||
369 | - ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the | 369 | - ``linux-libc-headers-yocto 3.4+git`` --- now using version 3.10 of the |
370 | ``linux-libc-headers`` by default. | 370 | ``linux-libc-headers`` by default. |
371 | 371 | ||
372 | - ``meta-toolchain-gmae`` - This recipe is obsolete. | 372 | - ``meta-toolchain-gmae`` --- this recipe is obsolete. |
373 | 373 | ||
374 | - ``packagegroup-core-sdk-gmae`` - This recipe is obsolete. | 374 | - ``packagegroup-core-sdk-gmae`` --- this recipe is obsolete. |
375 | 375 | ||
376 | - ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is | 376 | - ``packagegroup-core-standalone-gmae-sdk-target`` --- this recipe is |
377 | obsolete. | 377 | obsolete. |
378 | 378 | ||
379 | .. _migration-1.6-removed-classes: | 379 | .. _migration-1.6-removed-classes: |
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 7fa6d39b84..5a52ebaed2 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -216,11 +216,11 @@ The following sanity check changes occurred. | |||
216 | - :term:`SRC_URI` is now checked for usage of two | 216 | - :term:`SRC_URI` is now checked for usage of two |
217 | problematic items: | 217 | problematic items: |
218 | 218 | ||
219 | - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is | 219 | - "${PN}" prefix/suffix use --- warnings always appear if ${PN} is |
220 | used. You must fix the issue regardless of whether multiconfig or | 220 | used. You must fix the issue regardless of whether multiconfig or |
221 | anything else that would cause prefixing/suffixing to happen. | 221 | anything else that would cause prefixing/suffixing to happen. |
222 | 222 | ||
223 | - Github archive tarballs - these are not guaranteed to be stable. | 223 | - Github archive tarballs --- these are not guaranteed to be stable. |
224 | Consequently, it is likely that the tarballs will be refreshed and | 224 | Consequently, it is likely that the tarballs will be refreshed and |
225 | thus the SRC_URI checksums will fail to apply. It is recommended | 225 | thus the SRC_URI checksums will fail to apply. It is recommended |
226 | that you fetch either an official release tarball or a specific | 226 | that you fetch either an official release tarball or a specific |
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index 53f6f1e03a..2312ea6494 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst | |||
@@ -200,7 +200,7 @@ Packaging changes | |||
200 | ----------------- | 200 | ----------------- |
201 | 201 | ||
202 | - ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is | 202 | - ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is |
203 | rarely needed to build modern software - gettext can do most of the | 203 | rarely needed to build modern software --- gettext can do most of the |
204 | things it used to be needed for. ``intltool`` has also been removed | 204 | things it used to be needed for. ``intltool`` has also been removed |
205 | from ``packagegroup-core-self-hosted`` as it is not needed to for | 205 | from ``packagegroup-core-self-hosted`` as it is not needed to for |
206 | standard builds. | 206 | standard builds. |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index 40a917bfc7..cf0b00f1af 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -23,7 +23,7 @@ Removed recipes | |||
23 | The following recipes have been removed: | 23 | The following recipes have been removed: |
24 | 24 | ||
25 | - ``bjam-native``: replaced by ``boost-build-native`` | 25 | - ``bjam-native``: replaced by ``boost-build-native`` |
26 | - ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. | 26 | - ``avahi-ui``: folded into the main ``avahi`` recipe --- the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. |
27 | - ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class | 27 | - ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class |
28 | - ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` | 28 | - ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` |
29 | - ``libmodulemd-v1``: replaced by ``libmodulemd`` | 29 | - ``libmodulemd-v1``: replaced by ``libmodulemd`` |
@@ -37,7 +37,7 @@ Removed classes | |||
37 | 37 | ||
38 | The following classes (.bbclass files) have been removed: | 38 | The following classes (.bbclass files) have been removed: |
39 | 39 | ||
40 | - ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. | 40 | - ``spdx``: obsolete --- the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. |
41 | 41 | ||
42 | - ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. | 42 | - ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. |
43 | 43 | ||
@@ -46,7 +46,7 @@ pseudo path filtering and mismatch behaviour | |||
46 | -------------------------------------------- | 46 | -------------------------------------------- |
47 | 47 | ||
48 | pseudo now operates on a filtered subset of files. This is a significant change | 48 | pseudo now operates on a filtered subset of files. This is a significant change |
49 | to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and | 49 | to the way pseudo operates within OpenEmbedded --- by default, pseudo monitors and |
50 | logs (adds to its database) any file created or modified whilst in a ``fakeroot`` | 50 | logs (adds to its database) any file created or modified whilst in a ``fakeroot`` |
51 | environment. However, there are large numbers of files that we simply don't care | 51 | environment. However, there are large numbers of files that we simply don't care |
52 | about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, | 52 | about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, |
@@ -68,7 +68,7 @@ structure above that subdirectory. For these types of cases in your own recipes, | |||
68 | extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not | 68 | extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not |
69 | be monitoring. | 69 | be monitoring. |
70 | 70 | ||
71 | In addition, pseudo's behaviour on mismatches has now been changed - rather | 71 | In addition, pseudo's behaviour on mismatches has now been changed --- rather |
72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file | 72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file |
73 | with a different path but the same inode as another file it has previously seen, | 73 | with a different path but the same inode as another file it has previously seen, |
74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` | 74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` |
@@ -137,10 +137,10 @@ DHCP server/client replaced | |||
137 | 137 | ||
138 | The ``dhcp`` software package has become unmaintained and thus has been | 138 | The ``dhcp`` software package has become unmaintained and thus has been |
139 | functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will | 139 | functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will |
140 | need to replace references to the recipe/package names as appropriate - most | 140 | need to replace references to the recipe/package names as appropriate --- most |
141 | commonly, at the package level ``dhcp-client`` should be replaced by | 141 | commonly, at the package level ``dhcp-client`` should be replaced by |
142 | ``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any | 142 | ``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any |
143 | custom configuration files for these they will need to be adapted - refer to | 143 | custom configuration files for these they will need to be adapted --- refer to |
144 | the upstream documentation for ``dhcpcd`` and ``kea`` for further details. | 144 | the upstream documentation for ``dhcpcd`` and ``kea`` for further details. |
145 | 145 | ||
146 | 146 | ||
@@ -181,7 +181,7 @@ In addition, the following new checks were added and default to triggering an er | |||
181 | 181 | ||
182 | - :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. | 182 | - :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. |
183 | 183 | ||
184 | - A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed. | 184 | - A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable --- remove any instances of these in your recipes if the warning is displayed. |
185 | 185 | ||
186 | 186 | ||
187 | .. _migration-3.2-src-uri-file-globbing: | 187 | .. _migration-3.2-src-uri-file-globbing: |
@@ -209,7 +209,7 @@ deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` | |||
209 | 209 | ||
210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. | 210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. |
211 | 211 | ||
212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. | 212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. |
213 | 213 | ||
214 | 214 | ||
215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: | 215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: |
@@ -303,7 +303,7 @@ now need to be changed to ``inherit image-artifact-names``. | |||
303 | Miscellaneous changes | 303 | Miscellaneous changes |
304 | --------------------- | 304 | --------------------- |
305 | 305 | ||
306 | - Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`. | 306 | - Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed --- replace any remaining instances with :term:`FEATURE_PACKAGES`. |
307 | - The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. | 307 | - The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. |
308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. | 308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. |
309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. | 309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index b1b81d6839..775ee3172b 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
@@ -17,7 +17,6 @@ using ``scripts/install-buildtools``) --- see | |||
17 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` | 17 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` |
18 | for details. | 18 | for details. |
19 | 19 | ||
20 | |||
21 | .. _migration-3.3-removed-recipes: | 20 | .. _migration-3.3-removed-recipes: |
22 | 21 | ||
23 | Removed recipes | 22 | Removed recipes |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 0ef6c435ec..cbb7efb0f4 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
@@ -146,7 +146,7 @@ Virtual runtime provides | |||
146 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 146 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
147 | 147 | ||
148 | Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and | 148 | Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and |
149 | :term:`RDEPENDS` - it is confusing because ``virtual/`` has no special | 149 | :term:`RDEPENDS` --- it is confusing because ``virtual/`` has no special |
150 | meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the | 150 | meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the |
151 | corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`). | 151 | corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`). |
152 | 152 | ||
@@ -171,7 +171,7 @@ Extensible SDK host extension | |||
171 | For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK` | 171 | For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK` |
172 | unconditionally which is fine, until the eSDK tries to override the | 172 | unconditionally which is fine, until the eSDK tries to override the |
173 | variable to its own values. Instead of installing packages specified | 173 | variable to its own values. Instead of installing packages specified |
174 | in this variable it uses native recipes instead - a very different | 174 | in this variable it uses native recipes instead --- a very different |
175 | approach. This has led to confusing errors when binaries are added | 175 | approach. This has led to confusing errors when binaries are added |
176 | to the SDK but not relocated. | 176 | to the SDK but not relocated. |
177 | 177 | ||
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 5a8fb4b5a9..323e4df7ae 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
@@ -5,7 +5,7 @@ New Features / Enhancements in 3.4 | |||
5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
6 | 6 | ||
7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades | 7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades |
8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance - see the above migration guide for help | 8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help |
9 | - Rust integrated into core, providing rust support for cross-compilation and SDK | 9 | - Rust integrated into core, providing rust support for cross-compilation and SDK |
10 | - New create-spdx class for creating SPDX SBoM documents | 10 | - New create-spdx class for creating SPDX SBoM documents |
11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland | 11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index a1fd3c4dad..e70c778263 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -565,7 +565,7 @@ Local Projects | |||
565 | ~~~~~~~~~~~~~~ | 565 | ~~~~~~~~~~~~~~ |
566 | 566 | ||
567 | Local projects are custom bits of software the user provides. These bits | 567 | Local projects are custom bits of software the user provides. These bits |
568 | reside somewhere local to a project - perhaps a directory into which the | 568 | reside somewhere local to a project --- perhaps a directory into which the |
569 | user checks in items (e.g. a local directory containing a development | 569 | user checks in items (e.g. a local directory containing a development |
570 | source tree used by the group). | 570 | source tree used by the group). |
571 | 571 | ||
@@ -1647,7 +1647,7 @@ you a good idea of when the task's data changes. | |||
1647 | 1647 | ||
1648 | To complicate the problem, there are things that should not be included | 1648 | To complicate the problem, there are things that should not be included |
1649 | in the checksum. First, there is the actual specific build path of a | 1649 | in the checksum. First, there is the actual specific build path of a |
1650 | given task - the :term:`WORKDIR`. It | 1650 | given task --- the :term:`WORKDIR`. It |
1651 | does not matter if the work directory changes because it should not | 1651 | does not matter if the work directory changes because it should not |
1652 | affect the output for target packages. Also, the build process has the | 1652 | affect the output for target packages. Also, the build process has the |
1653 | objective of making native or cross packages relocatable. | 1653 | objective of making native or cross packages relocatable. |
@@ -1706,7 +1706,7 @@ need to fix this situation. | |||
1706 | Thus far, this section has limited discussion to the direct inputs into | 1706 | Thus far, this section has limited discussion to the direct inputs into |
1707 | a task. Information based on direct inputs is referred to as the | 1707 | a task. Information based on direct inputs is referred to as the |
1708 | "basehash" in the code. However, the question of a task's indirect | 1708 | "basehash" in the code. However, the question of a task's indirect |
1709 | inputs still exits - items already built and present in the | 1709 | inputs still exits --- items already built and present in the |
1710 | :term:`Build Directory`. The checksum (or | 1710 | :term:`Build Directory`. The checksum (or |
1711 | signature) for a particular task needs to add the hashes of all the | 1711 | signature) for a particular task needs to add the hashes of all the |
1712 | tasks on which the particular task depends. Choosing which dependencies | 1712 | tasks on which the particular task depends. Choosing which dependencies |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 30c7af4531..c3123dcb6d 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -52,7 +52,7 @@ A development host or :term:`Build Host` is key to | |||
52 | using the Yocto Project. Because the goal of the Yocto Project is to | 52 | using the Yocto Project. Because the goal of the Yocto Project is to |
53 | develop images or applications that run on embedded hardware, | 53 | develop images or applications that run on embedded hardware, |
54 | development of those images and applications generally takes place on a | 54 | development of those images and applications generally takes place on a |
55 | system not intended to run the software - the development host. | 55 | system not intended to run the software --- the development host. |
56 | 56 | ||
57 | You need to set up a development host in order to use it with the Yocto | 57 | You need to set up a development host in order to use it with the Yocto |
58 | Project. Most find that it is best to have a native Linux machine | 58 | Project. Most find that it is best to have a native Linux machine |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 8683fb9ebd..50b7901b29 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -857,7 +857,7 @@ helpful for getting started: | |||
857 | distribution. | 857 | distribution. |
858 | 858 | ||
859 | Another point worth noting is that historically within the Yocto | 859 | Another point worth noting is that historically within the Yocto |
860 | Project, recipes were referred to as packages - thus, the existence | 860 | Project, recipes were referred to as packages --- thus, the existence |
861 | of several BitBake variables that are seemingly mis-named, (e.g. | 861 | of several BitBake variables that are seemingly mis-named, (e.g. |
862 | :term:`PR`, | 862 | :term:`PR`, |
863 | :term:`PV`, and | 863 | :term:`PV`, and |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 3c9321f09c..a190e743cd 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -17,7 +17,7 @@ The 'perf' tool is the profiling and tracing tool that comes bundled | |||
17 | with the Linux kernel. | 17 | with the Linux kernel. |
18 | 18 | ||
19 | Don't let the fact that it's part of the kernel fool you into thinking | 19 | Don't let the fact that it's part of the kernel fool you into thinking |
20 | that it's only for tracing and profiling the kernel - you can indeed use | 20 | that it's only for tracing and profiling the kernel --- you can indeed use |
21 | it to trace and profile just the kernel, but you can also use it to | 21 | it to trace and profile just the kernel, but you can also use it to |
22 | profile specific applications separately (with or without kernel | 22 | profile specific applications separately (with or without kernel |
23 | context), and you can also use it to trace and profile the kernel and | 23 | context), and you can also use it to trace and profile the kernel and |
@@ -176,7 +176,7 @@ interactive text-based UI (or simply as text if we specify ``--stdio`` to | |||
176 | 176 | ||
177 | As our first attempt at profiling this workload, we'll simply run 'perf | 177 | As our first attempt at profiling this workload, we'll simply run 'perf |
178 | record', handing it the workload we want to profile (everything after | 178 | record', handing it the workload we want to profile (everything after |
179 | 'perf record' and any perf options we hand it - here none - will be | 179 | 'perf record' and any perf options we hand it --- here none, will be |
180 | executed in a new shell). perf collects samples until the process exits | 180 | executed in a new shell). perf collects samples until the process exits |
181 | and records them in a file named 'perf.data' in the current working | 181 | and records them in a file named 'perf.data' in the current working |
182 | directory. :: | 182 | directory. :: |
@@ -202,7 +202,7 @@ The above screenshot displays a 'flat' profile, one entry for each | |||
202 | 'bucket' corresponding to the functions that were profiled during the | 202 | 'bucket' corresponding to the functions that were profiled during the |
203 | profiling run, ordered from the most popular to the least (perf has | 203 | profiling run, ordered from the most popular to the least (perf has |
204 | options to sort in various orders and keys as well as display entries | 204 | options to sort in various orders and keys as well as display entries |
205 | only above a certain threshold and so on - see the perf documentation | 205 | only above a certain threshold and so on --- see the perf documentation |
206 | for details). Note that this includes both userspace functions (entries | 206 | for details). Note that this includes both userspace functions (entries |
207 | containing a [.]) and kernel functions accounted to the process (entries | 207 | containing a [.]) and kernel functions accounted to the process (entries |
208 | containing a [k]). (perf has command-line modifiers that can be used to | 208 | containing a [k]). (perf has command-line modifiers that can be used to |
@@ -597,7 +597,7 @@ and tell perf to do a profile using it as the sampling event:: | |||
597 | The screenshot above shows the results of running a profile using | 597 | The screenshot above shows the results of running a profile using |
598 | sched:sched_switch tracepoint, which shows the relative costs of various | 598 | sched:sched_switch tracepoint, which shows the relative costs of various |
599 | paths to sched_wakeup (note that sched_wakeup is the name of the | 599 | paths to sched_wakeup (note that sched_wakeup is the name of the |
600 | tracepoint - it's actually defined just inside ttwu_do_wakeup(), which | 600 | tracepoint --- it's actually defined just inside ttwu_do_wakeup(), which |
601 | accounts for the function name actually displayed in the profile: | 601 | accounts for the function name actually displayed in the profile: |
602 | 602 | ||
603 | .. code-block:: c | 603 | .. code-block:: c |
@@ -866,7 +866,7 @@ System-Wide Tracing and Profiling | |||
866 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 866 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
867 | 867 | ||
868 | The examples so far have focused on tracing a particular program or | 868 | The examples so far have focused on tracing a particular program or |
869 | workload - in other words, every profiling run has specified the program | 869 | workload --- in other words, every profiling run has specified the program |
870 | to profile in the command-line e.g. 'perf record wget ...'. | 870 | to profile in the command-line e.g. 'perf record wget ...'. |
871 | 871 | ||
872 | It's also possible, and more interesting in many cases, to run a | 872 | It's also possible, and more interesting in many cases, to run a |
@@ -950,7 +950,7 @@ Filtering | |||
950 | Notice that there are a lot of events that don't really have anything to | 950 | Notice that there are a lot of events that don't really have anything to |
951 | do with what we're interested in, namely events that schedule 'perf' | 951 | do with what we're interested in, namely events that schedule 'perf' |
952 | itself in and out or that wake perf up. We can get rid of those by using | 952 | itself in and out or that wake perf up. We can get rid of those by using |
953 | the '--filter' option - for each event we specify using -e, we can add a | 953 | the '--filter' option --- for each event we specify using -e, we can add a |
954 | --filter after that to filter out trace events that contain fields with | 954 | --filter after that to filter out trace events that contain fields with |
955 | specific values:: | 955 | specific values:: |
956 | 956 | ||
@@ -1120,7 +1120,7 @@ callgraphs from starting a few programs during those 30 seconds: | |||
1120 | .. admonition:: Tying it Together | 1120 | .. admonition:: Tying it Together |
1121 | 1121 | ||
1122 | The trace events subsystem accommodate static and dynamic tracepoints | 1122 | The trace events subsystem accommodate static and dynamic tracepoints |
1123 | in exactly the same way - there's no difference as far as the | 1123 | in exactly the same way --- there's no difference as far as the |
1124 | infrastructure is concerned. See the ftrace section for more details | 1124 | infrastructure is concerned. See the ftrace section for more details |
1125 | on the trace event subsystem. | 1125 | on the trace event subsystem. |
1126 | 1126 | ||
@@ -1186,7 +1186,7 @@ For this section, we'll assume you've already performed the basic setup | |||
1186 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. | 1186 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. |
1187 | 1187 | ||
1188 | ftrace, trace-cmd, and kernelshark run on the target system, and are | 1188 | ftrace, trace-cmd, and kernelshark run on the target system, and are |
1189 | ready to go out-of-the-box - no additional setup is necessary. For the | 1189 | ready to go out-of-the-box --- no additional setup is necessary. For the |
1190 | rest of this section we assume you've ssh'ed to the host and will be | 1190 | rest of this section we assume you've ssh'ed to the host and will be |
1191 | running ftrace on the target. kernelshark is a GUI application and if | 1191 | running ftrace on the target. kernelshark is a GUI application and if |
1192 | you use the '-X' option to ssh you can have the kernelshark GUI run on | 1192 | you use the '-X' option to ssh you can have the kernelshark GUI run on |
@@ -1306,7 +1306,7 @@ great way to learn about how the kernel code works in a dynamic sense. | |||
1306 | ftrace:function tracepoint. | 1306 | ftrace:function tracepoint. |
1307 | 1307 | ||
1308 | It is a little more difficult to follow the call chains than it needs to | 1308 | It is a little more difficult to follow the call chains than it needs to |
1309 | be - luckily there's a variant of the function tracer that displays the | 1309 | be --- luckily there's a variant of the function tracer that displays the |
1310 | callchains explicitly, called the 'function_graph' tracer:: | 1310 | callchains explicitly, called the 'function_graph' tracer:: |
1311 | 1311 | ||
1312 | root@sugarbay:/sys/kernel/debug/tracing# echo function_graph > current_tracer | 1312 | root@sugarbay:/sys/kernel/debug/tracing# echo function_graph > current_tracer |
@@ -2116,7 +2116,7 @@ You can now view the trace in text form on the target:: | |||
2116 | . | 2116 | . |
2117 | 2117 | ||
2118 | You can now safely destroy the trace | 2118 | You can now safely destroy the trace |
2119 | session (note that this doesn't delete the trace - it's still there in | 2119 | session (note that this doesn't delete the trace --- it's still there in |
2120 | ~/lttng-traces):: | 2120 | ~/lttng-traces):: |
2121 | 2121 | ||
2122 | root@crownbay:~# lttng destroy | 2122 | root@crownbay:~# lttng destroy |
@@ -2200,7 +2200,7 @@ You can now view the trace in text form on the target:: | |||
2200 | . | 2200 | . |
2201 | 2201 | ||
2202 | You can now safely destroy the trace session (note that this doesn't delete the | 2202 | You can now safely destroy the trace session (note that this doesn't delete the |
2203 | trace - it's still there in ~/lttng-traces):: | 2203 | trace --- it's still there in ~/lttng-traces):: |
2204 | 2204 | ||
2205 | root@crownbay:~# lttng destroy | 2205 | root@crownbay:~# lttng destroy |
2206 | Session auto-20190303-021943 destroyed at /home/root | 2206 | Session auto-20190303-021943 destroyed at /home/root |
@@ -2536,7 +2536,7 @@ Execute the workload you're interested in:: | |||
2536 | root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt | 2536 | root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt |
2537 | 2537 | ||
2538 | And look at the output (note here that we're using 'trace_pipe' instead of | 2538 | And look at the output (note here that we're using 'trace_pipe' instead of |
2539 | trace to capture this trace - this allows us to wait around on the pipe | 2539 | trace to capture this trace --- this allows us to wait around on the pipe |
2540 | for data to appear):: | 2540 | for data to appear):: |
2541 | 2541 | ||
2542 | root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe | 2542 | root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 4144277e88..296734e7c1 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
@@ -165,7 +165,7 @@ Adding a New Recipe to the Workspace Layer | |||
165 | ========================================== | 165 | ========================================== |
166 | 166 | ||
167 | Use the ``devtool add`` command to add a new recipe to the workspace | 167 | Use the ``devtool add`` command to add a new recipe to the workspace |
168 | layer. The recipe you add should not exist - ``devtool`` creates it for | 168 | layer. The recipe you add should not exist --- ``devtool`` creates it for |
169 | you. The source files the recipe uses should exist in an external area. | 169 | you. The source files the recipe uses should exist in an external area. |
170 | 170 | ||
171 | The following example creates and adds a new recipe named ``jackson`` to | 171 | The following example creates and adds a new recipe named ``jackson`` to |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 478fbb3a69..20e09f8577 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -364,7 +364,7 @@ redirect requests through proxy servers. | |||
364 | 364 | ||
365 | **Q:** Can I get rid of build output so I can start over? | 365 | **Q:** Can I get rid of build output so I can start over? |
366 | 366 | ||
367 | **A:** Yes - you can easily do this. When you use BitBake to build an | 367 | **A:** Yes --- you can easily do this. When you use BitBake to build an |
368 | image, all the build output goes into the directory created when you run | 368 | image, all the build output goes into the directory created when you run |
369 | the build environment setup script (i.e. | 369 | the build environment setup script (i.e. |
370 | :ref:`structure-core-script`). By default, this :term:`Build Directory` | 370 | :ref:`structure-core-script`). By default, this :term:`Build Directory` |
@@ -428,7 +428,7 @@ relatively normal and the second is not: | |||
428 | build/tmp/sysroots/x86_64-linux/usr/bin | 428 | build/tmp/sysroots/x86_64-linux/usr/bin |
429 | 429 | ||
430 | Even if the paths look unusual, | 430 | Even if the paths look unusual, |
431 | they both are correct - the first for a target and the second for a | 431 | they both are correct --- the first for a target and the second for a |
432 | native recipe. These paths are a consequence of the ``DESTDIR`` | 432 | native recipe. These paths are a consequence of the ``DESTDIR`` |
433 | mechanism and while they appear strange, they are correct and in | 433 | mechanism and while they appear strange, they are correct and in |
434 | practice very effective. | 434 | practice very effective. |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 021e49e9d7..496fd6ae41 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -213,8 +213,8 @@ These files are standard top-level files. | |||
213 | 213 | ||
214 | .. _structure-build: | 214 | .. _structure-build: |
215 | 215 | ||
216 | The Build Directory - ``build/`` | 216 | The Build Directory --- ``build/`` |
217 | ================================ | 217 | ================================== |
218 | 218 | ||
219 | The OpenEmbedded build system creates the :term:`Build Directory` | 219 | The OpenEmbedded build system creates the :term:`Build Directory` |
220 | when you run the build environment setup | 220 | when you run the build environment setup |
@@ -589,7 +589,7 @@ install" places its output that is then split into sub-packages within | |||
589 | ``build/tmp/work/tunearch/recipename/version/`` | 589 | ``build/tmp/work/tunearch/recipename/version/`` |
590 | ----------------------------------------------- | 590 | ----------------------------------------------- |
591 | 591 | ||
592 | The recipe work directory - ``${WORKDIR}``. | 592 | The recipe work directory --- ``${WORKDIR}``. |
593 | 593 | ||
594 | As described earlier in the | 594 | As described earlier in the |
595 | ":ref:`structure-build-tmp-sysroots`" section, | 595 | ":ref:`structure-build-tmp-sysroots`" section, |
@@ -654,8 +654,8 @@ recipes. In practice, this is only used for ``gcc`` and its variants | |||
654 | 654 | ||
655 | .. _structure-meta: | 655 | .. _structure-meta: |
656 | 656 | ||
657 | The Metadata - ``meta/`` | 657 | The Metadata --- ``meta/`` |
658 | ======================== | 658 | ========================== |
659 | 659 | ||
660 | As mentioned previously, :term:`Metadata` is the core of the | 660 | As mentioned previously, :term:`Metadata` is the core of the |
661 | Yocto Project. Metadata has several important subdivisions: | 661 | Yocto Project. Metadata has several important subdivisions: |
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 98ca677015..bc09613db7 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -342,7 +342,7 @@ universal, the list includes them just in case: | |||
342 | your Linux distribution. | 342 | your Linux distribution. |
343 | 343 | ||
344 | Another point worth noting is that historically within the Yocto | 344 | Another point worth noting is that historically within the Yocto |
345 | Project, recipes were referred to as packages - thus, the existence | 345 | Project, recipes were referred to as packages --- thus, the existence |
346 | of several BitBake variables that are seemingly mis-named, (e.g. | 346 | of several BitBake variables that are seemingly mis-named, (e.g. |
347 | :term:`PR`, :term:`PV`, and | 347 | :term:`PR`, :term:`PV`, and |
348 | :term:`PE`). | 348 | :term:`PE`). |
@@ -458,7 +458,7 @@ universal, the list includes them just in case: | |||
458 | Directory created by unpacking a released tarball as compared to | 458 | Directory created by unpacking a released tarball as compared to |
459 | cloning ``git://git.yoctoproject.org/poky``. When you unpack a | 459 | cloning ``git://git.yoctoproject.org/poky``. When you unpack a |
460 | tarball, you have an exact copy of the files based on the time of | 460 | tarball, you have an exact copy of the files based on the time of |
461 | release - a fixed release point. Any changes you make to your local | 461 | release --- a fixed release point. Any changes you make to your local |
462 | files in the Source Directory are on top of the release and will | 462 | files in the Source Directory are on top of the release and will |
463 | remain local only. On the other hand, when you clone the ``poky`` Git | 463 | remain local only. On the other hand, when you clone the ``poky`` Git |
464 | repository, you have an active development repository with access to | 464 | repository, you have an active development repository with access to |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 1198ac5696..0f9e114771 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -591,7 +591,7 @@ system and gives an overview of their function and contents. | |||
591 | This variable is useful in situations where the same recipe appears | 591 | This variable is useful in situations where the same recipe appears |
592 | in more than one layer. Setting this variable allows you to | 592 | in more than one layer. Setting this variable allows you to |
593 | prioritize a layer against other layers that contain the same recipe | 593 | prioritize a layer against other layers that contain the same recipe |
594 | - effectively letting you control the precedence for the multiple | 594 | --- effectively letting you control the precedence for the multiple |
595 | layers. The precedence established through this variable stands | 595 | layers. The precedence established through this variable stands |
596 | regardless of a recipe's version (:term:`PV` variable). For | 596 | regardless of a recipe's version (:term:`PV` variable). For |
597 | example, a layer that has a recipe with a higher :term:`PV` value but for | 597 | example, a layer that has a recipe with a higher :term:`PV` value but for |
@@ -888,7 +888,7 @@ system and gives an overview of their function and contents. | |||
888 | :term:`BUILD_OS` | 888 | :term:`BUILD_OS` |
889 | Specifies the operating system in use on the build host (e.g. | 889 | Specifies the operating system in use on the build host (e.g. |
890 | "linux"). The OpenEmbedded build system sets the value of | 890 | "linux"). The OpenEmbedded build system sets the value of |
891 | :term:`BUILD_OS` from the OS reported by the ``uname`` command - the | 891 | :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the |
892 | first word, converted to lower-case characters. | 892 | first word, converted to lower-case characters. |
893 | 893 | ||
894 | :term:`BUILD_PREFIX` | 894 | :term:`BUILD_PREFIX` |
@@ -1775,7 +1775,7 @@ system and gives an overview of their function and contents. | |||
1775 | ``${TMPDIR}/deploy``. | 1775 | ``${TMPDIR}/deploy``. |
1776 | 1776 | ||
1777 | For more information on the structure of the Build Directory, see | 1777 | For more information on the structure of the Build Directory, see |
1778 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1778 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1779 | For more detail on the contents of the ``deploy`` directory, see the | 1779 | For more detail on the contents of the ``deploy`` directory, see the |
1780 | ":ref:`overview-manual/concepts:images`", | 1780 | ":ref:`overview-manual/concepts:images`", |
1781 | ":ref:`overview-manual/concepts:package feeds`", and | 1781 | ":ref:`overview-manual/concepts:package feeds`", and |
@@ -1819,7 +1819,7 @@ system and gives an overview of their function and contents. | |||
1819 | <ref-classes-image>` class. | 1819 | <ref-classes-image>` class. |
1820 | 1820 | ||
1821 | For more information on the structure of the Build Directory, see | 1821 | For more information on the structure of the Build Directory, see |
1822 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1822 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1823 | For more detail on the contents of the ``deploy`` directory, see the | 1823 | For more detail on the contents of the ``deploy`` directory, see the |
1824 | ":ref:`overview-manual/concepts:images`" and | 1824 | ":ref:`overview-manual/concepts:images`" and |
1825 | ":ref:`overview-manual/concepts:application development sdk`" sections both in | 1825 | ":ref:`overview-manual/concepts:application development sdk`" sections both in |
@@ -2348,24 +2348,24 @@ system and gives an overview of their function and contents. | |||
2348 | 2348 | ||
2349 | Here are some examples of features you can add: | 2349 | Here are some examples of features you can add: |
2350 | 2350 | ||
2351 | - "dbg-pkgs" - Adds -dbg packages for all installed packages including | 2351 | - "dbg-pkgs" --- adds -dbg packages for all installed packages including |
2352 | symbol information for debugging and profiling. | 2352 | symbol information for debugging and profiling. |
2353 | 2353 | ||
2354 | - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and | 2354 | - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and |
2355 | enables post-installation logging. See the 'allow-empty-password' and | 2355 | enables post-installation logging. See the 'allow-empty-password' and |
2356 | 'post-install-logging' features in the ":ref:`ref-features-image`" | 2356 | 'post-install-logging' features in the ":ref:`ref-features-image`" |
2357 | section for more information. | 2357 | section for more information. |
2358 | - "dev-pkgs" - Adds -dev packages for all installed packages. This is | 2358 | - "dev-pkgs" --- adds -dev packages for all installed packages. This is |
2359 | useful if you want to develop against the libraries in the image. | 2359 | useful if you want to develop against the libraries in the image. |
2360 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2360 | - "read-only-rootfs" --- creates an image whose root filesystem is |
2361 | read-only. See the | 2361 | read-only. See the |
2362 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" | 2362 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
2363 | section in the Yocto Project Development Tasks Manual for more | 2363 | section in the Yocto Project Development Tasks Manual for more |
2364 | information | 2364 | information |
2365 | - "tools-debug" - Adds debugging tools such as gdb and strace. | 2365 | - "tools-debug" --- adds debugging tools such as gdb and strace. |
2366 | - "tools-sdk" - Adds development tools such as gcc, make, | 2366 | - "tools-sdk" --- adds development tools such as gcc, make, |
2367 | pkgconfig and so forth. | 2367 | pkgconfig and so forth. |
2368 | - "tools-testapps" - Adds useful testing tools | 2368 | - "tools-testapps" --- adds useful testing tools |
2369 | such as ts_print, aplay, arecord and so forth. | 2369 | such as ts_print, aplay, arecord and so forth. |
2370 | 2370 | ||
2371 | For a complete list of image features that ships with the Yocto | 2371 | For a complete list of image features that ships with the Yocto |
@@ -3454,7 +3454,7 @@ system and gives an overview of their function and contents. | |||
3454 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3454 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
3455 | 3455 | ||
3456 | :term:`IMAGE_NAME_SUFFIX` | 3456 | :term:`IMAGE_NAME_SUFFIX` |
3457 | Suffix used for the image output filename - defaults to ``".rootfs"`` | 3457 | Suffix used for the image output filename --- defaults to ``".rootfs"`` |
3458 | to distinguish the image file from other files created during image | 3458 | to distinguish the image file from other files created during image |
3459 | building; however if this suffix is redundant or not desired you can | 3459 | building; however if this suffix is redundant or not desired you can |
3460 | clear the value of this variable (set the value to ""). For example, | 3460 | clear the value of this variable (set the value to ""). For example, |
@@ -6541,7 +6541,7 @@ system and gives an overview of their function and contents. | |||
6541 | ``baz``. | 6541 | ``baz``. |
6542 | 6542 | ||
6543 | The names of the packages you list within :term:`RDEPENDS` must be the | 6543 | The names of the packages you list within :term:`RDEPENDS` must be the |
6544 | names of other packages - they cannot be recipe names. Although | 6544 | names of other packages --- they cannot be recipe names. Although |
6545 | package names and recipe names usually match, the important point | 6545 | package names and recipe names usually match, the important point |
6546 | here is that you are providing package names within the :term:`RDEPENDS` | 6546 | here is that you are providing package names within the :term:`RDEPENDS` |
6547 | variable. For an example of the default list of packages created from | 6547 | variable. For an example of the default list of packages created from |
@@ -7646,35 +7646,35 @@ system and gives an overview of their function and contents. | |||
7646 | 7646 | ||
7647 | There are standard and recipe-specific options. Here are standard ones: | 7647 | There are standard and recipe-specific options. Here are standard ones: |
7648 | 7648 | ||
7649 | - ``apply`` - Whether to apply the patch or not. The default | 7649 | - ``apply`` --- whether to apply the patch or not. The default |
7650 | action is to apply the patch. | 7650 | action is to apply the patch. |
7651 | 7651 | ||
7652 | - ``striplevel`` - Which striplevel to use when applying the | 7652 | - ``striplevel`` --- which striplevel to use when applying the |
7653 | patch. The default level is 1. | 7653 | patch. The default level is 1. |
7654 | 7654 | ||
7655 | - ``patchdir`` - Specifies the directory in which the patch should | 7655 | - ``patchdir`` --- specifies the directory in which the patch should |
7656 | be applied. The default is ``${``\ :term:`S`\ ``}``. | 7656 | be applied. The default is ``${``\ :term:`S`\ ``}``. |
7657 | 7657 | ||
7658 | Here are options specific to recipes building code from a revision | 7658 | Here are options specific to recipes building code from a revision |
7659 | control system: | 7659 | control system: |
7660 | 7660 | ||
7661 | - ``mindate`` - Apply the patch only if | 7661 | - ``mindate`` --- apply the patch only if |
7662 | :term:`SRCDATE` is equal to or greater than | 7662 | :term:`SRCDATE` is equal to or greater than |
7663 | ``mindate``. | 7663 | ``mindate``. |
7664 | 7664 | ||
7665 | - ``maxdate`` - Apply the patch only if :term:`SRCDATE` is not later | 7665 | - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later |
7666 | than ``maxdate``. | 7666 | than ``maxdate``. |
7667 | 7667 | ||
7668 | - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or | 7668 | - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or |
7669 | greater than ``minrev``. | 7669 | greater than ``minrev``. |
7670 | 7670 | ||
7671 | - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later | 7671 | - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later |
7672 | than ``maxrev``. | 7672 | than ``maxrev``. |
7673 | 7673 | ||
7674 | - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to | 7674 | - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to |
7675 | ``rev``. | 7675 | ``rev``. |
7676 | 7676 | ||
7677 | - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to | 7677 | - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to |
7678 | ``rev``. | 7678 | ``rev``. |
7679 | 7679 | ||
7680 | .. note:: | 7680 | .. note:: |
@@ -9461,8 +9461,8 @@ system and gives an overview of their function and contents. | |||
9461 | - :term:`TMPDIR`: The top-level build output directory | 9461 | - :term:`TMPDIR`: The top-level build output directory |
9462 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier | 9462 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier |
9463 | - :term:`PN`: The recipe name | 9463 | - :term:`PN`: The recipe name |
9464 | - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which | 9464 | - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which |
9465 | is usually the case for most recipes, then `EXTENDPE` is blank) | 9465 | is usually the case for most recipes, then `EXTENDPE` is blank. |
9466 | - :term:`PV`: The recipe version | 9466 | - :term:`PV`: The recipe version |
9467 | - :term:`PR`: The recipe revision | 9467 | - :term:`PR`: The recipe revision |
9468 | 9468 | ||
diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst index 5f7dba8775..e2c086ffa0 100644 --- a/documentation/ref-manual/varlocality.rst +++ b/documentation/ref-manual/varlocality.rst | |||
@@ -113,7 +113,7 @@ This section lists variables that are required for recipes. | |||
113 | 113 | ||
114 | - :term:`LIC_FILES_CHKSUM` | 114 | - :term:`LIC_FILES_CHKSUM` |
115 | 115 | ||
116 | - :term:`SRC_URI` - used in recipes that fetch local or remote files. | 116 | - :term:`SRC_URI` --- used in recipes that fetch local or remote files. |
117 | 117 | ||
118 | .. _ref-varlocality-recipe-dependencies: | 118 | .. _ref-varlocality-recipe-dependencies: |
119 | 119 | ||
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index 276daa9bb6..7483d51fa3 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst | |||
@@ -172,19 +172,19 @@ variables and Makefile variables during development. | |||
172 | The main point of this section is to explain the following three cases | 172 | The main point of this section is to explain the following three cases |
173 | regarding variable behavior: | 173 | regarding variable behavior: |
174 | 174 | ||
175 | - *Case 1 - No Variables Set in the Makefile Map to Equivalent | 175 | - *Case 1 --- No Variables Set in the Makefile Map to Equivalent |
176 | Environment Variables Set in the SDK Setup Script:* Because matching | 176 | Environment Variables Set in the SDK Setup Script:* Because matching |
177 | variables are not specifically set in the ``Makefile``, the variables | 177 | variables are not specifically set in the ``Makefile``, the variables |
178 | retain their values based on the environment setup script. | 178 | retain their values based on the environment setup script. |
179 | 179 | ||
180 | - *Case 2 - Variables Are Set in the Makefile that Map to Equivalent | 180 | - *Case 2 --- Variables Are Set in the Makefile that Map to Equivalent |
181 | Environment Variables from the SDK Setup Script:* Specifically | 181 | Environment Variables from the SDK Setup Script:* Specifically |
182 | setting matching variables in the ``Makefile`` during the build | 182 | setting matching variables in the ``Makefile`` during the build |
183 | results in the environment settings of the variables being | 183 | results in the environment settings of the variables being |
184 | overwritten. In this case, the variables you set in the ``Makefile`` | 184 | overwritten. In this case, the variables you set in the ``Makefile`` |
185 | are used. | 185 | are used. |
186 | 186 | ||
187 | - *Case 3 - Variables Are Set Using the Command Line that Map to | 187 | - *Case 3 --- Variables Are Set Using the Command Line that Map to |
188 | Equivalent Environment Variables from the SDK Setup Script:* | 188 | Equivalent Environment Variables from the SDK Setup Script:* |
189 | Executing the ``Makefile`` from the command line results in the | 189 | Executing the ``Makefile`` from the command line results in the |
190 | environment variables being overwritten. In this case, the | 190 | environment variables being overwritten. In this case, the |
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 16f73ca468..bb267d2d88 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
@@ -82,8 +82,8 @@ topology that includes a controller and a cluster of workers: | |||
82 | .. image:: figures/ab-test-cluster.png | 82 | .. image:: figures/ab-test-cluster.png |
83 | :align: center | 83 | :align: center |
84 | 84 | ||
85 | Yocto Project Tests - Types of Testing Overview | 85 | Yocto Project Tests --- Types of Testing Overview |
86 | =============================================== | 86 | ================================================= |
87 | 87 | ||
88 | The Autobuilder tests different elements of the project by using | 88 | The Autobuilder tests different elements of the project by using |
89 | the following types of tests: | 89 | the following types of tests: |
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index d7fe415cb0..41e93a3068 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst | |||
@@ -84,7 +84,7 @@ Transitioning to a custom environment for systems development | |||
84 | 84 | ||
85 | #. **Now you're ready to create an image recipe**. | 85 | #. **Now you're ready to create an image recipe**. |
86 | There are a number of ways to do this. However, it is strongly recommended | 86 | There are a number of ways to do this. However, it is strongly recommended |
87 | that you have your own image recipe - don't try appending to existing image | 87 | that you have your own image recipe --- don't try appending to existing image |
88 | recipes. Recipes for images are trivial to create and you usually want to | 88 | recipes. Recipes for images are trivial to create and you usually want to |
89 | fully customize their contents. | 89 | fully customize their contents. |
90 | 90 | ||