summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAlejandro Enedino Hernandez Samaniego <aehs29@gmail.com>2019-10-08 17:36:11 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-10-09 14:01:01 +0100
commit677bfa6a697d1807a689105dcfe4c6def6f08d30 (patch)
tree113956e69643a97e5f24fc8769edac37f355e5de /documentation
parent704c3e623eb6f7d271aa29024d8c9d228e2d3ccf (diff)
downloadpoky-677bfa6a697d1807a689105dcfe4c6def6f08d30.tar.gz
documentation: Update multiconfig syntax and explanation on BBMULTICONFIG
The syntax to use multiconfig builds changed from multiconfig:foo:target to mc:foo:target. Clarify that BBMULTICONFIG defines additional configurations along with the one coming from local.conf. Fix these changes on both the dev manual and the reference manual. (From yocto-docs rev: 9e79e96cad66316c1b4ee608723edfa763f0f9ef) Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml26
-rw-r--r--documentation/ref-manual/ref-variables.xml4
2 files changed, 19 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 165c3aa6a7..f72f81f551 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5420,26 +5420,34 @@
5420 <literallayout class='monospaced'> 5420 <literallayout class='monospaced'>
5421 BBMULTICONFIG = "x86 arm" 5421 BBMULTICONFIG = "x86 arm"
5422 </literallayout> 5422 </literallayout>
5423 </para>
5424
5425 <para>Please note, that a "default" configuration already exists by definition,
5426 this configuration is named: "" (empty string) and is defined by the variables
5427 coming from your local.conf file. So, the previous example actually adds two
5428 additional configurations to your build "arm" and "x86" along with "".
5423 </para></listitem> 5429 </para></listitem>
5424 <listitem><para> 5430 <listitem><para>
5425 <emphasis>Launch BitBake</emphasis>: 5431 <emphasis>Launch BitBake</emphasis>:
5426 Use the following BitBake command form to launch the 5432 Use the following BitBake command form to launch the
5427 multiple configuration build: 5433 multiple configuration build:
5428 <literallayout class='monospaced'> 5434 <literallayout class='monospaced'>
5429 $ bitbake [multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable> [[[multiconfig:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable>] ... ] 5435 $ bitbake [mc:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable> [[[mc:<replaceable>multiconfigname</replaceable>:]<replaceable>target</replaceable>] ... ]
5430 </literallayout> 5436 </literallayout>
5431 For the example in this section, the following 5437 For the example in this section, the following
5432 command applies: 5438 command applies:
5433 <literallayout class='monospaced'> 5439 <literallayout class='monospaced'>
5434 $ bitbake multiconfig:x86:core-image-minimal multiconfig:arm:core-image-sato 5440 $ bitbake mc:x86:core-image-minimal mc:arm:core-image-sato mc::core-image-base
5435 </literallayout> 5441 </literallayout>
5436 The previous BitBake command builds a 5442 The previous BitBake command builds a
5437 <filename>core-image-minimal</filename> image that 5443 <filename>core-image-minimal</filename> image that
5438 is configured through the 5444 is configured through the
5439 <filename>x86.conf</filename> configuration file 5445 <filename>x86.conf</filename> configuration file,
5440 and builds a <filename>core-image-sato</filename> 5446 a <filename>core-image-sato</filename>
5441 image that is configured through the 5447 image that is configured through the
5442 <filename>arm.conf</filename> configuration file. 5448 <filename>arm.conf</filename> configuration file and a
5449 <filename>core-image-base</filename> that is configured
5450 through your <filename>local.conf</filename> configuration file.
5443 </para></listitem> 5451 </para></listitem>
5444 </itemizedlist> 5452 </itemizedlist>
5445 <note> 5453 <note>
@@ -5479,7 +5487,7 @@
5479 build, you must declare the dependencies in the recipe 5487 build, you must declare the dependencies in the recipe
5480 using the following statement form: 5488 using the following statement form:
5481 <literallayout class='monospaced'> 5489 <literallayout class='monospaced'>
5482 <replaceable>task_or_package</replaceable>[mcdepends] = "multiconfig:<replaceable>from_multiconfig</replaceable>:<replaceable>to_multiconfig</replaceable>:<replaceable>recipe_name</replaceable>:<replaceable>task_on_which_to_depend</replaceable>" 5490 <replaceable>task_or_package</replaceable>[mcdepends] = "mc:<replaceable>from_multiconfig</replaceable>:<replaceable>to_multiconfig</replaceable>:<replaceable>recipe_name</replaceable>:<replaceable>task_on_which_to_depend</replaceable>"
5483 </literallayout> 5491 </literallayout>
5484 To better show how to use this statement, consider the 5492 To better show how to use this statement, consider the
5485 example scenario from the first paragraph of this section. 5493 example scenario from the first paragraph of this section.
@@ -5487,7 +5495,7 @@
5487 that builds the <filename>core-image-sato</filename> 5495 that builds the <filename>core-image-sato</filename>
5488 image: 5496 image:
5489 <literallayout class='monospaced'> 5497 <literallayout class='monospaced'>
5490 do_image[mcdepends] = "multiconfig:x86:arm:core-image-minimal:do_rootfs" 5498 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs"
5491 </literallayout> 5499 </literallayout>
5492 In this example, the 5500 In this example, the
5493 <replaceable>from_multiconfig</replaceable> is "x86". 5501 <replaceable>from_multiconfig</replaceable> is "x86".
@@ -5502,7 +5510,7 @@
5502 Once you set up this dependency, you can build the 5510 Once you set up this dependency, you can build the
5503 "x86" multiconfig using a BitBake command as follows: 5511 "x86" multiconfig using a BitBake command as follows:
5504 <literallayout class='monospaced'> 5512 <literallayout class='monospaced'>
5505 $ bitbake multiconfig:x86:core-image-sato 5513 $ bitbake mc:x86:core-image-sato
5506 </literallayout> 5514 </literallayout>
5507 This command executes all the tasks needed to create 5515 This command executes all the tasks needed to create
5508 the <filename>core-image-sato</filename> image for the 5516 the <filename>core-image-sato</filename> image for the
@@ -5518,7 +5526,7 @@
5518 Consider this change to the statement in the 5526 Consider this change to the statement in the
5519 <filename>core-image-sato</filename> recipe: 5527 <filename>core-image-sato</filename> recipe:
5520 <literallayout class='monospaced'> 5528 <literallayout class='monospaced'>
5521 do_image[mcdepends] = "multiconfig:x86:arm:core-image-minimal:do_image" 5529 do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_image"
5522 </literallayout> 5530 </literallayout>
5523 In this case, BitBake must create the 5531 In this case, BitBake must create the
5524 <filename>core-image-minimal</filename> image for the 5532 <filename>core-image-minimal</filename> image for the
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 93b7588385..8ad3f9b3ca 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1344,12 +1344,12 @@
1344 1344
1345 <glossentry id='var-BBMULTICONFIG'><glossterm>BBMULTICONFIG</glossterm> 1345 <glossentry id='var-BBMULTICONFIG'><glossterm>BBMULTICONFIG</glossterm>
1346 <info> 1346 <info>
1347 BBMULTICONFIG[doc] = "Specifies each separate configuration when you are building targets with multiple configurations." 1347 BBMULTICONFIG[doc] = "Specifies each additional separate configuration when you are building targets with multiple configurations."
1348 </info> 1348 </info>
1349 <glossdef> 1349 <glossdef>
1350 <para role="glossdeffirst"> 1350 <para role="glossdeffirst">
1351<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 1351<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
1352 Specifies each separate configuration when you are 1352 Specifies each additional separate configuration when you are
1353 building targets with multiple configurations. 1353 building targets with multiple configurations.
1354 Use this variable in your 1354 Use this variable in your
1355 <filename>conf/local.conf</filename> configuration file. 1355 <filename>conf/local.conf</filename> configuration file.