From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH 2/2] ref-manual/variables.rst: expand PARALLEL_MAKE description
Date: Tue, 8 Nov 2022 21:40:17 +0100 [thread overview]
Message-ID: <20221108204017.494051-2-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20221108204017.494051-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Explain that this variable apply not only to make, but also
to ninja, and to other build tools which support parallel jobs.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/ref-manual/variables.rst | 28 +++++++++++++++-----------
1 file 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.
desired splitting.
:term:`PARALLEL_MAKE`
- Extra options passed to the ``make`` command during the
- :ref:`ref-tasks-compile` task in order to specify
- parallel compilation on the local build host. This variable is
- usually in the form "-j x", where x represents the maximum number of
- parallel threads ``make`` can run.
+
+ Extra options passed to the build tool command (``make``,
+ ``ninja`` or more specific build engines, like the Go language one)
+ during the :ref:`ref-tasks-compile` task, to specify parallel compilation
+ on the local build host. This variable is usually in the form "-j x",
+ where x represents the maximum number of parallel threads such engines
+ can run.
.. note::
- In order for :term:`PARALLEL_MAKE` to be effective, ``make`` must be
- called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure
- this is to use the ``oe_runmake`` function.
+ For software compiled by ``make``, in order for :term:`PARALLEL_MAKE`
+ to be effective, ``make`` must be called with
+ ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
+ way to ensure this is to use the ``oe_runmake`` function.
By default, the OpenEmbedded build system automatically sets this
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.
section in the Yocto Project Development Tasks Manual.
:term:`PARALLEL_MAKEINST`
- Extra options passed to the ``make install`` command during the
- :ref:`ref-tasks-install` task in order to specify
+ Extra options passed to the build tool install command
+ (``make install``, ``ninja install`` or more specific ones)
+ during the :ref:`ref-tasks-install` task in order to specify
parallel installation. This variable defaults to the value of
:term:`PARALLEL_MAKE`.
.. note::
- In order for :term:`PARALLEL_MAKEINST` to be effective, ``make`` must
- be called with
+ For software compiled by ``make``, in order for :term:`PARALLEL_MAKEINST`
+ to be effective, ``make`` must be called with
``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
way to ensure this is to use the ``oe_runmake`` function.
--
2.34.1
prev parent reply other threads:[~2022-11-08 20:40 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-08 20:40 [PATCH 1/2] ref-manual/variables.rst: expand BB_NUMBER_THREADS description michael.opdenacker
2022-11-08 20:40 ` michael.opdenacker [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221108204017.494051-2-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox