diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-02-09 17:48:06 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-02-24 16:13:28 +0000 |
commit | 025386d53ceef681d7e829ad184b6850af55619c (patch) | |
tree | 720a253731442d2b84ed443c8b143fdc23dfc493 /documentation/dev-manual/debugging.rst | |
parent | 67efdd63c2b1d94bdc4a8da2895b3f7186e7a7c4 (diff) | |
download | poky-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/dev-manual/debugging.rst')
-rw-r--r-- | documentation/dev-manual/debugging.rst | 8 |
1 files changed, 4 insertions, 4 deletions
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 | |||
170 | various package-related information. When you use the utility, you must | 170 | various package-related information. When you use the utility, you must |
171 | use it to view information on packages that have already been built. | 171 | use it to view information on packages that have already been built. |
172 | 172 | ||
173 | Following are a few of the available ``oe-pkgdata-util`` subcommands. | 173 | Here 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 | |||
608 | the console as "silent" as possible. Also, if you want status messages | 608 | the console as "silent" as possible. Also, if you want status messages |
609 | in the log, use the "debug" loglevel. | 609 | in the log, use the "debug" loglevel. |
610 | 610 | ||
611 | Following is an example written in Python. The code handles logging for | 611 | Here is an example written in Python. The code handles logging for |
612 | a function that determines the number of tasks needed to be run. See the | 612 | a function that determines the number of tasks needed to be run. See the |
613 | ":ref:`ref-tasks-listtasks`" | 613 | ":ref:`ref-tasks-listtasks`" |
614 | section for additional information:: | 614 | section for additional information:: |
@@ -636,7 +636,7 @@ logs, you have the same goals --- informative with minimal console output. | |||
636 | The syntax you use for recipes written in Bash is similar to that of | 636 | The syntax you use for recipes written in Bash is similar to that of |
637 | recipes written in Python described in the previous section. | 637 | recipes written in Python described in the previous section. |
638 | 638 | ||
639 | Following is an example written in Bash. The code logs the progress of | 639 | Here is an example written in Bash. The code logs the progress of |
640 | the ``do_my_function`` function:: | 640 | the ``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 |