diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-07-09 11:33:32 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-07-11 13:30:44 +0100 |
commit | b578190fb4c916f4c521a6278371ff1d02fd0910 (patch) | |
tree | 22d53c58c8b5501f19958b16cee335591d5b8db9 | |
parent | 919d22732358473fd5037f5251b4195028fb076a (diff) | |
download | poky-b578190fb4c916f4c521a6278371ff1d02fd0910.tar.gz |
ref-manual/variables.rst: make reference to new limiting-resources doc
For host resource limiting variables, make a reference to the new
"Limiting the Host Resources Usage" document.
(From yocto-docs rev: 161a8549441e8c38791ab7f63001b2a15a39d2f2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/variables.rst | 32 |
1 files changed, 25 insertions, 7 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c56418e2a2..d079e4b598 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -589,8 +589,12 @@ system and gives an overview of their function and contents. | |||
589 | See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual. | 589 | See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual. |
590 | 590 | ||
591 | :term:`BB_LOADFACTOR_MAX` | 591 | :term:`BB_LOADFACTOR_MAX` |
592 | The system load threshold above which BitBake will stop runnig extra | 592 | The system load threshold above which :term:`BitBake` will stop running |
593 | tasks. | 593 | extra tasks. |
594 | |||
595 | For more information on how to limit the resources used during builds, see | ||
596 | the :doc:`/dev-manual/limiting-resources` section of the Yocto Project | ||
597 | Development Tasks Manual. | ||
594 | 598 | ||
595 | :term:`BB_LOGCONFIG` | 599 | :term:`BB_LOGCONFIG` |
596 | See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual. | 600 | See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual. |
@@ -649,11 +653,9 @@ system and gives an overview of their function and contents. | |||
649 | An alternative to using :term:`BB_NUMBER_THREADS` to keep the usage | 653 | An alternative to using :term:`BB_NUMBER_THREADS` to keep the usage |
650 | of build system resources under control is to use the smarter | 654 | of build system resources under control is to use the smarter |
651 | :term:`BB_PRESSURE_MAX_CPU`, :term:`BB_PRESSURE_MAX_IO` or | 655 | :term:`BB_PRESSURE_MAX_CPU`, :term:`BB_PRESSURE_MAX_IO` or |
652 | :term:`BB_PRESSURE_MAX_MEMORY` controls. They will prevent BitBake | 656 | :term:`BB_PRESSURE_MAX_MEMORY` controls. See the |
653 | from starting new tasks as long as thresholds are exceeded. Anyway, | 657 | :doc:`/dev-manual/limiting-resources` section of the Yocto Project |
654 | as with :term:`BB_NUMBER_THREADS`, such controls won't prevent the | 658 | Development Tasks Manual. |
655 | tasks already being run from using all CPU threads on the system | ||
656 | if :term:`PARALLEL_MAKE` is not set to a low value. | ||
657 | 659 | ||
658 | :term:`BB_ORIGENV` | 660 | :term:`BB_ORIGENV` |
659 | See :term:`bitbake:BB_ORIGENV` in the BitBake manual. | 661 | See :term:`bitbake:BB_ORIGENV` in the BitBake manual. |
@@ -664,12 +666,24 @@ system and gives an overview of their function and contents. | |||
664 | :term:`BB_PRESSURE_MAX_CPU` | 666 | :term:`BB_PRESSURE_MAX_CPU` |
665 | See :term:`bitbake:BB_PRESSURE_MAX_CPU` in the BitBake manual. | 667 | See :term:`bitbake:BB_PRESSURE_MAX_CPU` in the BitBake manual. |
666 | 668 | ||
669 | For more information on how to limit the resources used during builds, see | ||
670 | the :doc:`/dev-manual/limiting-resources` section of the Yocto Project | ||
671 | Development Tasks Manual. | ||
672 | |||
667 | :term:`BB_PRESSURE_MAX_IO` | 673 | :term:`BB_PRESSURE_MAX_IO` |
668 | See :term:`bitbake:BB_PRESSURE_MAX_IO` in the BitBake manual. | 674 | See :term:`bitbake:BB_PRESSURE_MAX_IO` in the BitBake manual. |
669 | 675 | ||
676 | For more information on how to limit the resources used during builds, see | ||
677 | the :doc:`/dev-manual/limiting-resources` section of the Yocto Project | ||
678 | Development Tasks Manual. | ||
679 | |||
670 | :term:`BB_PRESSURE_MAX_MEMORY` | 680 | :term:`BB_PRESSURE_MAX_MEMORY` |
671 | See :term:`bitbake:BB_PRESSURE_MAX_MEMORY` in the BitBake manual. | 681 | See :term:`bitbake:BB_PRESSURE_MAX_MEMORY` in the BitBake manual. |
672 | 682 | ||
683 | For more information on how to limit the resources used during builds, see | ||
684 | the :doc:`/dev-manual/limiting-resources` section of the Yocto Project | ||
685 | Development Tasks Manual. | ||
686 | |||
673 | :term:`BB_RUNFMT` | 687 | :term:`BB_RUNFMT` |
674 | See :term:`bitbake:BB_RUNFMT` in the BitBake manual. | 688 | See :term:`bitbake:BB_RUNFMT` in the BitBake manual. |
675 | 689 | ||
@@ -7006,6 +7020,10 @@ system and gives an overview of their function and contents. | |||
7006 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" | 7020 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" |
7007 | section in the Yocto Project Development Tasks Manual. | 7021 | section in the Yocto Project Development Tasks Manual. |
7008 | 7022 | ||
7023 | For more information on how to limit the resources used during builds, see | ||
7024 | the :doc:`/dev-manual/limiting-resources` section of the Yocto Project | ||
7025 | Development Tasks Manual. | ||
7026 | |||
7009 | :term:`PARALLEL_MAKEINST` | 7027 | :term:`PARALLEL_MAKEINST` |
7010 | Extra options passed to the build tool install command | 7028 | Extra options passed to the build tool install command |
7011 | (``make install``, ``ninja install`` or more specific ones) | 7029 | (``make install``, ``ninja install`` or more specific ones) |