| Message ID | 20220902173550.89987-1-michael.opdenacker@bootlin.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v3] doc: bitbake-user-manual: Add definition for BB_PRESSURE_MAX variables | expand |
Hi Michael, On 9/2/22 19:35, Michael Opdenacker via lists.openembedded.org wrote: > From: Michael Opdenacker <michael.opdenacker@bootlin.com> > > From: Aryaman Gupta <aryaman.gupta@windriver.com> > > 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. > > Signed-off-by: Aryaman Gupta <aryaman.gupta@windriver.com> > Signed-off-by: Randy Macleod <Randy.Macleod@windriver.com> IIRC you're supposed to add your SoB when you're sending a patch even if it comes from someone else. Otherwwise, looks good. Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Thanks Aryaman, Michael, Quentin
Hi Quentin On 9/5/22 15:54, Quentin Schulz wrote: > Hi Michael, > > On 9/2/22 19:35, Michael Opdenacker via lists.openembedded.org wrote: >> From: Michael Opdenacker <michael.opdenacker@bootlin.com> >> >> From: Aryaman Gupta <aryaman.gupta@windriver.com> >> >> 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. >> >> Signed-off-by: Aryaman Gupta <aryaman.gupta@windriver.com> >> Signed-off-by: Randy Macleod <Randy.Macleod@windriver.com> > > IIRC you're supposed to add your SoB when you're sending a patch even > if it comes from someone else. > > Otherwwise, looks good. > > Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Thanks for the clarification. Indeed, according to https://www.kernel.org/doc/html/latest/process/submitting-patches.html?highlight=further+sobs#sign-your-work-the-developer-s-certificate-of-origin, anyone participating to the distribution of the patch should add his/her SoB too. I'll keep this in mind next time. I hope Richard can add those when merging. Cheers Michael.
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 12aef3cb..725e6c2c 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -483,6 +483,31 @@ overview of their function and contents. You must set this variable in the external environment in order for it to work. + :term:`BB_PRESSURE_MAX_CPU` + The threshold for maximum CPU pressure before BitBake prevents the + scheduling of new tasks. Once the :term:`BB_PRESSURE_MAX_CPU` threshold + is exceeded, new tasks are not started until the pressure subsides to + below the threshold. If :term:`BB_PRESSURE_MAX_CPU` is not set, CPU + pressure is not monitored. A threshold can be set in ``conf/local.conf`` + as:: + + BB_PRESSURE_MAX_CPU = "500" + + :term:`BB_PRESSURE_MAX_IO` + The threshold for maximum IO pressure experienced before BitBake + prevents the scheduling of new tasks. The IO pressure is regulated in the + same way as :term:`BB_PRESSURE_MAX_CPU`. At this point in time, + experiments show that IO pressure tends to be short-lived and regulating + just the CPU can help to reduce it. + + :term:`BB_PRESSURE_MAX_MEMORY` + The threshold for maximum memory pressure experienced before BitBake + prevents the scheduling of new tasks. The memory pressure is regulated in + the same way as :term:`BB_PRESSURE_MAX_CPU`. Note that any memory + pressure indicates that a system is being pushed beyond its capacity. At + this point in time, experiments show that memory pressure tends to be + short-lived and regulating just the CPU can help to reduce it. + :term:`BB_RUNFMT` Specifies the name of the executable script files (i.e. run files) saved into ``${``\ :term:`T`\ ``}``. By default, the