summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/debugging.rst
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/dev-manual/debugging.rst
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/dev-manual/debugging.rst')
-rw-r--r--documentation/dev-manual/debugging.rst8
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
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