summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-11-16 09:42:53 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-11-25 15:24:19 +0000
commitaffc8b985a6b059424ae67e230cdc1f1215c9977 (patch)
treeb1166d0bc8f7f4416783251c9a55976af530e7f1 /documentation
parent4cb3862f6a1190ab3bf94bc827231e8ddabb8c62 (diff)
downloadpoky-affc8b985a6b059424ae67e230cdc1f1215c9977.tar.gz
documentation: BB_NUMBER_THREADS and PARALLEL_MAKE suggestions
Text that suggests setting the BB_NUMBER_THREADS and PARALLEL_MAKE variables to speed build time has been updated to suggest a setting of twice the number of host cores supported. The 2x number came to light through a discussion on the project mailing list initiated by Robert P. J. Day. Reported-by: Robert P. J. Day (From yocto-docs rev: 1846b41a595b7bd905ca828eaa04112d1533d7a1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-bsp-appendix.xml7
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml11
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml2
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml5
4 files changed, 11 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml
index 7b8dc6ead5..aecb24f725 100644
--- a/documentation/dev-manual/dev-manual-bsp-appendix.xml
+++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml
@@ -562,9 +562,10 @@
562 You should also be sure any other variables in which you are interested are set. 562 You should also be sure any other variables in which you are interested are set.
563 Some variables to consider are <filename>BB_NUMBER_THREADS</filename> 563 Some variables to consider are <filename>BB_NUMBER_THREADS</filename>
564 and <filename>PARALLEL_MAKE</filename>, both of which can greatly reduce your build time 564 and <filename>PARALLEL_MAKE</filename>, both of which can greatly reduce your build time
565 if you are using a multi-threaded development system (e.g. values of 565 if your development system supports multiple cores.
566 <filename>8</filename> and <filename>j 6</filename>, respectively are optimal 566 For development systems that support multiple cores, a good rule of thumb is to set
567 for a development machine that has four available cores).</para></listitem> 567 both the <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>
568 variables to twice the number of cores your system supports.</para></listitem>
568 <listitem><para>Update the <filename>bblayers.conf</filename> file so that it includes 569 <listitem><para>Update the <filename>bblayers.conf</filename> file so that it includes
569 the path to your new BSP layer. 570 the path to your new BSP layer.
570 In this example you need to include the pathname to <filename>meta-mymachine</filename>. 571 In this example you need to include the pathname to <filename>meta-mymachine</filename>.
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 7ac349b6e3..0f13344800 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -221,9 +221,9 @@
221 If your host development system supports multi-core and multi-thread capabilities, 221 If your host development system supports multi-core and multi-thread capabilities,
222 you can uncomment these statements and set the variables to significantly shorten 222 you can uncomment these statements and set the variables to significantly shorten
223 the full build time. 223 the full build time.
224 As a guideline, set <filename>BB_NUMBER_THREADS</filename> to twice the number 224 As a guideline, set both <filename>BB_NUMBER_THREADS</filename> and
225 of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and 225 <filename>PARALLEL_MAKE</filename> to twice the number
226 a half times the number of cores your machine supports. 226 of cores your machine supports.
227 </note> 227 </note>
228 </para> 228 </para>
229 <para> 229 <para>
@@ -390,9 +390,8 @@
390 build time if your host supports multi-core and multi-thread capabilities: 390 build time if your host supports multi-core and multi-thread capabilities:
391 <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>. 391 <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>.
392 If the host system has multiple cores then you can optimize build time 392 If the host system has multiple cores then you can optimize build time
393 by setting <filename>BB_NUMBER_THREADS</filename> to twice the number of 393 by setting both these variables to twice the number of
394 cores and setting <filename>PARALLEL_MAKE</filename> to one and a half times the 394 cores.</para></listitem>
395 number of cores.</para></listitem>
396 <listitem><para><emphasis>Identify Your <filename>meta-kernel-dev</filename> 395 <listitem><para><emphasis>Identify Your <filename>meta-kernel-dev</filename>
397 Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the 396 Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the
398 <filename>bblayers.conf</filename> file found in the 397 <filename>bblayers.conf</filename> file found in the
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 6843094fca..fc4fb9c5b1 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -927,7 +927,7 @@
927 This variable is usually in the form <filename>-j 4</filename>, where the number 927 This variable is usually in the form <filename>-j 4</filename>, where the number
928 represents the maximum number of parallel threads make can run. 928 represents the maximum number of parallel threads make can run.
929 If you development host supports multiple cores a good rule of thumb is to set 929 If you development host supports multiple cores a good rule of thumb is to set
930 this variable to one and a half times the number of cores on the host.</para> 930 this variable to twice the number of cores on the host.</para>
931 </glossdef> 931 </glossdef>
932 </glossentry> 932 </glossentry>
933 933
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index fcbf3a1847..23e097b20f 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -410,11 +410,8 @@
410 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. 410 <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables.
411 By default, these variables are commented out. 411 By default, these variables are commented out.
412 However, if you have a multi-core CPU you might want to uncomment 412 However, if you have a multi-core CPU you might want to uncomment
413 the lines and set the variable 413 the lines and set both variables equal to twice the number of your
414 <filename>BB_NUMBER_THREADS</filename> equal to twice the number of your
415 host's processor cores. 414 host's processor cores.
416 Also, you could set the variable <filename>PARALLEL_MAKE</filename> equal to
417 1.5 times the number of processor cores.
418 Setting these variables can significantly shorten your build time. 415 Setting these variables can significantly shorten your build time.
419 </para> 416 </para>
420 417