Bug 5214

Summary: Improve PACKAGECONFIG explanation
Product: [Documentation] Reference Reporter: Gary Thomas <gary>
Component: handbookAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: Medium CC: bluelightning, jessica.zhang, poky.doc.watcher, poky.watcher, ross.burton, srifenbark, twoerner
Version: unspecified   
Target Milestone: 1.5   
Hardware: All   
OS: Multiple   
URL: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=9a66296f090f4ef023b3b5ae6f237676b6e9bd87
Whiteboard: 07 October 2013: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Gary Thomas 2013-09-17 10:57:42 UTC
The scant section on PACKAGECONFIG in the ref-variables manual is still rather vague.
In particular, the various methods for setting the PACKAGECONFIG variable should be
explained as they are quite varied and arcane.  For example, the simplest but perhaps
the most intrusive way to set this is using a .bbappend file, but there are other ways,
each of which have their own different/unique syntax.
Comment 1 Scott Rifenbark 2013-09-17 15:35:36 UTC
Paul, 

Could you provide some more information on how to use this variable here?  

Thanks,
Scott
Comment 2 Ross Burton 2013-10-07 10:38:02 UTC
The documentation covers *writing* a PACKAGECONFIG block, but it doesn't cover *changing* a PACKAGECONFIG statement.  Two ways: bbappend or conf file.  Some very rough notes that need to be expanded:

bbappend.  Create a [packagename].bbappend in your layer and override the value of PACKAGECONFIG.  It can either be overridden completely (PACKAGECONFIG="foo bar") or just amended (PACKAGECONFIG_append = " bar").

conf file, such as local.conf or mydistro.conf.  The same method applies but the variable needs to be PACKAGECONFIG_pn-[packagename], i.e. PACKAGECONFIG_pn-libfoo = "foo bar".
Comment 3 Trevor Woerner 2013-10-07 13:27:49 UTC
(In reply to comment #2)
> conf file, such as local.conf or mydistro.conf.  The same method applies but
> the variable needs to be PACKAGECONFIG_pn-[packagename], i.e.
> PACKAGECONFIG_pn-libfoo = "foo bar".

Additionally, the experimentation I've done seems to indicate that if you
want to _append to a package's PACKAGECONFIG in a conf file you need to use:

    PACKAGECONFIG_append_pn-[package] = " foo bar"
Comment 4 Scott Rifenbark 2013-10-07 15:05:37 UTC
Hi, 

Here is an expanded glossary description for the PACKAGECONFIG variable.  I have tried to describe it now to cover some various use scenarios.  I do need it looked at for accuracy as I made some guesses and assumptions. 

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#var-PACKAGECONFIG

Thanks, 
Scott
Comment 5 Ross Burton 2013-10-07 15:16:12 UTC
In the configuration block, give two examples for clarity:

PACKAGECONFIG_pn-[packagename]="f4 f5"
PACKAGECONFIG_append_pn-[packagename] = " f4"
Comment 6 Paul Eggleton 2013-10-07 15:29:53 UTC
Please use pn-<recipename> instead of pn-[packagename] in these examples, since the syntax matches the convention in the rest of the manual and we're talking recipes not packages here.
Comment 7 Scott Rifenbark 2013-10-07 15:49:30 UTC
Hi, 

Check out the review changes here:

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#var-PACKAGECONFIG

Thanks, 
Scott
Comment 8 Ross Burton 2013-10-07 15:54:08 UTC
The conf file examples lost their _pn-[recipename] parts.

  PACKAGECONFIG_pn-[recipename]="f4 f5"
  PACKAGECONFIG_append_pn-[recipename] = " f4"
Comment 9 Paul Eggleton 2013-10-07 16:01:06 UTC
pn-<recipename> ...
Comment 10 Trevor Woerner 2013-10-07 16:11:14 UTC
I thought RRECOMMENDS was added to the PACKAGECONFIG option list

http://patchwork.openembedded.org/patch/57837/

bringing the PACKAGECONFIG option count to 5, not 4?
Comment 11 Scott Rifenbark 2013-10-07 16:16:21 UTC
Looks like it was.  I will add that to the list.
Comment 12 Scott Rifenbark 2013-10-07 16:20:41 UTC
Hi, 

Check out the review changes here:

http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#var-PACKAGECONFIG

Thanks, 
Scott
Comment 13 Ross Burton 2013-10-07 16:24:21 UTC
Submitted but not accepted, please remove the runtime recommends section.  Apart from that, looks good.
Comment 14 Scott Rifenbark 2013-10-07 16:33:02 UTC
OK, 

I took the RRECOMMENDS stuff out and restored it to four rather than five things.  Here is the link - http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#var-PACKAGECONFIG

I am marking it RESOLVED and putting the doc requirement to "Done".

Thanks, 
Scott