diff mbox series

doc/user-manual: Add BB_LOADFACTOR_MAX

Message ID 20240411122508.2149106-1-richard.purdie@linuxfoundation.org
State Accepted, archived
Commit 833b76e9333e317cab5f17d6f7daaecc89c69547
Headers show
Series doc/user-manual: Add BB_LOADFACTOR_MAX | expand

Commit Message

Richard Purdie April 11, 2024, 12:25 p.m. UTC
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(+)

Comments

Michael Opdenacker April 11, 2024, 1:50 p.m. UTC | #1
Hi Richard,

On 4/11/24 at 14:25, Richard Purdie wrote:
> 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 --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
s/bitbake/BitBake/

That's the convention we follow everywhere, when talking about the 
total, not the command to type of course.
> +      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.
> +

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Once this is merged, I'll make the YP docs directly point to this in the 
BitBake manual. At the moment, we have a shorter description.
Thanks!
Michael
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