diff options
| author |   Scott Rifenbark <srifenbark@gmail.com> | 2018-08-30 11:29:12 -0700 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-10-04 14:33:10 +0100 |
| commit | f2d432674b187685591f60cec3b2980b377c63fe (patch) | |
| tree | 44647b44882c3c09fb6e6f4d4b3b0120bdffaf1c | |
| parent | d47febbae4ff24be259037f12bafbc14b9e2d6a8 (diff) | |
| download | bitbake-f2d432674b187685591f60cec3b2980b377c63fe.tar.gz | |
bitbake-user-manual: Added new section on multiconfig builds
Created a new example. Also added a figure for the separate
configuration file hierarchy
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
| -rw-r--r-- | doc/bitbake-user-manual/bitbake-user-manual-intro.xml | 69 | ||||
| -rw-r--r-- | doc/bitbake-user-manual/figures/bb_multiconfig_files.png | bin | 0 -> 19991 bytes |
2 files changed, 69 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml index 4cf0ed9d1..1dbf141c9 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml @@ -723,6 +723,75 @@ </literallayout> </para> </section> + + <section id='executing-a-multiple-configuration-build'> + <title>Executing a Multiple Configuration Build</title> + + <para> + BitBake is able to build multiple images or packages + using a single command where the different targets + require different configurations (multiple configuration + builds). + Each target, in this scenario, is referred to as a + "multiconfig". + </para> + + <para> + To accomplish a multiple configuration build, you must + define each target's configuration separately using + a parallel configuration file in the build directory. + The location for these multiconfig configuration files + is specific. + They must reside in the current build directory in + a sub-directory of <filename>conf</filename> named + <filename>multiconfig</filename>. + Following is an example for two separate targets: + <imagedata fileref="figures/bb_multiconfig_files.png" align="center" width="4in" depth="3in" /> + </para> + + <para> + The reason for this required file hierarchy + is because the <filename>BBPATH</filename> variable + is not constructed until the layers are parsed. + Consequently, using the configuration file as a + pre-configuration file is not possible unless it is + located in the current working directory. + </para> + + <para> + Minimally, each configuration file must define the + machine and the temporary directory BitBake uses + for the build. + Suggested practice dictates that you do not + overlap the temporary directories used during the + builds. + </para> + + <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 + configuration file. + Enabling is accomplished through a variable specific + to the build environment. + </para> + + <para> + Once the target configuration files are in place and + BitBake has been enabled to perform multiple configuration + builds, use the following command form to start the + builds: + <literallayout class='monospaced'> + $ 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>: + <literallayout class='monospaced'> + $ bitbake multiconfig:Target_1:<replaceable>target</replaceable> multiconfig:Target_2:<replaceable>target</replaceable> + </literallayout> + </para> + </section> </section> </section> </chapter> diff --git a/doc/bitbake-user-manual/figures/bb_multiconfig_files.png b/doc/bitbake-user-manual/figures/bb_multiconfig_files.png Binary files differnew file mode 100644 index 000000000..041f06403 --- /dev/null +++ b/doc/bitbake-user-manual/figures/bb_multiconfig_files.png |
