Bug 8168

Summary: Be clearer about using pkg-config instead of *-config scripts
Product: [Documentation] General Docs Reporter: Paul Eggleton <bluelightning>
Component: docs-generalAssignee: Ross Burton <ross.burton>
Status: VERIFIED FIXED QA Contact: Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Severity: enhancement    
Priority: Medium CC: bogdanx.a.voiculescu, mhalstead, ross.burton, srifenbark
Version: unspecified   
Target Milestone: 2.0   
Hardware: All   
OS: Multiple   
Whiteboard: 15 Oct 2015: IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Paul Eggleton 2015-08-16 08:09:24 UTC 
It would be good if we could spell out that various *-config scripts get disabled and that pkg-config should be used instead (in places other than the reference manual upgrade section and a few scattered variable entries in the glossary). It may warrant a mini-section of its own which we can at least point to from the "writing a new recipe" section of the dev manual.
Comment 1 Scott Rifenbark 2015-10-15 17:34:59 UTC 
Hi, 

After consulting with Paul here, I have placed a couple notes in the "Writing a New Recipe" section of the dev-manual to try and address this situation.  It seemed best to mention the issue in both the configuration and compilation areas.  Please look things over here and comment.

http://www.yoctoproject.org/docs/2.0/dev-manual/dev-manual.html#new-recipe-configuring-the-recipe

http://www.yoctoproject.org/docs/2.0/dev-manual/dev-manual.html#new-recipe-compilation

Another sort of related issue I found was the mis-use of a class name for the pkgconfig.bbclass reference section.  I made a small correction in the opening sentence of that entry to properly identify the class.

http://www.yoctoproject.org/docs/2.0/ref-manual/ref-manual.html#ref-classes-pkgconfig

Let me know if this solution will be okay.

Scott
Comment 2 Ross Burton 2015-10-20 14:40:59 UTC 
Looks good to me, closing.  Thanks Scott.