summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
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/ref-manual
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/ref-manual')
-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
9 files changed, 21 insertions, 21 deletions
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