Bug 6045

Summary:	Unclear how to build an ISO
Product:	[Documentation] General Docs	Reporter:	Volker <lists.volker>
Component:	docs-general	Assignee:	Scott Rifenbark <srifenbark>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	Medium	CC:	bluelightning, dvhart, lists.volker, richard.purdie, srifenbark
Version:	unspecified
Target Milestone:	1.6 M5
Hardware:	x86
OS:	Multiple
Whiteboard:	10 April 2014: Marking RESOLVED.
OS type for building Yocto:	---	Type of Regression:	New (Never tested)
Verified:		Documentation change:	Done (doc changes complete)

Description Volker 2014-03-25 20:26:38 UTC

I am new to Yocto and run into an issue creating an ISO.

It is/was unclear to me how to build an ISO. Reading through the dev and reference manual didn't help. The reference manual provided the hint that it is based on bootimg.bbclass.

The default conf/local.conf uses three classes that are listed in the same section as the bootimg.bbclass in "USER_CLASSES". Therefore I assumed that I have to append bootimg to the USER_CLASSES. My logic here got reassured because the default conf/local.conf documents the USER_CLASSES as "Additional image features".

Adding bootimg to the USER_CLASSES results in an error about a NameError.
And it seems like this is the wrong place for it after someone helped me with it. It is still not clear to me when/how to use the classes, I described the way how I understood them. My assumptation is that you have to load classes before you can use them and not to define variables which then autoloads the class.

On IRC I got help about it and was asked to open a ticket to improve the documentation.

Comment 1 Scott Rifenbark 2014-03-26 21:25:24 UTC

Thanks for opening the bug on this.  I am changing the status to ACCEPTED and will work on getting the right documentation solution in place for this. I am also adding Paul and Richard to the CC list as a resource for me.

Scott

Comment 2 Darren Hart 2014-03-27 15:06:35 UTC

Scott, to enable building of ISO images, we just add the following to local.conf:

NOISO="0"

Comment 3 Scott Rifenbark 2014-04-01 22:32:04 UTC

Hi, 

See the description for the NOISO variable.  I have added a sentence at the end saying how to enable building an ISO.  http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#var-NOISO.

If this is okay then I will close it out. 

Scott

Comment 4 Darren Hart 2014-04-02 06:36:51 UTC

Scott, this is a clear description of the variable. The problem is that someone wondering how to build an ISO image, wouldn't know to look for the NOISO variable, nor where to put it. This should probably be discussed in the developer manual along with creating image types (IMAGE_FSTYPES), or similar.

Comment 5 Scott Rifenbark 2014-04-07 16:39:59 UTC

Hi, 

I have updated the image-live.bbclass description a bit to include an example case for creating an ISO image.  I felt that I did not want to add a complete new section on creating an ISO file.  So, I looked around for areas that would talk about creating an ISO image and we really did not have any.  I feel with the added information to the image-live.bbclass section and the specifics in the NOISO variable description, the user could now successfully search for and find some information on ISO file creation. 

Please look this addition over at http://www.yoctoproject.org/docs/1.6/ref-manual/ref-manual.html#ref-classes-image-live

Thanks,
Scott

Comment 6 Scott Rifenbark 2014-04-09 12:38:47 UTC

Setting the documentation flag to "Done." on this one.

Scott

Comment 7 Scott Rifenbark 2014-04-10 19:48:01 UTC

Marking RESOLVED... I forgot to do that when I reset the documentation flag.