diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 7 | ||||
| -rw-r--r-- | documentation/ref-manual/closer-look.xml | 15 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-structure.xml | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 23 | ||||
| -rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 30 |
5 files changed, 33 insertions, 50 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index df29302fdb..c3206b86f8 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -297,10 +297,9 @@ | |||
| 297 | This file defines many aspects of the build environment including | 297 | This file defines many aspects of the build environment including |
| 298 | the target machine architecture through the | 298 | the target machine architecture through the |
| 299 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, | 299 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, |
| 300 | the development machine's processor use through the | 300 | the packaging format used during the build |
| 301 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and | 301 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>), |
| 302 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and | 302 | and a centralized tarball download directory through the |
| 303 | a centralized tarball download directory through the | ||
| 304 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> | 303 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> |
| 305 | <listitem><para> | 304 | <listitem><para> |
| 306 | Build the image using the <filename>bitbake</filename> command. | 305 | Build the image using the <filename>bitbake</filename> command. |
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index c0c0d619a4..eaf07d665f 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
| @@ -162,9 +162,10 @@ | |||
| 162 | <itemizedlist> | 162 | <itemizedlist> |
| 163 | <listitem><para><emphasis>Parallelism Options:</emphasis> | 163 | <listitem><para><emphasis>Parallelism Options:</emphasis> |
| 164 | Controlled by the | 164 | Controlled by the |
| 165 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> | 165 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>, |
| 166 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>, | ||
| 166 | and | 167 | and |
| 167 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> | 168 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> |
| 168 | variables.</para></listitem> | 169 | variables.</para></listitem> |
| 169 | <listitem><para><emphasis>Target Machine Selection:</emphasis> | 170 | <listitem><para><emphasis>Target Machine Selection:</emphasis> |
| 170 | Controlled by the | 171 | Controlled by the |
| @@ -216,12 +217,10 @@ | |||
| 216 | For example, suppose you had several build environments and | 217 | For example, suppose you had several build environments and |
| 217 | they shared some common features. | 218 | they shared some common features. |
| 218 | You can set these default build properties here. | 219 | You can set these default build properties here. |
| 219 | A good example is perhaps the level of parallelism you want | 220 | A good example is perhaps the packaging format to use |
| 220 | to use through the | 221 | through the |
| 221 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> | 222 | <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> |
| 222 | and | 223 | variable.</para> |
| 223 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> | ||
| 224 | variables.</para> | ||
| 225 | <para>One useful scenario for using the | 224 | <para>One useful scenario for using the |
| 226 | <filename>conf/site.conf</filename> file is to extend your | 225 | <filename>conf/site.conf</filename> file is to extend your |
| 227 | <link linkend='var-BBPATH'><filename>BBPATH</filename></link> | 226 | <link linkend='var-BBPATH'><filename>BBPATH</filename></link> |
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 14419d3a84..1098006c73 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
| @@ -467,12 +467,8 @@ | |||
| 467 | <filename><link linkend='var-MACHINE'>MACHINE</link></filename> | 467 | <filename><link linkend='var-MACHINE'>MACHINE</link></filename> |
| 468 | for which you want to build, which package types you wish to use | 468 | for which you want to build, which package types you wish to use |
| 469 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), | 469 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), |
| 470 | the location from which you want to access downloaded files | 470 | and the location from which you want to access downloaded files |
| 471 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), | 471 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>). |
| 472 | and how you want your host machine to use resources | ||
| 473 | (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> | ||
| 474 | and | ||
| 475 | <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>). | ||
| 476 | </para> | 472 | </para> |
| 477 | 473 | ||
| 478 | <para> | 474 | <para> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 7abad0460a..281c4e3e2d 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -729,20 +729,17 @@ | |||
| 729 | 729 | ||
| 730 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm><imagedata fileref="figures/define-generic.png" />BB_NUMBER_THREADS</glossterm> | 730 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm><imagedata fileref="figures/define-generic.png" />BB_NUMBER_THREADS</glossterm> |
| 731 | <info> | 731 | <info> |
| 732 | BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. A good rule of thumb is for this variable to be twice the number of cores." | 732 | BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. This variable is automatically configured to be equal to the number of build system cores." |
| 733 | </info> | 733 | </info> |
| 734 | <glossdef> | 734 | <glossdef> |
| 735 | <para> | 735 | <para> |
| 736 | The maximum number of tasks BitBake should run in parallel | 736 | The maximum number of tasks BitBake should run in parallel |
| 737 | at any one time. | 737 | at any one time. |
| 738 | If your host development system supports multiple cores, | 738 | The OpenEmbedded build system automatically configures |
| 739 | a good rule of thumb is to have this variable be twice the | 739 | this variable to be equal to the number of cores on the |
| 740 | number of cores. | 740 | build system. |
| 741 | </para> | 741 | To gain optimal parallelism, you should not have to |
| 742 | 742 | override this variable. | |
| 743 | <para> | ||
| 744 | The default value for <filename>BB_NUMBER_THREADS</filename> | ||
| 745 | is equal to the number of cores your build system has. | ||
| 746 | </para> | 743 | </para> |
| 747 | </glossdef> | 744 | </glossdef> |
| 748 | </glossentry> | 745 | </glossentry> |
| @@ -7380,11 +7377,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 7380 | </para> | 7377 | </para> |
| 7381 | 7378 | ||
| 7382 | <para> | 7379 | <para> |
| 7383 | If your development host supports multiple cores, a good | 7380 | The OpenEmbedded build system automatically sets this |
| 7384 | rule of thumb is to set this variable to twice the number | 7381 | variable to be equal to the number of cores the build |
| 7385 | of cores on the host. | 7382 | system uses. |
| 7386 | If you do not set <filename>PARALLEL_MAKE</filename>, it | ||
| 7387 | defaults to the number of cores your build system has. | ||
| 7388 | <note> | 7383 | <note> |
| 7389 | Individual recipes might clear out this variable if | 7384 | Individual recipes might clear out this variable if |
| 7390 | the software being built has problems running its | 7385 | the software being built has problems running its |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 8fe9b766e6..f21558ebbd 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
| @@ -509,15 +509,17 @@ | |||
| 509 | </para> | 509 | </para> |
| 510 | 510 | ||
| 511 | <para> | 511 | <para> |
| 512 | Another couple of variables of interest are the | 512 | Another three variables of interest are the |
| 513 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the | 513 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, |
| 514 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. | 514 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, |
| 515 | By default, these variables are set to the number of processor | 515 | and |
| 516 | cores your build host uses. | 516 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> |
| 517 | However, if your build host uses multiple processor cores, | 517 | variables. |
| 518 | you should increase these settings to twice the number of | 518 | By default, these variables are optimally set based on the |
| 519 | cores used. | 519 | number of processor cores your build host uses. |
| 520 | Doing so can significantly shorten your build time. | 520 | Although it is possible to override these variables, the |
| 521 | default values the OpenEmbedded build system derives provide you | ||
| 522 | with parallelism during the build. | ||
| 521 | </para> | 523 | </para> |
| 522 | 524 | ||
| 523 | <para> | 525 | <para> |
| @@ -898,18 +900,10 @@ | |||
| 898 | <filename>conf/local.conf</filename> configuration file | 900 | <filename>conf/local.conf</filename> configuration file |
| 899 | in the Build Directory. | 901 | in the Build Directory. |
| 900 | You need to manually edit this file to specify the machine you | 902 | You need to manually edit this file to specify the machine you |
| 901 | are building and to optimize your build time. | 903 | are building: |
| 902 | Here are the minimal changes to make: | ||
| 903 | <literallayout class='monospaced'> | 904 | <literallayout class='monospaced'> |
| 904 | BB_NUMBER_THREADS = "8" | ||
| 905 | PARALLEL_MAKE = "-j 8" | ||
| 906 | MACHINE ?= "beaglebone" | 905 | MACHINE ?= "beaglebone" |
| 907 | </literallayout> | 906 | </literallayout> |
| 908 | Briefly, set | ||
| 909 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> | ||
| 910 | and | ||
| 911 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to | ||
| 912 | twice your host processor's number of cores. | ||
| 913 | </para> | 907 | </para> |
| 914 | 908 | ||
| 915 | <para> | 909 | <para> |
