diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-12-06 16:36:00 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-12-18 13:18:55 +0000 |
commit | 84b242ef8bc103e49d83dcc25d968ab59524e1f3 (patch) | |
tree | 0fd504622c840757a2995a158ebc422605a8d5e9 /documentation/test-manual/understand-autobuilder.rst | |
parent | c24e3b9f676ea68c100154f1aa865430ed2c99f1 (diff) | |
download | poky-84b242ef8bc103e49d83dcc25d968ab59524e1f3.tar.gz |
test-manual: text and formatting fixes
(From yocto-docs rev: 7c4f616f773bb9071b395e977b2ca9f8ac8f7e2a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/test-manual/understand-autobuilder.rst')
-rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index 7a6cb2443b..a3fff29aca 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
@@ -32,8 +32,8 @@ which looks like:: | |||
32 | } | 32 | } |
33 | }, | 33 | }, |
34 | 34 | ||
35 | And to expand that, you need the "arch-qemu" entry from | 35 | And to expand that, you need the ``arch-qemu`` entry from |
36 | the "templates" section, which looks like:: | 36 | the ``templates`` section, which looks like:: |
37 | 37 | ||
38 | "arch-qemu" : { | 38 | "arch-qemu" : { |
39 | "BUILDINFO" : true, | 39 | "BUILDINFO" : true, |
@@ -54,11 +54,11 @@ the "templates" section, which looks like:: | |||
54 | } | 54 | } |
55 | }, | 55 | }, |
56 | 56 | ||
57 | Combining these two entries you can see that "qemux86-64" is a three step build where the | 57 | Combining these two entries you can see that ``qemux86-64`` is a three step |
58 | ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for | 58 | build where ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` |
59 | ``MACHINE="qemux86-64"`` but with differing :term:`SDKMACHINE` settings. In step | 59 | for each step; all for ``MACHINE="qemux86-64"`` but with differing |
60 | 1 an extra variable is added to the ``auto.conf`` file to enable wic | 60 | :term:`SDKMACHINE` settings. In step 1, an extra variable is added to the |
61 | image generation. | 61 | ``auto.conf`` file to enable wic image generation. |
62 | 62 | ||
63 | While not every detail of this is covered here, you can see how the | 63 | 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 |
@@ -163,8 +163,9 @@ Autobuilder Worker Janitor | |||
163 | -------------------------- | 163 | -------------------------- |
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 |
167 | maintenance of a cache of cloned repositories to improve the speed | 167 | "Run clobberdir" in :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`) |
168 | and maintenance of a cache of cloned repositories to improve the speed | ||
168 | the system can checkout repositories. | 169 | the system can checkout repositories. |
169 | 170 | ||
170 | Shared DL_DIR | 171 | Shared DL_DIR |
@@ -172,7 +173,7 @@ Shared DL_DIR | |||
172 | 173 | ||
173 | The Workers are all connected over NFS which allows :term:`DL_DIR` to be shared | 174 | The Workers are all connected over NFS which allows :term:`DL_DIR` to be shared |
174 | between them. This reduces network accesses from the system and allows | 175 | between them. This reduces network accesses from the system and allows |
175 | the build to be sped up. Usage of the directory within the build system | 176 | the build to be sped up. The usage of the directory within the build system |
176 | is designed to be able to be shared over NFS. | 177 | is designed to be able to be shared over NFS. |
177 | 178 | ||
178 | Shared SSTATE_DIR | 179 | Shared SSTATE_DIR |
@@ -180,8 +181,8 @@ Shared SSTATE_DIR | |||
180 | 181 | ||
181 | The Workers are all connected over NFS which allows the ``sstate`` | 182 | The Workers are all connected over NFS which allows the ``sstate`` |
182 | directory to be shared between them. This means once a Worker has built | 183 | directory to be shared between them. This means once a Worker has built |
183 | an artifact, all the others can benefit from it. Usage of the directory | 184 | an artifact, all the others can benefit from it. The usage of the directory |
184 | within the directory is designed for sharing over NFS. | 185 | within the build system is designed for sharing over NFS. |
185 | 186 | ||
186 | Resulttool | 187 | Resulttool |
187 | ---------- | 188 | ---------- |
@@ -192,7 +193,7 @@ in a given build and their status. Additional information, such as | |||
192 | failure logs or the time taken to run the tests, may also be included. | 193 | failure logs or the time taken to run the tests, may also be included. |
193 | 194 | ||
194 | Resulttool is part of OpenEmbedded-Core and is used to manipulate these | 195 | Resulttool is part of OpenEmbedded-Core and is used to manipulate these |
195 | json results files. It has the ability to merge files together, display | 196 | JSON results files. It has the ability to merge files together, display |
196 | reports of the test results and compare different result files. | 197 | reports of the test results and compare different result files. |
197 | 198 | ||
198 | For details, see :yocto_wiki:`/Resulttool`. | 199 | For details, see :yocto_wiki:`/Resulttool`. |
@@ -206,7 +207,7 @@ are general setup steps that are run once and include: | |||
206 | 207 | ||
207 | #. Set up any :term:`buildtools` tarball if configured. | 208 | #. Set up any :term:`buildtools` tarball if configured. |
208 | 209 | ||
209 | #. Call "buildhistory-init" if :ref:`ref-classes-buildhistory` is configured. | 210 | #. Call ``buildhistory-init`` if :ref:`ref-classes-buildhistory` is configured. |
210 | 211 | ||
211 | For each step that is configured in ``config.json``, it will perform the | 212 | For each step that is configured in ``config.json``, it will perform the |
212 | following: | 213 | following: |
@@ -258,7 +259,7 @@ it is inevitable that users will end up needing to heavily customise the | |||
258 | ``yocto-autobuilder-helper`` repository, particularly the | 259 | ``yocto-autobuilder-helper`` repository, particularly the |
259 | ``config.json`` file as they will want to define their own test matrix. | 260 | ``config.json`` file as they will want to define their own test matrix. |
260 | 261 | ||
261 | The Autobuilder supports wo customization options: | 262 | The Autobuilder supports two customization options: |
262 | 263 | ||
263 | - variable substitution | 264 | - variable substitution |
264 | 265 | ||
@@ -278,7 +279,7 @@ environment:: | |||
278 | $ ABHELPER_JSON="config.json /some/location/local.json" | 279 | $ ABHELPER_JSON="config.json /some/location/local.json" |
279 | 280 | ||
280 | One issue users often run into is validation of the ``config.json`` files. A | 281 | One issue users often run into is validation of the ``config.json`` files. A |
281 | tip for minimizing issues from invalid json files is to use a Git | 282 | tip for minimizing issues from invalid JSON files is to use a Git |
282 | ``pre-commit-hook.sh`` script to verify the JSON file before committing | 283 | ``pre-commit-hook.sh`` script to verify the JSON file before committing |
283 | it. Create a symbolic link as follows:: | 284 | it. Create a symbolic link as follows:: |
284 | 285 | ||