summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-09-05 09:31:24 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-10-04 14:33:31 +0100
commit859d36b1309ccb41d0218bfad11c4cfceebcd980 (patch)
tree6cc2c7e20c96b15d87ce61d83fc5d798dad396aa /bitbake
parente06421bfc401c3aeac01db08e32c7833085352ec (diff)
downloadpoky-859d36b1309ccb41d0218bfad11c4cfceebcd980.tar.gz
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>
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml26
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml39
2 files changed, 58 insertions, 7 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
index 1dbf141c9e..47c8d5d89b 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
@@ -769,11 +769,23 @@
769 769
770 <para> 770 <para>
771 Aside from separate configuration files for each 771 Aside from separate configuration files for each
772 target, you have to enable BitBake to perform multiple 772 target, you must also enable BitBake to perform multiple
773 configuration builds by enabling it in the local 773 configuration builds.
774 Enabling is accomplished by setting the
775 <link linkend='var-BBMULTICONFIG'><filename>BBMULTICONFIG</filename></link>
776 variable in the <filename>local.conf</filename>
774 configuration file. 777 configuration file.
775 Enabling is accomplished through a variable specific 778 As an example, suppose you had configuration files
776 to the build environment. 779 for <filename>target1</filename> and
780 <filename>target2</filename> defined in the build
781 directory.
782 The following statement in the
783 <filename>local.conf</filename> file both enables
784 BitBake to perform multiple configuration builds and
785 specifies the two multiconfigs:
786 <literallayout class='monospaced'>
787 BBMULTICONFIG = "target1 target2"
788 </literallayout>
777 </para> 789 </para>
778 790
779 <para> 791 <para>
@@ -785,10 +797,10 @@
785 $ bitbake [multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable> [[[multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable>] ... ] 797 $ bitbake [multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable> [[[multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable>] ... ]
786 </literallayout> 798 </literallayout>
787 Here is an example for two multiconfigs: 799 Here is an example for two multiconfigs:
788 <filename>Target_1</filename> and 800 <filename>target1</filename> and
789 <filename>Target_2</filename>: 801 <filename>target2</filename>:
790 <literallayout class='monospaced'> 802 <literallayout class='monospaced'>
791 $ bitbake multiconfig:Target_1:<replaceable>target</replaceable> multiconfig:Target_2:<replaceable>target</replaceable> 803 $ bitbake multiconfig:target1:<replaceable>target</replaceable> multiconfig:target2:<replaceable>target</replaceable>
792 </literallayout> 804 </literallayout>
793 </para> 805 </para>
794 </section> 806 </section>
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index 0313359d98..b5a793649c 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -1205,6 +1205,45 @@
1205 </glossdef> 1205 </glossdef>
1206 </glossentry> 1206 </glossentry>
1207 1207
1208 <glossentry id='var-BBMULTICONFIG'><glossterm>BBMULTICONFIG</glossterm>
1209 <info>
1210 BBMULTICONFIG[doc] = "Enables BitBake to perform multiple configuration builds and lists each separate configuration (multiconfig)."
1211 </info>
1212 <glossdef>
1213 <para role="glossdeffirst">
1214<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1215 Enables BitBake to perform multiple configuration builds
1216 and lists each separate configuration (multiconfig).
1217 You can use this variable to cause BitBake to build
1218 multiple targets where each target has a separate
1219 configuration.
1220 Define <filename>BBMULTICONFIG</filename> in your
1221 <filename>conf/local.conf</filename> configuration file.
1222 </para>
1223
1224 <para>
1225 As an example, the following line specifies three
1226 multiconfigs, each having a separate configuration file:
1227 <literallayout class='monospaced'>
1228 BBMULTIFONFIG = "configA configB configC"
1229 </literallayout>
1230 Each configuration file you use must reside in the
1231 build directory within a directory named
1232 <filename>conf/multiconfig</filename> (e.g.
1233 <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>).
1234 </para>
1235
1236 <para>
1237 For information on how to use
1238 <filename>BBMULTICONFIG</filename> in an environment that
1239 supports building targets with multiple configurations,
1240 see the
1241 "<link linkend='executing-a-multiple-configuration-build'>Executing a Multiple Configuration Build</link>"
1242 section.
1243 </para>
1244 </glossdef>
1245 </glossentry>
1246
1208 <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> 1247 <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
1209 <glossdef> 1248 <glossdef>
1210 <para> 1249 <para>