diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-05 08:34:26 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-06 17:39:09 +0000 |
| commit | 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch) | |
| tree | e1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/test-manual | |
| parent | ae280972ffba62d7ed839b692957f61b0955cbca (diff) | |
| download | poky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz | |
manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/test-manual')
| -rw-r--r-- | documentation/test-manual/intro.rst | 18 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 2 |
2 files changed, 10 insertions, 10 deletions
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 2d75e141f1..aaf64ae017 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
| @@ -100,12 +100,11 @@ the following types of tests: | |||
| 100 | different configurations, such as different init systems. The | 100 | different configurations, such as different init systems. The |
| 101 | Autobuilder tests literally hundreds of configurations and targets. | 101 | Autobuilder tests literally hundreds of configurations and targets. |
| 102 | 102 | ||
| 103 | - *Sanity Checks During the Build Process:* Tests initiated through | 103 | - *Sanity Checks During the Build Process:* Tests initiated through the |
| 104 | the :ref:`insane <ref-classes-insane>` | 104 | :ref:`ref-classes-insane` class. These checks ensure the output of the |
| 105 | class. These checks ensure the output of the builds are correct. | 105 | builds are correct. For example, does the ELF architecture in the |
| 106 | For example, does the ELF architecture in the generated binaries | 106 | generated binaries match the target system? ARM binaries would not work |
| 107 | match the target system? ARM binaries would not work in a MIPS | 107 | in a MIPS system! |
| 108 | system! | ||
| 109 | 108 | ||
| 110 | - *Build Performance Testing:* Tests whether or not commonly used steps | 109 | - *Build Performance Testing:* Tests whether or not commonly used steps |
| 111 | during builds work efficiently and avoid regressions. Tests to time | 110 | during builds work efficiently and avoid regressions. Tests to time |
| @@ -121,7 +120,8 @@ the following types of tests: | |||
| 121 | 120 | ||
| 122 | $ bitbake image -c testsdkext | 121 | $ bitbake image -c testsdkext |
| 123 | 122 | ||
| 124 | The tests utilize the :ref:`testsdkext <ref-classes-testsdk>` class and the ``do_testsdkext`` task. | 123 | The tests utilize the :ref:`ref-classes-testsdk` class and the |
| 124 | ``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 distributions | 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 |
| @@ -131,7 +131,7 @@ the following types of tests: | |||
| 131 | 131 | ||
| 132 | $ bitbake image -c testimage | 132 | $ bitbake image -c testimage |
| 133 | 133 | ||
| 134 | The tests utilize the :ref:`testimage <ref-classes-testimage>` | 134 | The tests utilize the :ref:`ref-classes-testimage` |
| 135 | class and the :ref:`ref-tasks-testimage` task. | 135 | class and the :ref:`ref-tasks-testimage` task. |
| 136 | 136 | ||
| 137 | - *Layer Testing:* The Autobuilder has the possibility to test whether | 137 | - *Layer Testing:* The Autobuilder has the possibility to test whether |
| @@ -151,7 +151,7 @@ the following types of tests: | |||
| 151 | 151 | ||
| 152 | $ bitbake image -c testsdk | 152 | $ bitbake image -c testsdk |
| 153 | 153 | ||
| 154 | The tests utilize the :ref:`testsdk <ref-classes-testsdk>` class and | 154 | The tests utilize the :ref:`ref-classes-testsdk` class and |
| 155 | the ``do_testsdk`` task. | 155 | the ``do_testsdk`` task. |
| 156 | 156 | ||
| 157 | - *Unit Testing:* Unit tests on various components of the system run | 157 | - *Unit Testing:* Unit tests on various components of the system run |
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index b6e331f68c..7a6cb2443b 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
| @@ -206,7 +206,7 @@ are general setup steps that are run once and include: | |||
| 206 | 206 | ||
| 207 | #. Set up any :term:`buildtools` tarball if configured. | 207 | #. Set up any :term:`buildtools` tarball if configured. |
| 208 | 208 | ||
| 209 | #. Call "buildhistory-init" if :ref:`buildhistory <ref-classes-buildhistory>` is configured. | 209 | #. Call "buildhistory-init" if :ref:`ref-classes-buildhistory` is configured. |
| 210 | 210 | ||
| 211 | For each step that is configured in ``config.json``, it will perform the | 211 | For each step that is configured in ``config.json``, it will perform the |
| 212 | following: | 212 | following: |
