diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-03-23 17:58:45 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-06 22:29:49 +0100 |
| commit | c643a4749c436baeb6943fe960f77a48deaef8e5 (patch) | |
| tree | e79fda634aed23f488fedff8f74a0f2b321f28f9 /documentation/test-manual | |
| parent | 07c7bdc6c24974dfd4fdc50d142a5d2049966f5f (diff) | |
| download | poky-c643a4749c436baeb6943fe960f77a48deaef8e5.tar.gz | |
manuals: Spellcheck and capitalization fixes
- Spelling fixes found using Emacs' spelling checker
configured for US English
- Fixes for some capitalization issues, especially some
project names (QEMU, openSUSE, BusyBox), that were not
consistently used with the same capitalization anyway.
- A few whitespace fixes too
(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/test-manual')
| -rw-r--r-- | documentation/test-manual/intro.rst | 10 | ||||
| -rw-r--r-- | documentation/test-manual/test-process.rst | 4 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 12 |
3 files changed, 13 insertions, 13 deletions
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 81c24a8c3f..101d283665 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
| @@ -26,7 +26,7 @@ engineers: | |||
| 26 | 26 | ||
| 27 | - *yocto-autobuilder2:* This | 27 | - *yocto-autobuilder2:* This |
| 28 | :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` | 28 | :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` |
| 29 | is the main README which detials how to set up the Yocto Project | 29 | is the main README which details how to set up the Yocto Project |
| 30 | Autobuilder. The ``yocto-autobuilder2`` repository represents the | 30 | Autobuilder. The ``yocto-autobuilder2`` repository represents the |
| 31 | Yocto Project's console UI plugin to Buildbot and the configuration | 31 | Yocto Project's console UI plugin to Buildbot and the configuration |
| 32 | necessary to configure Buildbot to perform the testing the project | 32 | necessary to configure Buildbot to perform the testing the project |
| @@ -88,7 +88,7 @@ Yocto Project Tests - Types of Testing Overview | |||
| 88 | =============================================== | 88 | =============================================== |
| 89 | 89 | ||
| 90 | The Autobuilder tests different elements of the project by using | 90 | The Autobuilder tests different elements of the project by using |
| 91 | thefollowing types of tests: | 91 | the following types of tests: |
| 92 | 92 | ||
| 93 | - *Build Testing:* Tests whether specific configurations build by | 93 | - *Build Testing:* Tests whether specific configurations build by |
| 94 | varying :term:`MACHINE`, | 94 | varying :term:`MACHINE`, |
| @@ -124,7 +124,7 @@ thefollowing types of tests: | |||
| 124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. | 124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. |
| 125 | 125 | ||
| 126 | - *Feature Testing:* Various scenario-based tests are run through the | 126 | - *Feature Testing:* Various scenario-based tests are run through the |
| 127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distrubutions | 127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distributions |
| 128 | we support. | 128 | we support. |
| 129 | 129 | ||
| 130 | - *Image Testing:* Image tests initiated through the following command:: | 130 | - *Image Testing:* Image tests initiated through the following command:: |
| @@ -474,7 +474,7 @@ correctly. The test would only run if python3 is installed in the SDK. | |||
| 474 | ---------------------- | 474 | ---------------------- |
| 475 | 475 | ||
| 476 | The performance tests usually measure how long operations take and the | 476 | The performance tests usually measure how long operations take and the |
| 477 | resource utilisation as that happens. An example from | 477 | resource utilization as that happens. An example from |
| 478 | ``meta/lib/oeqa/buildperf/test_basic.py`` contains the following:: | 478 | ``meta/lib/oeqa/buildperf/test_basic.py`` contains the following:: |
| 479 | 479 | ||
| 480 | class Test3(BuildPerfTestCase): | 480 | class Test3(BuildPerfTestCase): |
| @@ -524,5 +524,5 @@ This is particularly true for oe-selftests since these can run in | |||
| 524 | parallel and changing metadata leads to changing checksums, which | 524 | parallel and changing metadata leads to changing checksums, which |
| 525 | confuses BitBake while running in parallel. If this is necessary, copy | 525 | confuses BitBake while running in parallel. If this is necessary, copy |
| 526 | layers to a temporary location and modify them. Some tests need to | 526 | layers to a temporary location and modify them. Some tests need to |
| 527 | change metadata, such as the devtool tests. To prevent the metadate from | 527 | change metadata, such as the devtool tests. To protect the metadata from |
| 528 | changes, set up temporary copies of that data first. | 528 | changes, set up temporary copies of that data first. |
diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 8a5e29d922..508ead5fad 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst | |||
| @@ -59,13 +59,13 @@ Release Builds | |||
| 59 | 59 | ||
| 60 | The project typically has two major releases a year with a six month | 60 | The project typically has two major releases a year with a six month |
| 61 | cadence in April and October. Between these there would be a number of | 61 | cadence in April and October. Between these there would be a number of |
| 62 | milestone releases (usually four) with the final one being stablization | 62 | milestone releases (usually four) with the final one being stabilization |
| 63 | only along with point releases of our stable branches. | 63 | only along with point releases of our stable branches. |
| 64 | 64 | ||
| 65 | The build and release process for these project releases is similar to | 65 | The build and release process for these project releases is similar to |
| 66 | that in `Day to Day Development <#test-daily-devel>`__, in that the | 66 | that in `Day to Day Development <#test-daily-devel>`__, in that the |
| 67 | a-full target of the Autobuilder is used but in addition the form is | 67 | a-full target of the Autobuilder is used but in addition the form is |
| 68 | configured to generate and publish artefacts and the milestone number, | 68 | configured to generate and publish artifacts and the milestone number, |
| 69 | version, release candidate number and other information is entered. The | 69 | version, release candidate number and other information is entered. The |
| 70 | box to "generate an email to QA"is also checked. | 70 | box to "generate an email to QA"is also checked. |
| 71 | 71 | ||
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index 199cc97a85..2d9d6735a9 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
| @@ -9,14 +9,14 @@ Execution Flow within the Autobuilder | |||
| 9 | 9 | ||
| 10 | The "a-full" and "a-quick" targets are the usual entry points into the | 10 | The "a-full" and "a-quick" targets are the usual entry points into the |
| 11 | Autobuilder and it makes sense to follow the process through the system | 11 | Autobuilder and it makes sense to follow the process through the system |
| 12 | starting there. This is best visualised from the Autobuilder Console | 12 | starting there. This is best visualized from the Autobuilder Console |
| 13 | view (:yocto_ab:`/typhoon/#/console`). | 13 | view (:yocto_ab:`/typhoon/#/console`). |
| 14 | 14 | ||
| 15 | Each item along the top of that view represents some "target build" and | 15 | Each item along the top of that view represents some "target build" and |
| 16 | these targets are all run in parallel. The 'full' build will trigger the | 16 | these targets are all run in parallel. The 'full' build will trigger the |
| 17 | majority of them, the "quick" build will trigger some subset of them. | 17 | majority of them, the "quick" build will trigger some subset of them. |
| 18 | The Autobuilder effectively runs whichever configuration is defined for | 18 | The Autobuilder effectively runs whichever configuration is defined for |
| 19 | each of those targets on a seperate buildbot worker. To understand the | 19 | each of those targets on a separate buildbot worker. To understand the |
| 20 | configuration, you need to look at the entry on ``config.json`` file | 20 | configuration, you need to look at the entry on ``config.json`` file |
| 21 | within the ``yocto-autobuilder-helper`` repository. The targets are | 21 | within the ``yocto-autobuilder-helper`` repository. The targets are |
| 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 | 22 | defined in the ‘overrides' section, a quick example could be qemux86-64 |
| @@ -64,10 +64,10 @@ While not every detail of this is covered here, you can see how the | |||
| 64 | template mechanism allows quite complex configurations to be built up | 64 | template mechanism allows quite complex configurations to be built up |
| 65 | yet allows duplication and repetition to be kept to a minimum. | 65 | yet allows duplication and repetition to be kept to a minimum. |
| 66 | 66 | ||
| 67 | The different build targets are designed to allow for parallelisation, | 67 | The different build targets are designed to allow for parallelization, |
| 68 | so different machines are usually built in parallel, operations using | 68 | so different machines are usually built in parallel, operations using |
| 69 | the same machine and metadata are built sequentially, with the aim of | 69 | the same machine and metadata are built sequentially, with the aim of |
| 70 | trying to optimise build efficiency as much as possible. | 70 | trying to optimize build efficiency as much as possible. |
| 71 | 71 | ||
| 72 | The ``config.json`` file is processed by the scripts in the Helper | 72 | The ``config.json`` file is processed by the scripts in the Helper |
| 73 | repository in the ``scripts`` directory. The following section details | 73 | repository in the ``scripts`` directory. The following section details |
| @@ -164,7 +164,7 @@ Autobuilder Worker Janitor | |||
| 164 | 164 | ||
| 165 | This is a process running on each Worker that performs two basic | 165 | This is a process running on each Worker that performs two basic |
| 166 | operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and | 166 | operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and |
| 167 | maintainenance of a cache of cloned repositories to improve the speed | 167 | maintenance of a cache of cloned repositories to improve the speed |
| 168 | the system can checkout repositories. | 168 | the system can checkout repositories. |
| 169 | 169 | ||
| 170 | Shared DL_DIR | 170 | Shared DL_DIR |
| @@ -250,7 +250,7 @@ Deploying Yocto Autobuilder | |||
| 250 | =========================== | 250 | =========================== |
| 251 | 251 | ||
| 252 | The most up to date information about how to setup and deploy your own | 252 | The most up to date information about how to setup and deploy your own |
| 253 | Autbuilder can be found in README.md in the ``yocto-autobuilder2`` | 253 | Autobuilder can be found in README.md in the ``yocto-autobuilder2`` |
| 254 | repository. | 254 | repository. |
| 255 | 255 | ||
| 256 | We hope that people can use the ``yocto-autobuilder2`` code directly but | 256 | We hope that people can use the ``yocto-autobuilder2`` code directly but |
