diff mbox series

[bitbake-devel] doc/user-manual: Add BB_LOADFACTOR_MAX

Message ID ff0e2a74b5fa86ebd92c6dff32f4e97d972683d7.camel@linuxfoundation.org
State New
Headers show
Series [bitbake-devel] doc/user-manual: Add BB_LOADFACTOR_MAX | expand

Commit Message

Richard Purdie April 11, 2024, 12:27 p.m. UTC 
Sharing with the docs list too...

Cheers,

Richard
Document BB_LOADFACTOR_MAX which was recently added.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../bitbake-user-manual-ref-variables.rst                | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index d3936935cd..00faeea686 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -432,6 +432,15 @@  overview of their function and contents.
       ``ConfigParsed`` event can set the variable to trigger the re-parse.
       You must be careful to avoid recursive loops with this functionality.
 
+   :term:`BB_LOADFACTOR_MAX`
+      Setting this to a value will cause bitbake to check the system load
+      average before executing new tasks. If the load average is above the
+      the number of CPUs multipled by this factor, no new task will be started
+      unless there is no task executing. A value of "1.5" has been found to
+      work reasonably. This is helpful for systems which don't have pressure
+      regulation enabled, which is more granular. Pressure values take
+      precedence over loadfactor.
+
    :term:`BB_LOGCONFIG`
       Specifies the name of a config file that contains the user logging
       configuration. See