documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.

Fixes [YOCTO #10183]

Added a new variable entry for the PACKAGECONFIG_CONFARGS variable.

With the introduction of the new PACKAGECONFIG_CONFARGS variable,
many places in the mainstream YP documentation that referenced
how to pass configure arguments using EXTRA_OECONF needed to also
make mention of this new variable.  I added many cross-references
to the new variable.

(From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 9b0015d2eefa20bb70bab37fdb8fa139f61c06f6..74deac5452dd546cbc86c0f977f5235df73e4a4e 100644 (file)
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2297,6 +2297,8 @@
                         However, you might still want to make some adjustments.
                         For example, you can set
                         <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink>
+                        or
+                        <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
                         to pass any needed configure options that are specific
                         to the recipe.</para></listitem>
                     <listitem><para><emphasis>CMake:</emphasis>
@@ -3011,8 +3013,10 @@
                     You do not need to add a <filename>do_compile</filename> step since by default BitBake
                     starts the <filename>make</filename> command to compile the application.
                     If you need additional <filename>make</filename> options, you should store them in the
-                    <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename>
-                    variable.
+                    <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></ulink>
+                    or
+                    <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
+                    variables.
                     BitBake passes these options into the GNU <filename>make</filename> invocation.
                     Note that a <filename>do_install</filename> task is still required.
                     Otherwise, BitBake runs an empty <filename>do_install</filename> task by default.

diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index 825409f5a7f71d34eaf9922219ae88f797c20526..a9eb1b6c7ffe393f84e42404fce02bfc90316fc5 100644 (file)
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -888,7 +888,9 @@
                         class,
                         you can add additional configuration options by using
                         the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
-                        variable.
+                        or
+                        <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>
+                        variables.
                         For information on how this variable works within
                         that class, see the
                         <filename>meta/classes/autotools.bbclass</filename> file.

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 98a365871dcec84caff2d363735b10e5bd097e65..2344a0406ae6dbeed883182730e70581ed387ed8 100644 (file)
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -161,13 +161,17 @@
                 cross-compilation.
                 You can pass additional parameters to
                 <filename>configure</filename> through the
-                <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable.
+                <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename>
+                or
+                <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>
+                variables.
                 </para></listitem>
             <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> -
                 Runs <filename>make</filename> with arguments that specify the
                 compiler and linker.
                 You can pass additional arguments through
-                the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable.
+                the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename>
+                variable.
                 </para></listitem>
             <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> -
                 Runs <filename>make install</filename> and passes in
@@ -3726,7 +3730,9 @@
         software that uses the Waf build system.
         You can use the
         <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
-        variable to specify additional configuration options to be passed on
+        or
+        <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>
+        variables to specify additional configuration options to be passed on
         the Waf command line.
     </para>
 </section>

diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml
index 4fcf1db6193d2f33627b1bea3c0a0f817a559389..893629d6985d7ac552cc5edb10edcfb3498d3288 100644 (file)
--- a/documentation/ref-manual/ref-qa-checks.xml
+++ b/documentation/ref-manual/ref-qa-checks.xml
@@ -918,7 +918,8 @@ can be found then it should be implemented.  I can't find one at the moment.
                     and the upstream change log or release notes.
                     Once you have worked out what the appropriate
                     change is, you can update
-                    <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
+                    <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>,
+                    <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>,
                     or the individual
                     <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
                     option values accordingly.

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 37ca37b62662e9c99a42c3f2343cee76ec328d13..afc36a5b1447ca5c73f46e7e29a5fdd30aeed267 100644 (file)
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4037,6 +4037,10 @@
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
                     Additional <filename>configure</filename> script options.
+                    See
+                    <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>
+                    for additional information on passing configure script
+                    options.
                 </para>
             </glossdef>
         </glossentry>
@@ -9112,10 +9116,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                         <listitem><para>Extra arguments
                             that should be added to the configure script
                             argument list
-                            (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>)
+                            (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
+                            or
+                            <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>)
                             if the feature is enabled.</para></listitem>
                         <listitem><para>Extra arguments
                             that should be added to <filename>EXTRA_OECONF</filename>
+                            or <filename>PACKAGECONFIG_CONFARGS</filename>
                             if the feature is disabled.
                             </para></listitem>
                         <listitem><para>Additional build dependencies
@@ -14817,7 +14824,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     task.
                     Normally, invalid configure options are simply not passed
                     to the configure script (e.g. should be removed from
-                    <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>).
+                    <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
+                    or
+                    <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>).
                     However, common options, for example, exist that are passed
                     to all configure scripts at a class level that might not
                     be valid for some configure scripts.

diff --git a/documentation/ref-manual/ref-varlocality.xml b/documentation/ref-manual/ref-varlocality.xml
index d3f873298de761aa2b484c452f90d5fb14a79573..54524d5b6097d30c6595971586e3fdd749b52c9b 100644 (file)
--- a/documentation/ref-manual/ref-varlocality.xml
+++ b/documentation/ref-manual/ref-varlocality.xml
@@ -176,16 +176,18 @@
             <para>
                 This section lists variables that define extra build information for recipes.
                 <itemizedlist>
+                    <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
+                        </link></filename></para></listitem>
                     <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
                         </filename></para></listitem>
                     <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
                         </filename></para></listitem>
                     <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
                         </filename></para></listitem>
+                    <listitem><para><filename><link linkend='var-PACKAGECONFIG_CONFARGS'>PACKAGECONFIG_CONFARGS</link>
+                        </filename></para></listitem>
                     <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
                         </para></listitem>
-                    <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
-                        </link></filename></para></listitem>
                 </itemizedlist>
             </para>
         </section>

diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index c2360e9f3712dd3280c032ab653b6c7957184a71..86f1e28fc99af9e6fe42db8e0d18abbf4940cb9f 100644 (file)
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -849,7 +849,10 @@
                     To force the value on the command line, add the
                     variable setting to
                     <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></ulink>
-                    within the recipe as follows:
+                    or
+                    <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
+                    within the recipe.
+                    Here is an example using <filename>EXTRA_OEMAKE</filename>:
                     <literallayout class='monospaced'>
      EXTRA_OEMAKE += "'CC=${CC}' 'CXX=${CXX}'"
                     </literallayout>
@@ -1062,9 +1065,12 @@
             then a fixed set of arguments is passed to it to enable
             cross-compilation plus any extras specified by
             <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink>
+            or
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
             set within the recipe.
             If you wish to pass additional options, add them to
-            <filename>EXTRA_OECONF</filename>.
+            <filename>EXTRA_OECONF</filename> or
+            <filename>PACKAGECONFIG_CONFARGS</filename>.
             Other supported build tools have similar variables
             (e.g.
             <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink>
@@ -1072,8 +1078,9 @@
             <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OESCONS'><filename>EXTRA_OESCONS</filename></ulink>
             for Scons, and so forth).
             If you need to pass anything on the <filename>make</filename>
-            command line, you can use <filename>EXTRA_OEMAKE</filename> to do
-            so.
+            command line, you can use <filename>EXTRA_OEMAKE</filename> or the
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
+            variables to do so.
         </para>
 
         <para>
@@ -1081,7 +1088,8 @@
             to help you set the arguments listed in the previous paragraph.
             The command determines the exact options being passed, and shows
             them to you along with any custom arguments specified through
-            <filename>EXTRA_OECONF</filename>.
+            <filename>EXTRA_OECONF</filename> or
+            <filename>PACKAGECONFIG_CONFARGS</filename>.
             If applicable, the command also shows you the output of the
             configure script's "&dash;&dash;help" option as a reference.
         </para>