documentation: Updated testimage targets.
The documentation of available names for TEST_TARGET have been updated to match the convention of using the class names of controllers.
--- documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++---- documentation/ref-manual/ref-variables.xml | 19 ++++--------------- 2 files changed, 8 insertions(+), 19 deletions(-)
documentation/dev-manual/dev-manual-common-tasks.xml +4 -4
@@ -11400,7 +11400,7 @@ within a separately started QEMU or any other virtual machine manager. </para></listitem> - <listitem><para><emphasis>"Systemd-bootTarget":</emphasis> + <listitem><para><emphasis>"SystemdbootTarget":</emphasis> Choose "Systemd-bootTarget" if your hardware is an EFI-based machine with <filename>systemd-boot</filename> as bootloader and
@@ -11459,10 +11459,10 @@ </section> <section id='selecting-systemd-boottarget'> - <title>Selecting Systemd-bootTarget</title> + <title>Selecting SystemdbootTarget</title> <para> - If you did not set <filename>TEST_TARGET</filename> to + If you did not set <filename>TEST_TARG "Systemd-bootTarget", then you do not need any information in this section. You can skip down to the
@@ -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>
documentation/ref-manual/ref-variables.xml +4 -15
@@ -15162,35 +15162,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>
Signature · 1 line
2.7.4
Paulo,
I have some questions on this commit for the dev-manual.
See inline comments from me....
Quoted 21 lines · Paulo Neves
The documentation of available names for
TEST_TARGEThave been updated to match the convention of using the class names of controllers.Signed-off-by Paulo Neves <[email protected]>--- documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++---- documentation/ref-manual/ref-variables.xml | 19 ++++--------------- 2 files changed, 8 insertions(+), 19 deletions(-)documentation/dev-manual/dev-manual-common-tasks.xml +0
-1@@ -11400,7 +11400,7 @@ within a separately started QEMU or any other virtual machine manager. </para></listitem> - <listitem><para><emphasis>"Systemd-bootTarget":</
Quoted 6 lines
emphasis>
+ <listitem><para><emphasis>"
SystemdbootTarget":</emphasis>
Choose "Systemd-bootTarget" if your hardware
is
There are many instances of the term "Systemd-bootTarget" remaining in the manual. I assume they also will need to convert to "SystemdbootTarget"?
Quoted 12 lines
an EFI-based machine with <filename>systemd-boot</filename> as
bootloader anddocumentation/dev-manual/dev-manual-common-tasks.xml +1
-2@@ -11459,10 +11459,10 @@ </section> <section id='selecting-systemd-boottarget'> - <title>Selecting Systemd-bootTarget</title> + <title>Selecting SystemdbootTarget</title> <para> - If you did not set <filename>TEST_TARGET</filename>
Quoted 3 lines
to
+ If you did not set <filename>TEST_TARG
Looks like an early truncation of the line that is used for the replacement? Should be "If you did not set <filename>TEST_TARGET</filename> to"
"Systemd-bootTarget", then you do not need any
Quoted 69 lines
information
in this section.
You can skip down to thedocumentation/dev-manual/dev-manual-common-tasks.xml +0
-1@@ -11472,7 +11472,7 @@ <para> If you did set <filename>TEST_TARGET</filename> to - "Systemd-bootTarget", you also need to perform aone-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>documentation/ref-manual/ref-variables.xml +0
-0@@ -15162,35 +15162,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".documentation/ref-manual/ref-variables.xml +1
-1+ when you use "SimpleRemoteTarget". <note> This argument is defined in - <filename>meta/lib/oeqa/targetcontrol.py</filename>.
- The small caps names are kept for
compatibilitydocumentation/ref-manual/ref-variables.xml +0
-4- reasons. - </note> - </para></listitem> - <listitem><para><emphasis>"GummibootTarget":</emphasis>
documentation/ref-manual/ref-variables.xml +0
-6- 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/
Quoted 4 lines
controllers/masterimage.py</filename>.
+ <filename>meta/lib/oeqa/
controllers/simpleremote.py</filename>.
I cannot find any file named "meta/lib/oeqa/controllers/simpleremote.py" in the poky repository. Is this file you are specifying correct for a reference to the "SimpleRemoteTarget" parameter?
</note>
Quoted 11 lines
</para></listitem> </itemizedlist>--
2.7.4--
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Hello Scott,
Regarding the other instances of Systemd-bootTarget I will try to grep for them and fix them.
Regarding the truncation It is a mistake on my part. Do you know how I can generate the manual to be sure that I do not have mistakes like that?
Regarding the file, my apologies. You cannot find it because the changes which this manual changes relate to have not yet been accepted. I was a bit caught off guard by the fact that the documentation and open-embedded mailing lists are separate so I did not think that I should only submit documentation changes after the OE/poky and others are accepted. When I produced my changes I did it in the poky git repository, and split the documentation ad-hoc. I will submit the documentation with the fixes you proposed after my other commits are accepted. My apologies for the time wasted.
Paulo Neves
Quoted 123 lines · Scott Rifenbark
Paulo,
I have some questions on this commit for the dev-manual.
See inline comments from me....
Quoted 16 lines · Paulo Neves
The documentation of available names for
TEST_TARGEThave been updated to match the convention of using the class names of controllers.Signed-off-by Paulo Neves <[email protected]>--- documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++---- documentation/ref-manual/ref-variables.xml | 19 ++++--------------- 2 files changed, 8 insertions(+), 19 deletions(-)documentation/dev-manual/dev-manual-common-tasks.xml +0
-0documentation/dev-manual/dev-manual-common-tasks.xml line 11404
Quoted 6 lines
documentation/dev-manual/dev-manual-common-tasks.xml +1
-1@@ -11400,7 +11400,7 @@ within a separately started QEMU or any other virtual machine manager. </para></listitem> - <listitem><para><emphasis>"Systemd-bootTarget":</emphasis> + <listitem><para><emphasis>"SystemdbootTarget":</emphasis> Choose "Systemd-bootTarget" if your hardware isThere are many instances of the term "Systemd-bootTarget" remaining in the manual. I assume they also will need to convert to "SystemdbootTarget"?
documentation/dev-manual/dev-manual-common-tasks.xml line 11465
Quoted 13 lines
documentation/dev-manual/dev-manual-common-tasks.xml +2
-2an EFI-based machine with <filename>systemd-boot</filename> as bootloader and@@ -11459,10 +11459,10 @@ </section> <section id='selecting-systemd-boottarget'> - <title>Selecting Systemd-bootTarget</title> + <title>Selecting SystemdbootTarget</title> <para> - If you did not set <filename>TEST_TARGET</filename> to + If you did not set <filename>TEST_TARGLooks like an early truncation of the line that is used for the replacement? Should be "If you did not set <filename>TEST_TARGET</filename> to"
Quoted 43 lines
documentation/dev-manual/dev-manual-common-tasks.xml +1
-1"Systemd-bootTarget", then you do not need any information in this section. You can skip down to the@@ -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>documentation/ref-manual/ref-variables.xml +3
-6@@ -15162,35 +15162,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.documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" · line 15182
Quoted 10 lines
documentation/ref-manual/ref-variables.xml +1
-9- </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>.I cannot find any file named "
meta/lib/oeqa/controllers/simpleremote.py" in the poky repository. Is this file you are specifying correct for a reference to the "SimpleRemoteTarget" parameter?Quoted 11 lines
documentation/ref-manual/ref-variables.xml +0
-1</note> </para></listitem> </itemizedlist> --2.7.4
--
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Paulo,
No problems... I made the changes already in the 2.6 version of the YP Ref Manual (see
https://yoctoproject.org/docs/2.6/ref-manual/ref-manual.html#var-TEST_TARGET).
You can review that for me and let me know what further changes I need. You can just respond via email if you like in this thread to tell me of any changes. You do not have to submit a formal patch.
I searched for and think I got all the instances of "Systemd-bootTarget" fixed. I figured this was just an oversight in the original patch you sent. No problems. Here is a link to the 2.6 version of the mega-manual that you could search through for any term....
https://yoctoproject.org/docs/2.6/mega-manual/mega-manual.html. That is a handy manual to locate terms across the entire Yocto Project manual set.
In short, you don't have to send me a new patch for the docs... I think we are 99% there. I just will need you to review that description of TEST_TARGET in the ref-manual (
https://yoctoproject.org/docs/2.6/ref-manual/ref-manual.html#var-TEST_TARGET)
and let me know if things are okay with that.
Best,
Scott
Quoted 180 lines · Paulo Neves
Hello Scott,
Regarding the other instances of Systemd-bootTarget I will try to grep for them and fix them.
Regarding the truncation It is a mistake on my part. Do you know how I can generate the manual to be sure that I do not have mistakes like that?Regarding the file, my apologies. You cannot find it because the changes which this manual changes relate to have not yet been accepted. I was a bit caught off guard by the fact that the documentation and open-embedded mailing lists are separate so I did not think that I should only submit documentation changes after the OE/poky and others are accepted. When I produced my changes I did it in the poky git repository, and split the documentation ad-hoc. I will submit the documentation with the fixes you proposed after my other commits are accepted. My apologies for the time wasted.
Paulo Neves
Quoted 19 lines · Scott Rifenbark
Paulo,
I have some questions on this commit for the dev-manual.
See inline comments from me....
Quoted 9 lines · Paulo Neves
The documentation of available names for
TEST_TARGEThave been updated to match the convention of using the class names of controllers.Signed-off-by Paulo Neves <[email protected]>--- documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++---- documentation/ref-manual/ref-variables.xml | 19++++---------------
Quoted 3 lines
Review
Quoted 3 lines
2 files changed, 8 insertions(+), 19 deletions(-)(quoted diff) +0
-0
b/documentation/dev-manual/dev-manual-common-tasks.xmlQuoted 8 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11403
Quoted 8 lines
index 0cb967f..2fcdad0 100644
documentation/dev-manual/dev-manual-common-tasks.xml +0
-1@@ -11400,7 +11400,7 @@ within a separately started QEMU or any other virtual machine manager. </para></listitem> - <listitem><para><emphasis>"Systemd-bootTarget":</emphasis>
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml line 11403
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml +1
-0+ <listitem><para><emphasis>"SystemdbootTarget":</emphasis>
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml line 11404
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml +0
-0Choose "Systemd-bootTarget" if yourhardware is
Quoted 3 lines
There are many instances of the term "Systemd-bootTarget" remaining in
the manual. I assume they also will need to convert to "SystemdbootTarget"?
Quoted 4 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11406
Quoted 4 lines
documentation/dev-manual/dev-manual-common-tasks.xml +0
-0an EFI-based machine with <filename>systemd-boot</filename> asbootloader and
Quoted 9 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11465
Quoted 9 lines
documentation/dev-manual/dev-manual-common-tasks.xml +1
-2@@ -11459,10 +11459,10 @@ </section> <section id='selecting-systemd-boottarget'> - <title>Selecting Systemd-bootTarget</title> + <title>Selecting SystemdbootTarget</title> <para> - If you did not set <filename>TEST_TARGET</filename>to
Quoted 4 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11465
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml +1
-0+ If you did not set <filename>TEST_TARGLooks like an early truncation of the line that is used for the
replacement? Should be "If you did not set <filename>TEST_TARGET</filename> to"
Quoted 2 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11466
Quoted 2 lines
documentation/dev-manual/dev-manual-common-tasks.xml +0
-0"Systemd-bootTarget", then you do not need anyinformation
Quoted 7 lines
documentation/dev-manual/dev-manual-common-tasks.xml line 11475
Quoted 7 lines
documentation/dev-manual/dev-manual-common-tasks.xml +0
-1in this section. You can skip down to the@@ -11472,7 +11472,7 @@ <para> If you did set <filename>TEST_TARGET</filename> to - "Systemd-bootTarget", you also need to perform aone-time
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml line 11475
Quoted 1 line
documentation/dev-manual/dev-manual-common-tasks.xml +1
-0+ "SystemdbootTarget", you also need to perform aone-time
Quoted 3 lines
documentation/dev-manual/dev-manual-common-tasks.xml
Quoted 3 lines
documentation/dev-manual/dev-manual-common-tasks.xml +0
-0setup of your master image by doing the following: <orderedlist> <listitem><para><emphasis>Set<filename>EFI_PROVIDER</filename>:</emphasis>
Quoted 1 line
Review
Quoted 1 line
(quoted diff) +0
-0
b/documentation/ref-manual/ref-variables.xmlQuoted 4 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/
Quoted 4 lines
index 2465553..a61fee6 100644
documentation/ref-manual/ref-variables.xml +0
-0@@ -15162,35 +15162,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 4 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 4 lines
documentation/ref-manual/ref-variables.xml +0
-1You can provide the following arguments with <filename>TEST_TARGET</filename>: <itemizedlist> - <listitem><para><emphasis>"qemu" and"QemuTarget":</emphasis>
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15165
Quoted 1 line
documentation/ref-manual/ref-variables.xml +1
-0+ <listitem><para><emphasis>"QemuTarget":</emphasis>
Quoted 3 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 3 lines
documentation/ref-manual/ref-variables.xml +0
-0Boots 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>"
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15169
Quoted 1 line
documentation/ref-manual/ref-variables.xml +0
-0section in the Yocto Project DevelopmentTasks
Quoted 3 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 3 lines
documentation/ref-manual/ref-variables.xml +0
-1Manual for more information. </para></listitem> - <listitem><para><emphasis>"simpleremote" and"SimpleRemoteTarget":</emphasis>
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15172
Quoted 1 line
documentation/ref-manual/ref-variables.xml +1
-0+ <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis>
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15173
Quoted 1 line
documentation/ref-manual/ref-variables.xml +0
-0Runs the tests on target hardware that isalready
Quoted 2 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15175
Quoted 2 lines
documentation/ref-manual/ref-variables.xml +0
-0up and running. The hardware can be on the network or itcan be
Quoted 3 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 3 lines
documentation/ref-manual/ref-variables.xml +0
-0a device running an image on QEMU. You must also set <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link>
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15179
Quoted 1 line
documentation/ref-manual/ref-variables.xml +0
-1- when you use "simpleremote" or"SimpleRemoteTarget".
Quoted 4 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 4 lines
documentation/ref-manual/ref-variables.xml +1
-1+ when you use "SimpleRemoteTarget". <note> This argument is defined in - <filename>meta/lib/oeqa/targetcontrol.py</filename>.
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15183
Quoted 1 line
documentation/ref-manual/ref-variables.xml +0
-1- The small caps names are kept forcompatibility
Quoted 4 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 4 lines
documentation/ref-manual/ref-variables.xml +0
-4- reasons. - </note> - </para></listitem> - <listitem><para><emphasis>"GummibootTarget":</emphasis>
Quoted 6 lines
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Quoted 6 lines
documentation/ref-manual/ref-variables.xml +0
-6- 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>.
Quoted 1 line
documentation/ref-manual/ref-variables.xml recipes-graphics/xorg-font/ · line 15182
Quoted 1 line
documentation/ref-manual/ref-variables.xml +1
-0+ <filename>meta/lib/oeqa/controllers/simpleremote.py</filename>.
Quoted 3 lines
I cannot find any file named "
meta/lib/oeqa/controllers/simpleremote.py"in the poky repository. Is this file you are specifying correct for a reference to the "SimpleRemoteTarget" parameter?
Quoted 14 lines
Quoted 12 lines
documentation/ref-manual/ref-variables.xml +0
-1</note> </para></listitem> </itemizedlist> --2.7.4
--
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto