Bug 12517

Summary: Update documentation on gen-tapdevs script
Product: [Documentation] General Docs Reporter: Stephano Cetola <stephano>
Component: docs-generalAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium+ CC: juro.bystricky, randy.macleod, srifenbark
Version: 2.2   
Target Milestone: 2.6 M1   
Hardware: x86   
OS: Multiple   
Whiteboard: 15 May 2018: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Stephano Cetola 2018-01-29 20:43:13 UTC
See Bug 12125 for details.

runqemu-gen-tapdevs requires qemu-helper-native to have already been built, and this is not mentioned anywhere. 

Also, sudo will break this script if you do not run it with an absolute path.

I will word this appropriately and reassign when finished.
Comment 1 Juro Bystricky 2018-01-29 22:06:46 UTC
and also the help message should not assume/display UID/GID=1000/1000 but display the actual UID/GID.
Comment 2 Stephano Cetola 2018-05-15 10:02:26 UTC
Scott,

Please change the following text in the mega-manual:

Run as root the script in scripts/runqemu-gen-tapdevs, which should generate a list of tap devices. This is the option typically chosen for Autobuilder-type environments.

We need to add to bullet points:

--Be sure to use an absolute path when calling this script with sudo.
--The package recipe `qemu-helper-native` is required to run this script. Build it with `bitbake qemu-helper-native`.

Let me know if you have any questions. Thanks!
Comment 3 Scott Rifenbark 2018-05-15 10:17:28 UTC
Stephano, 

See https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#qemu-image-enabling-tests and let me know if this is good.  There was no change in what you had for that first paragraph and what was already in the manual. 

I added the two bullet points in a note.

Scott
Comment 4 Stephano Cetola 2018-05-15 10:24:43 UTC
Looks perfect, thanks!
Comment 5 Scott Rifenbark 2018-05-15 10:29:48 UTC
Thanks, 

I set the doc flag to "done" as well.

Scott