summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-05-05 07:39:20 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-07-28 18:02:28 +0100
commite05c636bc85fd06b8f5b2f941ddd7d5b8e3e8b9c (patch)
tree522be06d281f206191f33fd4a8895d20138efabb
parent8c9fb712268ee1bc6cbdb3f0415be01ede3af152 (diff)
downloadpoky-e05c636bc85fd06b8f5b2f941ddd7d5b8e3e8b9c.tar.gz
ref-manual, dev-manual: Added info about make race work-around
I updated both the PARALLEL_MAKE and PARALLEL_MAKEINST variables by expanding the note to indicate how to prohibit parallel make threads. Also, added a cross-referencing link to the "Debugging Parallel Make Races" section. I added a short note to the start of the "Debugging Parallel Make Races" section noting that if they can't properly fix the condition, they can always do a work-around to set the PARALLEL_MAKE or PARALLEL_MAKEINST variables to null. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: f8dccf3f115647cb039d91415819186cf38fa8bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml8
-rw-r--r--documentation/ref-manual/ref-variables.xml31
2 files changed, 29 insertions, 10 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 1d4e34f91e..bab68a1bb9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -9089,6 +9089,14 @@
9089 you debug and fix them. 9089 you debug and fix them.
9090 This section presents a real-world example of an error encountered 9090 This section presents a real-world example of an error encountered
9091 on the Yocto Project autobuilder and the process used to fix it. 9091 on the Yocto Project autobuilder and the process used to fix it.
9092 <note>
9093 If you cannot properly fix a <filename>make</filename> race
9094 condition, you can work around it by clearing either the
9095 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>
9096 or
9097 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename></ulink>
9098 variables.
9099 </note>
9092 </para> 9100 </para>
9093 9101
9094 <section id='the-failure'> 9102 <section id='the-failure'>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 27008c7a5d..dfe775b23f 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -8525,13 +8525,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8525 </para> 8525 </para>
8526 8526
8527 <para> 8527 <para>
8528 The OpenEmbedded build system automatically sets this 8528 By default, the OpenEmbedded build system automatically
8529 variable to be equal to the number of cores the build 8529 sets this variable to be equal to the number of cores the
8530 system uses. 8530 build system uses.
8531 <note> 8531 <note>
8532 Individual recipes might clear out this variable if 8532 If the software being built experiences dependency
8533 the software being built has problems running its 8533 issues during the <filename>do_compile</filename>
8534 <filename>make</filename> process in parallel. 8534 task that result in race conditions, you can clear
8535 the <filename>PARALLEL_MAKE</filename> variable within
8536 the recipe as a workaround.
8537 For information on addressing race conditions, see the
8538 "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>"
8539 section in the Yocto Project Development Manual.
8535 </note> 8540 </note>
8536 For single socket systems (i.e. one CPU), you should not 8541 For single socket systems (i.e. one CPU), you should not
8537 have to override this variable to gain optimal parallelism 8542 have to override this variable to gain optimal parallelism
@@ -8539,7 +8544,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8539 However, if you have very large systems that employ 8544 However, if you have very large systems that employ
8540 multiple physical CPUs, you might want to make sure the 8545 multiple physical CPUs, you might want to make sure the
8541 <filename>PARALLEL_MAKE</filename> variable is not 8546 <filename>PARALLEL_MAKE</filename> variable is not
8542 set higher than "20". 8547 set higher than "-j 20".
8543 </para> 8548 </para>
8544 8549
8545 <para> 8550 <para>
@@ -8564,9 +8569,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8564 This variable defaults to the value of 8569 This variable defaults to the value of
8565 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>. 8570 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>.
8566 <note> 8571 <note>
8567 Individual recipes might clear out this variable if 8572 If the software being built experiences dependency
8568 the software being built has problems running its 8573 issues during the
8569 <filename>make install</filename> process in parallel. 8574 <filename>do_install</filename> task that result in
8575 race conditions, you can clear the
8576 <filename>PARALLEL_MAKEINST</filename> variable within
8577 the recipe as a workaround.
8578 For information on addressing race conditions, see the
8579 "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>"
8580 section in the Yocto Project Development Manual.
8570 </note> 8581 </note>
8571 </para> 8582 </para>
8572 </glossdef> 8583 </glossdef>