Bug 9001

Summary: bootimg.bbclass does not document GRUB boot lodader support
Product: [Documentation] Mega Manual Reporter: Gatis Paeglis <gatis.paeglis>
Component: mega-manualAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: bluelightning, california.l.sullivan, srifenbark
Version: unspecified   
Target Milestone: 2.3 M4   
Hardware: x86   
OS: Multiple   
Whiteboard: 12 May 2017: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Gatis Paeglis 2016-01-26 10:32:43 UTC
http://www.yoctoproject.org/docs/2.0/mega-manual/mega-manual.html#ref-classes-bootimg

This class has support for creating bootable GRUB based images, but the feature is not documented.
Comment 1 Scott Rifenbark 2016-01-27 23:55:01 UTC
Hi, 

If you look at http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-classes-bootimg you will see the bootimg class description in the ref-manual.  If it supports GRUB-based images, then I presume we need to add that to the list that currently shows only .hddimg and .iso.  

I probably need some information from you to create a new list item as I don't know any of the details for documenting this new support.  Could you provide me with some further information?

Thanks,
Scott
Comment 2 Gatis Paeglis 2016-01-28 10:58:07 UTC
> I presume we need to add that to the list that currently shows only .hddimg and .iso.

This list is complete. There can be for example *.iso image with syslinux boot loader and with grub boot loader. So it is still *.iso image, only the type of boot loader changes.

The issue is that this class documents only the syslinux:

"The bootimg class creates a bootable image using SYSLINUX"

> I probably need some information from you to create a new list item as I don't know any of the details for documenting this new support.  Could you provide me with some further information?

You can check git history "gitk bootimg.bbclass" and send an email to the person who added grub support. He should know better what to document.
Comment 3 Gatis Paeglis 2016-01-28 10:58:42 UTC
updating status "new more info" -> "new"
Comment 4 Scott Rifenbark 2016-10-25 20:13:40 UTC
Moving to 2.3 M2
Comment 5 Scott Rifenbark 2017-01-31 16:26:48 UTC
Moved to 2.3 M3.
Comment 6 Scott Rifenbark 2017-03-20 18:35:21 UTC
OK - My bad on letting this bug languish for so long...

I have investigated this a bit and it appears the bootimg.bbclass class was merged into the image-live.bbclass for YP 2.1 release.  My question is does this bug still apply?  The latest information for image-live.bbclass is here - http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#ref-classes-image-live.  The information in question does not appear here in this class description.  Was the functionality dropped from the code?  Or did I just drop it in the docs?  Let me know if we need to update the image-live.bbclass description.

Thanks, 
Scott
Comment 7 Stephen K Jolley 2017-05-04 15:17:36 UTC
Cal,

Can you review Scott's documentation?
Comment 8 California Sullivan 2017-05-11 23:43:31 UTC
I think the image-live.bbclass documentation should say plainly that it is used for .iso and .hddimg images, rather than only the iso example. Also, it should mention that these live images contain syslinux for legacy boot, and the bootloader specified by EFI_PROVIDER if "efi" is in MACHINE_FEATURES. This would be closer to what I imagine:

This class controls building HDDIMG and ISO images. Use this class by adding "live" to IMAGE_FSTYPES. You can selectively build just one of these types through the NOHDD and NOISO variables. Live images contain syslinux for legacy booting, as well as the bootloader specified by EFI_PROVIDER if MACHINE_FEATURES contains "efi".
Comment 9 Stephen K Jolley 2017-05-12 17:37:58 UTC
It appears you have gotten feedback.  Removing NEEDINFO.
Comment 10 Scott Rifenbark 2017-05-12 18:31:57 UTC
Here are some changes to deal with this doc issue.  Let me know if they are okay.

 * image-live.bbclass reference section - http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#ref-classes-image-live

 * EFI_PROVIDER glossary description.  I added a cross-referencing link back to the image-live.bbclass section - http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#var-EFI_PROVIDER

Thanks, 
Scott
Comment 11 California Sullivan 2017-05-12 19:31:54 UTC
Looks good to me.
Comment 12 Scott Rifenbark 2017-05-12 19:55:50 UTC
Thanks Cal, 

I am RESOLVING and putting the doc flag to "done."

Scott