summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-02 12:20:05 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-04 08:47:14 +0100
commitce31b76fd1decbe63fa1d5acbb773ca5e6bd3ad3 (patch)
treeb71d2a16008ef660705022cd637ccf3ed1057c4d /documentation
parentd4503fbf26a2bb2d169348a143b77c0e1d2b5f07 (diff)
downloadopenembedded-core-contrib-ce31b76fd1decbe63fa1d5acbb773ca5e6bd3ad3.tar.gz
ref-manual: Updated the PACKAGECONFIG_CONFARGS variable description
Fixes [YOCTO #11600] Made some technical corrections to the PACKAGECONFIG_CONFARGS variable description in the glossary. (From yocto-docs rev: c422783984748f170943eab418bfa7d0111fa352) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml26
1 files changed, 20 insertions, 6 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4a2c79f1be..efe423adc7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -9653,7 +9653,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-PACKAGECONFIG_CONFARGS'><glossterm>PACKAGECONFIG_CONFARGS</glossterm>
<info>
- PACKAGECONFIG_CONFARGS[doc] = "A space-separated list of configuration options generated from PACKAGECONFIG."
+ PACKAGECONFIG_CONFARGS[doc] = "A space-separated list of configuration options generated from the PACKAGECONFIG setting."
</info>
<glossdef>
<para role="glossdeffirst">
@@ -9662,11 +9662,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
from the
<link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
setting.
- This list of options helps other classes and
- recipes take advantage of the
- <filename>PACKAGECONFIG</filename> mechanism without
- having to include options from
- <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>.
+ </para>
+
+ <para>
+ Classes such as
+ <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
+ and
+ <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
+ use <filename>PACKAGECONFIG_CONFARGS</filename> to pass
+ <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
+ options to tasks such as
+ <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
+ and
+ <link linkend='ref-tasks-cmake'><filename>do_cmake</filename></link>,
+ respectively.
+ If you are using
+ <filename>PACKAGECONFIG</filename> but not a class that
+ handles the <filename>do_configure</filename> task, then
+ you need to use
+ <filename>PACKAGECONFIG_CONFARGS</filename> appropriately.
</para>
<para>