summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-02-09 17:48:06 +0100
committerSteve Sakoman <steve@sakoman.com>2024-03-01 05:19:54 -1000
commitfa870dfd0fd760ec1ab0342f5c82851c043f3eaf (patch)
treec6993e569b3e007213425a31a1aff8761c413dfc
parent74ebddb9219e02cd300630a550353560768ed77e (diff)
downloadpoky-fa870dfd0fd760ec1ab0342f5c82851c043f3eaf.tar.gz
manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. (From yocto-docs rev: 2539f1b9cbf9bdd40eff93c6522dc76133debed7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/bsp-guide/bsp.rst9
-rw-r--r--documentation/dev-manual/building.rst2
-rw-r--r--documentation/dev-manual/debugging.rst8
-rw-r--r--documentation/dev-manual/development-shell.rst2
-rw-r--r--documentation/dev-manual/layers.rst8
-rw-r--r--documentation/dev-manual/libraries.rst4
-rw-r--r--documentation/dev-manual/licenses.rst2
-rw-r--r--documentation/dev-manual/new-machine.rst2
-rw-r--r--documentation/dev-manual/new-recipe.rst8
-rw-r--r--documentation/dev-manual/packages.rst4
-rw-r--r--documentation/dev-manual/prebuilt-libraries.rst4
-rw-r--r--documentation/dev-manual/python-development-shell.rst2
-rw-r--r--documentation/dev-manual/qemu.rst4
-rw-r--r--documentation/dev-manual/runtime-testing.rst4
-rw-r--r--documentation/dev-manual/speeding-up-build.rst4
-rw-r--r--documentation/dev-manual/start.rst6
-rw-r--r--documentation/kernel-dev/common.rst4
-rw-r--r--documentation/migration-guides/migration-1.5.rst6
-rw-r--r--documentation/migration-guides/migration-2.2.rst16
-rw-r--r--documentation/migration-guides/migration-2.4.rst8
-rw-r--r--documentation/migration-guides/migration-2.5.rst8
-rw-r--r--documentation/migration-guides/migration-4.0.rst2
-rw-r--r--documentation/overview-manual/concepts.rst23
-rw-r--r--documentation/overview-manual/yp-intro.rst2
-rw-r--r--documentation/ref-manual/classes.rst8
-rw-r--r--documentation/ref-manual/devtool-reference.rst8
-rw-r--r--documentation/ref-manual/faq.rst4
-rw-r--r--documentation/ref-manual/features.rst2
-rw-r--r--documentation/ref-manual/images.rst2
-rw-r--r--documentation/ref-manual/release-process.rst6
-rw-r--r--documentation/ref-manual/structure.rst2
-rw-r--r--documentation/ref-manual/terms.rst6
-rw-r--r--documentation/ref-manual/variables.rst8
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst14
-rw-r--r--documentation/sdk-manual/intro.rst2
-rw-r--r--documentation/toaster-manual/setup-and-use.rst4
36 files changed, 92 insertions, 116 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 6cb35ba6cc..1779f9e208 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -853,8 +853,7 @@ Before looking at BSP requirements, you should consider the following:
853 dictating that a specific kernel or kernel version be used in a given 853 dictating that a specific kernel or kernel version be used in a given
854 BSP. 854 BSP.
855 855
856Following are the requirements for a released BSP that conform to the 856The requirements for a released BSP that conform to the Yocto Project are:
857Yocto Project:
858 857
859- *Layer Name:* The BSP must have a layer name that follows the Yocto 858- *Layer Name:* The BSP must have a layer name that follows the Yocto
860 Project standards. For information on BSP layer names, see the 859 Project standards. For information on BSP layer names, see the
@@ -958,7 +957,7 @@ Yocto Project:
958Released BSP Recommendations 957Released BSP Recommendations
959---------------------------- 958----------------------------
960 959
961Following are recommendations for released BSPs that conform to the 960Here are recommendations for released BSPs that conform to the
962Yocto Project: 961Yocto Project:
963 962
964- *Bootable Images:* Released BSPs can contain one or more bootable 963- *Bootable Images:* Released BSPs can contain one or more bootable
@@ -1020,7 +1019,7 @@ the following:
1020 that additional hierarchy and the files would obviously not be able 1019 that additional hierarchy and the files would obviously not be able
1021 to reside in a machine-specific directory. 1020 to reside in a machine-specific directory.
1022 1021
1023Following is a specific example to help you better understand the 1022Here is a specific example to help you better understand the
1024process. This example customizes a recipe by adding a 1023process. This example customizes a recipe by adding a
1025BSP-specific configuration file named ``interfaces`` to the 1024BSP-specific configuration file named ``interfaces`` to the
1026``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer 1025``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer
@@ -1443,7 +1442,7 @@ metadata used to build the kernel. In this case, a kernel append file
1443kernel recipe (i.e. ``linux-yocto_5.15.bb``), which is located in 1442kernel recipe (i.e. ``linux-yocto_5.15.bb``), which is located in
1444:yocto_git:`/poky/tree/meta-yocto-bsp/recipes-kernel/linux`. 1443:yocto_git:`/poky/tree/meta-yocto-bsp/recipes-kernel/linux`.
1445 1444
1446Following is the contents of the append file:: 1445The contents of the append file are::
1447 1446
1448 KBRANCH:genericx86 = "v5.15/standard/base" 1447 KBRANCH:genericx86 = "v5.15/standard/base"
1449 KBRANCH:genericx86-64 = "v5.15/standard/base" 1448 KBRANCH:genericx86-64 = "v5.15/standard/base"
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index e964bd1aee..7fcac33b75 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -160,7 +160,7 @@ Follow these steps to set up and execute multiple configuration builds:
160 The location for these multiconfig configuration files is specific. 160 The location for these multiconfig configuration files is specific.
161 They must reside in the current :term:`Build Directory` in a sub-directory of 161 They must reside in the current :term:`Build Directory` in a sub-directory of
162 ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory 162 ``conf`` named ``multiconfig`` or within a layer's ``conf`` directory
163 under a directory named ``multiconfig``. Following is an example that defines 163 under a directory named ``multiconfig``. Here is an example that defines
164 two configuration files for the "x86" and "arm" multiconfigs: 164 two configuration files for the "x86" and "arm" multiconfigs:
165 165
166 .. image:: figures/multiconfig_files.png 166 .. image:: figures/multiconfig_files.png
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index bd1e716b0b..71b5807f5a 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -170,7 +170,7 @@ You can use the ``oe-pkgdata-util`` command-line utility to query
170various package-related information. When you use the utility, you must 170various package-related information. When you use the utility, you must
171use it to view information on packages that have already been built. 171use it to view information on packages that have already been built.
172 172
173Following are a few of the available ``oe-pkgdata-util`` subcommands. 173Here are a few of the available ``oe-pkgdata-util`` subcommands.
174 174
175.. note:: 175.. note::
176 176
@@ -608,7 +608,7 @@ logs, keep in mind the goal is to have informative logs while keeping
608the console as "silent" as possible. Also, if you want status messages 608the console as "silent" as possible. Also, if you want status messages
609in the log, use the "debug" loglevel. 609in the log, use the "debug" loglevel.
610 610
611Following is an example written in Python. The code handles logging for 611Here is an example written in Python. The code handles logging for
612a function that determines the number of tasks needed to be run. See the 612a function that determines the number of tasks needed to be run. See the
613":ref:`ref-tasks-listtasks`" 613":ref:`ref-tasks-listtasks`"
614section for additional information:: 614section for additional information::
@@ -636,7 +636,7 @@ logs, you have the same goals --- informative with minimal console output.
636The syntax you use for recipes written in Bash is similar to that of 636The syntax you use for recipes written in Bash is similar to that of
637recipes written in Python described in the previous section. 637recipes written in Python described in the previous section.
638 638
639Following is an example written in Bash. The code logs the progress of 639Here is an example written in Bash. The code logs the progress of
640the ``do_my_function`` function:: 640the ``do_my_function`` function::
641 641
642 do_my_function() { 642 do_my_function() {
@@ -1221,7 +1221,7 @@ Here are some other tips that you might find useful:
1221 "$@" 1221 "$@"
1222 } 1222 }
1223 1223
1224 Following are some usage examples:: 1224 Here are some usage examples::
1225 1225
1226 $ g FOO # Search recursively for "FOO" 1226 $ g FOO # Search recursively for "FOO"
1227 $ g -i foo # Search recursively for "foo", ignoring case 1227 $ g -i foo # Search recursively for "foo", ignoring case
diff --git a/documentation/dev-manual/development-shell.rst b/documentation/dev-manual/development-shell.rst
index a18d792150..be26bcffc7 100644
--- a/documentation/dev-manual/development-shell.rst
+++ b/documentation/dev-manual/development-shell.rst
@@ -16,7 +16,7 @@ OpenEmbedded build system were executing them. Consequently, working
16this way can be helpful when debugging a build or preparing software to 16this way can be helpful when debugging a build or preparing software to
17be used with the OpenEmbedded build system. 17be used with the OpenEmbedded build system.
18 18
19Following is an example that uses ``devshell`` on a target named 19Here is an example that uses ``devshell`` on a target named
20``matchbox-desktop``:: 20``matchbox-desktop``::
21 21
22 $ bitbake matchbox-desktop -c devshell 22 $ bitbake matchbox-desktop -c devshell
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 2da5d9f93e..9bfbd726d9 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -82,7 +82,7 @@ Follow these general steps to create your layer without using tools:
82 LAYERVERSION_yoctobsp = "4" 82 LAYERVERSION_yoctobsp = "4"
83 LAYERSERIES_COMPAT_yoctobsp = "dunfell" 83 LAYERSERIES_COMPAT_yoctobsp = "dunfell"
84 84
85 Following is an explanation of the layer configuration file: 85 Here is an explanation of the layer configuration file:
86 86
87 - :term:`BBPATH`: Adds the layer's 87 - :term:`BBPATH`: Adds the layer's
88 root directory to BitBake's search path. Through the use of the 88 root directory to BitBake's search path. Through the use of the
@@ -191,7 +191,7 @@ following list:
191- *Structure Your Layers:* Proper use of overrides within append files 191- *Structure Your Layers:* Proper use of overrides within append files
192 and placement of machine-specific files within your layer can ensure 192 and placement of machine-specific files within your layer can ensure
193 that a build is not using the wrong Metadata and negatively impacting 193 that a build is not using the wrong Metadata and negatively impacting
194 a build for a different machine. Following are some examples: 194 a build for a different machine. Here are some examples:
195 195
196 - *Modify Variables to Support a Different Machine:* Suppose you 196 - *Modify Variables to Support a Different Machine:* Suppose you
197 have a layer named ``meta-one`` that adds support for building 197 have a layer named ``meta-one`` that adds support for building
@@ -513,7 +513,7 @@ In the main recipe, note the :term:`SRC_URI`
513variable, which tells the OpenEmbedded build system where to find files 513variable, which tells the OpenEmbedded build system where to find files
514during the build. 514during the build.
515 515
516Following is the append file, which is named ``formfactor_0.0.bbappend`` 516Here is the append file, which is named ``formfactor_0.0.bbappend``
517and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The 517and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The
518file is in the layer at ``recipes-bsp/formfactor``:: 518file is in the layer at ``recipes-bsp/formfactor``::
519 519
@@ -588,7 +588,7 @@ Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named
588 fi 588 fi
589 } 589 }
590 590
591Following is the append file, which is named ``xserver-xf86-config_%.bbappend`` 591Here is the append file, which is named ``xserver-xf86-config_%.bbappend``
592and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The 592and is from the Raspberry Pi BSP Layer named ``meta-raspberrypi``. The
593file is in the layer at ``recipes-graphics/xorg-xserver``:: 593file is in the layer at ``recipes-graphics/xorg-xserver``::
594 594
diff --git a/documentation/dev-manual/libraries.rst b/documentation/dev-manual/libraries.rst
index ae4ca27209..521dbb9a7c 100644
--- a/documentation/dev-manual/libraries.rst
+++ b/documentation/dev-manual/libraries.rst
@@ -37,7 +37,7 @@ library files.
37 Some previously released versions of the Yocto Project defined the 37 Some previously released versions of the Yocto Project defined the
38 static library files through ``${PN}-dev``. 38 static library files through ``${PN}-dev``.
39 39
40Following is part of the BitBake configuration file, where you can see 40Here is the part of the BitBake configuration file, where you can see
41how the static library files are defined:: 41how the static library files are defined::
42 42
43 PACKAGE_BEFORE_PN ?= "" 43 PACKAGE_BEFORE_PN ?= ""
@@ -177,7 +177,7 @@ Additional Implementation Details
177--------------------------------- 177---------------------------------
178 178
179There are generic implementation details as well as details that are specific to 179There are generic implementation details as well as details that are specific to
180package management systems. Following are implementation details 180package management systems. Here are implementation details
181that exist regardless of the package management system: 181that exist regardless of the package management system:
182 182
183- The typical convention used for the class extension code as used by 183- The typical convention used for the class extension code as used by
diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst
index 419af7c326..197712b68d 100644
--- a/documentation/dev-manual/licenses.rst
+++ b/documentation/dev-manual/licenses.rst
@@ -27,7 +27,7 @@ Specifying the ``LIC_FILES_CHKSUM`` Variable
27-------------------------------------------- 27--------------------------------------------
28 28
29The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text 29The :term:`LIC_FILES_CHKSUM` variable contains checksums of the license text
30in the source code for the recipe. Following is an example of how to 30in the source code for the recipe. Here is an example of how to
31specify :term:`LIC_FILES_CHKSUM`:: 31specify :term:`LIC_FILES_CHKSUM`::
32 32
33 LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ 33 LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \
diff --git a/documentation/dev-manual/new-machine.rst b/documentation/dev-manual/new-machine.rst
index b7978f4ba9..d007c1631f 100644
--- a/documentation/dev-manual/new-machine.rst
+++ b/documentation/dev-manual/new-machine.rst
@@ -104,7 +104,7 @@ contains directories for specific machines such as ``qemuarm`` and
104defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file 104defaults, see the ``meta/recipes-bsp/formfactor/files/config`` file
105found in the same area. 105found in the same area.
106 106
107Following is an example for "qemuarm" machine:: 107Here is an example for "qemuarm" machine::
108 108
109 HAVE_TOUCHSCREEN=1 109 HAVE_TOUCHSCREEN=1
110 HAVE_KEYBOARD=1 110 HAVE_KEYBOARD=1
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index ed87f9b2d0..be52610621 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -100,7 +100,7 @@ command::
100 100
101Running ``recipetool create -o OUTFILE`` creates the base recipe and 101Running ``recipetool create -o OUTFILE`` creates the base recipe and
102locates it properly in the layer that contains your source files. 102locates it properly in the layer that contains your source files.
103Following are some syntax examples: 103Here are some syntax examples:
104 104
105 - Use this syntax to generate a recipe based on source. Once generated, 105 - Use this syntax to generate a recipe based on source. Once generated,
106 the recipe resides in the existing source code layer:: 106 the recipe resides in the existing source code layer::
@@ -1233,7 +1233,7 @@ inherit the :ref:`ref-classes-autotools` class, which contains the definitions
1233of all the steps needed to build an Autotool-based application. The result of 1233of all the steps needed to build an Autotool-based application. The result of
1234the build is automatically packaged. And, if the application uses NLS for 1234the build is automatically packaged. And, if the application uses NLS for
1235localization, packages with local information are generated (one package per 1235localization, packages with local information are generated (one package per
1236language). Following is one example: (``hello_2.3.bb``):: 1236language). Here is one example: (``hello_2.3.bb``)::
1237 1237
1238 SUMMARY = "GNU Helloworld application" 1238 SUMMARY = "GNU Helloworld application"
1239 SECTION = "examples" 1239 SECTION = "examples"
@@ -1286,7 +1286,7 @@ Splitting an Application into Multiple Packages
1286You can use the variables :term:`PACKAGES` and :term:`FILES` to split an 1286You can use the variables :term:`PACKAGES` and :term:`FILES` to split an
1287application into multiple packages. 1287application into multiple packages.
1288 1288
1289Following is an example that uses the ``libxpm`` recipe. By default, 1289Here is an example that uses the ``libxpm`` recipe. By default,
1290this recipe generates a single package that contains the library along 1290this recipe generates a single package that contains the library along
1291with a few binaries. You can modify the recipe to split the binaries 1291with a few binaries. You can modify the recipe to split the binaries
1292into separate packages:: 1292into separate packages::
@@ -1511,7 +1511,7 @@ in the BitBake User Manual.
1511 when you make the assignment, but this is not generally needed. 1511 when you make the assignment, but this is not generally needed.
1512 1512
1513- *Quote All Assignments ("value"):* Use double quotes around values in 1513- *Quote All Assignments ("value"):* Use double quotes around values in
1514 all variable assignments (e.g. ``"value"``). Following is an example:: 1514 all variable assignments (e.g. ``"value"``). Here is an example::
1515 1515
1516 VAR1 = "${OTHERVAR}" 1516 VAR1 = "${OTHERVAR}"
1517 VAR2 = "The version is ${PV}" 1517 VAR2 = "The version is ${PV}"
diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst
index 79f21d9f34..0e991e409a 100644
--- a/documentation/dev-manual/packages.rst
+++ b/documentation/dev-manual/packages.rst
@@ -365,7 +365,7 @@ For more examples that show how to use ``do_split_packages``, see the
365directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can 365directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can
366also find examples in ``meta/classes-recipe/kernel.bbclass``. 366also find examples in ``meta/classes-recipe/kernel.bbclass``.
367 367
368Following is a reference that shows ``do_split_packages`` mandatory and 368Here is a reference that shows ``do_split_packages`` mandatory and
369optional arguments:: 369optional arguments::
370 370
371 Mandatory arguments 371 Mandatory arguments
@@ -1123,7 +1123,7 @@ The ``devtool edit-recipe`` command lets you take a look at the recipe::
1123 ... 1123 ...
1124 LICENSE:${PN}-vary = "MIT" 1124 LICENSE:${PN}-vary = "MIT"
1125 1125
1126Here are three key points in the previous example: 1126Three key points in the previous example are:
1127 1127
1128- :term:`SRC_URI` uses the NPM 1128- :term:`SRC_URI` uses the NPM
1129 scheme so that the NPM fetcher is used. 1129 scheme so that the NPM fetcher is used.
diff --git a/documentation/dev-manual/prebuilt-libraries.rst b/documentation/dev-manual/prebuilt-libraries.rst
index b80a844e93..a05f39ca1e 100644
--- a/documentation/dev-manual/prebuilt-libraries.rst
+++ b/documentation/dev-manual/prebuilt-libraries.rst
@@ -148,8 +148,8 @@ recipe. By default, ``libfoo.so`` gets packaged into ``${PN}-dev``, which
148triggers a QA warning that a non-symlink library is in a ``-dev`` package, 148triggers a QA warning that a non-symlink library is in a ``-dev`` package,
149and binaries in the same recipe link to the library in ``${PN}-dev``, 149and binaries in the same recipe link to the library in ``${PN}-dev``,
150which triggers more QA warnings. To solve this problem, you need to package the 150which triggers more QA warnings. To solve this problem, you need to package the
151unversioned library into ``${PN}`` where it belongs. The following are the abridged 151unversioned library into ``${PN}`` where it belongs. The abridged
152default :term:`FILES` variables in ``bitbake.conf``:: 152default :term:`FILES` variables in ``bitbake.conf`` are::
153 153
154 SOLIBS = ".so.*" 154 SOLIBS = ".so.*"
155 SOLIBSDEV = ".so" 155 SOLIBSDEV = ".so"
diff --git a/documentation/dev-manual/python-development-shell.rst b/documentation/dev-manual/python-development-shell.rst
index 2dc6a3f138..81a5c43472 100644
--- a/documentation/dev-manual/python-development-shell.rst
+++ b/documentation/dev-manual/python-development-shell.rst
@@ -35,7 +35,7 @@ system were executing them. Consequently, working this way can be
35helpful when debugging a build or preparing software to be used with the 35helpful when debugging a build or preparing software to be used with the
36OpenEmbedded build system. 36OpenEmbedded build system.
37 37
38Following is an example that uses ``pydevshell`` on a target named 38Here is an example that uses ``pydevshell`` on a target named
39``matchbox-desktop``:: 39``matchbox-desktop``::
40 40
41 $ bitbake matchbox-desktop -c pydevshell 41 $ bitbake matchbox-desktop -c pydevshell
diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 88a63c1808..f998e47934 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -318,7 +318,7 @@ timestamp when it needs to look for an image. Minimally, through the use
318of options, you must provide either a machine name, a virtual machine 318of options, you must provide either a machine name, a virtual machine
319image (``*wic.vmdk``), or a kernel image (``*.bin``). 319image (``*wic.vmdk``), or a kernel image (``*.bin``).
320 320
321Following is the command-line help output for the ``runqemu`` command:: 321Here is the command-line help output for the ``runqemu`` command::
322 322
323 $ runqemu --help 323 $ runqemu --help
324 324
@@ -360,7 +360,7 @@ Following is the command-line help output for the ``runqemu`` command::
360``runqemu`` Command-Line Options 360``runqemu`` Command-Line Options
361================================ 361================================
362 362
363Following is a description of ``runqemu`` options you can provide on the 363Here is a description of ``runqemu`` options you can provide on the
364command line: 364command line:
365 365
366.. note:: 366.. note::
diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst
index 7b9345fb79..bd3f42ac09 100644
--- a/documentation/dev-manual/runtime-testing.rst
+++ b/documentation/dev-manual/runtime-testing.rst
@@ -199,7 +199,7 @@ perform a one-time setup of your controller image by doing the following:
199 "controller" image and you can customize the image recipe as you would 199 "controller" image and you can customize the image recipe as you would
200 any other recipe. 200 any other recipe.
201 201
202 Here are the image recipe requirements: 202 Image recipe requirements are:
203 203
204 - Inherits ``core-image`` so that kernel modules are installed. 204 - Inherits ``core-image`` so that kernel modules are installed.
205 205
@@ -578,7 +578,7 @@ data:
578 When set to "true", the package is not automatically installed into 578 When set to "true", the package is not automatically installed into
579 the DUT. 579 the DUT.
580 580
581Following is an example JSON file that handles test "foo" installing 581Here is an example JSON file that handles test "foo" installing
582package "bar" and test "foobar" installing packages "foo" and "bar". 582package "bar" and test "foobar" installing packages "foo" and "bar".
583Once the test is complete, the packages are removed from the DUT:: 583Once the test is complete, the packages are removed from the DUT::
584 584
diff --git a/documentation/dev-manual/speeding-up-build.rst b/documentation/dev-manual/speeding-up-build.rst
index 31b6f75ab0..6e0d7873ac 100644
--- a/documentation/dev-manual/speeding-up-build.rst
+++ b/documentation/dev-manual/speeding-up-build.rst
@@ -33,7 +33,7 @@ auto-scaling ensures that the build system fundamentally takes advantage
33of potential parallel operations during the build based on the build 33of potential parallel operations during the build based on the build
34machine's capabilities. 34machine's capabilities.
35 35
36Following are additional factors that can affect build speed: 36Additional factors that can affect build speed are:
37 37
38- File system type: The file system type that the build is being 38- File system type: The file system type that the build is being
39 performed on can also influence performance. Using ``ext4`` is 39 performed on can also influence performance. Using ``ext4`` is
@@ -88,7 +88,7 @@ that can help you speed up the build:
88 variable to "1". 88 variable to "1".
89 89
90- Disable static library generation for recipes derived from 90- Disable static library generation for recipes derived from
91 ``autoconf`` or ``libtool``: Following is an example showing how to 91 ``autoconf`` or ``libtool``: Here is an example showing how to
92 disable static libraries and still provide an override to handle 92 disable static libraries and still provide an override to handle
93 exceptions:: 93 exceptions::
94 94
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 794da1e672..9dc9b855b3 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -36,7 +36,7 @@ particular working environment and set of practices.
36 equipment together and set up your development environment's 36 equipment together and set up your development environment's
37 hardware topology. 37 hardware topology.
38 38
39 Here are possible roles: 39 Possible roles are:
40 40
41 - *Application Developer:* This type of developer does application 41 - *Application Developer:* This type of developer does application
42 level work on top of an existing software stack. 42 level work on top of an existing software stack.
@@ -99,7 +99,7 @@ particular working environment and set of practices.
99 99
1005. *Set up the Application Development Machines:* As mentioned earlier, 1005. *Set up the Application Development Machines:* As mentioned earlier,
101 application developers are creating applications on top of existing 101 application developers are creating applications on top of existing
102 software stacks. Following are some best practices for setting up 102 software stacks. Here are some best practices for setting up
103 machines used for application development: 103 machines used for application development:
104 104
105 - Use a pre-built toolchain that contains the software stack 105 - Use a pre-built toolchain that contains the software stack
@@ -118,7 +118,7 @@ particular working environment and set of practices.
118 118
1196. *Set up the Core Development Machines:* As mentioned earlier, core 1196. *Set up the Core Development Machines:* As mentioned earlier, core
120 developers work on the contents of the operating system itself. 120 developers work on the contents of the operating system itself.
121 Following are some best practices for setting up machines used for 121 Here are some best practices for setting up machines used for
122 developing images: 122 developing images:
123 123
124 - Have the :term:`OpenEmbedded Build System` available on 124 - Have the :term:`OpenEmbedded Build System` available on
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 3e1ef389b8..cbcb30281a 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -1376,7 +1376,7 @@ In order to run this task, you must have an existing ``.config`` file.
1376See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for 1376See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for
1377information on how to create a configuration file. 1377information on how to create a configuration file.
1378 1378
1379Following is sample output from the ``do_kernel_configcheck`` task: 1379Here is sample output from the ``do_kernel_configcheck`` task:
1380 1380
1381.. code-block:: none 1381.. code-block:: none
1382 1382
@@ -1809,7 +1809,7 @@ tree. Using Git is an efficient way to see what has changed in the tree.
1809What Changed in a Kernel? 1809What Changed in a Kernel?
1810------------------------- 1810-------------------------
1811 1811
1812Following are a few examples that show how to use Git commands to 1812Here are a few examples that show how to use Git commands to
1813examine changes. These examples are by no means the only way to see 1813examine changes. These examples are by no means the only way to see
1814changes. 1814changes.
1815 1815
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index 6affe68b58..81a434d5b7 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -252,7 +252,7 @@ section in the Yocto Project Development Tasks Manual.
252Build History 252Build History
253------------- 253-------------
254 254
255Following are changes to Build History: 255The changes to Build History are:
256 256
257- Installed package sizes: ``installed-package-sizes.txt`` for an image 257- Installed package sizes: ``installed-package-sizes.txt`` for an image
258 now records the size of the files installed by each package instead 258 now records the size of the files installed by each package instead
@@ -275,7 +275,7 @@ section in the Yocto Project Development Tasks Manual.
275``udev`` 275``udev``
276-------- 276--------
277 277
278Following are changes to ``udev``: 278The changes to ``udev`` are:
279 279
280- ``udev`` no longer brings in ``udev-extraconf`` automatically through 280- ``udev`` no longer brings in ``udev-extraconf`` automatically through
281 :term:`RRECOMMENDS`, since this was originally 281 :term:`RRECOMMENDS`, since this was originally
@@ -319,7 +319,7 @@ Removed and Renamed Recipes
319Other Changes 319Other Changes
320------------- 320-------------
321 321
322Following is a list of short entries describing other changes: 322Here is a list of short entries describing other changes:
323 323
324- ``run-postinsts``: Make this generic. 324- ``run-postinsts``: Make this generic.
325 325
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index 40e3b5cb2b..49cd9b9ae0 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -70,9 +70,9 @@ Metadata Must Now Use Python 3 Syntax
70 70
71The metadata is now required to use Python 3 syntax. For help preparing 71The metadata is now required to use Python 3 syntax. For help preparing
72metadata, see any of the many Python 3 porting guides available. 72metadata, see any of the many Python 3 porting guides available.
73Alternatively, you can reference the conversion commits for Bitbake and 73Alternatively, you can reference the conversion commits for BitBake and
74you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are 74you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes.
75particular areas of interest: 75Particular areas of interest are:
76 76
77 - subprocess command-line pipes needing locale decoding 77 - subprocess command-line pipes needing locale decoding
78 78
@@ -181,14 +181,8 @@ root filesystem, provides an image, and uses the ``nographic`` option::
181 181
182 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic 182 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
183 183
184Following is a list of variables that can be set in configuration files 184Here is a list of variables that can be set in configuration files
185such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``: 185such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``::
186
187.. note::
188
189 "QB" means "QEMU Boot".
190
191::
192 186
193 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") 187 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
194 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") 188 QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst
index 964ed92937..66dfc20d95 100644
--- a/documentation/migration-guides/migration-2.4.rst
+++ b/documentation/migration-guides/migration-2.4.rst
@@ -89,8 +89,6 @@ occurred:
89Removed Recipes 89Removed Recipes
90--------------- 90---------------
91 91
92The following recipes have been removed:
93
94- ``acpitests``: This recipe is not maintained. 92- ``acpitests``: This recipe is not maintained.
95 93
96- ``autogen-native``: No longer required by Grub, oe-core, or 94- ``autogen-native``: No longer required by Grub, oe-core, or
@@ -213,8 +211,6 @@ recipes you might have. This will avoid breakage in post 2.4 releases.
213Package QA Changes 211Package QA Changes
214------------------ 212------------------
215 213
216The following package QA changes took place:
217
218- The "unsafe-references-in-scripts" QA check has been removed. 214- The "unsafe-references-in-scripts" QA check has been removed.
219 215
220- If you refer to ``${COREBASE}/LICENSE`` within 216- If you refer to ``${COREBASE}/LICENSE`` within
@@ -229,8 +225,6 @@ The following package QA changes took place:
229``README`` File Changes 225``README`` File Changes
230----------------------- 226-----------------------
231 227
232The following are changes to ``README`` files:
233
234- The main Poky ``README`` file has been moved to the ``meta-poky`` 228- The main Poky ``README`` file has been moved to the ``meta-poky``
235 layer and has been renamed ``README.poky``. A symlink has been 229 layer and has been renamed ``README.poky``. A symlink has been
236 created so that references to the old location work. 230 created so that references to the old location work.
@@ -246,8 +240,6 @@ The following are changes to ``README`` files:
246Miscellaneous Changes 240Miscellaneous Changes
247--------------------- 241---------------------
248 242
249The following are additional changes:
250
251- The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it 243- The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it
252 have been removed. You should remove this variable from any custom 244 have been removed. You should remove this variable from any custom
253 recipes. 245 recipes.
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst
index fdbf2f3da3..03ecb16dc6 100644
--- a/documentation/migration-guides/migration-2.5.rst
+++ b/documentation/migration-guides/migration-2.5.rst
@@ -85,8 +85,6 @@ The following recipes have been removed:
85Scripts and Tools Changes 85Scripts and Tools Changes
86------------------------- 86-------------------------
87 87
88The following are changes to scripts and tools:
89
90- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The 88- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The
91 ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts 89 ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts
92 previously shipped with poky but not in OpenEmbedded-Core have been 90 previously shipped with poky but not in OpenEmbedded-Core have been
@@ -117,8 +115,6 @@ The following are changes to scripts and tools:
117BitBake Changes 115BitBake Changes
118--------------- 116---------------
119 117
120The following are BitBake changes:
121
122- The ``--runall`` option has changed. There are two different 118- The ``--runall`` option has changed. There are two different
123 behaviors people might want: 119 behaviors people might want:
124 120
@@ -151,7 +147,7 @@ The following are BitBake changes:
151Python and Python 3 Changes 147Python and Python 3 Changes
152--------------------------- 148---------------------------
153 149
154The following are auto-packaging changes to Python and Python 3: 150Here are auto-packaging changes to Python and Python 3:
155 151
156The script-managed ``python-*-manifest.inc`` files that were previously 152The script-managed ``python-*-manifest.inc`` files that were previously
157used to generate Python and Python 3 packages have been replaced with a 153used to generate Python and Python 3 packages have been replaced with a
@@ -185,8 +181,6 @@ change please see :yocto_git:`this commit
185Miscellaneous Changes 181Miscellaneous Changes
186--------------------- 182---------------------
187 183
188The following are additional changes:
189
190- The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. 184- The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels.
191 If your kernel recipe or ``.bbappend`` file mentions packaging at 185 If your kernel recipe or ``.bbappend`` file mentions packaging at
192 all, you should replace references to the kernel in package names 186 all, you should replace references to the kernel in package names
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst
index fc801144b1..9e78fc709f 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -140,7 +140,7 @@ Python changes
140 classes should be updated to inherit ``setuptools*`` equivalents instead. 140 classes should be updated to inherit ``setuptools*`` equivalents instead.
141 141
142- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. 142- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__.
143 Here are the new Python packaging classes that should be used: 143 The new Python packaging classes that should be used are
144 :ref:`python_flit_core <ref-classes-python_flit_core>`, 144 :ref:`python_flit_core <ref-classes-python_flit_core>`,
145 :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` 145 :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>`
146 and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. 146 and :ref:`python_poetry_core <ref-classes-python_poetry_core>`.
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 371c73418a..3e80d6fddd 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -37,7 +37,7 @@ to each data source as a layer. For information on layers, see the
37":ref:`dev-manual/layers:understanding and creating layers`" 37":ref:`dev-manual/layers:understanding and creating layers`"
38section of the Yocto Project Development Tasks Manual. 38section of the Yocto Project Development Tasks Manual.
39 39
40Following are some brief details on these core components. For 40Here are some brief details on these core components. For
41additional information on how these components interact during a build, 41additional information on how these components interact during a build,
42see the 42see the
43":ref:`overview-manual/concepts:openembedded build system concepts`" 43":ref:`overview-manual/concepts:openembedded build system concepts`"
@@ -1351,10 +1351,9 @@ can initialize the environment before using the tools.
1351 the :doc:`/sdk-manual/index` manual. 1351 the :doc:`/sdk-manual/index` manual.
1352 1352
1353All the output files for an SDK are written to the ``deploy/sdk`` folder 1353All the output files for an SDK are written to the ``deploy/sdk`` folder
1354inside the :term:`Build Directory` as 1354inside the :term:`Build Directory` as shown in the previous figure. Depending
1355shown in the previous figure. Depending on the type of SDK, there are 1355on the type of SDK, there are several variables to configure these files.
1356several variables to configure these files. Here are the variables 1356The variables associated with an extensible SDK are:
1357associated with an extensible SDK:
1358 1357
1359- :term:`DEPLOY_DIR`: Points to 1358- :term:`DEPLOY_DIR`: Points to
1360 the ``deploy`` directory. 1359 the ``deploy`` directory.
@@ -2279,7 +2278,7 @@ which is integrating ``sayhello`` in our root file system:
2279#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into 2278#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into
2280 the root file system 2279 the root file system
2281 2280
2282The following are the contents of ``libhello/Makefile``:: 2281The contents of ``libhello/Makefile`` are::
2283 2282
2284 LIB=libhello.so 2283 LIB=libhello.so
2285 2284
@@ -2307,7 +2306,7 @@ The following are the contents of ``libhello/Makefile``::
2307 and ``CFLAGS`` as BitBake will set them as environment variables according 2306 and ``CFLAGS`` as BitBake will set them as environment variables according
2308 to your build configuration. 2307 to your build configuration.
2309 2308
2310The following are the contents of ``libhello/hellolib.h``:: 2309The contents of ``libhello/hellolib.h`` are::
2311 2310
2312 #ifndef HELLOLIB_H 2311 #ifndef HELLOLIB_H
2313 #define HELLOLIB_H 2312 #define HELLOLIB_H
@@ -2316,7 +2315,7 @@ The following are the contents of ``libhello/hellolib.h``::
2316 2315
2317 #endif 2316 #endif
2318 2317
2319The following are the contents of ``libhello/hellolib.c``:: 2318The contents of ``libhello/hellolib.c`` are::
2320 2319
2321 #include <stdio.h> 2320 #include <stdio.h>
2322 2321
@@ -2324,7 +2323,7 @@ The following are the contents of ``libhello/hellolib.c``::
2324 puts("Hello from a Yocto demo \n"); 2323 puts("Hello from a Yocto demo \n");
2325 } 2324 }
2326 2325
2327The following are the contents of ``sayhello/Makefile``:: 2326The contents of ``sayhello/Makefile`` are::
2328 2327
2329 EXEC=sayhello 2328 EXEC=sayhello
2330 LDFLAGS += -lhello 2329 LDFLAGS += -lhello
@@ -2337,7 +2336,7 @@ The following are the contents of ``sayhello/Makefile``::
2337 clean: 2336 clean:
2338 rm -rf $(EXEC) *.o 2337 rm -rf $(EXEC) *.o
2339 2338
2340The following are the contents of ``sayhello/sayhello.c``:: 2339The contents of ``sayhello/sayhello.c`` are::
2341 2340
2342 #include <hellolib.h> 2341 #include <hellolib.h>
2343 2342
@@ -2346,7 +2345,7 @@ The following are the contents of ``sayhello/sayhello.c``::
2346 return 0; 2345 return 0;
2347 } 2346 }
2348 2347
2349The following are the contents of ``libhello_0.1.bb``:: 2348The contents of ``libhello_0.1.bb`` are::
2350 2349
2351 SUMMARY = "Hello demo library" 2350 SUMMARY = "Hello demo library"
2352 DESCRIPTION = "Hello shared library used in Yocto demo" 2351 DESCRIPTION = "Hello shared library used in Yocto demo"
@@ -2369,7 +2368,7 @@ The following are the contents of ``libhello_0.1.bb``::
2369 oe_soinstall ${PN}.so.${PV} ${D}${libdir} 2368 oe_soinstall ${PN}.so.${PV} ${D}${libdir}
2370 } 2369 }
2371 2370
2372The following are the contents of ``sayhello_0.1.bb``:: 2371The contents of ``sayhello_0.1.bb`` are::
2373 2372
2374 SUMMARY = "SayHello demo" 2373 SUMMARY = "SayHello demo"
2375 DESCRIPTION = "SayHello project used in Yocto demo" 2374 DESCRIPTION = "SayHello project used in Yocto demo"
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index f7cd2486af..3dc8ae5519 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -742,7 +742,7 @@ workflow:
742.. image:: figures/YP-flow-diagram.png 742.. image:: figures/YP-flow-diagram.png
743 :align: center 743 :align: center
744 744
745Following is a brief summary of the "workflow": 745Here is a brief summary of the "workflow":
746 746
7471. Developers specify architecture, policies, patches and configuration 7471. Developers specify architecture, policies, patches and configuration
748 details. 748 details.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 216b236e33..05473edcca 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -616,7 +616,7 @@ information about using :ref:`ref-classes-devshell`.
616The :ref:`ref-classes-devupstream` class uses 616The :ref:`ref-classes-devupstream` class uses
617:term:`BBCLASSEXTEND` to add a variant of the 617:term:`BBCLASSEXTEND` to add a variant of the
618recipe that fetches from an alternative URI (e.g. Git) instead of a 618recipe that fetches from an alternative URI (e.g. Git) instead of a
619tarball. Following is an example:: 619tarball. Here is an example::
620 620
621 BBCLASSEXTEND = "devupstream:target" 621 BBCLASSEXTEND = "devupstream:target"
622 SRC_URI:class-devupstream = "git://git.example.com/example;branch=main" 622 SRC_URI:class-devupstream = "git://git.example.com/example;branch=main"
@@ -1141,8 +1141,8 @@ Please keep in mind that the QA checks
1141are meant to detect real or potential problems in the packaged 1141are meant to detect real or potential problems in the packaged
1142output. So exercise caution when disabling these checks. 1142output. So exercise caution when disabling these checks.
1143 1143
1144Here are the tests you can list with the :term:`WARN_QA` and 1144The tests you can list with the :term:`WARN_QA` and
1145:term:`ERROR_QA` variables: 1145:term:`ERROR_QA` variables are:
1146 1146
1147- ``already-stripped:`` Checks that produced binaries have not 1147- ``already-stripped:`` Checks that produced binaries have not
1148 already been stripped prior to the build system extracting debug 1148 already been stripped prior to the build system extracting debug
@@ -3148,7 +3148,7 @@ information.
3148The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot. 3148The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot.
3149It is intended to be inherited from U-Boot recipes. 3149It is intended to be inherited from U-Boot recipes.
3150 3150
3151Here are variables used by this class: 3151The variables used by this class are:
3152 3152
3153- :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when 3153- :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when
3154 building the FIT image. 3154 building the FIT image.
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index ba0385c4c8..4144277e88 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -379,16 +379,14 @@ command::
379Unless you provide a specific recipe name on the command line, the 379Unless you provide a specific recipe name on the command line, the
380command checks all recipes in all configured layers. 380command checks all recipes in all configured layers.
381 381
382Following is a partial example table that reports on all the recipes. 382Here is a partial example table that reports on all the recipes.
383Notice the reported reason for not upgrading the ``base-passwd`` recipe. 383Notice the reported reason for not upgrading the ``base-passwd`` recipe.
384In this example, while a new version is available upstream, you do not 384In this example, while a new version is available upstream, you do not
385want to use it because the dependency on ``cdebconf`` is not easily 385want to use it because the dependency on ``cdebconf`` is not easily
386satisfied. Maintainers can explicit the reason that is shown by adding 386satisfied. Maintainers can explicit the reason that is shown by adding
387the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. 387the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
388See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` 388See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
389for an example. 389for an example::
390
391::
392 390
393 $ devtool check-upgrade-status 391 $ devtool check-upgrade-status
394 ... 392 ...
@@ -599,7 +597,7 @@ The ``devtool status`` command has no command-line options::
599 597
600 $ devtool status 598 $ devtool status
601 599
602Following is sample output after using 600Here is sample output after using
603:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` 601:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>`
604to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:: 602to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory::
605 603
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index b428dc2db6..9fb60899c9 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -312,7 +312,7 @@ HTTPS requests and direct them to the ``http://`` sources mirror. You
312can use ``file://`` URLs to point to local directories or network shares 312can use ``file://`` URLs to point to local directories or network shares
313as well. 313as well.
314 314
315Here are other options:: 315Another option is to set::
316 316
317 BB_NO_NETWORK = "1" 317 BB_NO_NETWORK = "1"
318 318
@@ -328,7 +328,7 @@ This statement
328limits the build system to pulling source from the :term:`PREMIRRORS` only. 328limits the build system to pulling source from the :term:`PREMIRRORS` only.
329Again, this technique is useful for reproducing builds. 329Again, this technique is useful for reproducing builds.
330 330
331Here is another technique:: 331Here is yet another technique::
332 332
333 BB_GENERATE_MIRROR_TARBALLS = "1" 333 BB_GENERATE_MIRROR_TARBALLS = "1"
334 334
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index a7078c7f3a..4f0366eeb6 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -198,7 +198,7 @@ you can add several different predefined packages such as development
198utilities or packages with debug information needed to investigate 198utilities or packages with debug information needed to investigate
199application problems or profile applications. 199application problems or profile applications.
200 200
201Here are the image features available for all images: 201The image features available for all images are:
202 202
203- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root 203- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root
204 logins and logins from accounts having an empty password string. 204 logins and logins from accounts having an empty password string.
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index da27512855..f875633128 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -32,7 +32,7 @@ that contain image recipe files::
32 32
33 $ ls meta*/recipes*/images/*.bb 33 $ ls meta*/recipes*/images/*.bb
34 34
35Following is a list of supported recipes: 35Here is a list of supported recipes:
36 36
37- ``build-appliance-image``: An example virtual machine that contains 37- ``build-appliance-image``: An example virtual machine that contains
38 all the pieces required to run builds using the build system as well 38 all the pieces required to run builds using the build system as well
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 2393ac8d81..2913a4d4eb 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -14,7 +14,7 @@ Major and Minor Release Cadence
14 14
15The Yocto Project delivers major releases (e.g. &DISTRO;) using a six 15The Yocto Project delivers major releases (e.g. &DISTRO;) using a six
16month cadence roughly timed each April and October of the year. 16month cadence roughly timed each April and October of the year.
17Following are examples of some major YP releases with their codenames 17Here are examples of some major YP releases with their codenames
18also shown. See the ":ref:`ref-manual/release-process:major release codenames`" 18also shown. See the ":ref:`ref-manual/release-process:major release codenames`"
19section for information on codenames used with major releases. 19section for information on codenames used with major releases.
20 20
@@ -29,8 +29,8 @@ major holidays in various geographies.
29 29
30The Yocto project delivers minor (point) releases on an unscheduled 30The Yocto project delivers minor (point) releases on an unscheduled
31basis and are usually driven by the accumulation of enough significant 31basis and are usually driven by the accumulation of enough significant
32fixes or enhancements to the associated major release. Following are 32fixes or enhancements to the associated major release.
33some example past point releases: 33Some example past point releases are:
34 34
35 - 4.1.3 35 - 4.1.3
36 - 4.0.8 36 - 4.0.8
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index d21134fd7f..021e49e9d7 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -530,7 +530,7 @@ recipe-specific :term:`WORKDIR` directories. Thus, the
530This directory holds information that BitBake uses for accounting 530This directory holds information that BitBake uses for accounting
531purposes to track what tasks have run and when they have run. The 531purposes to track what tasks have run and when they have run. The
532directory is sub-divided by architecture, package name, and version. 532directory is sub-divided by architecture, package name, and version.
533Following is an example:: 533Here is an example::
534 534
535 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do 535 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do
536 536
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 2a5baa4cbf..d602f7ea36 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -4,7 +4,7 @@
4Yocto Project Terms 4Yocto Project Terms
5******************* 5*******************
6 6
7Following is a list of terms and definitions users new to the Yocto Project 7Here is a list of terms and definitions users new to the Yocto Project
8development environment might find helpful. While some of these terms are 8development environment might find helpful. While some of these terms are
9universal, the list includes them just in case: 9universal, the list includes them just in case:
10 10
@@ -66,8 +66,8 @@ universal, the list includes them just in case:
66 (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The 66 (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The
67 :term:`TOPDIR` variable points to the Build Directory. 67 :term:`TOPDIR` variable points to the Build Directory.
68 68
69 You have a lot of flexibility when creating the Build Directory. 69 You have a lot of flexibility when creating the :term:`Build Directory`.
70 Following are some examples that show how to create the directory. The 70 Here are some examples that show how to create the directory. The
71 examples assume your :term:`Source Directory` is named ``poky``: 71 examples assume your :term:`Source Directory` is named ``poky``:
72 72
73 - Create the Build Directory inside your Source Directory and let 73 - Create the Build Directory inside your Source Directory and let
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index ae14c450dd..691a0cdc1a 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -318,7 +318,7 @@ system and gives an overview of their function and contents.
318 318
319 :term:`BB_ALLOWED_NETWORKS` 319 :term:`BB_ALLOWED_NETWORKS`
320 Specifies a space-delimited list of hosts that the fetcher is allowed 320 Specifies a space-delimited list of hosts that the fetcher is allowed
321 to use to obtain the required source code. Following are 321 to use to obtain the required source code. Here are
322 considerations surrounding this variable: 322 considerations surrounding this variable:
323 323
324 - This host list is only used if :term:`BB_NO_NETWORK` is either not set 324 - This host list is only used if :term:`BB_NO_NETWORK` is either not set
@@ -6174,7 +6174,7 @@ system and gives an overview of their function and contents.
6174 The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of 6174 The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of
6175 the recipe you prefer to provide "virtual/kernel". 6175 the recipe you prefer to provide "virtual/kernel".
6176 6176
6177 Following are more examples:: 6177 Here are more examples::
6178 6178
6179 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" 6179 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
6180 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 6180 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
@@ -8940,7 +8940,7 @@ system and gives an overview of their function and contents.
8940 configuration can define the :term:`UBOOT_MACHINE` and optionally the 8940 configuration can define the :term:`UBOOT_MACHINE` and optionally the
8941 :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. 8941 :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`.
8942 8942
8943 Following is an example from the ``meta-freescale`` layer. :: 8943 Here is an example from the ``meta-freescale`` layer. ::
8944 8944
8945 UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" 8945 UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor"
8946 UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" 8946 UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig"
@@ -9413,7 +9413,7 @@ system and gives an overview of their function and contents.
9413 With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to 9413 With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to
9414 specify a list of additional dependencies (e.g. native tools, 9414 specify a list of additional dependencies (e.g. native tools,
9415 bootloaders, and so forth), that are required to build Wic images. 9415 bootloaders, and so forth), that are required to build Wic images.
9416 Following is an example:: 9416 Here is an example::
9417 9417
9418 WKS_FILE_DEPENDS = "some-native-tool" 9418 WKS_FILE_DEPENDS = "some-native-tool"
9419 9419
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index 7b458f281b..d384b4916a 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -51,8 +51,8 @@ Follow these steps to locate and hand-install the toolchain:
51 51
52 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh 52 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
53 53
544. *Run the Installer:* Be sure you have execution privileges and run 54#. *Run the Installer:* Be sure you have execution privileges and run
55 the installer. Following is an example from the ``Downloads`` 55 the installer. Here is an example from the ``Downloads``
56 directory:: 56 directory::
57 57
58 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh 58 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
@@ -155,12 +155,12 @@ build the SDK installer. Follow these steps:
155 variable inside your ``local.conf`` file before building the 155 variable inside your ``local.conf`` file before building the
156 SDK installer. Doing so ensures that the eventual SDK 156 SDK installer. Doing so ensures that the eventual SDK
157 installation process installs the appropriate library packages 157 installation process installs the appropriate library packages
158 as part of the SDK. Following is an example using ``libc`` 158 as part of the SDK. Here is an example using ``libc``
159 static development libraries: TOOLCHAIN_TARGET_TASK:append = " 159 static development libraries: TOOLCHAIN_TARGET_TASK:append = "
160 libc-staticdev" 160 libc-staticdev"
161 161
1627. *Run the Installer:* You can now run the SDK installer from 162#. *Run the Installer:* You can now run the SDK installer from
163 ``tmp/deploy/sdk`` in the Build Directory. Following is an example:: 163 ``tmp/deploy/sdk`` in the :term:`Build Directory`. Here is an example::
164 164
165 $ cd poky/build/tmp/deploy/sdk 165 $ cd poky/build/tmp/deploy/sdk
166 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 166 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
@@ -225,7 +225,7 @@ Follow these steps to extract the root filesystem:
225 This script is located in the top-level directory in which you 225 This script is located in the top-level directory in which you
226 installed the toolchain (e.g. ``poky_sdk``). 226 installed the toolchain (e.g. ``poky_sdk``).
227 227
228 Following is an example based on the toolchain installed in the 228 Here is an example based on the toolchain installed in the
229 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section:: 229 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section::
230 230
231 $ source poky_sdk/environment-setup-core2-64-poky-linux 231 $ source poky_sdk/environment-setup-core2-64-poky-linux
@@ -233,7 +233,7 @@ Follow these steps to extract the root filesystem:
2333. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` 2333. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk``
234 command and provide the root filesystem image. 234 command and provide the root filesystem image.
235 235
236 Following is an example command that extracts the root filesystem 236 Here is an example command that extracts the root filesystem
237 from a previously built root filesystem image that was downloaded 237 from a previously built root filesystem image that was downloaded
238 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`. 238 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`.
239 This command extracts the root filesystem into the ``core2-64-sato`` 239 This command extracts the root filesystem into the ``core2-64-sato``
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index 802d3f3d42..4310e133fb 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -66,7 +66,7 @@ The SDK development environment consists of the following:
66 66
67In summary, the extensible and standard SDK share many features. 67In summary, the extensible and standard SDK share many features.
68However, the extensible SDK has powerful development tools to help you 68However, the extensible SDK has powerful development tools to help you
69more quickly develop applications. Following is a table that summarizes 69more quickly develop applications. Here is a table that summarizes
70the primary differences between the standard and extensible SDK types 70the primary differences between the standard and extensible SDK types
71when considering which to build: 71when considering which to build:
72 72
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
index 1e1a314d66..69155bdeb7 100644
--- a/documentation/toaster-manual/setup-and-use.rst
+++ b/documentation/toaster-manual/setup-and-use.rst
@@ -366,7 +366,7 @@ Perform the following steps to install Toaster:
366 366
367 /etc/apache2/conf.d/toaster.conf 367 /etc/apache2/conf.d/toaster.conf
368 368
369 Following is a sample Apache configuration for Toaster you can follow: 369 Here is a sample Apache configuration for Toaster you can follow:
370 370
371 .. code-block:: apache 371 .. code-block:: apache
372 372
@@ -496,7 +496,7 @@ The Toaster web interface allows you to do the following:
496Toaster Web Interface Videos 496Toaster Web Interface Videos
497---------------------------- 497----------------------------
498 498
499Following are several videos that show how to use the Toaster GUI: 499Here are several videos that show how to use the Toaster GUI:
500 500
501- *Build Configuration:* This 501- *Build Configuration:* This
502 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and 502 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and