summaryrefslogtreecommitdiffstats
path: root/documentation/test-manual/test-manual-understand-autobuilder.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/test-manual/test-manual-understand-autobuilder.xml')
-rw-r--r--documentation/test-manual/test-manual-understand-autobuilder.xml21
1 files changed, 11 insertions, 10 deletions
diff --git a/documentation/test-manual/test-manual-understand-autobuilder.xml b/documentation/test-manual/test-manual-understand-autobuilder.xml
index c96713c1dc..a04006605f 100644
--- a/documentation/test-manual/test-manual-understand-autobuilder.xml
+++ b/documentation/test-manual/test-manual-understand-autobuilder.xml
@@ -20,7 +20,7 @@
20 <filename>config.json</filename> file within the 20 <filename>config.json</filename> file within the
21 <filename>yocto-autobuilder-helper</filename> repository. The targets are defined in 21 <filename>yocto-autobuilder-helper</filename> repository. The targets are defined in
22 the ‘overrides’ section, a quick example could be qemux86-64 which looks 22 the ‘overrides’ section, a quick example could be qemux86-64 which looks
23 like:<literallayout> 23 like:<literallayout class="monospaced">
24 "qemux86-64" : { 24 "qemux86-64" : {
25 "MACHINE" : "qemux86-64", 25 "MACHINE" : "qemux86-64",
26 "TEMPLATE" : "arch-qemu", 26 "TEMPLATE" : "arch-qemu",
@@ -32,7 +32,7 @@
32 }, 32 },
33 </literallayout>And 33 </literallayout>And
34 to expand that, you need the “arch-qemu” entry from the “templates” section, which looks 34 to expand that, you need the “arch-qemu” entry from the “templates” section, which looks
35 like:<literallayout> 35 like:<literallayout class="monospaced">
36 "arch-qemu" : { 36 "arch-qemu" : {
37 "BUILDINFO" : true, 37 "BUILDINFO" : true,
38 "BUILDHISTORY" : true, 38 "BUILDHISTORY" : true,
@@ -52,11 +52,12 @@
52 } 52 }
53 }, 53 },
54 </literallayout>Combining 54 </literallayout>Combining
55 these two entries you can see that “qemux86-64” is a three step build where the “bitbake 55 these two entries you can see that “qemux86-64” is a three step build where the
56 BBTARGETS” would be run, then “bitbake SANITYTARGETS” for each step; all for 56 <filename>bitbake BBTARGETS</filename> would be run, then <filename>bitbake
57 MACHINE=”qemx86-64” but with differing SDKMACHINE settings. In step 1 an extra variable 57 SANITYTARGETS</filename> for each step; all for
58 is added to the <filename>auto.conf</filename> file to enable wic image 58 <filename>MACHINE=”qemx86-64”</filename> but with differing SDKMACHINE settings. In
59 generation.</para> 59 step 1 an extra variable is added to the <filename>auto.conf</filename> file to enable
60 wic image generation.</para>
60 <para>While not every detail of this is covered here, you can see how the templating 61 <para>While not every detail of this is covered here, you can see how the templating
61 mechanism allows quite complex configurations to be built up yet allows duplication and 62 mechanism allows quite complex configurations to be built up yet allows duplication and
62 repetition to be kept to a minimum.</para> 63 repetition to be kept to a minimum.</para>
@@ -284,18 +285,18 @@
284 substitution of the paths. The Helper script repository includes a 285 substitution of the paths. The Helper script repository includes a
285 <filename>local-example.json</filename> file to show how you could override these 286 <filename>local-example.json</filename> file to show how you could override these
286 from a separate configuration file. Pass the following into the environment of the 287 from a separate configuration file. Pass the following into the environment of the
287 Autobuilder:<literallayout> 288 Autobuilder:<literallayout class="monospaced">
288 $ ABHELPER_JSON="config.json local-example.json" 289 $ ABHELPER_JSON="config.json local-example.json"
289 </literallayout>As 290 </literallayout>As
290 another example, you could also pass the following into the 291 another example, you could also pass the following into the
291 environment:<literallayout> 292 environment:<literallayout class="monospaced">
292 $ ABHELPER_JSON="config.json <replaceable>/some/location/</replaceable>local.json" 293 $ ABHELPER_JSON="config.json <replaceable>/some/location/</replaceable>local.json"
293 </literallayout>One 294 </literallayout>One
294 issue users often run into is validation of the <filename>config.json</filename> files. 295 issue users often run into is validation of the <filename>config.json</filename> files.
295 A tip for minimizing issues from invalid json files is to use a Git 296 A tip for minimizing issues from invalid json files is to use a Git
296 <filename>pre-commit-hook.sh</filename> script to verify the JSON file before 297 <filename>pre-commit-hook.sh</filename> script to verify the JSON file before
297 committing it. Create a symbolic link as 298 committing it. Create a symbolic link as
298 follows:<literallayout> 299 follows:<literallayout class="monospaced">
299 $ ln -s ../../scripts/pre-commit-hook.sh .git/hooks/pre-commit 300 $ ln -s ../../scripts/pre-commit-hook.sh .git/hooks/pre-commit
300 </literallayout></para> 301 </literallayout></para>
301 </section> 302 </section>