sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2016-09-07 10:17:42 -07:00 committed by Richard Purdie
parent 066ecf613f
commit 72d1435f20
7 changed files with 48 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -2297,6 +2297,8 @@
However, you might still want to make some adjustments. However, you might still want to make some adjustments.
For example, you can set For example, you can set
<ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink> <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 pass any needed configure options that are specific
to the recipe.</para></listitem> to the recipe.</para></listitem>
<listitem><para><emphasis>CMake:</emphasis> <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 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. starts the <filename>make</filename> command to compile the application.
If you need additional <filename>make</filename> options, you should store them in the 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> <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></ulink>
variable. 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. BitBake passes these options into the GNU <filename>make</filename> invocation.
Note that a <filename>do_install</filename> task is still required. Note that a <filename>do_install</filename> task is still required.
Otherwise, BitBake runs an empty <filename>do_install</filename> task by default. Otherwise, BitBake runs an empty <filename>do_install</filename> task by default.

4
documentation/ref-manual/closer-look.xml
View File

@ -888,7 +888,9 @@
class, class,
you can add additional configuration options by using you can add additional configuration options by using
the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> 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 For information on how this variable works within
that class, see the that class, see the
<filename>meta/classes/autotools.bbclass</filename> file. <filename>meta/classes/autotools.bbclass</filename> file.

12
documentation/ref-manual/ref-classes.xml
View File

@ -161,13 +161,17 @@
cross-compilation. cross-compilation.
You can pass additional parameters to You can pass additional parameters to
<filename>configure</filename> through the <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> </para></listitem>
<listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> -
Runs <filename>make</filename> with arguments that specify the Runs <filename>make</filename> with arguments that specify the
compiler and linker. compiler and linker.
You can pass additional arguments through 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> </para></listitem>
<listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> - <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> -
Runs <filename>make install</filename> and passes in Runs <filename>make install</filename> and passes in
@ -3726,7 +3730,9 @@
software that uses the Waf build system. software that uses the Waf build system.
You can use the You can use the
<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> <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. the Waf command line.
</para> </para>
</section> </section>

3
documentation/ref-manual/ref-qa-checks.xml
View File

@ -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. and the upstream change log or release notes.
Once you have worked out what the appropriate Once you have worked out what the appropriate
change is, you can update 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 or the individual
<link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>
option values accordingly. option values accordingly.

13
documentation/ref-manual/ref-variables.xml
View File

@ -4037,6 +4037,10 @@
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Additional <filename>configure</filename> script options. 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> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -9112,10 +9116,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<listitem><para>Extra arguments <listitem><para>Extra arguments
that should be added to the configure script that should be added to the configure script
argument list 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> if the feature is enabled.</para></listitem>
<listitem><para>Extra arguments <listitem><para>Extra arguments
that should be added to <filename>EXTRA_OECONF</filename> that should be added to <filename>EXTRA_OECONF</filename>
or <filename>PACKAGECONFIG_CONFARGS</filename>
if the feature is disabled. if the feature is disabled.
</para></listitem> </para></listitem>
<listitem><para>Additional build dependencies <listitem><para>Additional build dependencies
@ -14817,7 +14824,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
task. task.
Normally, invalid configure options are simply not passed Normally, invalid configure options are simply not passed
to the configure script (e.g. should be removed from 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 However, common options, for example, exist that are passed
to all configure scripts at a class level that might not to all configure scripts at a class level that might not
be valid for some configure scripts. be valid for some configure scripts.

6
documentation/ref-manual/ref-varlocality.xml
View File

@ -176,16 +176,18 @@
<para> <para>
This section lists variables that define extra build information for recipes. This section lists variables that define extra build information for recipes.
<itemizedlist> <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> <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
</filename></para></listitem> </filename></para></listitem>
<listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link> <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
</filename></para></listitem> </filename></para></listitem>
<listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link> <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
</filename></para></listitem> </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> <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
</para></listitem> </para></listitem>
<listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
</link></filename></para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>

18
documentation/sdk-manual/sdk-extensible.xml
View File

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