Bug 9667

Summary: Image types in quick start guide should be appropriate and consistent
Product: [Documentation] Quick Start Reporter: Henry Bruce <henry.bruce>
Component: quick-startAssignee: Henry Bruce <henry.bruce>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium+ CC: bluelightning, poky.doc.watcher, poky.watcher, randy.macleod, richard.purdie, srifenbark
Version: unspecified   
Target Milestone: 2.2 M4   
Hardware: x86   
OS: Multiple   
Whiteboard: 03 Oct 2016: IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Henry Bruce 2016-05-24 00:29:36 UTC
The quick start guide uses core-image-sato for the qemux86 target and core-image minimal for Minnowboard Max.

core-image-sato is an unfamiliar U/I. The extra build time does not benefit the average user who is likely to open a console and work from there. For MinnowMax core-image-minimal does not build kernel modules so low speed I/O connector is not full operational.

Both targets should should be headless to reflect the majority of IoT platforms and be the same for a consistent experience. A headless target will also force documentation of the qemu "nographic" mode. MinnowMax should have functional low speed I/O.

core-image-base would be a suitable image. Other suggestions welcome.
Comment 1 Richard Purdie 2016-05-26 14:49:19 UTC
This is tricky as not everyone using the project is an IoT user and not every user is comfortable with the console.

I think one big obvious improvement would be if sato has the terminal icon on the first desktop screen shown, then anyone wanting a console has an easy way to find it (its currently one screen to the right iirc).

Assigning this to Jussi to see if there are any tweaks we cna make as part of the sato gtk3 transition.
Comment 2 Jussi Kukkonen 2016-05-27 10:17:54 UTC
> I think one big obvious improvement would be if sato has the terminal icon
> on the first desktop screen shown ...

I'll see if there's a good solution to this, I agree current default is a bit useless.
Comment 3 Jussi Kukkonen 2016-06-21 16:49:19 UTC
(In reply to comment #1)
> I think one big obvious improvement would be if sato has the terminal icon
> on the first desktop screen shown, then anyone wanting a console has an easy
> way to find it (its currently one screen to the right iirc).

This particular issue should be fixed. 

Do we want to do something more here -- like improve the headless target used for Minnowboard Max if core-image-minimal does not have all the kernel modules?

I'm resetting assignee in any case.
Comment 4 Scott Rifenbark 2016-06-27 17:54:13 UTC
Hi, 

So what is the conclusion here?  Right now we use core-image-minimal and core-image-sata.  I like the mix personally.  Let me know though and we can change it.  

Scott
Comment 5 Scott Rifenbark 2016-09-26 16:41:25 UTC
Setting this to NEEDINFO.  I need some conclusion here to move forward. 

Scott
Comment 6 Henry Bruce 2016-09-27 20:28:55 UTC
I still believe that we should offer a simple headless build through core-image-minimal targeting qemu. It offers a much quicker build and avoids the keyboard mapping issues caused by X11 fowarding on MacOS. Developers who have managed to create an OS image should be familiar enough with command line to use a qemu image. We can offer core-image-sato as a GUI option.

As for Minnow Max, what is the rationale for giving instructions to build an image where the majority of functionality on low speed I/O connector is disabled? If we used core-image-base the connector would work. The BSP team agrees with me on this.

If Richard nor Scott still disagree with my proposal, I suggest we close as INVALID.
Comment 7 Richard Purdie 2016-10-03 14:32:15 UTC
core-image-minimal is too minimal to replace sato, it has no ssh server and is missing a ton of other things a developer might want. 

So I do agree we should recommend something else for minnow. core-image-base or core-image-full-cmdline would seem like options.

The -base/-cmdline verses sato is a harder question. Under qemu, we do have graphics. I think making decisions based on X11 forwarding not working in MacOS is a false economy, whilst Henry evidently hits that use case hard I'm not sure the majority of our new users do.

Perhaps we could just give the users a choice in the quickstart between minimal, full-cmdline and sato as examples of what you can do?
Comment 8 Scott Rifenbark 2016-10-03 19:02:12 UTC
Thanks, 

I will leave bitbake core-image-sato alone.  Regarding the second part of the example, see step 3 of the second set of build steps within http://www.yoctoproject.org/docs/2.2/yocto-project-qs/yocto-project-qs.html#qs-building-images.  I have suggested some types of images to build and changed the actual build command to use core-image-base.

Let me know if this all works.

Thanks,
Scott
Comment 9 Henry Bruce 2016-10-10 17:26:45 UTC
I agree that we should use core-image-base instead of core-image-minimal. 

Although manual recommends using core-image-base for MinnowMax build, actual command line refers to core-image-minimal. 

Also can we backport this documentation change to krogoth?
Comment 10 Scott Rifenbark 2016-10-11 12:45:20 UTC
Henry, 

That was an oversight on my part.  I have fixed it up and published to master (2.2) and back-ported to 2.1.2 (top of korgoth branch).

See the third step of the second build in http://www.yoctoproject.org/docs/2.2/yocto-project-qs/yocto-project-qs.html#qs-building-images and http://www.yoctoproject.org/docs/2.1.2/yocto-project-qs/yocto-project-qs.html#qs-building-images.

Thanks, 
Scott
Comment 11 Henry Bruce 2016-10-12 21:30:08 UTC
I'll accept Richard's decision that core-image-sato is preferable to core-image-base for qemux86 target. 

Marking as resolved.
Comment 12 Scott Rifenbark 2016-10-14 19:15:56 UTC
Turning the doc flag to "done".

Scott