diff options
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 1 | ||||
| -rw-r--r-- | documentation/dev-manual/common-tasks.rst | 9 | ||||
| -rw-r--r-- | documentation/kernel-dev/concepts-appx.rst | 3 | ||||
| -rw-r--r-- | documentation/kernel-dev/intro.rst | 2 | ||||
| -rw-r--r-- | documentation/overview-manual/concepts.rst | 25 | ||||
| -rw-r--r-- | documentation/overview-manual/development-environment.rst | 5 | ||||
| -rw-r--r-- | documentation/overview-manual/yp-intro.rst | 6 | ||||
| -rw-r--r-- | documentation/profile-manual/usage.rst | 22 | ||||
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 3 | ||||
| -rw-r--r-- | documentation/sdk-manual/appendix-obtain.rst | 3 | ||||
| -rw-r--r-- | documentation/sdk-manual/extensible.rst | 6 | ||||
| -rw-r--r-- | documentation/sdk-manual/intro.rst | 2 | ||||
| -rw-r--r-- | documentation/sdk-manual/working-projects.rst | 2 | ||||
| -rw-r--r-- | documentation/standards.md | 10 | ||||
| -rw-r--r-- | documentation/test-manual/intro.rst | 1 | ||||
| -rw-r--r-- | documentation/toaster-manual/intro.rst | 2 | ||||
| -rw-r--r-- | documentation/what-i-wish-id-known.rst | 1 |
17 files changed, 72 insertions, 31 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 8ec7f2957e..280b160807 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
| @@ -725,6 +725,7 @@ workflow. | |||
| 725 | 725 | ||
| 726 | .. image:: figures/bsp-dev-flow.png | 726 | .. image:: figures/bsp-dev-flow.png |
| 727 | :align: center | 727 | :align: center |
| 728 | :width: 70% | ||
| 728 | 729 | ||
| 729 | #. *Set up Your Host Development System to Support Development Using the | 730 | #. *Set up Your Host Development System to Support Development Using the |
| 730 | Yocto Project*: See the ":ref:`dev-manual/start:preparing the build host`" | 731 | Yocto Project*: See the ":ref:`dev-manual/start:preparing the build host`" |
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 9b5a7536c1..f7632a5735 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
| @@ -1125,6 +1125,7 @@ The remainder of the section provides details for the steps. | |||
| 1125 | 1125 | ||
| 1126 | .. image:: figures/recipe-workflow.png | 1126 | .. image:: figures/recipe-workflow.png |
| 1127 | :align: center | 1127 | :align: center |
| 1128 | :width: 50% | ||
| 1128 | 1129 | ||
| 1129 | Locate or Automatically Create a Base Recipe | 1130 | Locate or Automatically Create a Base Recipe |
| 1130 | -------------------------------------------- | 1131 | -------------------------------------------- |
| @@ -3618,7 +3619,7 @@ Yocto Project Overview and Concepts Manual. | |||
| 3618 | The following figure and list overviews the build process: | 3619 | The following figure and list overviews the build process: |
| 3619 | 3620 | ||
| 3620 | .. image:: figures/bitbake-build-flow.png | 3621 | .. image:: figures/bitbake-build-flow.png |
| 3621 | :align: center | 3622 | :width: 100% |
| 3622 | 3623 | ||
| 3623 | 1. *Set up Your Host Development System to Support Development Using the | 3624 | 1. *Set up Your Host Development System to Support Development Using the |
| 3624 | Yocto Project*: See the ":doc:`start`" section for options on how to get a | 3625 | Yocto Project*: See the ":doc:`start`" section for options on how to get a |
| @@ -3736,6 +3737,7 @@ Follow these steps to set up and execute multiple configuration builds: | |||
| 3736 | 3737 | ||
| 3737 | .. image:: figures/multiconfig_files.png | 3738 | .. image:: figures/multiconfig_files.png |
| 3738 | :align: center | 3739 | :align: center |
| 3740 | :width: 50% | ||
| 3739 | 3741 | ||
| 3740 | The reason for this required file hierarchy is because the :term:`BBPATH` | 3742 | The reason for this required file hierarchy is because the :term:`BBPATH` |
| 3741 | variable is not constructed until the layers are parsed. | 3743 | variable is not constructed until the layers are parsed. |
| @@ -7691,7 +7693,7 @@ On a browser, | |||
| 7691 | go to ``http://192.168.7.2:3000`` and you see the following: | 7693 | go to ``http://192.168.7.2:3000`` and you see the following: |
| 7692 | 7694 | ||
| 7693 | .. image:: figures/cute-files-npm-example.png | 7695 | .. image:: figures/cute-files-npm-example.png |
| 7694 | :align: center | 7696 | :width: 100% |
| 7695 | 7697 | ||
| 7696 | You can find the recipe in ``workspace/recipes/cute-files``. You can use | 7698 | You can find the recipe in ``workspace/recipes/cute-files``. You can use |
| 7697 | the recipe in any layer you choose. | 7699 | the recipe in any layer you choose. |
| @@ -8215,6 +8217,7 @@ variable. Here is an example abbreviated listing: | |||
| 8215 | 8217 | ||
| 8216 | .. image:: figures/buildhistory.png | 8218 | .. image:: figures/buildhistory.png |
| 8217 | :align: center | 8219 | :align: center |
| 8220 | :width: 50% | ||
| 8218 | 8221 | ||
| 8219 | At the top level, there is a ``metadata-revs`` file that lists the | 8222 | At the top level, there is a ``metadata-revs`` file that lists the |
| 8220 | revisions of the repositories for the enabled layers when the build was | 8223 | revisions of the repositories for the enabled layers when the build was |
| @@ -8555,7 +8558,7 @@ instruction in the ``README`` file | |||
| 8555 | Here is a sample screenshot of the interface: | 8558 | Here is a sample screenshot of the interface: |
| 8556 | 8559 | ||
| 8557 | .. image:: figures/buildhistory-web.png | 8560 | .. image:: figures/buildhistory-web.png |
| 8558 | :align: center | 8561 | :width: 100% |
| 8559 | 8562 | ||
| 8560 | Performing Automated Runtime Testing | 8563 | Performing Automated Runtime Testing |
| 8561 | ==================================== | 8564 | ==================================== |
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 8ec3d6be45..b3a2f3abbf 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst | |||
| @@ -221,7 +221,7 @@ the line-by-line code ``diff`` level is now a trivial operation. | |||
| 221 | The following illustration shows the conceptual Yocto Linux kernel. | 221 | The following illustration shows the conceptual Yocto Linux kernel. |
| 222 | 222 | ||
| 223 | .. image:: figures/kernel-architecture-overview.png | 223 | .. image:: figures/kernel-architecture-overview.png |
| 224 | :align: center | 224 | :width: 100% |
| 225 | 225 | ||
| 226 | In the illustration, the "Kernel.org Branch Point" marks the specific | 226 | In the illustration, the "Kernel.org Branch Point" marks the specific |
| 227 | spot (or Linux kernel release) from which the Yocto Linux kernel is | 227 | spot (or Linux kernel release) from which the Yocto Linux kernel is |
| @@ -324,6 +324,7 @@ source files used during the build. | |||
| 324 | 324 | ||
| 325 | .. image:: figures/kernel-overview-2-generic.png | 325 | .. image:: figures/kernel-overview-2-generic.png |
| 326 | :align: center | 326 | :align: center |
| 327 | :width: 70% | ||
| 327 | 328 | ||
| 328 | Again, for additional information on the Yocto Project kernel's | 329 | Again, for additional information on the Yocto Project kernel's |
| 329 | architecture and its branching strategy, see the | 330 | architecture and its branching strategy, see the |
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index e406f6e47f..b9ce7f241c 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst | |||
| @@ -106,7 +106,7 @@ modification workflow. The illustration and accompanying list provide | |||
| 106 | general information and references for further information. | 106 | general information and references for further information. |
| 107 | 107 | ||
| 108 | .. image:: figures/kernel-dev-flow.png | 108 | .. image:: figures/kernel-dev-flow.png |
| 109 | :align: center | 109 | :width: 100% |
| 110 | 110 | ||
| 111 | 1. *Set up Your Host Development System to Support Development Using the | 111 | 1. *Set up Your Host Development System to Support Development Using the |
| 112 | Yocto Project*: See the ":doc:`/dev-manual/start`" section in | 112 | Yocto Project*: See the ":doc:`/dev-manual/start`" section in |
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 |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index e171d7aaa3..f1001e0bd3 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
| @@ -176,7 +176,7 @@ development: | |||
| 176 | repositories for each of these areas. | 176 | repositories for each of these areas. |
| 177 | 177 | ||
| 178 | .. image:: figures/source-repos.png | 178 | .. image:: figures/source-repos.png |
| 179 | :align: center | 179 | :width: 100% |
| 180 | 180 | ||
| 181 | For steps on how to view and access these upstream Git repositories, | 181 | For steps on how to view and access these upstream Git repositories, |
| 182 | see the ":ref:`dev-manual/start:accessing source repositories`" | 182 | see the ":ref:`dev-manual/start:accessing source repositories`" |
| @@ -191,6 +191,7 @@ development: | |||
| 191 | 191 | ||
| 192 | .. image:: figures/index-downloads.png | 192 | .. image:: figures/index-downloads.png |
| 193 | :align: center | 193 | :align: center |
| 194 | :width: 50% | ||
| 194 | 195 | ||
| 195 | For steps on how to view and access these files, see the | 196 | For steps on how to view and access these files, see the |
| 196 | ":ref:`dev-manual/start:accessing index of releases`" | 197 | ":ref:`dev-manual/start:accessing index of releases`" |
| @@ -205,7 +206,7 @@ development: | |||
| 205 | :yocto_dl:`Index of /releases: </releases>` area. | 206 | :yocto_dl:`Index of /releases: </releases>` area. |
| 206 | 207 | ||
| 207 | .. image:: figures/yp-download.png | 208 | .. image:: figures/yp-download.png |
| 208 | :align: center | 209 | :width: 100% |
| 209 | 210 | ||
| 210 | For steps on how to use the "DOWNLOADS" page, see the | 211 | For steps on how to use the "DOWNLOADS" page, see the |
| 211 | ":ref:`dev-manual/start:using the downloads page`" | 212 | ":ref:`dev-manual/start:using the downloads page`" |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index f240ce0f4b..a2e0862459 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
| @@ -24,7 +24,7 @@ software customizations and build interchange for multiple hardware | |||
| 24 | platforms as well as software stacks that can be maintained and scaled. | 24 | platforms as well as software stacks that can be maintained and scaled. |
| 25 | 25 | ||
| 26 | .. image:: figures/key-dev-elements.png | 26 | .. image:: figures/key-dev-elements.png |
| 27 | :align: center | 27 | :width: 100% |
| 28 | 28 | ||
| 29 | For further introductory information on the Yocto Project, you might be | 29 | For further introductory information on the Yocto Project, you might be |
| 30 | interested in this | 30 | interested in this |
| @@ -638,7 +638,7 @@ these items that make up the Poky repository in the | |||
| 638 | The following figure illustrates what generally comprises Poky: | 638 | The following figure illustrates what generally comprises Poky: |
| 639 | 639 | ||
| 640 | .. image:: figures/poky-reference-distribution.png | 640 | .. image:: figures/poky-reference-distribution.png |
| 641 | :align: center | 641 | :width: 100% |
| 642 | 642 | ||
| 643 | - BitBake is a task executor and scheduler that is the heart of the | 643 | - BitBake is a task executor and scheduler that is the heart of the |
| 644 | OpenEmbedded build system. | 644 | OpenEmbedded build system. |
| @@ -720,7 +720,7 @@ accomplish image and SDK generation. The following figure overviews that | |||
| 720 | workflow: | 720 | workflow: |
| 721 | 721 | ||
| 722 | .. image:: figures/YP-flow-diagram.png | 722 | .. image:: figures/YP-flow-diagram.png |
| 723 | :align: center | 723 | :width: 100% |
| 724 | 724 | ||
| 725 | Following is a brief summary of the "workflow": | 725 | Following is a brief summary of the "workflow": |
| 726 | 726 | ||
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 0fd703d8a5..0ff9d921fd 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
| @@ -197,6 +197,7 @@ in an interactive UI:: | |||
| 197 | 197 | ||
| 198 | .. image:: figures/perf-wget-flat-stripped.png | 198 | .. image:: figures/perf-wget-flat-stripped.png |
| 199 | :align: center | 199 | :align: center |
| 200 | :width: 70% | ||
| 200 | 201 | ||
| 201 | The above screenshot displays a 'flat' profile, one entry for each | 202 | The above screenshot displays a 'flat' profile, one entry for each |
| 202 | 'bucket' corresponding to the functions that were profiled during the | 203 | 'bucket' corresponding to the functions that were profiled during the |
| @@ -230,6 +231,7 @@ but the entire callchain to the sampled function as well:: | |||
| 230 | 231 | ||
| 231 | .. image:: figures/perf-wget-g-copy-to-user-expanded-stripped.png | 232 | .. image:: figures/perf-wget-g-copy-to-user-expanded-stripped.png |
| 232 | :align: center | 233 | :align: center |
| 234 | :width: 70% | ||
| 233 | 235 | ||
| 234 | Using the callgraph view, we can actually see not only which functions | 236 | Using the callgraph view, we can actually see not only which functions |
| 235 | took the most time, but we can also see a summary of how those functions | 237 | took the most time, but we can also see a summary of how those functions |
| @@ -266,6 +268,7 @@ busybox. | |||
| 266 | 268 | ||
| 267 | .. image:: figures/perf-wget-g-copy-from-user-expanded-stripped.png | 269 | .. image:: figures/perf-wget-g-copy-from-user-expanded-stripped.png |
| 268 | :align: center | 270 | :align: center |
| 271 | :width: 70% | ||
| 269 | 272 | ||
| 270 | The above screenshot shows the other half of the journey for the data - | 273 | The above screenshot shows the other half of the journey for the data - |
| 271 | from the wget program's userspace buffers to disk. To get the buffers to | 274 | from the wget program's userspace buffers to disk. To get the buffers to |
| @@ -283,6 +286,7 @@ let's expand the first entry containing BusyBox: | |||
| 283 | 286 | ||
| 284 | .. image:: figures/perf-wget-busybox-expanded-stripped.png | 287 | .. image:: figures/perf-wget-busybox-expanded-stripped.png |
| 285 | :align: center | 288 | :align: center |
| 289 | :width: 70% | ||
| 286 | 290 | ||
| 287 | Again, before we expanded we saw that the function was labeled with a | 291 | Again, before we expanded we saw that the function was labeled with a |
| 288 | hex value instead of a symbol as with most of the kernel entries. | 292 | hex value instead of a symbol as with most of the kernel entries. |
| @@ -330,6 +334,7 @@ their functions symbolically: | |||
| 330 | 334 | ||
| 331 | .. image:: figures/perf-wget-busybox-debuginfo.png | 335 | .. image:: figures/perf-wget-busybox-debuginfo.png |
| 332 | :align: center | 336 | :align: center |
| 337 | :width: 70% | ||
| 333 | 338 | ||
| 334 | If we expand one of the entries and press 'enter' on a leaf node, we're | 339 | If we expand one of the entries and press 'enter' on a leaf node, we're |
| 335 | presented with a menu of actions we can take to get more information | 340 | presented with a menu of actions we can take to get more information |
| @@ -337,6 +342,7 @@ related to that entry: | |||
| 337 | 342 | ||
| 338 | .. image:: figures/perf-wget-busybox-dso-zoom-menu.png | 343 | .. image:: figures/perf-wget-busybox-dso-zoom-menu.png |
| 339 | :align: center | 344 | :align: center |
| 345 | :width: 70% | ||
| 340 | 346 | ||
| 341 | One of these actions allows us to show a view that displays a | 347 | One of these actions allows us to show a view that displays a |
| 342 | busybox-centric view of the profiled functions (in this case we've also | 348 | busybox-centric view of the profiled functions (in this case we've also |
| @@ -344,6 +350,7 @@ expanded all the nodes using the 'E' key): | |||
| 344 | 350 | ||
| 345 | .. image:: figures/perf-wget-busybox-dso-zoom.png | 351 | .. image:: figures/perf-wget-busybox-dso-zoom.png |
| 346 | :align: center | 352 | :align: center |
| 353 | :width: 70% | ||
| 347 | 354 | ||
| 348 | Finally, we can see that now that the BusyBox debuginfo is installed, | 355 | Finally, we can see that now that the BusyBox debuginfo is installed, |
| 349 | the previously unresolved symbol in the ``sys_clock_gettime()`` entry | 356 | the previously unresolved symbol in the ``sys_clock_gettime()`` entry |
| @@ -354,6 +361,7 @@ function: | |||
| 354 | 361 | ||
| 355 | .. image:: figures/perf-wget-g-copy-to-user-expanded-debuginfo.png | 362 | .. image:: figures/perf-wget-g-copy-to-user-expanded-debuginfo.png |
| 356 | :align: center | 363 | :align: center |
| 364 | :width: 70% | ||
| 357 | 365 | ||
| 358 | At the lowest level of detail, we can dive down to the assembly level | 366 | At the lowest level of detail, we can dive down to the assembly level |
| 359 | and see which instructions caused the most overhead in a function. | 367 | and see which instructions caused the most overhead in a function. |
| @@ -362,6 +370,7 @@ with a menu: | |||
| 362 | 370 | ||
| 363 | .. image:: figures/perf-wget-busybox-annotate-menu.png | 371 | .. image:: figures/perf-wget-busybox-annotate-menu.png |
| 364 | :align: center | 372 | :align: center |
| 373 | :width: 70% | ||
| 365 | 374 | ||
| 366 | Selecting 'Annotate udhcpc_main', we get a detailed listing of | 375 | Selecting 'Annotate udhcpc_main', we get a detailed listing of |
| 367 | percentages by instruction for the udhcpc_main function. From the | 376 | percentages by instruction for the udhcpc_main function. From the |
| @@ -370,6 +379,7 @@ taken up by a couple tests and the move of a constant (1) to a register: | |||
| 370 | 379 | ||
| 371 | .. image:: figures/perf-wget-busybox-annotate-udhcpc.png | 380 | .. image:: figures/perf-wget-busybox-annotate-udhcpc.png |
| 372 | :align: center | 381 | :align: center |
| 382 | :width: 70% | ||
| 373 | 383 | ||
| 374 | As a segue into tracing, let's try another profile using a different | 384 | As a segue into tracing, let's try another profile using a different |
| 375 | counter, something other than the default 'cycles'. | 385 | counter, something other than the default 'cycles'. |
| @@ -593,6 +603,7 @@ and tell perf to do a profile using it as the sampling event:: | |||
| 593 | 603 | ||
| 594 | .. image:: figures/sched-wakeup-profile.png | 604 | .. image:: figures/sched-wakeup-profile.png |
| 595 | :align: center | 605 | :align: center |
| 606 | :width: 70% | ||
| 596 | 607 | ||
| 597 | The screenshot above shows the results of running a profile using | 608 | The screenshot above shows the results of running a profile using |
| 598 | sched:sched_switch tracepoint, which shows the relative costs of various | 609 | sched:sched_switch tracepoint, which shows the relative costs of various |
| @@ -894,6 +905,7 @@ other processes running on the system as well: | |||
| 894 | 905 | ||
| 895 | .. image:: figures/perf-systemwide.png | 906 | .. image:: figures/perf-systemwide.png |
| 896 | :align: center | 907 | :align: center |
| 908 | :width: 70% | ||
| 897 | 909 | ||
| 898 | In the snapshot above, we can see callchains that originate in libc, and | 910 | In the snapshot above, we can see callchains that originate in libc, and |
| 899 | a callchain from Xorg that demonstrates that we're using a proprietary X | 911 | a callchain from Xorg that demonstrates that we're using a proprietary X |
| @@ -911,6 +923,7 @@ record a profile:: | |||
| 911 | 923 | ||
| 912 | .. image:: figures/perf-report-cycles-u.png | 924 | .. image:: figures/perf-report-cycles-u.png |
| 913 | :align: center | 925 | :align: center |
| 926 | :width: 70% | ||
| 914 | 927 | ||
| 915 | Notice in the screenshot above, we see only userspace entries ([.]) | 928 | Notice in the screenshot above, we see only userspace entries ([.]) |
| 916 | 929 | ||
| @@ -921,6 +934,7 @@ the entries associated with the libc-xxx.so DSO. | |||
| 921 | 934 | ||
| 922 | .. image:: figures/perf-systemwide-libc.png | 935 | .. image:: figures/perf-systemwide-libc.png |
| 923 | :align: center | 936 | :align: center |
| 937 | :width: 70% | ||
| 924 | 938 | ||
| 925 | We can also use the system-wide -a switch to do system-wide tracing. | 939 | We can also use the system-wide -a switch to do system-wide tracing. |
| 926 | Here we'll trace a couple of scheduler events:: | 940 | Here we'll trace a couple of scheduler events:: |
| @@ -1116,6 +1130,7 @@ callgraphs from starting a few programs during those 30 seconds: | |||
| 1116 | 1130 | ||
| 1117 | .. image:: figures/perf-probe-do_fork-profile.png | 1131 | .. image:: figures/perf-probe-do_fork-profile.png |
| 1118 | :align: center | 1132 | :align: center |
| 1133 | :width: 70% | ||
| 1119 | 1134 | ||
| 1120 | .. admonition:: Tying it Together | 1135 | .. admonition:: Tying it Together |
| 1121 | 1136 | ||
| @@ -1684,6 +1699,7 @@ events (or even one or more complete subsystems) to trace: | |||
| 1684 | 1699 | ||
| 1685 | .. image:: figures/kernelshark-choose-events.png | 1700 | .. image:: figures/kernelshark-choose-events.png |
| 1686 | :align: center | 1701 | :align: center |
| 1702 | :width: 70% | ||
| 1687 | 1703 | ||
| 1688 | Note that these are exactly the same sets of events described in the | 1704 | Note that these are exactly the same sets of events described in the |
| 1689 | previous trace events subsystem section, and in fact is where trace-cmd | 1705 | previous trace events subsystem section, and in fact is where trace-cmd |
| @@ -1699,6 +1715,7 @@ will turn into the 'Stop' button after the trace has started): | |||
| 1699 | 1715 | ||
| 1700 | .. image:: figures/kernelshark-output-display.png | 1716 | .. image:: figures/kernelshark-output-display.png |
| 1701 | :align: center | 1717 | :align: center |
| 1718 | :width: 70% | ||
| 1702 | 1719 | ||
| 1703 | Notice that the right-hand pane shows the exact trace-cmd command-line | 1720 | Notice that the right-hand pane shows the exact trace-cmd command-line |
| 1704 | that's used to run the trace, along with the results of the trace-cmd | 1721 | that's used to run the trace, along with the results of the trace-cmd |
| @@ -1710,12 +1727,14 @@ detailed event listing below that: | |||
| 1710 | 1727 | ||
| 1711 | .. image:: figures/kernelshark-i915-display.png | 1728 | .. image:: figures/kernelshark-i915-display.png |
| 1712 | :align: center | 1729 | :align: center |
| 1730 | :width: 70% | ||
| 1713 | 1731 | ||
| 1714 | Here's another example, this time a display resulting from tracing 'all | 1732 | Here's another example, this time a display resulting from tracing 'all |
| 1715 | events': | 1733 | events': |
| 1716 | 1734 | ||
| 1717 | .. image:: figures/kernelshark-all.png | 1735 | .. image:: figures/kernelshark-all.png |
| 1718 | :align: center | 1736 | :align: center |
| 1737 | :width: 70% | ||
| 1719 | 1738 | ||
| 1720 | The tool is pretty self-explanatory, but for more detailed information | 1739 | The tool is pretty self-explanatory, but for more detailed information |
| 1721 | on navigating through the data, see the `kernelshark | 1740 | on navigating through the data, see the `kernelshark |
| @@ -1974,6 +1993,7 @@ with profiling data: | |||
| 1974 | 1993 | ||
| 1975 | .. image:: figures/sysprof-copy-to-user.png | 1994 | .. image:: figures/sysprof-copy-to-user.png |
| 1976 | :align: center | 1995 | :align: center |
| 1996 | :width: 70% | ||
| 1977 | 1997 | ||
| 1978 | The left pane shows a list of functions and processes. Selecting one of | 1998 | The left pane shows a list of functions and processes. Selecting one of |
| 1979 | those expands that function in the right pane, showing all its callees. | 1999 | those expands that function in the right pane, showing all its callees. |
| @@ -1988,6 +2008,7 @@ in the perf display shown in the perf section of this page. | |||
| 1988 | 2008 | ||
| 1989 | .. image:: figures/sysprof-copy-from-user.png | 2009 | .. image:: figures/sysprof-copy-from-user.png |
| 1990 | :align: center | 2010 | :align: center |
| 2011 | :width: 70% | ||
| 1991 | 2012 | ||
| 1992 | Similarly, the above is a snapshot of the Sysprof display of a | 2013 | Similarly, the above is a snapshot of the Sysprof display of a |
| 1993 | copy-from-user callchain. | 2014 | copy-from-user callchain. |
| @@ -1999,6 +2020,7 @@ left pane. In this case, the lower pane is showing all the callers of | |||
| 1999 | 2020 | ||
| 2000 | .. image:: figures/sysprof-callers.png | 2021 | .. image:: figures/sysprof-callers.png |
| 2001 | :align: center | 2022 | :align: center |
| 2023 | :width: 70% | ||
| 2002 | 2024 | ||
| 2003 | Double-clicking on one of those functions will in turn change the focus | 2025 | Double-clicking on one of those functions will in turn change the focus |
| 2004 | to the selected function, and so on. | 2026 | to the selected function, and so on. |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index a1a8bcdc98..10ca70a2b3 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -126,8 +126,7 @@ common working area used across the tool. | |||
| 126 | The following figure shows the workspace structure: | 126 | The following figure shows the workspace structure: |
| 127 | 127 | ||
| 128 | .. image:: figures/build-workspace-directory.png | 128 | .. image:: figures/build-workspace-directory.png |
| 129 | :align: center | 129 | :scale: 100% |
| 130 | :scale: 70% | ||
| 131 | 130 | ||
| 132 | .. code-block:: none | 131 | .. code-block:: none |
| 133 | 132 | ||
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index 841abac5aa..ece378c75e 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst | |||
| @@ -265,8 +265,7 @@ install the Standard SDK by running the ``*.sh`` SDK installation | |||
| 265 | script: | 265 | script: |
| 266 | 266 | ||
| 267 | .. image:: figures/sdk-installed-standard-sdk-directory.png | 267 | .. image:: figures/sdk-installed-standard-sdk-directory.png |
| 268 | :scale: 80% | 268 | :scale: 100% |
| 269 | :align: center | ||
| 270 | 269 | ||
| 271 | The installed SDK consists of an environment setup script for the SDK, a | 270 | The installed SDK consists of an environment setup script for the SDK, a |
| 272 | configuration file for the target, a version file for the target, and | 271 | configuration file for the target, a version file for the target, and |
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index c5970f74fa..6bb262273d 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst | |||
| @@ -233,7 +233,7 @@ shows common development flows you would use with the ``devtool add`` | |||
| 233 | command: | 233 | command: |
| 234 | 234 | ||
| 235 | .. image:: figures/sdk-devtool-add-flow.png | 235 | .. image:: figures/sdk-devtool-add-flow.png |
| 236 | :align: center | 236 | :width: 100% |
| 237 | 237 | ||
| 238 | 1. *Generating the New Recipe*: The top part of the flow shows three | 238 | 1. *Generating the New Recipe*: The top part of the flow shows three |
| 239 | scenarios by which you could use ``devtool add`` to generate a recipe | 239 | scenarios by which you could use ``devtool add`` to generate a recipe |
| @@ -401,7 +401,7 @@ diagram shows common development flows for the ``devtool modify`` | |||
| 401 | command: | 401 | command: |
| 402 | 402 | ||
| 403 | .. image:: figures/sdk-devtool-modify-flow.png | 403 | .. image:: figures/sdk-devtool-modify-flow.png |
| 404 | :align: center | 404 | :width: 100% |
| 405 | 405 | ||
| 406 | 1. *Preparing to Modify the Code*: The top part of the flow shows three | 406 | 1. *Preparing to Modify the Code*: The top part of the flow shows three |
| 407 | scenarios by which you could use ``devtool modify`` to prepare to | 407 | scenarios by which you could use ``devtool modify`` to prepare to |
| @@ -620,7 +620,7 @@ The following diagram shows the common development flow used with the | |||
| 620 | ``devtool upgrade`` command: | 620 | ``devtool upgrade`` command: |
| 621 | 621 | ||
| 622 | .. image:: figures/sdk-devtool-upgrade-flow.png | 622 | .. image:: figures/sdk-devtool-upgrade-flow.png |
| 623 | :align: center | 623 | :width: 100% |
| 624 | 624 | ||
| 625 | 1. *Initiate the Upgrade*: The top part of the flow shows the typical | 625 | 1. *Initiate the Upgrade*: The top part of the flow shows the typical |
| 626 | scenario by which you use the ``devtool upgrade`` command. The | 626 | scenario by which you use the ``devtool upgrade`` command. The |
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst index 802d3f3d42..ce00538b2a 100644 --- a/documentation/sdk-manual/intro.rst +++ b/documentation/sdk-manual/intro.rst | |||
| @@ -149,7 +149,7 @@ SDK Development Model | |||
| 149 | Fundamentally, the SDK fits into the development process as follows: | 149 | Fundamentally, the SDK fits into the development process as follows: |
| 150 | 150 | ||
| 151 | .. image:: figures/sdk-environment.png | 151 | .. image:: figures/sdk-environment.png |
| 152 | :align: center | 152 | :width: 100% |
| 153 | 153 | ||
| 154 | The SDK is installed on any machine and can be used to develop applications, | 154 | The SDK is installed on any machine and can be used to develop applications, |
| 155 | images, and kernels. An SDK can even be used by a QA Engineer or Release | 155 | images, and kernels. An SDK can even be used by a QA Engineer or Release |
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index 276daa9bb6..efef5c8bd2 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst | |||
| @@ -19,6 +19,7 @@ The following figure presents a simple Autotools workflow. | |||
| 19 | 19 | ||
| 20 | .. image:: figures/sdk-autotools-flow.png | 20 | .. image:: figures/sdk-autotools-flow.png |
| 21 | :align: center | 21 | :align: center |
| 22 | :width: 70% | ||
| 22 | 23 | ||
| 23 | Follow these steps to create a simple Autotools-based "Hello World" | 24 | Follow these steps to create a simple Autotools-based "Hello World" |
| 24 | project: | 25 | project: |
| @@ -168,6 +169,7 @@ variables and Makefile variables during development. | |||
| 168 | 169 | ||
| 169 | .. image:: figures/sdk-makefile-flow.png | 170 | .. image:: figures/sdk-makefile-flow.png |
| 170 | :align: center | 171 | :align: center |
| 172 | :width: 70% | ||
| 171 | 173 | ||
| 172 | The main point of this section is to explain the following three cases | 174 | The main point of this section is to explain the following three cases |
| 173 | regarding variable behavior: | 175 | regarding variable behavior: |
diff --git a/documentation/standards.md b/documentation/standards.md index d288376828..81aff5f193 100644 --- a/documentation/standards.md +++ b/documentation/standards.md | |||
| @@ -48,8 +48,14 @@ To include a screenshot in PNG format: | |||
| 48 | .. image:: figures/user-configuration.png | 48 | .. image:: figures/user-configuration.png |
| 49 | :align: center | 49 | :align: center |
| 50 | 50 | ||
| 51 | Depending on the size of the image, you may also shrink it | 51 | A diagram with many details usually needs to use |
| 52 | to prevent it from filling the whole page width: | 52 | the whole page width to be readable on all media. |
| 53 | In this case, the `:align:` directive is unnecessary: | ||
| 54 | |||
| 55 | :scale: 100% | ||
| 56 | |||
| 57 | Conversely, you may also shrink some images to | ||
| 58 | to prevent them from filling the whole page width: | ||
| 53 | 59 | ||
| 54 | :scale: 50% | 60 | :scale: 50% |
| 55 | 61 | ||
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 17cde316b3..eb9ebe2d5f 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
| @@ -83,6 +83,7 @@ topology that includes a controller and a cluster of workers: | |||
| 83 | 83 | ||
| 84 | .. image:: figures/ab-test-cluster.png | 84 | .. image:: figures/ab-test-cluster.png |
| 85 | :align: center | 85 | :align: center |
| 86 | :width: 70% | ||
| 86 | 87 | ||
| 87 | Yocto Project Tests - Types of Testing Overview | 88 | Yocto Project Tests - Types of Testing Overview |
| 88 | =============================================== | 89 | =============================================== |
diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst index 57e5b2bb7b..a324744b7d 100644 --- a/documentation/toaster-manual/intro.rst +++ b/documentation/toaster-manual/intro.rst | |||
| @@ -92,6 +92,7 @@ suited for a single user developing on a single build host. | |||
| 92 | 92 | ||
| 93 | .. image:: figures/simple-configuration.png | 93 | .. image:: figures/simple-configuration.png |
| 94 | :align: center | 94 | :align: center |
| 95 | :width: 70% | ||
| 95 | 96 | ||
| 96 | Toaster as a hosted service is suited for multiple users developing | 97 | Toaster as a hosted service is suited for multiple users developing |
| 97 | across several build hosts. When Toaster is set up as a hosted service, | 98 | across several build hosts. When Toaster is set up as a hosted service, |
| @@ -99,3 +100,4 @@ its components can be spread across several machines: | |||
| 99 | 100 | ||
| 100 | .. image:: figures/hosted-service.png | 101 | .. image:: figures/hosted-service.png |
| 101 | :align: center | 102 | :align: center |
| 103 | :width: 50% | ||
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 0b81fa8033..46c5cf19f9 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
| @@ -98,6 +98,7 @@ contact us with other suggestions. | |||
| 98 | be going wrong. | 98 | be going wrong. |
| 99 | 99 | ||
| 100 | .. image:: figures/yp-how-it-works-new-diagram.png | 100 | .. image:: figures/yp-how-it-works-new-diagram.png |
| 101 | :width: 100% | ||
| 101 | 102 | ||
| 102 | #. **Know that you can generate a dependency graph and learn how to do it:** | 103 | #. **Know that you can generate a dependency graph and learn how to do it:** |
| 103 | A dependency graph shows dependencies between recipes, tasks, and targets. | 104 | A dependency graph shows dependencies between recipes, tasks, and targets. |
