summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-05-06 19:17:57 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-05-13 11:28:34 +0100
commitd4a82b30b7d3622d5e3101aeb333bbdb31622176 (patch)
treead8ebb64f0363ad685ad6d6163cc4bf2ce4f535f
parentf3540fc691c12aca637ddea71bd0090ddcc40e19 (diff)
downloadpoky-d4a82b30b7d3622d5e3101aeb333bbdb31622176.tar.gz
manuals: reduce verbosity related to "the following" expression
(From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/README2
-rw-r--r--documentation/dev-manual/common-tasks.rst10
-rw-r--r--documentation/dev-manual/qemu.rst6
-rw-r--r--documentation/kernel-dev/common.rst4
-rw-r--r--documentation/kernel-dev/concepts-appx.rst3
-rw-r--r--documentation/kernel-dev/faq.rst2
-rw-r--r--documentation/overview-manual/intro.rst2
-rw-r--r--documentation/overview-manual/yp-intro.rst20
-rw-r--r--documentation/ref-manual/classes.rst2
-rw-r--r--documentation/ref-manual/features.rst2
-rw-r--r--documentation/ref-manual/system-requirements.rst10
-rw-r--r--documentation/ref-manual/variables.rst2
-rw-r--r--documentation/toaster-manual/reference.rst12
13 files changed, 36 insertions, 41 deletions
diff --git a/documentation/README b/documentation/README
index 176c6db35b..fddf4e706d 100644
--- a/documentation/README
+++ b/documentation/README
@@ -167,7 +167,7 @@ The layout of the Yocto Project manuals is organized as follows
167 Section 167 Section
168 Section 168 Section
169 169
170The following headings styles are defined in Sphinx: 170Here are the heading styles defined in Sphinx:
171 171
172 Book => overline === 172 Book => overline ===
173 Chapter => overline *** 173 Chapter => overline ***
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 4200b8dd61..5c3fc41772 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -2513,7 +2513,7 @@ chapter of the BitBake User Manual.
2513 syntax, although access to OpenEmbedded variables and internal 2513 syntax, although access to OpenEmbedded variables and internal
2514 methods are also available. 2514 methods are also available.
2515 2515
2516 The following is an example function from the ``sed`` recipe:: 2516 Here is an example function from the ``sed`` recipe::
2517 2517
2518 do_install () { 2518 do_install () {
2519 autotools_do_install 2519 autotools_do_install
@@ -7413,7 +7413,7 @@ The variable can contain multiple [one-line] metadata fields separated
7413by the literal sequence '\\n'. The separator can be redefined using the 7413by the literal sequence '\\n'. The separator can be redefined using the
7414variable flag ``separator``. 7414variable flag ``separator``.
7415 7415
7416The following is an example that adds two custom fields for ipk 7416Here is an example that adds two custom fields for ipk
7417packages:: 7417packages::
7418 7418
7419 PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets" 7419 PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets"
@@ -7844,7 +7844,7 @@ Build history information is kept in
7844``${``\ :term:`TOPDIR`\ ``}/buildhistory`` 7844``${``\ :term:`TOPDIR`\ ``}/buildhistory``
7845in the Build Directory as defined by the 7845in the Build Directory as defined by the
7846:term:`BUILDHISTORY_DIR` 7846:term:`BUILDHISTORY_DIR`
7847variable. The following is an example abbreviated listing: 7847variable. Here is an example abbreviated listing:
7848 7848
7849.. image:: figures/buildhistory.png 7849.. image:: figures/buildhistory.png
7850 :align: center 7850 :align: center
@@ -11058,7 +11058,7 @@ this function, you have to follow the following steps:
110583. Meta-spdxscanner provides several methods within the bbclass to create spdx files. 110583. Meta-spdxscanner provides several methods within the bbclass to create spdx files.
11059 Please choose one that you want to use and enable the spdx task. You have to 11059 Please choose one that you want to use and enable the spdx task. You have to
11060 add some config options in ``local.conf`` file in your :term:`Build 11060 add some config options in ``local.conf`` file in your :term:`Build
11061 Directory`. The following is an example showing how to generate spdx files 11061 Directory`. Here is an example showing how to generate spdx files
11062 during bitbake using the fossology-python.bbclass:: 11062 during bitbake using the fossology-python.bbclass::
11063 11063
11064 # Select fossology-python.bbclass. 11064 # Select fossology-python.bbclass.
@@ -11088,7 +11088,7 @@ package, by using the
11088variable. Using this variable also avoids QA errors when you use a 11088variable. Using this variable also avoids QA errors when you use a
11089non-common, non-CLOSED license in a recipe. 11089non-common, non-CLOSED license in a recipe.
11090 11090
11091The following is an example that uses the ``LICENSE.Abilis.txt`` file as 11091Here is an example that uses the ``LICENSE.Abilis.txt`` file as
11092the license from the fetched source:: 11092the license from the fetched source::
11093 11093
11094 NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" 11094 NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt"
diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst
index 2b6d3d76c7..f7366938dd 100644
--- a/documentation/dev-manual/qemu.rst
+++ b/documentation/dev-manual/qemu.rst
@@ -219,15 +219,15 @@ using an NFS server.
219 Should you need to start, stop, or restart the NFS share, you can use 219 Should you need to start, stop, or restart the NFS share, you can use
220 the following commands: 220 the following commands:
221 221
222 - The following command starts the NFS share:: 222 - To start the NFS share::
223 223
224 runqemu-export-rootfs start file-system-location 224 runqemu-export-rootfs start file-system-location
225 225
226 - The following command stops the NFS share:: 226 - To stop the NFS share::
227 227
228 runqemu-export-rootfs stop file-system-location 228 runqemu-export-rootfs stop file-system-location
229 229
230 - The following command restarts the NFS share:: 230 - To restart the NFS share::
231 231
232 runqemu-export-rootfs restart file-system-location 232 runqemu-export-rootfs restart file-system-location
233 233
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index cea3ce7405..0fede0c012 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -338,7 +338,7 @@ section:
338 the ``yocto-4.12`` branch. 338 the ``yocto-4.12`` branch.
339 339
340 The following commands show how to create a local copy of the 340 The following commands show how to create a local copy of the
341 ``yocto-kernel-cache`` and be in the ``yocto-4.12`` branch:: 341 ``yocto-kernel-cache`` and switch to the ``yocto-4.12`` branch::
342 342
343 $ cd ~ 343 $ cd ~
344 $ git clone git://git.yoctoproject.org/yocto-kernel-cache --branch yocto-4.12 344 $ git clone git://git.yoctoproject.org/yocto-kernel-cache --branch yocto-4.12
@@ -491,7 +491,7 @@ As an example, consider the following append file used by the BSPs in
491 491
492 meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend 492 meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend
493 493
494The following listing shows the file. Be aware that the actual commit ID 494Here are the contents of this file. Be aware that the actual commit ID
495strings in this example listing might be different than the actual 495strings in this example listing might be different than the actual
496strings in the file from the ``meta-yocto-bsp`` layer upstream. 496strings in the file from the ``meta-yocto-bsp`` layer upstream.
497:: 497::
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst
index 63e67315fa..2101f374cb 100644
--- a/documentation/kernel-dev/concepts-appx.rst
+++ b/documentation/kernel-dev/concepts-appx.rst
@@ -379,8 +379,7 @@ or non-hardware. To better show this, consider a situation where the
379 yocto-kernel-cache/ktypes/base/hardware.kcf 379 yocto-kernel-cache/ktypes/base/hardware.kcf
380 yocto-kernel-cache/bsp/qemu-ppc32/hardware.kcf 380 yocto-kernel-cache/bsp/qemu-ppc32/hardware.kcf
381 381
382The following list 382Here are explanations for the various files:
383provides explanations for the various files:
384 383
385- ``hardware.kcf``: Specifies a list of kernel Kconfig files that 384- ``hardware.kcf``: Specifies a list of kernel Kconfig files that
386 contain hardware options only. 385 contain hardware options only.
diff --git a/documentation/kernel-dev/faq.rst b/documentation/kernel-dev/faq.rst
index 8169511445..cffd1c4330 100644
--- a/documentation/kernel-dev/faq.rst
+++ b/documentation/kernel-dev/faq.rst
@@ -7,7 +7,7 @@ Kernel Development FAQ
7Common Questions and Solutions 7Common Questions and Solutions
8============================== 8==============================
9 9
10The following lists some solutions for common questions. 10Here are some solutions for common questions.
11 11
12How do I use my own Linux kernel ``.config`` file? 12How do I use my own Linux kernel ``.config`` file?
13-------------------------------------------------- 13--------------------------------------------------
diff --git a/documentation/overview-manual/intro.rst b/documentation/overview-manual/intro.rst
index a2afe77564..a8091771f4 100644
--- a/documentation/overview-manual/intro.rst
+++ b/documentation/overview-manual/intro.rst
@@ -12,7 +12,7 @@ introduces the Yocto Project by providing concepts, software overviews,
12best-known-methods (BKMs), and any other high-level introductory 12best-known-methods (BKMs), and any other high-level introductory
13information suitable for a new Yocto Project user. 13information suitable for a new Yocto Project user.
14 14
15The following list describes what you can get from this manual: 15Here is what you can get from this manual:
16 16
17- :ref:`overview-manual/yp-intro:introducing the yocto project`\ *:* 17- :ref:`overview-manual/yp-intro:introducing the yocto project`\ *:*
18 This chapter provides an introduction to the Yocto Project. You will learn 18 This chapter provides an introduction to the Yocto Project. You will learn
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index fca02e4cec..7a01828c5f 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -38,8 +38,7 @@ to the Yocto Project.
38Features 38Features
39-------- 39--------
40 40
41The following list describes features and advantages of the Yocto 41Here are features and advantages of the Yocto Project:
42Project:
43 42
44- *Widely Adopted Across the Industry:* Many semiconductor, operating 43- *Widely Adopted Across the Industry:* Many semiconductor, operating
45 system, software, and service vendors adopt and support the Yocto 44 system, software, and service vendors adopt and support the Yocto
@@ -137,8 +136,7 @@ Project:
137Challenges 136Challenges
138---------- 137----------
139 138
140The following list presents challenges you might encounter when 139Here are challenges you might encounter when developing using the Yocto Project:
141developing using the Yocto Project:
142 140
143- *Steep Learning Curve:* The Yocto Project has a steep learning curve 141- *Steep Learning Curve:* The Yocto Project has a steep learning curve
144 and has many different ways to accomplish similar tasks. It can be 142 and has many different ways to accomplish similar tasks. It can be
@@ -292,8 +290,8 @@ associated with the Yocto Project.
292Development Tools 290Development Tools
293----------------- 291-----------------
294 292
295The following list consists of tools that help you develop images and 293Here are tools that help you develop images and applications using
296applications using the Yocto Project: 294the Yocto Project:
297 295
298- *CROPS:* `CROPS <https://github.com/crops/poky-container/>`__ is an 296- *CROPS:* `CROPS <https://github.com/crops/poky-container/>`__ is an
299 open source, cross-platform development framework that leverages 297 open source, cross-platform development framework that leverages
@@ -347,8 +345,8 @@ applications using the Yocto Project:
347Production Tools 345Production Tools
348---------------- 346----------------
349 347
350The following list consists of tools that help production related 348Here are tools that help with production related activities using the
351activities using the Yocto Project: 349Yocto Project:
352 350
353- *Auto Upgrade Helper:* This utility when used in conjunction with the 351- *Auto Upgrade Helper:* This utility when used in conjunction with the
354 :term:`OpenEmbedded Build System` 352 :term:`OpenEmbedded Build System`
@@ -444,8 +442,7 @@ activities using the Yocto Project:
444Open-Embedded Build System Components 442Open-Embedded Build System Components
445------------------------------------- 443-------------------------------------
446 444
447The following list consists of components associated with the 445Here are components associated with the :term:`OpenEmbedded Build System`:
448:term:`OpenEmbedded Build System`:
449 446
450- *BitBake:* BitBake is a core component of the Yocto Project and is 447- *BitBake:* BitBake is a core component of the Yocto Project and is
451 used by the OpenEmbedded build system to build images. While BitBake 448 used by the OpenEmbedded build system to build images. While BitBake
@@ -511,8 +508,7 @@ section.
511Packages for Finished Targets 508Packages for Finished Targets
512----------------------------- 509-----------------------------
513 510
514The following lists components associated with packages for finished 511Here are components associated with packages for finished targets:
515targets:
516 512
517- *Matchbox:* Matchbox is an Open Source, base environment for the X 513- *Matchbox:* Matchbox is an Open Source, base environment for the X
518 Window System running on non-desktop, embedded platforms such as 514 Window System running on non-desktop, embedded platforms such as
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index a6347449f1..ffa17139fe 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1009,7 +1009,7 @@ Please keep in mind that the QA checks
1009exist in order to detect real or potential problems in the packaged 1009exist in order to detect real or potential problems in the packaged
1010output. So exercise caution when disabling these checks. 1010output. So exercise caution when disabling these checks.
1011 1011
1012The following list shows the tests you can list with the ``WARN_QA`` and 1012Here are the tests you can list with the ``WARN_QA`` and
1013``ERROR_QA`` variables: 1013``ERROR_QA`` variables:
1014 1014
1015- ``already-stripped:`` Checks that produced binaries have not 1015- ``already-stripped:`` Checks that produced binaries have not
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index eb4947d594..31d24b8c28 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -196,7 +196,7 @@ you can add several different predefined packages such as development
196utilities or packages with debug information needed to investigate 196utilities or packages with debug information needed to investigate
197application problems or profile applications. 197application problems or profile applications.
198 198
199The following image features are available for all images: 199Here are the image features available for all images:
200 200
201- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root 201- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root
202 logins and logins from accounts having an empty password string. 202 logins and logins from accounts having an empty password string.
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 4fa4d3ef52..fc251945db 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -111,7 +111,7 @@ function.
111Ubuntu and Debian 111Ubuntu and Debian
112----------------- 112-----------------
113 113
114The following list shows the required packages by function given a 114Here are the required packages by function given a
115supported Ubuntu or Debian Linux distribution: 115supported Ubuntu or Debian Linux distribution:
116 116
117.. note:: 117.. note::
@@ -150,7 +150,7 @@ supported Ubuntu or Debian Linux distribution:
150Fedora Packages 150Fedora Packages
151--------------- 151---------------
152 152
153The following list shows the required packages by function given a 153Here are the required packages by function given a
154supported Fedora Linux distribution: 154supported Fedora Linux distribution:
155 155
156- *Essentials:* Packages needed to build an image for a headless 156- *Essentials:* Packages needed to build an image for a headless
@@ -167,7 +167,7 @@ supported Fedora Linux distribution:
167openSUSE Packages 167openSUSE Packages
168----------------- 168-----------------
169 169
170The following list shows the required packages by function given a 170Here are the required packages by function given a
171supported openSUSE Linux distribution: 171supported openSUSE Linux distribution:
172 172
173- *Essentials:* Packages needed to build an image for a headless 173- *Essentials:* Packages needed to build an image for a headless
@@ -185,7 +185,7 @@ supported openSUSE Linux distribution:
185CentOS-7 Packages 185CentOS-7 Packages
186----------------- 186-----------------
187 187
188The following list shows the required packages by function given a 188Here are the required packages by function given a
189supported CentOS-7 Linux distribution: 189supported CentOS-7 Linux distribution:
190 190
191- *Essentials:* Packages needed to build an image for a headless 191- *Essentials:* Packages needed to build an image for a headless
@@ -212,7 +212,7 @@ supported CentOS-7 Linux distribution:
212CentOS-8 Packages 212CentOS-8 Packages
213----------------- 213-----------------
214 214
215The following list shows the required packages by function given a 215Here are the required packages by function given a
216supported CentOS-8 Linux distribution: 216supported CentOS-8 Linux distribution:
217 217
218- *Essentials:* Packages needed to build an image for a headless 218- *Essentials:* Packages needed to build an image for a headless
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 957362bb6d..0b61f77cb4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4754,7 +4754,7 @@ system and gives an overview of their function and contents.
4754 4754
4755 NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" 4755 NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source"
4756 4756
4757 The following is an example that 4757 Here is an example that
4758 uses the ``LICENSE.Abilis.txt`` file as the license from the fetched 4758 uses the ``LICENSE.Abilis.txt`` file as the license from the fetched
4759 source:: 4759 source::
4760 4760
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index 5d52c449cd..988a262188 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -186,7 +186,7 @@ Configuring the Workflow
186------------------------ 186------------------------
187 187
188The ``bldcontrol/management/commands/checksettings.py`` file controls 188The ``bldcontrol/management/commands/checksettings.py`` file controls
189workflow configuration. The following steps outline the process to 189workflow configuration. Here is the process to
190initially populate this database. 190initially populate this database.
191 191
1921. The default project settings are set from 1921. The default project settings are set from
@@ -237,7 +237,7 @@ The following example sets "name" to "CUSTOM_XML_ONLY" and its value to
237Understanding Fixture File Format 237Understanding Fixture File Format
238--------------------------------- 238---------------------------------
239 239
240The following is an overview of the file format used by the 240Here is an overview of the file format used by the
241``oe-core.xml``, ``poky.xml``, and ``custom.xml`` files. 241``oe-core.xml``, ``poky.xml``, and ``custom.xml`` files.
242 242
243The following subsections describe each of the sections in the fixture 243The following subsections describe each of the sections in the fixture
@@ -407,7 +407,7 @@ To get the status of pending builds, use the following call::
407Be sure to provide values for host and port. The output is a JSON file that 407Be sure to provide values for host and port. The output is a JSON file that
408itemizes all builds in progress. This file includes the time in seconds since 408itemizes all builds in progress. This file includes the time in seconds since
409each respective build started as well as the progress of the cloning, parsing, 409each respective build started as well as the progress of the cloning, parsing,
410and task execution. The following is sample output for a build in progress: 410and task execution. Here is sample output for a build in progress:
411 411
412.. code-block:: JSON 412.. code-block:: JSON
413 413
@@ -440,8 +440,8 @@ call::
440 http://host:port/toastergui/api/builds 440 http://host:port/toastergui/api/builds
441 441
442Be sure to provide values for host and port. The output is a JSON file that 442Be sure to provide values for host and port. The output is a JSON file that
443itemizes all complete builds, and includes build summary information. The 443itemizes all complete builds, and includes build summary information. Here
444following is sample output for a completed build: 444is sample output for a completed build:
445 445
446.. code-block:: JSON 446.. code-block:: JSON
447 447
@@ -479,7 +479,7 @@ Completed query. See the ":ref:`toaster-manual/reference:checking status of buil
479section for more information. 479section for more information.
480 480
481The output is a JSON file that itemizes the specific build and includes 481The output is a JSON file that itemizes the specific build and includes
482build summary information. The following is sample output for a specific 482build summary information. Here is sample output for a specific
483build: 483build:
484 484
485.. code-block:: JSON 485.. code-block:: JSON