[yocto] [yocto-docs] documentation: Updated testimage targets.
Scott Rifenbark
srifenbark at gmail.com
Fri Aug 10 12:21:29 PDT 2018
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
On Fri, Aug 10, 2018 at 11:44 AM, Paulo Neves <ptsneves at gmail.com> wrote:
> 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
>
>
> On Mon, Aug 6, 2018 at 11:12 PM Scott Rifenbark <srifenbark at gmail.com>
> wrote:
> >
> > Paulo,
> >
> > I have some questions on this commit for the dev-manual.
> >
> > See inline comments from me....
> >
> >
> >
> > On Mon, Aug 6, 2018 at 4:34 AM, Paulo Neves <ptsneves at gmail.com> wrote:
> >>
> >> The documentation of available names for TEST_TARGET have
> >> been updated to match the convention of using the
> >> class names of controllers.
> >>
> >> Signed-off-by: Paulo Neves <ptsneves at gmail.com>
> >> ---
> >> documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++----
> >> documentation/ref-manual/ref-variables.xml | 19
> ++++---------------
> >> 2 files changed, 8 insertions(+), 19 deletions(-)
> >>
> >> diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml
> b/documentation/dev-manual/dev-manual-common-tasks.xml
> >> index 0cb967f..2fcdad0 100644
> >> --- a/documentation/dev-manual/dev-manual-common-tasks.xml
> >> +++ b/documentation/dev-manual/dev-manual-common-tasks.xml
> >> @@ -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
> >
> >
> > There are many instances of the term "Systemd-bootTarget" remaining in
> the manual. I assume they also will need to convert to "SystemdbootTarget"?
> >
> >>
> >> 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
> >
> >
> > 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
> 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>
> >> diff --git a/documentation/ref-manual/ref-variables.xml
> b/documentation/ref-manual/ref-variables.xml
> >> index 2465553..a61fee6 100644
> >> --- a/documentation/ref-manual/ref-variables.xml
> >> +++ b/documentation/ref-manual/ref-variables.xml
> >> @@ -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>.
> >
> >
> > 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>
> >> </para></listitem>
> >> </itemizedlist>
> >> --
> >> 2.7.4
> >>
> >> --
> >> _______________________________________________
> >> yocto mailing list
> >> yocto at yoctoproject.org
> >> https://lists.yoctoproject.org/listinfo/yocto
> >
> >
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.yoctoproject.org/pipermail/yocto/attachments/20180810/9bbe3019/attachment.html>
More information about the yocto
mailing list