Bug 5065

Summary: Document the fact that the SRCREV_meta needs to be updated after modifying the linux-yocto metadata meta branch
Product: [Documentation] Kernel Development Reporter: Elvis Dowson <elvis.dowson>
Component: kernel-developmentAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: major    
Priority: Medium CC: dvhart, srifenbark
Version: 1.5   
Target Milestone: 1.5 M5   
Hardware: All   
OS: Multiple   
URL: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=5d3dc0e6ebc40b937c3f3ef397e2c94e7cb3b69b
Whiteboard: 13 September 2013: IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Elvis Dowson 2013-08-28 18:21:52 UTC
After modifying the meta-data in the linux-yocto meta branch, a kernel developer should not forget to update the SRCREVs in the linux-yocto_3.8.bb recipe.

This should be explicitly mentioned int the kernel development manual, else a kernel developer, new to modifying and updating the linux-yocto kernel meta data might spend hours or days trying to figure out why changes haven't been picked up by the build system.
Comment 1 Darren Hart 2013-08-29 03:46:11 UTC
I'm thinking a blurb could be added to "3.3.2. In-Tree Metadata" in the kernel-dev manual about being sure to update the SRCREV_meta variable to match the commit in the KMETA branch you wish to use.

The question is, would that have avoided the problem for you? I want to understand which sections you read and why you read them first. Was this one of them? If not, which one did you read? Would one of them need an update, or is some other higher level introduction to the SRCREV* vars needed elsewhere in the document?
Comment 2 Scott Rifenbark 2013-09-10 22:52:01 UTC
Darren, 

When you get more clarification on this we can update the manual.  I'm on the CC list so will be able to track it. 

Scott
Comment 3 Darren Hart 2013-09-11 16:26:16 UTC
Scott, what clarification do you need? 

As far as the manual is concerned, whenever changes are made to any of the branches with associated SRCREV, typically:

SRCREV_machine (something like standard/minnowboard, but defined by KBRANCH)
SRCREV_meta (typically just meta, but defined by KMETA)

If you change these branches and want to rebuild from the source using the recipe, you need to update the corresponding SRCREV to match or you will be fetching an older commit.
Comment 4 Darren Hart 2013-09-11 16:27:10 UTC
Reassigning to Scott with information provided. Scott, please let me know if that is enough to get changes in. If you would prefer I update the manual directly we can do that as well.
Comment 5 Scott Rifenbark 2013-09-12 23:24:46 UTC
Hi, 

I have added a paragraph at the end of the suggested section.  Here is the link.

http://www.yoctoproject.org/docs/1.5/kernel-dev/kernel-dev.html#in-tree-metadata

It is very general and assumes people reading it know what they are doing.  If you have comments or suggestions, add some comments here in Bugzilla.

Scott
Comment 6 Elvis Dowson 2013-09-13 02:53:22 UTC
Hi Scott,
         The updated section looks fine.

Elvis Dowson
Comment 7 Scott Rifenbark 2013-09-13 14:45:50 UTC
Elvis, 

Thanks for the review.  I am marking this bug resolved and turning off the Doc flag.

Scott