diff options
author | Paulo Neves <ptsneves@gmail.com> | 2018-08-07 15:01:17 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-08-15 10:28:44 +0100 |
commit | c610d310e74e916aef97de2ed9832f49b7aac60b (patch) | |
tree | 484119e5bbbfd5914e675695db92371c21f1ed67 /documentation | |
parent | 3d96c5ef26b1bebd79a915ff6067612487fd2d15 (diff) | |
download | poky-c610d310e74e916aef97de2ed9832f49b7aac60b.tar.gz |
dev-manual, ref-manual: Updated available names for TEST_TARGET
The documentation of available names for TEST_TARGET has been
updated to match the convention of using the class names of
controllers.
This commit was modified some to make it work. Fixed some
formatting errors and isolated and changed missed instances.
(From yocto-docs rev: 1bec1dc38cdd1746ce6dd539f9c3e5665d12ab8e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 22 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 23 |
2 files changed, 17 insertions, 28 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index afda0a439d..4bb9d7113b 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -11400,8 +11400,8 @@ | |||
11400 | within a separately started QEMU or any | 11400 | within a separately started QEMU or any |
11401 | other virtual machine manager. | 11401 | other virtual machine manager. |
11402 | </para></listitem> | 11402 | </para></listitem> |
11403 | <listitem><para><emphasis>"Systemd-bootTarget":</emphasis> | 11403 | <listitem><para><emphasis>"SystemdbootTarget":</emphasis> |
11404 | Choose "Systemd-bootTarget" if your hardware is | 11404 | Choose "SystemdbootTarget" if your hardware is |
11405 | an EFI-based machine with | 11405 | an EFI-based machine with |
11406 | <filename>systemd-boot</filename> as bootloader and | 11406 | <filename>systemd-boot</filename> as bootloader and |
11407 | <filename>core-image-testmaster</filename> | 11407 | <filename>core-image-testmaster</filename> |
@@ -11409,10 +11409,10 @@ | |||
11409 | Also, your hardware under test must be in a | 11409 | Also, your hardware under test must be in a |
11410 | DHCP-enabled network that gives it the same IP | 11410 | DHCP-enabled network that gives it the same IP |
11411 | address for each reboot.</para> | 11411 | address for each reboot.</para> |
11412 | <para>If you choose "Systemd-bootTarget", there are | 11412 | <para>If you choose "SystemdbootTarget", there are |
11413 | additional requirements and considerations. | 11413 | additional requirements and considerations. |
11414 | See the | 11414 | See the |
11415 | "<link linkend='selecting-systemd-boottarget'>Selecting Systemd-bootTarget</link>" | 11415 | "<link linkend='selecting-systemdboottarget'>Selecting SystemdbootTarget</link>" |
11416 | section, which follows, for more information. | 11416 | section, which follows, for more information. |
11417 | </para></listitem> | 11417 | </para></listitem> |
11418 | <listitem><para><emphasis>"BeagleBoneTarget":</emphasis> | 11418 | <listitem><para><emphasis>"BeagleBoneTarget":</emphasis> |
@@ -11458,12 +11458,12 @@ | |||
11458 | </para> | 11458 | </para> |
11459 | </section> | 11459 | </section> |
11460 | 11460 | ||
11461 | <section id='selecting-systemd-boottarget'> | 11461 | <section id='selecting-systemdboottarget'> |
11462 | <title>Selecting Systemd-bootTarget</title> | 11462 | <title>Selecting SystemdbootTarget</title> |
11463 | 11463 | ||
11464 | <para> | 11464 | <para> |
11465 | If you did not set <filename>TEST_TARGET</filename> to | 11465 | If you did not set <filename>TEST_TARGET</filename> to |
11466 | "Systemd-bootTarget", then you do not need any information | 11466 | "SystemdbootTarget", then you do not need any information |
11467 | in this section. | 11467 | in this section. |
11468 | You can skip down to the | 11468 | You can skip down to the |
11469 | "<link linkend='qemu-image-running-tests'>Running Tests</link>" | 11469 | "<link linkend='qemu-image-running-tests'>Running Tests</link>" |
@@ -11472,7 +11472,7 @@ | |||
11472 | 11472 | ||
11473 | <para> | 11473 | <para> |
11474 | If you did set <filename>TEST_TARGET</filename> to | 11474 | If you did set <filename>TEST_TARGET</filename> to |
11475 | "Systemd-bootTarget", you also need to perform a one-time | 11475 | "SystemdbootTarget", you also need to perform a one-time |
11476 | setup of your master image by doing the following: | 11476 | setup of your master image by doing the following: |
11477 | <orderedlist> | 11477 | <orderedlist> |
11478 | <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis> | 11478 | <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis> |
@@ -11543,7 +11543,7 @@ | |||
11543 | 11543 | ||
11544 | <para> | 11544 | <para> |
11545 | The final thing you need to do when setting | 11545 | The final thing you need to do when setting |
11546 | <filename>TEST_TARGET</filename> to "Systemd-bootTarget" is | 11546 | <filename>TEST_TARGET</filename> to "SystemdbootTarget" is |
11547 | to set up the test image: | 11547 | to set up the test image: |
11548 | <orderedlist> | 11548 | <orderedlist> |
11549 | <listitem><para><emphasis>Set up your <filename>local.conf</filename> file:</emphasis> | 11549 | <listitem><para><emphasis>Set up your <filename>local.conf</filename> file:</emphasis> |
@@ -11552,7 +11552,7 @@ | |||
11552 | <literallayout class='monospaced'> | 11552 | <literallayout class='monospaced'> |
11553 | IMAGE_FSTYPES += "tar.gz" | 11553 | IMAGE_FSTYPES += "tar.gz" |
11554 | INHERIT += "testimage" | 11554 | INHERIT += "testimage" |
11555 | TEST_TARGET = "Systemd-bootTarget" | 11555 | TEST_TARGET = "SystemdbootTarget" |
11556 | TEST_TARGET_IP = "192.168.2.3" | 11556 | TEST_TARGET_IP = "192.168.2.3" |
11557 | </literallayout> | 11557 | </literallayout> |
11558 | </para></listitem> | 11558 | </para></listitem> |
@@ -11969,7 +11969,7 @@ | |||
11969 | The target controller object used to deploy | 11969 | The target controller object used to deploy |
11970 | and start an image on a particular target | 11970 | and start an image on a particular target |
11971 | (e.g. QemuTarget, SimpleRemote, and | 11971 | (e.g. QemuTarget, SimpleRemote, and |
11972 | Systemd-bootTarget). | 11972 | SystemdbootTarget). |
11973 | Tests usually use the following: | 11973 | Tests usually use the following: |
11974 | <itemizedlist> | 11974 | <itemizedlist> |
11975 | <listitem><para><emphasis><filename>ip</filename>:</emphasis> | 11975 | <listitem><para><emphasis><filename>ip</filename>:</emphasis> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 346090f0d4..206a77012d 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -15285,9 +15285,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
15285 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 15285 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
15286 | Specifies the target controller to use when running tests | 15286 | Specifies the target controller to use when running tests |
15287 | against a test image. | 15287 | against a test image. |
15288 | The default controller to use is "qemu": | 15288 | The default controller to use is "QemuTarget": |
15289 | <literallayout class='monospaced'> | 15289 | <literallayout class='monospaced'> |
15290 | TEST_TARGET = "qemu" | 15290 | TEST_TARGET = "QemuTarget" |
15291 | </literallayout> | 15291 | </literallayout> |
15292 | </para> | 15292 | </para> |
15293 | 15293 | ||
@@ -15306,35 +15306,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
15306 | You can provide the following arguments with | 15306 | You can provide the following arguments with |
15307 | <filename>TEST_TARGET</filename>: | 15307 | <filename>TEST_TARGET</filename>: |
15308 | <itemizedlist> | 15308 | <itemizedlist> |
15309 | <listitem><para><emphasis>"qemu" and "QemuTarget":</emphasis> | 15309 | <listitem><para><emphasis>"QemuTarget":</emphasis> |
15310 | Boots a QEMU image and runs the tests. | 15310 | Boots a QEMU image and runs the tests. |
15311 | See the | 15311 | See the |
15312 | "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" | 15312 | "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" |
15313 | section in the Yocto Project Development Tasks | 15313 | section in the Yocto Project Development Tasks |
15314 | Manual for more information. | 15314 | Manual for more information. |
15315 | </para></listitem> | 15315 | </para></listitem> |
15316 | <listitem><para><emphasis>"simpleremote" and "SimpleRemoteTarget":</emphasis> | 15316 | <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> |
15317 | Runs the tests on target hardware that is already | 15317 | Runs the tests on target hardware that is already |
15318 | up and running. | 15318 | up and running. |
15319 | The hardware can be on the network or it can be | 15319 | The hardware can be on the network or it can be |
15320 | a device running an image on QEMU. | 15320 | a device running an image on QEMU. |
15321 | You must also set | 15321 | You must also set |
15322 | <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> | 15322 | <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> |
15323 | when you use "simpleremote" or "SimpleRemoteTarget". | 15323 | when you use "SimpleRemoteTarget". |
15324 | <note> | 15324 | <note> |
15325 | This argument is defined in | 15325 | This argument is defined in |
15326 | <filename>meta/lib/oeqa/targetcontrol.py</filename>. | 15326 | <filename>meta/lib/oeqa/controllers/simpleremote.py</filename>. |
15327 | The small caps names are kept for compatibility | ||
15328 | reasons. | ||
15329 | </note> | ||
15330 | </para></listitem> | ||
15331 | <listitem><para><emphasis>"GummibootTarget":</emphasis> | ||
15332 | Automatically deploys and runs tests on an | ||
15333 | EFI-enabled machine that has a master image | ||
15334 | installed. | ||
15335 | <note> | ||
15336 | This argument is defined in | ||
15337 | <filename>meta/lib/oeqa/controllers/masterimage.py</filename>. | ||
15338 | </note> | 15327 | </note> |
15339 | </para></listitem> | 15328 | </para></listitem> |
15340 | </itemizedlist> | 15329 | </itemizedlist> |