Bug 13225

Summary: Need better explanation of how recipes create packages
Product: [Documentation] Reference Reporter: Scott Rifenbark <srifenbark>
Component: handbookAssignee: Antonin Godard <antonin.godard>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: bluelightning, mark.morton, michael.opdenacker, poky.doc.watcher, poky.watcher, randy.macleod, richard.purdie, sscott
Version: 5.99   
Target Milestone: 5.2 M4   
Hardware: All   
OS: Multiple   
Whiteboard: October 17 2019: ACCEPTED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Scott Rifenbark 2019-03-14 14:33:12 UTC
We need better documentation on how a recipe creates packages.  This explanation would likely fit in the existing YP Overview and Concepts Manual where we describe the build process in some detail. 

I am filing this bug for Steve Scott <sscott@san.rr.com> who contacted the yocto@yoctoproject.org group asking about where to find documentation on this topic.  

Scott
Comment 1 Scott Rifenbark 2019-04-17 00:18:12 UTC
Hi, 

I am calling out for some raw information here.  How do recipes create packages?  We have this section in the overview and concepts manual (https://yoctoproject.org/docs/2.7/overview-manual/overview-manual.html#bitbake-dev-environment) that breaks down the BitBake process.  One of the sub-sections is about splitting packages.

Can someone provide an overview of the process?  Is all the information captured in that BitBake section referenced by the link in the previous paragraph?

Thanks, 
Scott R.
Comment 2 steve scott 2019-10-07 17:45:29 UTC
Scott:

The overview section of the manual does not provide an explanation that enables someone new to yocto project to grasp YP packaging. In fact, the section says, "The FILES variable defines the files that go into each package in PACKAGES. If you want details on how this is accomplished, you can look at package.bbclass." This is perhaps the most important concept, and the reader is referred to bbclass source code that is probably at this point still incomprehensible to a newbie.

This link:
https://dominion.thruhere.net/koen/OE/OE-usermanual.html#recipes_packages

provides an excellent tutorial on YP packaging from a user's point of view. It is from an old OE manual, and I have not been able to find a copy of it archived on the OE site. I think you could almost copy this section verbatim into the YP Overview section on packaging.

If there is some way to contribute to the documentation, I would be happy to give it a try.

steve
Comment 3 Scott Rifenbark 2019-10-17 16:48:48 UTC
Steve,

Thanks for the link and the extra information on this bug.  I have taken ownership of it from Richard and I will use the information in that link to fix up the Overview manual.

Scott
Comment 4 steve scott 2019-10-17 17:14:25 UTC
Hi Scott:

I was able to find a couple of other urls for the old oe manual:
https://www.cumulations.com/img/openembedded-usermanual.pdf
http://www.embeddedlinux.org.cn/OEManual/

You might want to archive the pdf version somewhere (perhaps include it in the YP archived documents). I was looking through it and it has a lot of good information.
Comment 5 Scott Rifenbark 2019-10-17 17:30:35 UTC
Hey Steve...  Thanks for additional doc.
Comment 6 Randy MacLeod 2024-10-24 15:03:59 UTC
Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.
Comment 7 Antonin Godard 2024-10-29 10:22:25 UTC
Documentation on package splitting was added by following commit:
https://git.yoctoproject.org/yocto-docs/commit/?id=143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9

Closing this bug.