From ac7522bd177575eb98f93fb0a5b40551d6ab57af Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 7 Oct 2013 09:31:03 -0700 Subject: ref-manual: Updated the PACKAGECONFIG variable description. Fixes [YOCTO #5214] Applied some updates to better describe the variable's use model. (From yocto-docs rev: 9a66296f090f4ef023b3b5ae6f237676b6e9bd87) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 78 +++++++++++++++++++++++++----- 1 file changed, 66 insertions(+), 12 deletions(-) diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index b3a9f8577c..0dcef35704 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -3774,20 +3774,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis. + PACKAGECONFIG blocks are defined + in recipes when you specify features and then arguments + that define feature behaviors. + Here is the basic block structure: + + PACKAGECONFIG ??= "f1 f2 f3 ..." + PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1" + PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2" + PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3" + The PACKAGECONFIG variable itself specifies a space-separated list of the features to enable. - The features themselves are specified as flags on the - PACKAGECONFIG variable. - You can provide up to four arguments, which are separated by - commas, to determine the behavior of each feature - when it is enabled or disabled. + Following the features, you can determine the behavior of + each feature by providing up to four order-dependent + arguments, which are separated by commas. You can omit any argument you like but must retain the separating commas. - The arguments specify the following: + The order is important and specifies the following: Extra arguments - that should be added to the configure script argument list + that should be added to the configure script + argument list (EXTRA_OECONF) if the feature is enabled. Extra arguments @@ -3806,14 +3815,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - Consider the following example taken from the + Consider the following + PACKAGECONFIG block taken from the librsvg recipe. - In this example the feature is croco, which - has three arguments that determine the feature's behavior. - + In this example the feature is croco, + which has three arguments that determine the feature's + behavior. + PACKAGECONFIG ??= "croco" PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" - + The --with-croco and libcroco arguments apply only if the feature is enabled. @@ -3827,6 +3838,49 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" added to the configure script rather than --with-croco. + + + The basic PACKAGECONFIG structure + previously described holds true regardless of whether you + are creating a block or changing a block. + When creating a block, use the structure inside your + recipe. + + + + If you want to change an existing + PACKAGECONFIG block, you can do so + one of two ways: + + Append file: + Create an append file named + <recipename>.bbappend in your + layer and override the value of + PACKAGECONFIG. + You can either completely override the variable: + + PACKAGECONFIG="f4 f5" + + Or, you can just amended the variable: + + PACKAGECONFIG_append = " f4" + + Configuration file: + This method is identical to changing the block + through an append file except you edit your + local.conf or + <mydistro>.conf file. + As with append files previously described, + you can either completely override the variable: + + PACKAGECONFIG_pn-<recipename>="f4 f5" + + Or, you can just amended the variable: + + PACKAGECONFIG_append_pn-<recipename> = " f4" + + + -- cgit v1.2.3-54-g00ecf