Bug 11600

Summary: PACKAGECONFIG_CONFARGS documentation is wrong
Product: [Documentation] Reference Reporter: Ross Burton <ross.burton>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium+ CC: bluelightning, poky.doc.watcher, poky.watcher, srifenbark
Version: 2.2   
Target Milestone: 2.4 M1   
Hardware: x86   
OS: Multiple   
Whiteboard: 06 June 2017: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Ross Burton 2017-06-01 13:44:50 UTC 
The first sentence is correct:

"A space-separated list of configuration options generated from the PACKAGECONFIG setting."

However the rest is wrong.

Something like:

"""
A space-separated list of configuration options generated from the PACKAGECONFIG setting.

Classes such as autotools.bbclass and cmake.bbclass use this variable to pass PACKAGECONFIG options to configure and cmake respectively.  If you are using PACKAGECONFIG but not a class which handles do_configure then you need to use PACKAGECONFIG_CONFARGS as appropriate.
"""
Comment 1 Scott Rifenbark 2017-06-02 18:19:39 UTC 
Ross, 

See http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#var-PACKAGECONFIG_CONFARGS for an attempt at this change.  One thing we don't have is a do_cmake task documented in the ref-manual.  Do we need to set that up?  Right now, the changes I made link to a non-existent section for do_cmake.

Scott
Comment 2 Ross Burton 2017-06-03 15:07:37 UTC 
The "configure" and "cmake" words in my sample were executable programs not bitbake tasks, so should be just "configure" and "cmake" and not linked to anything else in the manual.
Comment 3 Scott Rifenbark 2017-06-05 22:25:57 UTC 
Ross, 

See http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-PACKAGECONFIG_CONFARGS and tell me if this is okay for the variable description.  

Thanks, 
Scott
Comment 4 Ross Burton 2017-06-05 23:18:53 UTC 
The first paragraphs look good but please delete "To illustrate how to use PACKAGECONFIG_CONFARGS, consider the following example [... ] thus avoiding having to use EXTRA_OECONF."
Comment 5 Scott Rifenbark 2017-06-05 23:33:41 UTC 
Ross, 

Please see http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-PACKAGECONFIG_CONFARGS for the correction.  Let me know if this is okay.

Scott
Comment 6 Ross Burton 2017-06-06 10:46:03 UTC 
Perfect.  Thanks!
Comment 7 Scott Rifenbark 2017-06-06 14:11:08 UTC 
Setting doc flag to "done".

Applying to the top of the pyro tree for 2.3.1.

Scott

(see http://www.yoctoproject.org/docs/2.3.1/ref-manual/ref-manual.html#var-PACKAGECONFIG_CONFARGS for the fix in 2.3.1)