manuals: suppress excess use of "following" word

To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.

In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.

In some cases too, completely remove the sentence, when
it's redundant with the preceding title.

(From yocto-docs rev: 2539f1b9cbf9bdd40eff93c6522dc76133debed7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Michael Opdenacker
2024-02-09 17:48:06 +01:00
committed by Steve Sakoman
parent 74ebddb921
commit fa870dfd0f
36 changed files with 92 additions and 116 deletions

View File

@@ -170,7 +170,7 @@ You can use the ``oe-pkgdata-util`` command-line utility to query
various package-related information. When you use the utility, you must
use it to view information on packages that have already been built.
Following are a few of the available ``oe-pkgdata-util`` subcommands.
Here are a few of the available ``oe-pkgdata-util`` subcommands.
.. note::
@@ -608,7 +608,7 @@ logs, keep in mind the goal is to have informative logs while keeping
the console as "silent" as possible. Also, if you want status messages
in the log, use the "debug" loglevel.
Following is an example written in Python. The code handles logging for
Here is an example written in Python. The code handles logging for
a function that determines the number of tasks needed to be run. See the
":ref:`ref-tasks-listtasks`"
section for additional information::
@@ -636,7 +636,7 @@ logs, you have the same goals --- informative with minimal console output.
The syntax you use for recipes written in Bash is similar to that of
recipes written in Python described in the previous section.
Following is an example written in Bash. The code logs the progress of
Here is an example written in Bash. The code logs the progress of
the ``do_my_function`` function::
do_my_function() {
@@ -1221,7 +1221,7 @@ Here are some other tips that you might find useful:
"$@"
}
Following are some usage examples::
Here are some usage examples::
$ g FOO # Search recursively for "FOO"
$ g -i foo # Search recursively for "foo", ignoring case