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/overview-manual | |
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/overview-manual')
-rw-r--r-- | documentation/overview-manual/concepts.rst | 18 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 |
2 files changed, 10 insertions, 10 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index d335c2fcdd..d177ca33b7 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -37,7 +37,7 @@ to each data source as a layer. For information on layers, see the | |||
37 | ":ref:`dev-manual/layers:understanding and creating layers`" | 37 | ":ref:`dev-manual/layers:understanding and creating layers`" |
38 | section of the Yocto Project Development Tasks Manual. | 38 | section of the Yocto Project Development Tasks Manual. |
39 | 39 | ||
40 | Following are some brief details on these core components. For | 40 | Here are some brief details on these core components. For |
41 | additional information on how these components interact during a build, | 41 | additional information on how these components interact during a build, |
42 | see the | 42 | see the |
43 | ":ref:`overview-manual/concepts:openembedded build system concepts`" | 43 | ":ref:`overview-manual/concepts:openembedded build system concepts`" |
@@ -1321,7 +1321,7 @@ can initialize the environment before using the tools. | |||
1321 | All the output files for an SDK are written to the ``deploy/sdk`` folder | 1321 | All the output files for an SDK are written to the ``deploy/sdk`` folder |
1322 | inside the :term:`Build Directory` as shown in the previous figure. Depending | 1322 | inside the :term:`Build Directory` as shown in the previous figure. Depending |
1323 | on the type of SDK, there are several variables to configure these files. | 1323 | on the type of SDK, there are several variables to configure these files. |
1324 | Here are the variables associated with an extensible SDK: | 1324 | The variables associated with an extensible SDK are: |
1325 | 1325 | ||
1326 | - :term:`DEPLOY_DIR`: Points to | 1326 | - :term:`DEPLOY_DIR`: Points to |
1327 | the ``deploy`` directory. | 1327 | the ``deploy`` directory. |
@@ -2238,7 +2238,7 @@ which is integrating ``sayhello`` in our root file system: | |||
2238 | #. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into | 2238 | #. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into |
2239 | the root file system | 2239 | the root file system |
2240 | 2240 | ||
2241 | The following are the contents of ``libhello/Makefile``:: | 2241 | The contents of ``libhello/Makefile`` are:: |
2242 | 2242 | ||
2243 | LIB=libhello.so | 2243 | LIB=libhello.so |
2244 | 2244 | ||
@@ -2266,7 +2266,7 @@ The following are the contents of ``libhello/Makefile``:: | |||
2266 | and ``CFLAGS`` as BitBake will set them as environment variables according | 2266 | and ``CFLAGS`` as BitBake will set them as environment variables according |
2267 | to your build configuration. | 2267 | to your build configuration. |
2268 | 2268 | ||
2269 | The following are the contents of ``libhello/hellolib.h``:: | 2269 | The contents of ``libhello/hellolib.h`` are:: |
2270 | 2270 | ||
2271 | #ifndef HELLOLIB_H | 2271 | #ifndef HELLOLIB_H |
2272 | #define HELLOLIB_H | 2272 | #define HELLOLIB_H |
@@ -2275,7 +2275,7 @@ The following are the contents of ``libhello/hellolib.h``:: | |||
2275 | 2275 | ||
2276 | #endif | 2276 | #endif |
2277 | 2277 | ||
2278 | The following are the contents of ``libhello/hellolib.c``:: | 2278 | The contents of ``libhello/hellolib.c`` are:: |
2279 | 2279 | ||
2280 | #include <stdio.h> | 2280 | #include <stdio.h> |
2281 | 2281 | ||
@@ -2283,7 +2283,7 @@ The following are the contents of ``libhello/hellolib.c``:: | |||
2283 | puts("Hello from a Yocto demo \n"); | 2283 | puts("Hello from a Yocto demo \n"); |
2284 | } | 2284 | } |
2285 | 2285 | ||
2286 | The following are the contents of ``sayhello/Makefile``:: | 2286 | The contents of ``sayhello/Makefile`` are:: |
2287 | 2287 | ||
2288 | EXEC=sayhello | 2288 | EXEC=sayhello |
2289 | LDFLAGS += -lhello | 2289 | LDFLAGS += -lhello |
@@ -2296,7 +2296,7 @@ The following are the contents of ``sayhello/Makefile``:: | |||
2296 | clean: | 2296 | clean: |
2297 | rm -rf $(EXEC) *.o | 2297 | rm -rf $(EXEC) *.o |
2298 | 2298 | ||
2299 | The following are the contents of ``sayhello/sayhello.c``:: | 2299 | The contents of ``sayhello/sayhello.c`` are:: |
2300 | 2300 | ||
2301 | #include <hellolib.h> | 2301 | #include <hellolib.h> |
2302 | 2302 | ||
@@ -2305,7 +2305,7 @@ The following are the contents of ``sayhello/sayhello.c``:: | |||
2305 | return 0; | 2305 | return 0; |
2306 | } | 2306 | } |
2307 | 2307 | ||
2308 | The following are the contents of ``libhello_0.1.bb``:: | 2308 | The contents of ``libhello_0.1.bb`` are:: |
2309 | 2309 | ||
2310 | SUMMARY = "Hello demo library" | 2310 | SUMMARY = "Hello demo library" |
2311 | DESCRIPTION = "Hello shared library used in Yocto demo" | 2311 | DESCRIPTION = "Hello shared library used in Yocto demo" |
@@ -2328,7 +2328,7 @@ The following are the contents of ``libhello_0.1.bb``:: | |||
2328 | oe_soinstall ${PN}.so.${PV} ${D}${libdir} | 2328 | oe_soinstall ${PN}.so.${PV} ${D}${libdir} |
2329 | } | 2329 | } |
2330 | 2330 | ||
2331 | The following are the contents of ``sayhello_0.1.bb``:: | 2331 | The contents of ``sayhello_0.1.bb`` are:: |
2332 | 2332 | ||
2333 | SUMMARY = "SayHello demo" | 2333 | SUMMARY = "SayHello demo" |
2334 | DESCRIPTION = "SayHello project used in Yocto demo" | 2334 | DESCRIPTION = "SayHello project used in Yocto demo" |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 1e6820c14e..4a27e12e01 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -737,7 +737,7 @@ workflow: | |||
737 | .. image:: figures/YP-flow-diagram.png | 737 | .. image:: figures/YP-flow-diagram.png |
738 | :width: 100% | 738 | :width: 100% |
739 | 739 | ||
740 | Following is a brief summary of the "workflow": | 740 | Here is a brief summary of the "workflow": |
741 | 741 | ||
742 | #. Developers specify architecture, policies, patches and configuration | 742 | #. Developers specify architecture, policies, patches and configuration |
743 | details. | 743 | details. |