blob: 79a65b8c9d99efc53abadac113e564b4ee0ff8e0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
CMAKE_NINJA_OUTPUT_PATH_PREFIX
------------------------------
.. versionadded:: 3.6
Tell the :ref:`Ninja Generators` to add a prefix to every output path in
``build.ninja``. A trailing slash is appended to the prefix, if missing.
This is useful when the generated ninja file is meant to be embedded as a
``subninja`` file into a *super* ninja project. For example, the command:
.. code-block:: shell
cd super-build-dir &&
cmake -G Ninja -S /path/to/src -B sub -DCMAKE_NINJA_OUTPUT_PATH_PREFIX=sub/
# ^^^---------- these match -----------^^^
generates a build directory with its top-level (:variable:`CMAKE_BINARY_DIR`)
in ``super-build-dir/sub``. The path to the build directory ends in the
output path prefix. This makes it suitable for use in a separately-written
``super-build-dir/build.ninja`` file with a directive like this::
subninja sub/build.ninja
The ``auto-regeneration`` rule in ``super-build-dir/build.ninja`` must
have an order-only dependency on ``sub/build.ninja``.
.. versionadded:: 3.27
The :generator:`Ninja Multi-Config` generator supports this variable.
.. note::
When ``CMAKE_NINJA_OUTPUT_PATH_PREFIX`` is set, the project generated
by CMake cannot be used as a standalone project. No default targets
are specified.
The value of ``CMAKE_NINJA_OUTPUT_PATH_PREFIX`` must match one or more
path components at the *end* of :variable:`CMAKE_BINARY_DIR`, or the
behavior is undefined. However, this requirement is not checked
automatically.
|
