summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrpjday@crashcourse.ca <rpjday@crashcourse.ca>2020-04-06 20:07:33 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-04-07 21:00:10 (GMT)
commit51ecc1069aba0bf4145a8d1a4bd3091cabe795ba (patch)
tree77b961904d2d74e94441c2eeea930958c716d65e
parentc063e3742544fb3f93ef3405e1cb6f7a50103c45 (diff)
downloadpoky-51ecc1069aba0bf4145a8d1a4bd3091cabe795ba.tar.gz
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>
-rw-r--r--documentation/ref-manual/ref-variables.xml40
1 files changed, 25 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9723cbb..b44fdcb 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -10417,12 +10417,20 @@
10417 <filename>PACKAGECONFIG</filename> blocks are defined 10417 <filename>PACKAGECONFIG</filename> blocks are defined
10418 in recipes when you specify features and then arguments 10418 in recipes when you specify features and then arguments
10419 that define feature behaviors. 10419 that define feature behaviors.
10420 Here is the basic block structure: 10420 Here is the basic block structure (broken over multiple
10421 lines for readability):
10421 <literallayout class='monospaced'> 10422 <literallayout class='monospaced'>
10422 PACKAGECONFIG ??= "f1 f2 f3 ..." 10423 PACKAGECONFIG ??= "f1 f2 f3 ..."
10423 PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1" 10424 PACKAGECONFIG[f1] = "\
10424 PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2" 10425 --with-f1, \
10425 PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3" 10426 --without-f1, \
10427 build-deps-for-f1, \
10428 runtime-deps-for-f1, \
10429 runtime-recommends-for-f1, \
10430 packageconfig-conflicts-for-f1 \
10431 "
10432 PACKAGECONFIG[f2] = "\
10433 ... and so on and so on ...
10426 </literallayout> 10434 </literallayout>
10427 </para> 10435 </para>
10428 10436
@@ -10431,7 +10439,7 @@
10431 variable itself specifies a space-separated list of the 10439 variable itself specifies a space-separated list of the
10432 features to enable. 10440 features to enable.
10433 Following the features, you can determine the behavior of 10441 Following the features, you can determine the behavior of
10434 each feature by providing up to five order-dependent 10442 each feature by providing up to six order-dependent
10435 arguments, which are separated by commas. 10443 arguments, which are separated by commas.
10436 You can omit any argument you like but must retain the 10444 You can omit any argument you like but must retain the
10437 separating commas. 10445 separating commas.
@@ -10461,6 +10469,10 @@
10461 (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>) 10469 (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>)
10462 that should be added if the feature is enabled. 10470 that should be added if the feature is enabled.
10463 </para></listitem> 10471 </para></listitem>
10472 <listitem><para>Any conflicting (that is, mutually
10473 exclusive) <filename>PACKAGECONFIG</filename>
10474 settings for this feature.
10475 </para></listitem>
10464 </orderedlist> 10476 </orderedlist>
10465 </para> 10477 </para>
10466 10478
@@ -10468,25 +10480,23 @@
10468 Consider the following 10480 Consider the following
10469 <filename>PACKAGECONFIG</filename> block taken from the 10481 <filename>PACKAGECONFIG</filename> block taken from the
10470 <filename>librsvg</filename> recipe. 10482 <filename>librsvg</filename> recipe.
10471 In this example the feature is <filename>croco</filename>, 10483 In this example the feature is <filename>gtk</filename>,
10472 which has three arguments that determine the feature's 10484 which has three arguments that determine the feature's
10473 behavior. 10485 behavior.
10474 <literallayout class='monospaced'> 10486 <literallayout class='monospaced'>
10475 PACKAGECONFIG ??= "croco" 10487 PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3"
10476 PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco"
10477 </literallayout> 10488 </literallayout>
10478 The <filename>--with-croco</filename> and 10489 The <filename>--with-gtk3</filename> and
10479 <filename>libcroco</filename> arguments apply only if 10490 <filename>gtk+3</filename> arguments apply only if
10480 the feature is enabled. 10491 the feature is enabled.
10481 In this case, <filename>--with-croco</filename> is 10492 In this case, <filename>--with-gtk3</filename> is
10482 added to the configure script argument list and 10493 added to the configure script argument list and
10483 <filename>libcroco</filename> is added to 10494 <filename>gtk+3</filename> is added to
10484 <filename>DEPENDS</filename>. 10495 <filename>DEPENDS</filename>.
10485 On the other hand, if the feature is disabled say through 10496 On the other hand, if the feature is disabled say through
10486 a <filename>.bbappend</filename> file in another layer, then 10497 a <filename>.bbappend</filename> file in another layer, then
10487 the second argument <filename>--without-croco</filename> is 10498 the second argument <filename>--without-gtk3</filename> is
10488 added to the configure script rather than 10499 added to the configure script instead.
10489 <filename>--with-croco</filename>.
10490 </para> 10500 </para>
10491 10501
10492 <para> 10502 <para>