1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00

ref-manual: update PACKAGECONFIG glossary entry

Update the glossary entry for PACKAGECONFIG in two ways:

1) Explain the recent sixth argument, which identifies conflicting
   features for a given feature.
2) Use a different example, as the librsvg "croco" feature no
   longer works that way.

(From yocto-docs rev: af9bf61a54c059e72c807ca8061a57d6fe74c5fa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
rpjday@crashcourse.ca
2020-04-06 16:07:33 -04:00
committed by Richard Purdie
parent c063e37425
commit 51ecc1069a
+25 -15
View File
@@ -10417,12 +10417,20 @@
<filename>PACKAGECONFIG</filename> blocks are defined <filename>PACKAGECONFIG</filename> blocks are defined
in recipes when you specify features and then arguments in recipes when you specify features and then arguments
that define feature behaviors. that define feature behaviors.
Here is the basic block structure: Here is the basic block structure (broken over multiple
lines for readability):
<literallayout class='monospaced'> <literallayout class='monospaced'>
PACKAGECONFIG ??= "f1 f2 f3 ..." PACKAGECONFIG ??= "f1 f2 f3 ..."
PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1" PACKAGECONFIG[f1] = "\
PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2" --with-f1, \
PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3" --without-f1, \
build-deps-for-f1, \
runtime-deps-for-f1, \
runtime-recommends-for-f1, \
packageconfig-conflicts-for-f1 \
"
PACKAGECONFIG[f2] = "\
... and so on and so on ...
</literallayout> </literallayout>
</para> </para>
@@ -10431,7 +10439,7 @@
variable itself specifies a space-separated list of the variable itself specifies a space-separated list of the
features to enable. features to enable.
Following the features, you can determine the behavior of Following the features, you can determine the behavior of
each feature by providing up to five order-dependent each feature by providing up to six order-dependent
arguments, which are separated by commas. arguments, which are separated by commas.
You can omit any argument you like but must retain the You can omit any argument you like but must retain the
separating commas. separating commas.
@@ -10461,6 +10469,10 @@
(<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>) (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>)
that should be added if the feature is enabled. that should be added if the feature is enabled.
</para></listitem> </para></listitem>
<listitem><para>Any conflicting (that is, mutually
exclusive) <filename>PACKAGECONFIG</filename>
settings for this feature.
</para></listitem>
</orderedlist> </orderedlist>
</para> </para>
@@ -10468,25 +10480,23 @@
Consider the following Consider the following
<filename>PACKAGECONFIG</filename> block taken from the <filename>PACKAGECONFIG</filename> block taken from the
<filename>librsvg</filename> recipe. <filename>librsvg</filename> recipe.
In this example the feature is <filename>croco</filename>, In this example the feature is <filename>gtk</filename>,
which has three arguments that determine the feature's which has three arguments that determine the feature's
behavior. behavior.
<literallayout class='monospaced'> <literallayout class='monospaced'>
PACKAGECONFIG ??= "croco" PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3"
PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco"
</literallayout> </literallayout>
The <filename>--with-croco</filename> and The <filename>--with-gtk3</filename> and
<filename>libcroco</filename> arguments apply only if <filename>gtk+3</filename> arguments apply only if
the feature is enabled. the feature is enabled.
In this case, <filename>--with-croco</filename> is In this case, <filename>--with-gtk3</filename> is
added to the configure script argument list and added to the configure script argument list and
<filename>libcroco</filename> is added to <filename>gtk+3</filename> is added to
<filename>DEPENDS</filename>. <filename>DEPENDS</filename>.
On the other hand, if the feature is disabled say through On the other hand, if the feature is disabled say through
a <filename>.bbappend</filename> file in another layer, then a <filename>.bbappend</filename> file in another layer, then
the second argument <filename>--without-croco</filename> is the second argument <filename>--without-gtk3</filename> is
added to the configure script rather than added to the configure script instead.
<filename>--with-croco</filename>.
</para> </para>
<para> <para>