diff options
author | Aryaman Gupta <aryaman.gupta@windriver.com> | 2022-09-19 16:58:12 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-09-29 21:24:29 +0100 |
commit | 764bbf2a9b001f7bf78b689613d8993a66b87430 (patch) | |
tree | 346ce179b18c8d33f6a74518b2e40544a983da0d /bitbake/doc/bitbake-user-manual | |
parent | f76140955183259878df7425774aa18d0032b397 (diff) | |
download | poky-764bbf2a9b001f7bf78b689613d8993a66b87430.tar.gz |
bitbake: doc: bitbake-user-manual: Add definition for BB_PRESSURE_MAX variables
Add the definitions for the BB_PRESSURE_MAX{CPU|IO|MEMORY} variables in the
bitbake varibales glossary. Further information on how to determine a good
threshold will be added to the Yocto reference manual in a later commit.
(Bitbake rev: c014281f72f4f54ec8e681ef2b8e1080de9ab5cf)
Signed-off-by: Aryaman Gupta <aryaman.gupta@windriver.com>
Signed-off-by: Randy Macleod <Randy.Macleod@windriver.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 12aef3cbb7..725e6c2cd5 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
@@ -483,6 +483,31 @@ overview of their function and contents. | |||
483 | You must set this variable in the external environment in order | 483 | You must set this variable in the external environment in order |
484 | for it to work. | 484 | for it to work. |
485 | 485 | ||
486 | :term:`BB_PRESSURE_MAX_CPU` | ||
487 | The threshold for maximum CPU pressure before BitBake prevents the | ||
488 | scheduling of new tasks. Once the :term:`BB_PRESSURE_MAX_CPU` threshold | ||
489 | is exceeded, new tasks are not started until the pressure subsides to | ||
490 | below the threshold. If :term:`BB_PRESSURE_MAX_CPU` is not set, CPU | ||
491 | pressure is not monitored. A threshold can be set in ``conf/local.conf`` | ||
492 | as:: | ||
493 | |||
494 | BB_PRESSURE_MAX_CPU = "500" | ||
495 | |||
496 | :term:`BB_PRESSURE_MAX_IO` | ||
497 | The threshold for maximum IO pressure experienced before BitBake | ||
498 | prevents the scheduling of new tasks. The IO pressure is regulated in the | ||
499 | same way as :term:`BB_PRESSURE_MAX_CPU`. At this point in time, | ||
500 | experiments show that IO pressure tends to be short-lived and regulating | ||
501 | just the CPU can help to reduce it. | ||
502 | |||
503 | :term:`BB_PRESSURE_MAX_MEMORY` | ||
504 | The threshold for maximum memory pressure experienced before BitBake | ||
505 | prevents the scheduling of new tasks. The memory pressure is regulated in | ||
506 | the same way as :term:`BB_PRESSURE_MAX_CPU`. Note that any memory | ||
507 | pressure indicates that a system is being pushed beyond its capacity. At | ||
508 | this point in time, experiments show that memory pressure tends to be | ||
509 | short-lived and regulating just the CPU can help to reduce it. | ||
510 | |||
486 | :term:`BB_RUNFMT` | 511 | :term:`BB_RUNFMT` |
487 | Specifies the name of the executable script files (i.e. run files) | 512 | Specifies the name of the executable script files (i.e. run files) |
488 | saved into ``${``\ :term:`T`\ ``}``. By default, the | 513 | saved into ``${``\ :term:`T`\ ``}``. By default, the |