diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-05-04 11:22:40 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-05-10 12:52:35 +0100 |
commit | 14c7cd24a579c00e18ad20e367e479389107da26 (patch) | |
tree | 68136bd52e8cc63ed742b8a50a27059595b56a38 /documentation/overview-manual/concepts.rst | |
parent | 6a92d985e55f3947e988b71792bb298ed232b7ad (diff) | |
download | poky-14c7cd24a579c00e18ad20e367e479389107da26.tar.gz |
manuals: improve the width of diagrams
Better for EPUB output in particular
- Make some diagrams wider when necessary
- Remove ":align: center" when we have ":width: 100%"
- Update the standards.md files to mention this
(From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/concepts.rst')
-rw-r--r-- | documentation/overview-manual/concepts.rst | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 6c341976f9..7b056acc87 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -166,7 +166,7 @@ remainder of this section expands on the fundamental input, output, | |||
166 | process, and metadata logical blocks that make up the workflow. | 166 | process, and metadata logical blocks that make up the workflow. |
167 | 167 | ||
168 | .. image:: figures/YP-flow-diagram.png | 168 | .. image:: figures/YP-flow-diagram.png |
169 | :align: center | 169 | :width: 100% |
170 | 170 | ||
171 | In general, the build's workflow consists of several functional areas: | 171 | In general, the build's workflow consists of several functional areas: |
172 | 172 | ||
@@ -209,7 +209,7 @@ Configuration" box of the :ref:`general workflow | |||
209 | figure <overview-manual/concepts:openembedded build system concepts>`: | 209 | figure <overview-manual/concepts:openembedded build system concepts>`: |
210 | 210 | ||
211 | .. image:: figures/user-configuration.png | 211 | .. image:: figures/user-configuration.png |
212 | :align: center | 212 | :width: 100% |
213 | 213 | ||
214 | BitBake needs some basic configuration files in order to complete a | 214 | BitBake needs some basic configuration files in order to complete a |
215 | build. These files are ``*.conf`` files. The minimally necessary ones | 215 | build. These files are ``*.conf`` files. The minimally necessary ones |
@@ -401,6 +401,7 @@ layers from the :ref:`general workflow figure | |||
401 | 401 | ||
402 | .. image:: figures/layer-input.png | 402 | .. image:: figures/layer-input.png |
403 | :align: center | 403 | :align: center |
404 | :width: 70% | ||
404 | 405 | ||
405 | In general, all layers have a similar structure. They all contain a | 406 | In general, all layers have a similar structure. They all contain a |
406 | licensing file (e.g. ``COPYING.MIT``) if the layer is to be distributed, | 407 | licensing file (e.g. ``COPYING.MIT``) if the layer is to be distributed, |
@@ -551,6 +552,7 @@ area of the :ref:`general workflow figure <overview-manual/concepts:openembedded | |||
551 | 552 | ||
552 | .. image:: figures/source-input.png | 553 | .. image:: figures/source-input.png |
553 | :align: center | 554 | :align: center |
555 | :width: 70% | ||
554 | 556 | ||
555 | Upstream Project Releases | 557 | Upstream Project Releases |
556 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 558 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -629,7 +631,7 @@ This section looks a little closer into the package feeds area used by | |||
629 | the build system. Here is a more detailed look at the area: | 631 | the build system. Here is a more detailed look at the area: |
630 | 632 | ||
631 | .. image:: figures/package-feeds.png | 633 | .. image:: figures/package-feeds.png |
632 | :align: center | 634 | :width: 100% |
633 | 635 | ||
634 | Package feeds are an intermediary step in the build process. The | 636 | Package feeds are an intermediary step in the build process. The |
635 | OpenEmbedded build system provides classes to generate different package | 637 | OpenEmbedded build system provides classes to generate different package |
@@ -702,7 +704,7 @@ The first stages of building a recipe are to fetch and unpack the source | |||
702 | code: | 704 | code: |
703 | 705 | ||
704 | .. image:: figures/source-fetching.png | 706 | .. image:: figures/source-fetching.png |
705 | :align: center | 707 | :width: 100% |
706 | 708 | ||
707 | The :ref:`ref-tasks-fetch` and | 709 | The :ref:`ref-tasks-fetch` and |
708 | :ref:`ref-tasks-unpack` tasks fetch | 710 | :ref:`ref-tasks-unpack` tasks fetch |
@@ -790,7 +792,7 @@ Once source code is fetched and unpacked, BitBake locates patch files | |||
790 | and applies them to the source files: | 792 | and applies them to the source files: |
791 | 793 | ||
792 | .. image:: figures/patching.png | 794 | .. image:: figures/patching.png |
793 | :align: center | 795 | :width: 100% |
794 | 796 | ||
795 | The :ref:`ref-tasks-patch` task uses a | 797 | The :ref:`ref-tasks-patch` task uses a |
796 | recipe's :term:`SRC_URI` statements | 798 | recipe's :term:`SRC_URI` statements |
@@ -831,7 +833,7 @@ compile the source code. Once compilation occurs, the files are copied | |||
831 | to a holding area (staged) in preparation for packaging: | 833 | to a holding area (staged) in preparation for packaging: |
832 | 834 | ||
833 | .. image:: figures/configuration-compile-autoreconf.png | 835 | .. image:: figures/configuration-compile-autoreconf.png |
834 | :align: center | 836 | :width: 100% |
835 | 837 | ||
836 | This step in the build process consists of the following tasks: | 838 | This step in the build process consists of the following tasks: |
837 | 839 | ||
@@ -889,7 +891,7 @@ After source code is configured, compiled, and staged, the build system | |||
889 | analyzes the results and splits the output into packages: | 891 | analyzes the results and splits the output into packages: |
890 | 892 | ||
891 | .. image:: figures/analysis-for-package-splitting.png | 893 | .. image:: figures/analysis-for-package-splitting.png |
892 | :align: center | 894 | :width: 100% |
893 | 895 | ||
894 | The :ref:`ref-tasks-package` and | 896 | The :ref:`ref-tasks-package` and |
895 | :ref:`ref-tasks-packagedata` | 897 | :ref:`ref-tasks-packagedata` |
@@ -968,7 +970,7 @@ Once packages are split and stored in the Package Feeds area, the build | |||
968 | system uses BitBake to generate the root filesystem image: | 970 | system uses BitBake to generate the root filesystem image: |
969 | 971 | ||
970 | .. image:: figures/image-generation.png | 972 | .. image:: figures/image-generation.png |
971 | :align: center | 973 | :width: 100% |
972 | 974 | ||
973 | The image generation process consists of several stages and depends on | 975 | The image generation process consists of several stages and depends on |
974 | several tasks and variables. The | 976 | several tasks and variables. The |
@@ -1086,7 +1088,7 @@ Development Kit (SDK) installer scripts for both the standard SDK and | |||
1086 | the extensible SDK (eSDK): | 1088 | the extensible SDK (eSDK): |
1087 | 1089 | ||
1088 | .. image:: figures/sdk-generation.png | 1090 | .. image:: figures/sdk-generation.png |
1089 | :align: center | 1091 | :width: 100% |
1090 | 1092 | ||
1091 | .. note:: | 1093 | .. note:: |
1092 | 1094 | ||
@@ -1262,6 +1264,7 @@ this output: | |||
1262 | 1264 | ||
1263 | .. image:: figures/images.png | 1265 | .. image:: figures/images.png |
1264 | :align: center | 1266 | :align: center |
1267 | :width: 75% | ||
1265 | 1268 | ||
1266 | .. note:: | 1269 | .. note:: |
1267 | 1270 | ||
@@ -1321,7 +1324,7 @@ SDK (e.g. ``bitbake -c populate_sdk_ext`` imagename) or a standard SDK | |||
1321 | closer look at this output: | 1324 | closer look at this output: |
1322 | 1325 | ||
1323 | .. image:: figures/sdk.png | 1326 | .. image:: figures/sdk.png |
1324 | :align: center | 1327 | :width: 100% |
1325 | 1328 | ||
1326 | The specific form of this output is a set of files that includes a | 1329 | The specific form of this output is a set of files that includes a |
1327 | self-extracting SDK installer (``*.sh``), host and target manifest | 1330 | self-extracting SDK installer (``*.sh``), host and target manifest |
@@ -1439,7 +1442,7 @@ The following figure shows a high-level build environment regarding | |||
1439 | toolchain construction and use. | 1442 | toolchain construction and use. |
1440 | 1443 | ||
1441 | .. image:: figures/cross-development-toolchains.png | 1444 | .. image:: figures/cross-development-toolchains.png |
1442 | :align: center | 1445 | :width: 100% |
1443 | 1446 | ||
1444 | Most of the work occurs on the Build Host. This is the machine used to | 1447 | Most of the work occurs on the Build Host. This is the machine used to |
1445 | build images and generally work within the the Yocto Project | 1448 | build images and generally work within the the Yocto Project |