Skip to content

Commit c95fb4e

Browse files
committed
[nrf fromtree] doc: document CMAKE_BUILD_PARALLEL_LEVEL and VERBOSE env variables
Sysbuild may include several images and when using ninja as build tools then build options like `ninja -v` or `ninja -j <n>` is only consumed by the top-level build folder, which is sysbuild itself. CMake supports setting number of jobs or verbosity using environment variables. Document this feature in the Building with sysbuild section. Signed-off-by: Torsten Rasmussen <[email protected]> (cherry picked from commit e270fd4)
1 parent ba87527 commit c95fb4e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/build/sysbuild/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,25 @@ As mentioned above, you can run sysbuild via ``west build`` or ``cmake``.
143143
an extra CMake argument. ``APP_DIR`` is the path to the main Zephyr
144144
application managed by sysbuild.
145145

146+
.. tip::
147+
148+
The environment variables, ``CMAKE_BUILD_PARALLEL_LEVEL`` and ``VERBOSE``, can be used to
149+
control the build process when using sysbuild with CMake and ninja.
150+
151+
To set number of jobs for ninja for all sysbuild images, set the CMAKE_BUILD_PARALLEL_LEVEL
152+
environment variable and invoke the build with ``cmake --build``, for example:
153+
154+
.. code-block:: shell
155+
156+
CMAKE_BUILD_PARALLEL_LEVEL=<n> cmake --build .
157+
158+
For verbose output of all images, use:
159+
160+
.. code-block:: shell
161+
162+
VERBOSE=1 cmake --build .
163+
164+
146165
Configuration namespacing
147166
*************************
148167

0 commit comments

Comments
 (0)