summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-02-09 17:48:06 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-02-24 16:13:28 +0000
commit025386d53ceef681d7e829ad184b6850af55619c (patch)
tree720a253731442d2b84ed443c8b143fdc23dfc493 /documentation
parent67efdd63c2b1d94bdc4a8da2895b3f7186e7a7c4 (diff)
downloadpoky-025386d53ceef681d7e829ad184b6850af55619c.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: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-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.rst6
-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.rst18
-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.rst4
-rw-r--r--documentation/ref-manual/faq.rst6
-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.rst4
-rw-r--r--documentation/ref-manual/variables.rst8
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst10
-rw-r--r--documentation/sdk-manual/intro.rst2
-rw-r--r--documentation/toaster-manual/setup-and-use.rst4
36 files changed, 85 insertions, 100 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 29c69a9305..11ca5d8b76 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -851,8 +851,7 @@ Before looking at BSP requirements, you should consider the following:
851 dictating that a specific kernel or kernel version be used in a given 851 dictating that a specific kernel or kernel version be used in a given
852 BSP. 852 BSP.
853 853
854Following are the requirements for a released BSP that conform to the 854The requirements for a released BSP that conform to the Yocto Project are:
855Yocto Project:
856 855
857- *Layer Name:* The BSP must have a layer name that follows the Yocto 856- *Layer Name:* The BSP must have a layer name that follows the Yocto
858 Project standards. For information on BSP layer names, see the 857 Project standards. For information on BSP layer names, see the
@@ -956,7 +955,7 @@ Yocto Project:
956Released BSP Recommendations 955Released BSP Recommendations
957---------------------------- 956----------------------------
958 957
959Following are recommendations for released BSPs that conform to the 958Here are recommendations for released BSPs that conform to the
960Yocto Project: 959Yocto Project:
961 960
962- *Bootable Images:* Released BSPs can contain one or more bootable 961- *Bootable Images:* Released BSPs can contain one or more bootable
@@ -1018,7 +1017,7 @@ the following:
1018 that additional hierarchy and the files would obviously not be able 1017 that additional hierarchy and the files would obviously not be able
1019 to reside in a machine-specific directory. 1018 to reside in a machine-specific directory.
1020 1019
1021Following is a specific example to help you better understand the 1020Here is a specific example to help you better understand the
1022process. This example customizes a recipe by adding a 1021process. This example customizes a recipe by adding a
1023BSP-specific configuration file named ``interfaces`` to the 1022BSP-specific configuration file named ``interfaces`` to the
1024``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer 1023``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer
@@ -1448,7 +1447,7 @@ metadata used to build the kernel. In this case, a kernel append file
1448kernel recipe (i.e. ``linux-yocto_6.1.bb``), which is located in 1447kernel recipe (i.e. ``linux-yocto_6.1.bb``), which is located in
1449:yocto_git:`/poky/tree/meta/recipes-kernel/linux`. 1448:yocto_git:`/poky/tree/meta/recipes-kernel/linux`.
1450 1449
1451Following is the contents of the append file:: 1450The contents of the append file are::
1452 1451
1453 KBRANCH:genericx86 = "v6.1/standard/base" 1452 KBRANCH:genericx86 = "v6.1/standard/base"
1454 KBRANCH:genericx86-64 = "v6.1/standard/base" 1453 KBRANCH:genericx86-64 = "v6.1/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 834eade766..ce29815e9f 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() {
@@ -1236,7 +1236,7 @@ Here are some other tips that you might find useful:
1236 "$@" 1236 "$@"
1237 } 1237 }
1238 1238
1239 Following are some usage examples:: 1239 Here are some usage examples::
1240 1240
1241 $ g FOO # Search recursively for "FOO" 1241 $ g FOO # Search recursively for "FOO"
1242 $ g -i foo # Search recursively for "foo", ignoring case 1242 $ 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 b3ccf633df..f7929e630e 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 57713effa0..bffff3675f 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 6b41d24db4..469b2d395a 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 2c1033eb35..61fc2eb122 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::
@@ -1232,7 +1232,7 @@ inherit the :ref:`ref-classes-autotools` class, which contains the definitions
1232of all the steps needed to build an Autotool-based application. The result of 1232of all the steps needed to build an Autotool-based application. The result of
1233the build is automatically packaged. And, if the application uses NLS for 1233the build is automatically packaged. And, if the application uses NLS for
1234localization, packages with local information are generated (one package per 1234localization, packages with local information are generated (one package per
1235language). Following is one example: (``hello_2.3.bb``):: 1235language). Here is one example: (``hello_2.3.bb``)::
1236 1236
1237 SUMMARY = "GNU Helloworld application" 1237 SUMMARY = "GNU Helloworld application"
1238 SECTION = "examples" 1238 SECTION = "examples"
@@ -1285,7 +1285,7 @@ Splitting an Application into Multiple Packages
1285You can use the variables :term:`PACKAGES` and :term:`FILES` to split an 1285You can use the variables :term:`PACKAGES` and :term:`FILES` to split an
1286application into multiple packages. 1286application into multiple packages.
1287 1287
1288Following is an example that uses the ``libxpm`` recipe. By default, 1288Here is an example that uses the ``libxpm`` recipe. By default,
1289this recipe generates a single package that contains the library along 1289this recipe generates a single package that contains the library along
1290with a few binaries. You can modify the recipe to split the binaries 1290with a few binaries. You can modify the recipe to split the binaries
1291into separate packages:: 1291into separate packages::
@@ -1510,7 +1510,7 @@ in the BitBake User Manual.
1510 when you make the assignment, but this is not generally needed. 1510 when you make the assignment, but this is not generally needed.
1511 1511
1512- *Quote All Assignments ("value"):* Use double quotes around values in 1512- *Quote All Assignments ("value"):* Use double quotes around values in
1513 all variable assignments (e.g. ``"value"``). Following is an example:: 1513 all variable assignments (e.g. ``"value"``). Here is an example::
1514 1514
1515 VAR1 = "${OTHERVAR}" 1515 VAR1 = "${OTHERVAR}"
1516 VAR2 = "The version is ${PV}" 1516 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 d431ea4b99..19f3e40d63 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -311,7 +311,7 @@ timestamp when it needs to look for an image. Minimally, through the use
311of options, you must provide either a machine name, a virtual machine 311of options, you must provide either a machine name, a virtual machine
312image (``*wic.vmdk``), or a kernel image (``*.bin``). 312image (``*wic.vmdk``), or a kernel image (``*.bin``).
313 313
314Following is the command-line help output for the ``runqemu`` command:: 314Here is the command-line help output for the ``runqemu`` command::
315 315
316 $ runqemu --help 316 $ runqemu --help
317 317
@@ -353,7 +353,7 @@ Following is the command-line help output for the ``runqemu`` command::
353``runqemu`` Command-Line Options 353``runqemu`` Command-Line Options
354================================ 354================================
355 355
356Following is a description of ``runqemu`` options you can provide on the 356Here is a description of ``runqemu`` options you can provide on the
357command line: 357command line:
358 358
359.. note:: 359.. note::
diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst
index 1a2e9ec4fe..7a2b42f25a 100644
--- a/documentation/dev-manual/runtime-testing.rst
+++ b/documentation/dev-manual/runtime-testing.rst
@@ -193,7 +193,7 @@ perform a one-time setup of your controller image by doing the following:
193 "controller" image and you can customize the image recipe as you would 193 "controller" image and you can customize the image recipe as you would
194 any other recipe. 194 any other recipe.
195 195
196 Here are the image recipe requirements: 196 Image recipe requirements are:
197 197
198 - Inherits ``core-image`` so that kernel modules are installed. 198 - Inherits ``core-image`` so that kernel modules are installed.
199 199
@@ -572,7 +572,7 @@ data:
572 When set to "true", the package is not automatically installed into 572 When set to "true", the package is not automatically installed into
573 the DUT. 573 the DUT.
574 574
575Following is an example JSON file that handles test "foo" installing 575Here is an example JSON file that handles test "foo" installing
576package "bar" and test "foobar" installing packages "foo" and "bar". 576package "bar" and test "foobar" installing packages "foo" and "bar".
577Once the test is complete, the packages are removed from the DUT:: 577Once the test is complete, the packages are removed from the DUT::
578 578
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 b108337795..8539bc0889 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
100#. *Set up the Application Development Machines:* As mentioned earlier, 100#. *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
119#. *Set up the Core Development Machines:* As mentioned earlier, core 119#. *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 9b197bfccb..0cee503346 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -1295,7 +1295,7 @@ In order to run this task, you must have an existing ``.config`` file.
1295See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for 1295See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for
1296information on how to create a configuration file. 1296information on how to create a configuration file.
1297 1297
1298Following is sample output from the :ref:`ref-tasks-kernel_configcheck` task: 1298Here is sample output from the :ref:`ref-tasks-kernel_configcheck` task:
1299 1299
1300.. code-block:: none 1300.. code-block:: none
1301 1301
@@ -1726,7 +1726,7 @@ tree. Using Git is an efficient way to see what has changed in the tree.
1726What Changed in a Kernel? 1726What Changed in a Kernel?
1727------------------------- 1727-------------------------
1728 1728
1729Following are a few examples that show how to use Git commands to 1729Here are a few examples that show how to use Git commands to
1730examine changes. These examples are by no means the only way to see 1730examine changes. These examples are by no means the only way to see
1731changes. 1731changes.
1732 1732
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index d82d33f91f..c8f3cbc165 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -256,7 +256,7 @@ section in the Yocto Project Development Tasks Manual.
256Build History 256Build History
257------------- 257-------------
258 258
259Following are changes to Build History: 259The changes to Build History are:
260 260
261- Installed package sizes: ``installed-package-sizes.txt`` for an image 261- Installed package sizes: ``installed-package-sizes.txt`` for an image
262 now records the size of the files installed by each package instead 262 now records the size of the files installed by each package instead
@@ -279,7 +279,7 @@ section in the Yocto Project Development Tasks Manual.
279``udev`` 279``udev``
280-------- 280--------
281 281
282Following are changes to ``udev``: 282The changes to ``udev`` are:
283 283
284- ``udev`` no longer brings in ``udev-extraconf`` automatically through 284- ``udev`` no longer brings in ``udev-extraconf`` automatically through
285 :term:`RRECOMMENDS`, since this was originally 285 :term:`RRECOMMENDS`, since this was originally
@@ -323,7 +323,7 @@ Removed and Renamed Recipes
323Other Changes 323Other Changes
324------------- 324-------------
325 325
326Following is a list of short entries describing other changes: 326Here is a list of short entries describing other changes:
327 327
328- ``run-postinsts``: Make this generic. 328- ``run-postinsts``: Make this generic.
329 329
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index 3932792c78..9d50dc6202 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -73,8 +73,8 @@ Metadata Must Now Use Python 3 Syntax
73The metadata is now required to use Python 3 syntax. For help preparing 73The metadata is now required to use Python 3 syntax. For help preparing
74metadata, see any of the many Python 3 porting guides available. 74metadata, see any of the many Python 3 porting guides available.
75Alternatively, you can reference the conversion commits for BitBake and 75Alternatively, you can reference the conversion commits for BitBake and
76you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are 76you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes.
77particular areas of interest: 77Particular areas of interest are:
78 78
79 - subprocess command-line pipes needing locale decoding 79 - subprocess command-line pipes needing locale decoding
80 80
@@ -182,7 +182,7 @@ root filesystem, provides an image, and uses the ``nographic`` option::
182 182
183 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic 183 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
184 184
185Following is a list of variables that can be set in configuration files 185Here is a list of variables that can be set in configuration files
186such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``:: 186such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``::
187 187
188 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") 188 QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst
index abad43acc3..5d5d601988 100644
--- a/documentation/migration-guides/migration-2.4.rst
+++ b/documentation/migration-guides/migration-2.4.rst
@@ -91,8 +91,6 @@ occurred:
91Removed Recipes 91Removed Recipes
92--------------- 92---------------
93 93
94The following recipes have been removed:
95
96- ``acpitests``: This recipe is not maintained. 94- ``acpitests``: This recipe is not maintained.
97 95
98- ``autogen-native``: No longer required by Grub, oe-core, or 96- ``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 9f089bb93b..facf5110b7 100644
--- a/documentation/migration-guides/migration-2.5.rst
+++ b/documentation/migration-guides/migration-2.5.rst
@@ -87,8 +87,6 @@ The following recipes have been removed:
87Scripts and Tools Changes 87Scripts and Tools Changes
88------------------------- 88-------------------------
89 89
90The following are changes to scripts and tools:
91
92- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The 90- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The
93 ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts 91 ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts
94 previously shipped with poky but not in OpenEmbedded-Core have been 92 previously shipped with poky but not in OpenEmbedded-Core have been
@@ -119,8 +117,6 @@ The following are changes to scripts and tools:
119BitBake Changes 117BitBake Changes
120--------------- 118---------------
121 119
122The following are BitBake changes:
123
124- The ``--runall`` option has changed. There are two different 120- The ``--runall`` option has changed. There are two different
125 behaviors people might want: 121 behaviors people might want:
126 122
@@ -153,7 +149,7 @@ The following are BitBake changes:
153Python and Python 3 Changes 149Python and Python 3 Changes
154--------------------------- 150---------------------------
155 151
156The following are auto-packaging changes to Python and Python 3: 152Here are auto-packaging changes to Python and Python 3:
157 153
158The script-managed ``python-*-manifest.inc`` files that were previously 154The script-managed ``python-*-manifest.inc`` files that were previously
159used to generate Python and Python 3 packages have been replaced with a 155used to generate Python and Python 3 packages have been replaced with a
@@ -187,8 +183,6 @@ change please see :yocto_git:`this commit
187Miscellaneous Changes 183Miscellaneous Changes
188--------------------- 184---------------------
189 185
190The following are additional changes:
191
192- The :ref:`ref-classes-kernel` class supports building packages for multiple kernels. 186- The :ref:`ref-classes-kernel` class supports building packages for multiple kernels.
193 If your kernel recipe or ``.bbappend`` file mentions packaging at 187 If your kernel recipe or ``.bbappend`` file mentions packaging at
194 all, you should replace references to the kernel in package names 188 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 2aa9145ef8..b5bd57c312 100644
--- a/documentation/migration-guides/migration-4.0.rst
+++ b/documentation/migration-guides/migration-4.0.rst
@@ -142,7 +142,7 @@ Python changes
142 classes should be updated to inherit ``setuptools*`` equivalents instead. 142 classes should be updated to inherit ``setuptools*`` equivalents instead.
143 143
144- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. 144- The Python package build process is now based on `wheels <https://pythonwheels.com/>`__.
145 Here are the new Python packaging classes that should be used: 145 The new Python packaging classes that should be used are
146 :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` 146 :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta`
147 and :ref:`ref-classes-python_poetry_core`. 147 and :ref:`ref-classes-python_poetry_core`.
148 148
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index d335c2fcdd..d177ca33b7 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`"
@@ -1321,7 +1321,7 @@ can initialize the environment before using the tools.
1321All the output files for an SDK are written to the ``deploy/sdk`` folder 1321All the output files for an SDK are written to the ``deploy/sdk`` folder
1322inside the :term:`Build Directory` as shown in the previous figure. Depending 1322inside the :term:`Build Directory` as shown in the previous figure. Depending
1323on the type of SDK, there are several variables to configure these files. 1323on the type of SDK, there are several variables to configure these files.
1324Here are the variables associated with an extensible SDK: 1324The variables associated with an extensible SDK are:
1325 1325
1326- :term:`DEPLOY_DIR`: Points to 1326- :term:`DEPLOY_DIR`: Points to
1327 the ``deploy`` directory. 1327 the ``deploy`` directory.
@@ -2238,7 +2238,7 @@ which is integrating ``sayhello`` in our root file system:
2238#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into 2238#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into
2239 the root file system 2239 the root file system
2240 2240
2241The following are the contents of ``libhello/Makefile``:: 2241The contents of ``libhello/Makefile`` are::
2242 2242
2243 LIB=libhello.so 2243 LIB=libhello.so
2244 2244
@@ -2266,7 +2266,7 @@ The following are the contents of ``libhello/Makefile``::
2266 and ``CFLAGS`` as BitBake will set them as environment variables according 2266 and ``CFLAGS`` as BitBake will set them as environment variables according
2267 to your build configuration. 2267 to your build configuration.
2268 2268
2269The following are the contents of ``libhello/hellolib.h``:: 2269The contents of ``libhello/hellolib.h`` are::
2270 2270
2271 #ifndef HELLOLIB_H 2271 #ifndef HELLOLIB_H
2272 #define HELLOLIB_H 2272 #define HELLOLIB_H
@@ -2275,7 +2275,7 @@ The following are the contents of ``libhello/hellolib.h``::
2275 2275
2276 #endif 2276 #endif
2277 2277
2278The following are the contents of ``libhello/hellolib.c``:: 2278The contents of ``libhello/hellolib.c`` are::
2279 2279
2280 #include <stdio.h> 2280 #include <stdio.h>
2281 2281
@@ -2283,7 +2283,7 @@ The following are the contents of ``libhello/hellolib.c``::
2283 puts("Hello from a Yocto demo \n"); 2283 puts("Hello from a Yocto demo \n");
2284 } 2284 }
2285 2285
2286The following are the contents of ``sayhello/Makefile``:: 2286The contents of ``sayhello/Makefile`` are::
2287 2287
2288 EXEC=sayhello 2288 EXEC=sayhello
2289 LDFLAGS += -lhello 2289 LDFLAGS += -lhello
@@ -2296,7 +2296,7 @@ The following are the contents of ``sayhello/Makefile``::
2296 clean: 2296 clean:
2297 rm -rf $(EXEC) *.o 2297 rm -rf $(EXEC) *.o
2298 2298
2299The following are the contents of ``sayhello/sayhello.c``:: 2299The contents of ``sayhello/sayhello.c`` are::
2300 2300
2301 #include <hellolib.h> 2301 #include <hellolib.h>
2302 2302
@@ -2305,7 +2305,7 @@ The following are the contents of ``sayhello/sayhello.c``::
2305 return 0; 2305 return 0;
2306 } 2306 }
2307 2307
2308The following are the contents of ``libhello_0.1.bb``:: 2308The contents of ``libhello_0.1.bb`` are::
2309 2309
2310 SUMMARY = "Hello demo library" 2310 SUMMARY = "Hello demo library"
2311 DESCRIPTION = "Hello shared library used in Yocto demo" 2311 DESCRIPTION = "Hello shared library used in Yocto demo"
@@ -2328,7 +2328,7 @@ The following are the contents of ``libhello_0.1.bb``::
2328 oe_soinstall ${PN}.so.${PV} ${D}${libdir} 2328 oe_soinstall ${PN}.so.${PV} ${D}${libdir}
2329 } 2329 }
2330 2330
2331The following are the contents of ``sayhello_0.1.bb``:: 2331The contents of ``sayhello_0.1.bb`` are::
2332 2332
2333 SUMMARY = "SayHello demo" 2333 SUMMARY = "SayHello demo"
2334 DESCRIPTION = "SayHello project used in Yocto demo" 2334 DESCRIPTION = "SayHello project used in Yocto demo"
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 1e6820c14e..4a27e12e01 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -737,7 +737,7 @@ workflow:
737.. image:: figures/YP-flow-diagram.png 737.. image:: figures/YP-flow-diagram.png
738 :width: 100% 738 :width: 100%
739 739
740Following is a brief summary of the "workflow": 740Here is a brief summary of the "workflow":
741 741
742#. Developers specify architecture, policies, patches and configuration 742#. Developers specify architecture, policies, patches and configuration
743 details. 743 details.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 844433c551..7300020ef1 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -693,7 +693,7 @@ information about using :ref:`ref-classes-devshell`.
693The :ref:`ref-classes-devupstream` class uses 693The :ref:`ref-classes-devupstream` class uses
694:term:`BBCLASSEXTEND` to add a variant of the 694:term:`BBCLASSEXTEND` to add a variant of the
695recipe that fetches from an alternative URI (e.g. Git) instead of a 695recipe that fetches from an alternative URI (e.g. Git) instead of a
696tarball. Following is an example:: 696tarball. Here is an example::
697 697
698 BBCLASSEXTEND = "devupstream:target" 698 BBCLASSEXTEND = "devupstream:target"
699 SRC_URI:class-devupstream = "git://git.example.com/example;branch=main" 699 SRC_URI:class-devupstream = "git://git.example.com/example;branch=main"
@@ -1246,8 +1246,8 @@ Please keep in mind that the QA checks
1246are meant to detect real or potential problems in the packaged 1246are meant to detect real or potential problems in the packaged
1247output. So exercise caution when disabling these checks. 1247output. So exercise caution when disabling these checks.
1248 1248
1249Here are the tests you can list with the :term:`WARN_QA` and 1249The tests you can list with the :term:`WARN_QA` and
1250:term:`ERROR_QA` variables: 1250:term:`ERROR_QA` variables are:
1251 1251
1252- ``already-stripped:`` Checks that produced binaries have not 1252- ``already-stripped:`` Checks that produced binaries have not
1253 already been stripped prior to the build system extracting debug 1253 already been stripped prior to the build system extracting debug
@@ -3246,7 +3246,7 @@ information.
3246The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot. 3246The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot.
3247It is intended to be inherited from U-Boot recipes. 3247It is intended to be inherited from U-Boot recipes.
3248 3248
3249Here are variables used by this class: 3249The variables used by this class are:
3250 3250
3251- :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when 3251- :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when
3252 building the FIT image. 3252 building the FIT image.
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index e167f58092..9319addc3c 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -378,7 +378,7 @@ command::
378Unless you provide a specific recipe name on the command line, the 378Unless you provide a specific recipe name on the command line, the
379command checks all recipes in all configured layers. 379command checks all recipes in all configured layers.
380 380
381Following is a partial example table that reports on all the recipes:: 381Here is a partial example table that reports on all the recipes::
382 382
383 $ devtool check-upgrade-status 383 $ devtool check-upgrade-status
384 ... 384 ...
@@ -598,7 +598,7 @@ The ``devtool status`` command has no command-line options::
598 598
599 $ devtool status 599 $ devtool status
600 600
601Following is sample output after using 601Here is sample output after using
602:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` 602:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>`
603to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:: 603to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory::
604 604
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index a3a15506c3..bab284bbfd 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -90,7 +90,7 @@ HTTPS requests and direct them to the ``http://`` sources mirror. You
90can use ``file://`` URLs to point to local directories or network shares 90can use ``file://`` URLs to point to local directories or network shares
91as well. 91as well.
92 92
93Here are other options:: 93Another option is to set::
94 94
95 BB_NO_NETWORK = "1" 95 BB_NO_NETWORK = "1"
96 96
@@ -106,7 +106,7 @@ This statement limits the build system to pulling source from the
106:term:`PREMIRRORS` only. Again, this technique is useful for reproducing 106:term:`PREMIRRORS` only. Again, this technique is useful for reproducing
107builds. 107builds.
108 108
109Here is another technique:: 109Here is yet another technique::
110 110
111 BB_GENERATE_MIRROR_TARBALLS = "1" 111 BB_GENERATE_MIRROR_TARBALLS = "1"
112 112
@@ -135,7 +135,7 @@ Most source fetching by the OpenEmbedded build system is done by
135single user or can be in ``/usr/local/etc/wgetrc`` as a global user 135single user or can be in ``/usr/local/etc/wgetrc`` as a global user
136file. 136file.
137 137
138Following is the applicable code for setting various proxy types in the 138Here is the applicable code for setting various proxy types in the
139``.wgetrc`` file. By default, these settings are disabled with comments. 139``.wgetrc`` file. By default, these settings are disabled with comments.
140To use them, remove the comments:: 140To use them, remove the comments::
141 141
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index b9d3b30f18..2ea946b31d 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -271,7 +271,7 @@ you can add several different predefined packages such as development
271utilities or packages with debug information needed to investigate 271utilities or packages with debug information needed to investigate
272application problems or profile applications. 272application problems or profile applications.
273 273
274Here are the image features available for all images: 274The image features available for all images are:
275 275
276- *allow-empty-password:* Allows Dropbear and OpenSSH to accept 276- *allow-empty-password:* Allows Dropbear and OpenSSH to accept
277 logins from accounts having an empty password string. 277 logins from accounts having an empty password string.
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index 0f6d6bdb3f..c45f9104a9 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 9c4144fd2c..920794679d 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 f1b11ad69b..acadd5efa3 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -537,7 +537,7 @@ recipe-specific :term:`WORKDIR` directories. Thus, the
537This directory holds information that BitBake uses for accounting 537This directory holds information that BitBake uses for accounting
538purposes to track what tasks have run and when they have run. The 538purposes to track what tasks have run and when they have run. The
539directory is sub-divided by architecture, package name, and version. 539directory is sub-divided by architecture, package name, and version.
540Following is an example:: 540Here is an example::
541 541
542 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do 542 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do
543 543
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 31ddeae009..ad9c46c339 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
@@ -67,7 +67,7 @@ universal, the list includes them just in case:
67 :term:`TOPDIR` variable points to the :term:`Build Directory`. 67 :term:`TOPDIR` variable points to the :term:`Build Directory`.
68 68
69 You have a lot of flexibility when creating the :term:`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 :term:`Build Directory` inside your Source Directory and let 73 - Create the :term:`Build Directory` inside your Source Directory and let
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6f7d6ff01e..f4beecf0d2 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -311,7 +311,7 @@ system and gives an overview of their function and contents.
311 311
312 :term:`BB_ALLOWED_NETWORKS` 312 :term:`BB_ALLOWED_NETWORKS`
313 Specifies a space-delimited list of hosts that the fetcher is allowed 313 Specifies a space-delimited list of hosts that the fetcher is allowed
314 to use to obtain the required source code. Following are 314 to use to obtain the required source code. Here are
315 considerations surrounding this variable: 315 considerations surrounding this variable:
316 316
317 - This host list is only used if :term:`BB_NO_NETWORK` is either not set 317 - This host list is only used if :term:`BB_NO_NETWORK` is either not set
@@ -6557,7 +6557,7 @@ system and gives an overview of their function and contents.
6557 The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of 6557 The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of
6558 the recipe you prefer to provide "virtual/kernel". 6558 the recipe you prefer to provide "virtual/kernel".
6559 6559
6560 Following are more examples:: 6560 Here are more examples::
6561 6561
6562 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" 6562 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
6563 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 6563 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
@@ -9391,7 +9391,7 @@ system and gives an overview of their function and contents.
9391 configuration can define the :term:`UBOOT_MACHINE` and optionally the 9391 configuration can define the :term:`UBOOT_MACHINE` and optionally the
9392 :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. 9392 :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`.
9393 9393
9394 Following is an example from the ``meta-freescale`` layer. :: 9394 Here is an example from the ``meta-freescale`` layer. ::
9395 9395
9396 UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" 9396 UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor"
9397 UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" 9397 UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig"
@@ -9929,7 +9929,7 @@ system and gives an overview of their function and contents.
9929 With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to 9929 With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to
9930 specify a list of additional dependencies (e.g. native tools, 9930 specify a list of additional dependencies (e.g. native tools,
9931 bootloaders, and so forth), that are required to build Wic images. 9931 bootloaders, and so forth), that are required to build Wic images.
9932 Following is an example:: 9932 Here is an example::
9933 9933
9934 WKS_FILE_DEPENDS = "some-native-tool" 9934 WKS_FILE_DEPENDS = "some-native-tool"
9935 9935
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index ad531cbf24..d06d6ec6b5 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -66,7 +66,7 @@ Follow these steps to locate and hand-install the toolchain:
66 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh 66 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
67 67
68#. *Run the Installer:* Be sure you have execution privileges and run 68#. *Run the Installer:* Be sure you have execution privileges and run
69 the installer. Following is an example from the ``Downloads`` 69 the installer. Here is an example from the ``Downloads``
70 directory:: 70 directory::
71 71
72 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh 72 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
@@ -165,12 +165,12 @@ build the SDK installer. Follow these steps:
165 variable inside your ``local.conf`` file before building the 165 variable inside your ``local.conf`` file before building the
166 SDK installer. Doing so ensures that the eventual SDK 166 SDK installer. Doing so ensures that the eventual SDK
167 installation process installs the appropriate library packages 167 installation process installs the appropriate library packages
168 as part of the SDK. Following is an example using ``libc`` 168 as part of the SDK. Here is an example using ``libc``
169 static development libraries: TOOLCHAIN_TARGET_TASK:append = " 169 static development libraries: TOOLCHAIN_TARGET_TASK:append = "
170 libc-staticdev" 170 libc-staticdev"
171 171
172#. *Run the Installer:* You can now run the SDK installer from 172#. *Run the Installer:* You can now run the SDK installer from
173 ``tmp/deploy/sdk`` in the :term:`Build Directory`. Following is an example:: 173 ``tmp/deploy/sdk`` in the :term:`Build Directory`. Here is an example::
174 174
175 $ cd poky/build/tmp/deploy/sdk 175 $ cd poky/build/tmp/deploy/sdk
176 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 176 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
@@ -235,7 +235,7 @@ Follow these steps to extract the root filesystem:
235 This script is located in the top-level directory in which you 235 This script is located in the top-level directory in which you
236 installed the toolchain (e.g. ``poky_sdk``). 236 installed the toolchain (e.g. ``poky_sdk``).
237 237
238 Following is an example based on the toolchain installed in the 238 Here is an example based on the toolchain installed in the
239 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section:: 239 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section::
240 240
241 $ source poky_sdk/environment-setup-core2-64-poky-linux 241 $ source poky_sdk/environment-setup-core2-64-poky-linux
@@ -243,7 +243,7 @@ Follow these steps to extract the root filesystem:
243#. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` 243#. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk``
244 command and provide the root filesystem image. 244 command and provide the root filesystem image.
245 245
246 Following is an example command that extracts the root filesystem 246 Here is an example command that extracts the root filesystem
247 from a previously built root filesystem image that was downloaded 247 from a previously built root filesystem image that was downloaded
248 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`. 248 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`.
249 This command extracts the root filesystem into the ``core2-64-sato`` 249 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 49aa921e70..e8fd191dbc 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 c5521edda1..a0c27499ba 100644
--- a/documentation/toaster-manual/setup-and-use.rst
+++ b/documentation/toaster-manual/setup-and-use.rst
@@ -365,7 +365,7 @@ Perform the following steps to install Toaster:
365 365
366 /etc/apache2/conf.d/toaster.conf 366 /etc/apache2/conf.d/toaster.conf
367 367
368 Following is a sample Apache configuration for Toaster you can follow: 368 Here is a sample Apache configuration for Toaster you can follow:
369 369
370 .. code-block:: apache 370 .. code-block:: apache
371 371
@@ -495,7 +495,7 @@ The Toaster web interface allows you to do the following:
495Toaster Web Interface Videos 495Toaster Web Interface Videos
496---------------------------- 496----------------------------
497 497
498Following are several videos that show how to use the Toaster GUI: 498Here are several videos that show how to use the Toaster GUI:
499 499
500- *Build Configuration:* This 500- *Build Configuration:* This
501 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and 501 `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and