bitbake: bitbake-user-manual: Added BBMULTICONFIG support

The BBMULTICONFIG variable is a variable used for BitBake and was
not documented in the BitBake Manual glossary.  I added the
definition.  I also added the variable to the example in the section
describing how to execute builds for multiple configurations.

(Bitbake rev: 836f994ec530ba82c935cb41e006d1f128885dc2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-09-05 09:31:24 -07:00
committed by Richard Purdie
parent e06421bfc4
commit 859d36b130
2 changed files with 58 additions and 7 deletions

View File

@@ -769,11 +769,23 @@
<para>
Aside from separate configuration files for each
target, you have to enable BitBake to perform multiple
configuration builds by enabling it in the local
target, you must also enable BitBake to perform multiple
configuration builds.
Enabling is accomplished by setting the
<link linkend='var-BBMULTICONFIG'><filename>BBMULTICONFIG</filename></link>
variable in the <filename>local.conf</filename>
configuration file.
Enabling is accomplished through a variable specific
to the build environment.
As an example, suppose you had configuration files
for <filename>target1</filename> and
<filename>target2</filename> defined in the build
directory.
The following statement in the
<filename>local.conf</filename> file both enables
BitBake to perform multiple configuration builds and
specifies the two multiconfigs:
<literallayout class='monospaced'>
BBMULTICONFIG = "target1 target2"
</literallayout>
</para>
<para>
@@ -785,10 +797,10 @@
$ bitbake [multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable> [[[multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable>] ... ]
</literallayout>
Here is an example for two multiconfigs:
<filename>Target_1</filename> and
<filename>Target_2</filename>:
<filename>target1</filename> and
<filename>target2</filename>:
<literallayout class='monospaced'>
$ bitbake multiconfig:Target_1:<replaceable>target</replaceable> multiconfig:Target_2:<replaceable>target</replaceable>
$ bitbake multiconfig:target1:<replaceable>target</replaceable> multiconfig:target2:<replaceable>target</replaceable>
</literallayout>
</para>
</section>

View File

@@ -1205,6 +1205,45 @@
</glossdef>
</glossentry>
<glossentry id='var-BBMULTICONFIG'><glossterm>BBMULTICONFIG</glossterm>
<info>
BBMULTICONFIG[doc] = "Enables BitBake to perform multiple configuration builds and lists each separate configuration (multiconfig)."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Enables BitBake to perform multiple configuration builds
and lists each separate configuration (multiconfig).
You can use this variable to cause BitBake to build
multiple targets where each target has a separate
configuration.
Define <filename>BBMULTICONFIG</filename> in your
<filename>conf/local.conf</filename> configuration file.
</para>
<para>
As an example, the following line specifies three
multiconfigs, each having a separate configuration file:
<literallayout class='monospaced'>
BBMULTIFONFIG = "configA configB configC"
</literallayout>
Each configuration file you use must reside in the
build directory within a directory named
<filename>conf/multiconfig</filename> (e.g.
<replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>).
</para>
<para>
For information on how to use
<filename>BBMULTICONFIG</filename> in an environment that
supports building targets with multiple configurations,
see the
"<link linkend='executing-a-multiple-configuration-build'>Executing a Multiple Configuration Build</link>"
section.
</para>
</glossdef>
</glossentry>
<glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
<glossdef>
<para>