Bug 11411 - native[sdk].bbclass: warn about naming convention
Summary: native[sdk].bbclass: warn about naming convention
Status: RESOLVED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium normal
Target Milestone: 2.4 M2
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 29 June 2017: RESOLVED
Depends on:
Blocks:
 
Reported: 2017-04-25 09:18 UTC by Patrick Ohly
Modified: 2017-06-29 16:00 UTC (History)
2 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Patrick Ohly 2017-04-25 09:18:33 UTC
The current documentation says:

Create a myrecipe-native.bb that inherits the native class. ...

respectively:

Create a nativesdk-myrecipe.bb recipe that inherits the nativesdk class.

It's not clear that these recipes name are more than just examples or how it's commonly done. There's real code which checks for the suffix resp. prefix, so this naming has to be followed.

I suggest adding a warning in both places:

This naming convention must be followed. Not doing so can lead to subtle problems because there is code which depends on it.
Comment 1 Scott Rifenbark 2017-04-25 15:27:36 UTC
Patrick, 

Thanks for the bug.  I set the target milestone and estimated "perfect" days.  This will get in in time for the HTML (on-line) version of the manual but likely not be in the released tarball since that is in RC right now.

Thanks,
Scott
Comment 2 Scott Rifenbark 2017-06-05 22:46:42 UTC
Hi Patrick, 

Please see http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#ref-classes-native and http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#ref-classes-nativesdk for the "native.bbclass" and "nativesdk.bbclass" reference descriptions.  I have warnings in both descriptions.  Let me know if this is okay. 

thanks, 
Scott
Comment 3 Scott Rifenbark 2017-06-29 16:00:45 UTC
No comments for a month... setting to RESOLVED and putting the doc flag to "done."

Scott