summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-02-09 17:48:06 +0100
committerSteve Sakoman <steve@sakoman.com>2024-03-01 05:19:54 -1000
commitfa870dfd0fd760ec1ab0342f5c82851c043f3eaf (patch)
treec6993e569b3e007213425a31a1aff8761c413dfc /documentation/overview-manual
parent74ebddb9219e02cd300630a550353560768ed77e (diff)
downloadpoky-fa870dfd0fd760ec1ab0342f5c82851c043f3eaf.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: 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>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r--documentation/overview-manual/concepts.rst23
-rw-r--r--documentation/overview-manual/yp-intro.rst2
2 files changed, 12 insertions, 13 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 371c73418a..3e80d6fddd 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`"
38section of the Yocto Project Development Tasks Manual. 38section of the Yocto Project Development Tasks Manual.
39 39
40Following are some brief details on these core components. For 40Here are some brief details on these core components. For
41additional information on how these components interact during a build, 41additional information on how these components interact during a build,
42see the 42see the
43":ref:`overview-manual/concepts:openembedded build system concepts`" 43":ref:`overview-manual/concepts:openembedded build system concepts`"
@@ -1351,10 +1351,9 @@ can initialize the environment before using the tools.
1351 the :doc:`/sdk-manual/index` manual. 1351 the :doc:`/sdk-manual/index` manual.
1352 1352
1353All the output files for an SDK are written to the ``deploy/sdk`` folder 1353All the output files for an SDK are written to the ``deploy/sdk`` folder
1354inside the :term:`Build Directory` as 1354inside the :term:`Build Directory` as shown in the previous figure. Depending
1355shown in the previous figure. Depending on the type of SDK, there are 1355on the type of SDK, there are several variables to configure these files.
1356several variables to configure these files. Here are the variables 1356The variables associated with an extensible SDK are:
1357associated with an extensible SDK:
1358 1357
1359- :term:`DEPLOY_DIR`: Points to 1358- :term:`DEPLOY_DIR`: Points to
1360 the ``deploy`` directory. 1359 the ``deploy`` directory.
@@ -2279,7 +2278,7 @@ which is integrating ``sayhello`` in our root file system:
2279#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into 2278#. Add ``sayhello`` to :term:`IMAGE_INSTALL` to integrate it into
2280 the root file system 2279 the root file system
2281 2280
2282The following are the contents of ``libhello/Makefile``:: 2281The contents of ``libhello/Makefile`` are::
2283 2282
2284 LIB=libhello.so 2283 LIB=libhello.so
2285 2284
@@ -2307,7 +2306,7 @@ The following are the contents of ``libhello/Makefile``::
2307 and ``CFLAGS`` as BitBake will set them as environment variables according 2306 and ``CFLAGS`` as BitBake will set them as environment variables according
2308 to your build configuration. 2307 to your build configuration.
2309 2308
2310The following are the contents of ``libhello/hellolib.h``:: 2309The contents of ``libhello/hellolib.h`` are::
2311 2310
2312 #ifndef HELLOLIB_H 2311 #ifndef HELLOLIB_H
2313 #define HELLOLIB_H 2312 #define HELLOLIB_H
@@ -2316,7 +2315,7 @@ The following are the contents of ``libhello/hellolib.h``::
2316 2315
2317 #endif 2316 #endif
2318 2317
2319The following are the contents of ``libhello/hellolib.c``:: 2318The contents of ``libhello/hellolib.c`` are::
2320 2319
2321 #include <stdio.h> 2320 #include <stdio.h>
2322 2321
@@ -2324,7 +2323,7 @@ The following are the contents of ``libhello/hellolib.c``::
2324 puts("Hello from a Yocto demo \n"); 2323 puts("Hello from a Yocto demo \n");
2325 } 2324 }
2326 2325
2327The following are the contents of ``sayhello/Makefile``:: 2326The contents of ``sayhello/Makefile`` are::
2328 2327
2329 EXEC=sayhello 2328 EXEC=sayhello
2330 LDFLAGS += -lhello 2329 LDFLAGS += -lhello
@@ -2337,7 +2336,7 @@ The following are the contents of ``sayhello/Makefile``::
2337 clean: 2336 clean:
2338 rm -rf $(EXEC) *.o 2337 rm -rf $(EXEC) *.o
2339 2338
2340The following are the contents of ``sayhello/sayhello.c``:: 2339The contents of ``sayhello/sayhello.c`` are::
2341 2340
2342 #include <hellolib.h> 2341 #include <hellolib.h>
2343 2342
@@ -2346,7 +2345,7 @@ The following are the contents of ``sayhello/sayhello.c``::
2346 return 0; 2345 return 0;
2347 } 2346 }
2348 2347
2349The following are the contents of ``libhello_0.1.bb``:: 2348The contents of ``libhello_0.1.bb`` are::
2350 2349
2351 SUMMARY = "Hello demo library" 2350 SUMMARY = "Hello demo library"
2352 DESCRIPTION = "Hello shared library used in Yocto demo" 2351 DESCRIPTION = "Hello shared library used in Yocto demo"
@@ -2369,7 +2368,7 @@ The following are the contents of ``libhello_0.1.bb``::
2369 oe_soinstall ${PN}.so.${PV} ${D}${libdir} 2368 oe_soinstall ${PN}.so.${PV} ${D}${libdir}
2370 } 2369 }
2371 2370
2372The following are the contents of ``sayhello_0.1.bb``:: 2371The contents of ``sayhello_0.1.bb`` are::
2373 2372
2374 SUMMARY = "SayHello demo" 2373 SUMMARY = "SayHello demo"
2375 DESCRIPTION = "SayHello project used in Yocto demo" 2374 DESCRIPTION = "SayHello project used in Yocto demo"
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index f7cd2486af..3dc8ae5519 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -742,7 +742,7 @@ workflow:
742.. image:: figures/YP-flow-diagram.png 742.. image:: figures/YP-flow-diagram.png
743 :align: center 743 :align: center
744 744
745Following is a brief summary of the "workflow": 745Here is a brief summary of the "workflow":
746 746
7471. Developers specify architecture, policies, patches and configuration 7471. Developers specify architecture, policies, patches and configuration
748 details. 748 details.