summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-11-29 17:19:10 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-12-03 13:53:01 +0000
commit951efacceb49757285ac7724b1105004910a142a (patch)
treeb7e3107a823ed915f47ab32dc30797d152733c96 /documentation
parentdbab91af5e420380bd53c3fa4614bf47e881c5f9 (diff)
downloadpoky-951efacceb49757285ac7724b1105004910a142a.tar.gz
documentation: poky-ref--manual - Updated PACKAGECONFIG
Fixes [YOCTO #3327] Re-write of the glossary description for the PACKAGECONFIG variable. This went through a couple of iterations. Paul Eggleton reviewed and provided technical information. (From yocto-docs rev: 7edf3d03bc4a448516f24caea4b49423a026885f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml73
1 files changed, 50 insertions, 23 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 39b74bcba0..10ffce39ac 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -2034,32 +2034,59 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2034 <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> 2034 <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm>
2035 <glossdef> 2035 <glossdef>
2036 <para> 2036 <para>
2037 This variable provides a means of enabling or disabling features of a recipe 2037 This variable provides a means of enabling or disabling
2038 on a per-recipe basis. 2038 features of a recipe on a per-recipe basis.
2039 The <filename>PACKAGECONFIG</filename> 2039 The <filename>PACKAGECONFIG</filename>
2040 variable itself specifies a space-separated list of the features 2040 variable itself specifies a space-separated list of the
2041 to enable, while the named flags set on the variable specify 2041 features to enable or disable.
2042 for each feature the additional build dependencies 2042 The features themselves are specified as flags on the
2043 (<filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>) 2043 <filename>PACKAGECONFIG</filename> variable.
2044 that should be added if the feature is enabled, and any extra arguments 2044 You can provide up to four arguments, which are separated by
2045 that should be added to the configure script argument list 2045 commas, to determine the behavior of each feature
2046 (<filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename>) 2046 when it is enabled or disabled.
2047 if the feature is enabled or disabled. 2047 You can omit any argument you like but must retain the
2048 </para> 2048 separating commas (see the examples further down).
2049 <para> 2049 The arguments specify the following:
2050 For example, the following taken from the <filename>librsvg</filename> 2050 <orderedlist>
2051 recipe will add <filename>--with-croco</filename> to the 2051 <listitem><para>Extra arguments
2052 configure script arguments and <filename>libcroco</filename> to 2052 (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>)
2053 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> 2053 that should be added to the configure script argument list
2054 by default. 2054 if the feature is enabled.</para></listitem>
2055 However, if "croco" is removed from <filename>PACKAGECONFIG</filename> 2055 <listitem><para>Extra arguments (<filename>EXTRA_OECONF</filename>)
2056 (for example, by using a <filename>.bbappend</filename> file in another layer), then 2056 that should be added if the feature is disabled.
2057 <filename>--without-croco</filename> will be added to the configure 2057 </para></listitem>
2058 script arguments instead: 2058 <listitem><para>Additional build dependencies
2059 <literallayout class='monospaced'> 2059 (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>)
2060 that should be added if the feature is enabled.
2061 </para></listitem>
2062 <listitem><para>Additional runtime dependencies
2063 (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
2064 that should be added if the feature is enabled.
2065 </para></listitem>
2066 </orderedlist>
2067 </para>
2068
2069 <para>
2070 Consider the following example taken from the
2071 <filename>librsvg</filename> recipe.
2072 In this example the feature is <filename>croco</filename>, which
2073 has three arguments that determine the feature's' behavior.
2074 <literallayout class='monospaced'>
2060 PACKAGECONFIG ??= "croco" 2075 PACKAGECONFIG ??= "croco"
2061 PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" 2076 PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco"
2062 </literallayout> 2077 </literallayout>
2078 The <filename>--with-croco</filename> and
2079 <filename>libcroco</filename> arguments apply only if
2080 the feature is enabled.
2081 In this case, <filename>--with-croco</filename> is
2082 added to the configure script argument list and
2083 <filename>libcroco</filename> is added to
2084 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>.
2085 On the other hand, if the feature is disabled say through
2086 a <filename>.bbappend</filename> file in another layer, then
2087 the second argument <filename>--without-croco</filename> is
2088 added to the configure script rather than
2089 <filename>--with-croco</filename>.
2063 </para> 2090 </para>
2064 </glossdef> 2091 </glossdef>
2065 </glossentry> 2092 </glossentry>