diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-08 21:30:11 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-11-10 22:12:56 +0000 |
commit | 51b6a55a80fd86c5d233bcaf3fb978f3731d68ef (patch) | |
tree | 2fed596ad6abc56a82751045444a95c3d57bb1f3 /documentation | |
parent | 15a8edceadc3a0cdb2d8bf5c33871bac13fcaaa2 (diff) | |
download | poky-51b6a55a80fd86c5d233bcaf3fb978f3731d68ef.tar.gz |
ref-manual/variables.rst: expand PARALLEL_MAKE description
Explain that this variable apply not only to make, but also
to ninja, and to other build tools which support parallel jobs.
(From yocto-docs rev: d3fe2aba3948040a01b9068df5085453ad65309c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/variables.rst | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 147679400f..d3aae63308 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -5818,17 +5818,20 @@ system and gives an overview of their function and contents. | |||
5818 | desired splitting. | 5818 | desired splitting. |
5819 | 5819 | ||
5820 | :term:`PARALLEL_MAKE` | 5820 | :term:`PARALLEL_MAKE` |
5821 | Extra options passed to the ``make`` command during the | 5821 | |
5822 | :ref:`ref-tasks-compile` task in order to specify | 5822 | Extra options passed to the build tool command (``make``, |
5823 | parallel compilation on the local build host. This variable is | 5823 | ``ninja`` or more specific build engines, like the Go language one) |
5824 | usually in the form "-j x", where x represents the maximum number of | 5824 | during the :ref:`ref-tasks-compile` task, to specify parallel compilation |
5825 | parallel threads ``make`` can run. | 5825 | on the local build host. This variable is usually in the form "-j x", |
5826 | where x represents the maximum number of parallel threads such engines | ||
5827 | can run. | ||
5826 | 5828 | ||
5827 | .. note:: | 5829 | .. note:: |
5828 | 5830 | ||
5829 | In order for :term:`PARALLEL_MAKE` to be effective, ``make`` must be | 5831 | For software compiled by ``make``, in order for :term:`PARALLEL_MAKE` |
5830 | called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure | 5832 | to be effective, ``make`` must be called with |
5831 | this is to use the ``oe_runmake`` function. | 5833 | ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy |
5834 | way to ensure this is to use the ``oe_runmake`` function. | ||
5832 | 5835 | ||
5833 | By default, the OpenEmbedded build system automatically sets this | 5836 | By default, the OpenEmbedded build system automatically sets this |
5834 | variable to be equal to the number of cores the build system uses. | 5837 | variable to be equal to the number of cores the build system uses. |
@@ -5853,15 +5856,16 @@ system and gives an overview of their function and contents. | |||
5853 | section in the Yocto Project Development Tasks Manual. | 5856 | section in the Yocto Project Development Tasks Manual. |
5854 | 5857 | ||
5855 | :term:`PARALLEL_MAKEINST` | 5858 | :term:`PARALLEL_MAKEINST` |
5856 | Extra options passed to the ``make install`` command during the | 5859 | Extra options passed to the build tool install command |
5857 | :ref:`ref-tasks-install` task in order to specify | 5860 | (``make install``, ``ninja install`` or more specific ones) |
5861 | during the :ref:`ref-tasks-install` task in order to specify | ||
5858 | parallel installation. This variable defaults to the value of | 5862 | parallel installation. This variable defaults to the value of |
5859 | :term:`PARALLEL_MAKE`. | 5863 | :term:`PARALLEL_MAKE`. |
5860 | 5864 | ||
5861 | .. note:: | 5865 | .. note:: |
5862 | 5866 | ||
5863 | In order for :term:`PARALLEL_MAKEINST` to be effective, ``make`` must | 5867 | For software compiled by ``make``, in order for :term:`PARALLEL_MAKEINST` |
5864 | be called with | 5868 | to be effective, ``make`` must be called with |
5865 | ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy | 5869 | ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy |
5866 | way to ensure this is to use the ``oe_runmake`` function. | 5870 | way to ensure this is to use the ``oe_runmake`` function. |
5867 | 5871 | ||