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>
This commit is contained in:
Paulo Neves
2018-08-07 15:01:17 -07:00
committed by Richard Purdie
parent 3d96c5ef26
commit c610d310e7
2 changed files with 17 additions and 28 deletions

View File

@@ -11400,8 +11400,8 @@
within a separately started QEMU or any
other virtual machine manager.
</para></listitem>
<listitem><para><emphasis>"Systemd-bootTarget":</emphasis>
Choose "Systemd-bootTarget" if your hardware is
<listitem><para><emphasis>"SystemdbootTarget":</emphasis>
Choose "SystemdbootTarget" if your hardware is
an EFI-based machine with
<filename>systemd-boot</filename> as bootloader and
<filename>core-image-testmaster</filename>
@@ -11409,10 +11409,10 @@
Also, your hardware under test must be in a
DHCP-enabled network that gives it the same IP
address for each reboot.</para>
<para>If you choose "Systemd-bootTarget", there are
<para>If you choose "SystemdbootTarget", there are
additional requirements and considerations.
See the
"<link linkend='selecting-systemd-boottarget'>Selecting Systemd-bootTarget</link>"
"<link linkend='selecting-systemdboottarget'>Selecting SystemdbootTarget</link>"
section, which follows, for more information.
</para></listitem>
<listitem><para><emphasis>"BeagleBoneTarget":</emphasis>
@@ -11458,12 +11458,12 @@
</para>
</section>
<section id='selecting-systemd-boottarget'>
<title>Selecting Systemd-bootTarget</title>
<section id='selecting-systemdboottarget'>
<title>Selecting SystemdbootTarget</title>
<para>
If you did not set <filename>TEST_TARGET</filename> to
"Systemd-bootTarget", then you do not need any information
"SystemdbootTarget", then you do not need any information
in this section.
You can skip down to the
"<link linkend='qemu-image-running-tests'>Running Tests</link>"
@@ -11472,7 +11472,7 @@
<para>
If you did set <filename>TEST_TARGET</filename> to
"Systemd-bootTarget", you also need to perform a one-time
"SystemdbootTarget", you also need to perform a one-time
setup of your master image by doing the following:
<orderedlist>
<listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis>
@@ -11543,7 +11543,7 @@
<para>
The final thing you need to do when setting
<filename>TEST_TARGET</filename> to "Systemd-bootTarget" is
<filename>TEST_TARGET</filename> to "SystemdbootTarget" is
to set up the test image:
<orderedlist>
<listitem><para><emphasis>Set up your <filename>local.conf</filename> file:</emphasis>
@@ -11552,7 +11552,7 @@
<literallayout class='monospaced'>
IMAGE_FSTYPES += "tar.gz"
INHERIT += "testimage"
TEST_TARGET = "Systemd-bootTarget"
TEST_TARGET = "SystemdbootTarget"
TEST_TARGET_IP = "192.168.2.3"
</literallayout>
</para></listitem>
@@ -11969,7 +11969,7 @@
The target controller object used to deploy
and start an image on a particular target
(e.g. QemuTarget, SimpleRemote, and
Systemd-bootTarget).
SystemdbootTarget).
Tests usually use the following:
<itemizedlist>
<listitem><para><emphasis><filename>ip</filename>:</emphasis>

View File

@@ -15285,9 +15285,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Specifies the target controller to use when running tests
against a test image.
The default controller to use is "qemu":
The default controller to use is "QemuTarget":
<literallayout class='monospaced'>
TEST_TARGET = "qemu"
TEST_TARGET = "QemuTarget"
</literallayout>
</para>
@@ -15306,35 +15306,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
You can provide the following arguments with
<filename>TEST_TARGET</filename>:
<itemizedlist>
<listitem><para><emphasis>"qemu" and "QemuTarget":</emphasis>
<listitem><para><emphasis>"QemuTarget":</emphasis>
Boots a QEMU image and runs the tests.
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>"
section in the Yocto Project Development Tasks
Manual for more information.
</para></listitem>
<listitem><para><emphasis>"simpleremote" and "SimpleRemoteTarget":</emphasis>
<listitem><para><emphasis>"SimpleRemoteTarget":</emphasis>
Runs the tests on target hardware that is already
up and running.
The hardware can be on the network or it can be
a device running an image on QEMU.
You must also set
<link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link>
when you use "simpleremote" or "SimpleRemoteTarget".
when you use "SimpleRemoteTarget".
<note>
This argument is defined in
<filename>meta/lib/oeqa/targetcontrol.py</filename>.
The small caps names are kept for compatibility
reasons.
</note>
</para></listitem>
<listitem><para><emphasis>"GummibootTarget":</emphasis>
Automatically deploys and runs tests on an
EFI-enabled machine that has a master image
installed.
<note>
This argument is defined in
<filename>meta/lib/oeqa/controllers/masterimage.py</filename>.
<filename>meta/lib/oeqa/controllers/simpleremote.py</filename>.
</note>
</para></listitem>
</itemizedlist>