diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 8fe4c1a914..d8e0d2b666 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -2405,6 +2405,46 @@ + ICECC_PARALLEL_MAKE + + + Extra options passed to the make + command during the do_compile task + that specify parallel compilation. + This variable usually takes the form of + -j 4, where the number + represents the maximum number of parallel threads + make can run. + + The options passed affect builds on all enabled + machines on the network, which are machines running the + iceccd daemon. + + + + + If your enabled machines support multiple cores, + coming up with the maximum number of parallel threads + that gives you the best performance could take some + experimentation since machine speed, network lag, + available memory, and existing machine loads can all + affect build time. + Consequently, unlike the + PARALLEL_MAKE + variable, there is no rule-of-thumb for setting + ICECC_PARALLEL_MAKE to achieve + optimal performance. + + + + If you do not set ICECC_PARALLEL_MAKE, + the build system does not use it (i.e. the system does + not detect and assign the number of cores as is done with + PARALLEL_MAKE). + + + + ICECC_PATH