Bug 641 - [DOC] need a doc for qemu usage
Summary: [DOC] need a doc for qemu usage
Status: RESOLVED FIXED
Alias: None
Product: Quick Start
Classification: Documentation
Component: quick-start (show other bugs)
Version: 1.0
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 1.7
Assignee: Trevor Woerner
QA Contact:
URL:
Whiteboard: 31 July: IN PROGRESS REVIEW
Depends on:
Blocks:
 
Reported: 2011-01-06 16:22 UTC by Kevin Tian
Modified: 2014-12-26 14:45 UTC (History)
7 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kevin Tian 2011-01-06 16:22:43 UTC
such as unfs as one method...
Comment 1 Jessica 2011-01-06 16:29:12 UTC
Qemu should has it own doc, and it doesn't belong to ADT and the unfs is only one usage model that can bring up Qemu.
Comment 2 Kevin Tian 2011-01-06 17:05:01 UTC
I didn't find a right category for this bug, and it's put here for tracking purpose. If you have a better place for this bug, feel free to move it. :-)
Comment 3 Scott Rifenbark 2011-02-01 09:47:38 UTC
Agree that qemu should have its own document.
Comment 4 Scott Rifenbark 2011-02-24 05:33:22 UTC
Post 1.0 documentation.  Likely this will be part of the Yocto Project Development guide slated for post 1.0.
Comment 5 Scott Rifenbark 2011-08-17 16:06:09 UTC
I am pushing this out to past 1.1.  It still could be part of the maturing yocto project development manual.  But, it will not be complete in any form until after 1.1 releases.
Comment 6 Scott Rifenbark 2011-08-23 17:19:33 UTC
changed to enhancement.
Comment 7 Scott Rifenbark 2012-04-24 23:01:09 UTC
This needs to be assigned to the "Development Manual" component when we have that set up under "Documentation".
Comment 8 Scott Rifenbark 2013-03-20 20:09:59 UTC
This bug needs to be assigned to a general documentation category.  The solution does not fit into any existing manuals.  The solution is to create a new manual if that is what we want to do.  I am not sure who is responsible for QEMU documentation in general.  There is a website for the project at http://wiki.qemu.org/Manual#User_Documentation and that evidently is the documentation.  

Are we responsible for updating QEMU user documentation?  Is what we are looking for specific to YP?  If neither is true we don't want to touch this.

Scott
Comment 9 Richard Purdie 2013-04-25 10:38:34 UTC
Scott: As I understand this the desire is to better document:

a) The different options available to runqemu
b) The different modes of operation our qemu integration can be used in (e.g. how we do the NFS boot using unfs)
c) Very briefly cover some tips/tricks with qemu, e.g. that Ctrl+Alt+3 gives you the serial console, Alt+Left during boot switches out the splash screen, that we use a touchscreen driver to avoid the annoying mouse grab.

When we have these three issues covered, we can close this bug. The question is then who can provide you with the right info. I'm assigning to Saul to find someone to get that to you.
Comment 10 Scott Rifenbark 2014-05-05 06:39:41 UTC
Richard, 

Thanks for the further clarification that will help measure the bug.  We can cover these three areas in a new chapter 5 section of the dev-manual.  Something along the line of "Running QEMU".

Scott
Comment 11 Scott Rifenbark 2014-07-08 13:03:14 UTC
I have spent quite a bit of time during the last week looking at and understanding the runqemu script and the overall environment for using QEMU.  I am at the point now where I can start writing up a new section on this topic.

Changing status to IN PROGRESS DESIGN.

Scott
Comment 12 Scott Rifenbark 2014-07-10 11:53:44 UTC
Hi, 

I am well into creating a new chapter for QEMU that will go for now in our YP Development Manual.  I need some information on various modes that you can run QEMU in.  The one example given here was "unfs".  Can I get some general information on that mode and perhaps some other useful modes?

Thanks, 
Scott
Comment 13 Scott Rifenbark 2014-07-31 15:28:21 UTC
Hi, 

There is a new chapter in the development manual to cover the YP flavor of QEMU.  I am marking this IN PROGRESS REVIEW.  It has had good review from Richard at this point.  I will leave it up for review for a while.

http://www.yoctoproject.org/docs/1.7/dev-manual/dev-manual.html#dev-manual-qemu

Thanks, 
Scott
Comment 14 Richard Purdie 2014-11-06 15:54:45 UTC
I'm happy with the section in the manual so resolving this bug.
Comment 15 Scott Rifenbark 2014-11-06 17:16:55 UTC
Hi, 

Based on Richard's comment, I am setting the documentation flag to "done."

Scott