Bug 6925 - Mismatch between documentation and linux-yocto-custom.bb comments
Summary: Mismatch between documentation and linux-yocto-custom.bb comments
Status: VERIFIED FIXED
Alias: None
Product: Kernel Development
Classification: Documentation
Component: kernel-development (show other bugs)
Version: unspecified
Hardware: All Multiple
: Low normal
Target Milestone: 1.9 M2
Assignee: Bruce Ashfield
QA Contact: Alexandru Roman
URL:
Whiteboard: 17 June 2015: Set the documentation f...
Depends on:
Blocks:
 
Reported: 2014-11-03 10:48 UTC by Paul Eggleton
Modified: 2015-09-09 11:55 UTC (History)
3 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: No (bug/feature does not impact docs)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Eggleton 2014-11-03 10:48:13 UTC
The Kernel Development manual states that you should copy and modify linux-yocto-custom.bb, but the comments in the header of that file recommend creating a bbappend. We shouldn't have conflicting instructions so one of these needs changing.

My personal opinion for this recipe is that the copy and modify approach is the better one, as there is actually very little in the .bb file that you wouldn't have to change in the bbappend so you might as well copy the whole thing (and probably rename it).

Darren, could you please make a recommendation and then we can make the change as appropriate?
Comment 1 Darren Hart 2014-11-03 19:07:24 UTC
I concur with copy-and-modify being the preferred approach.
Comment 2 Darren Hart 2014-11-03 19:08:13 UTC
Bruce, do you mind taking this one?
Comment 3 Scott Rifenbark 2015-05-11 15:49:24 UTC
Hey, 

Not sure if there is a documentation change needed here for the manual... please advise.

Scott
Comment 4 Bruce Ashfield 2015-05-11 19:07:17 UTC
Nothing for the manual, I'll update the source to match.

(In reply to comment #3)
> Hey, 
> 
> Not sure if there is a documentation change needed here for the manual...
> please advise.
> 
> Scott
Comment 5 Scott Rifenbark 2015-06-17 13:00:17 UTC
Set the documentation flag to "No"
Comment 6 Alexandru Roman 2015-09-09 11:55:47 UTC
Verified on master: db92bc23880794be77373b0f2d8c26279dcecb84