OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 Borland Makefiles.html	5.14 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 CodeBlocks.html	9.18 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 CodeLite.html	8.35 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Eclipse CDT4.html	7.6 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Green Hills MULTI.html	23.55 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Kate.html	7.44 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 MSYS Makefiles.html	5.94 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 MinGW Makefiles.html	6.04 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 NMake Makefiles JOM.html	5.5 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 NMake Makefiles.html	5.11 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Ninja Multi-Config.html	28.69 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Ninja.html	9.51 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Sublime Text 2.html	8.3 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Unix Makefiles.html	6.89 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 10 2010.html	6.58 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 11 2012.html	12.04 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 12 2013.html	11.32 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 14 2015.html	13.27 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 15 2017.html	12.28 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 16 2019.html	11.4 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 17 2022.html	11.35 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 6.html	5.57 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 7 .NET 2003.html	5.68 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 7.html	5.66 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 8 2005.html	5.74 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Visual Studio 9 2008.html	9.02 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Watcom WMake.html	4.96 KB	04/04/2023 07:05:06 PM	rw-r--r--
📄 Xcode.html	10.61 KB	04/04/2023 07:05:06 PM	rw-r--r--

Editing: Ninja Multi-Config.html

<!DOCTYPE html>

<title>Ninja Multi-Config &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="Visual%20Studio%206.html" title="Visual Studio 6"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="Ninja.html" title="Ninja"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-generators.7.html" accesskey="U">cmake-generators(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Ninja Multi-Config</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="ninja-multi-config">
<h1>Ninja Multi-Config<a class="headerlink" href="#ninja-multi-config" title="Permalink to this heading">¶</a></h1>
<div class="versionadded">
New in version 3.17.
</div>
Generates multiple <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> files.
This generator is very much like the <a class="reference internal" href="Ninja.html#generator:Ninja" title="Ninja"><code class="xref cmake cmake-generator docutils literal notranslate">Ninja</code></a> generator, but with
some key differences. Only these differences will be discussed in this
document.
Unlike the <a class="reference internal" href="Ninja.html#generator:Ninja" title="Ninja"><code class="xref cmake cmake-generator docutils literal notranslate">Ninja</code></a> generator, <code class="docutils literal notranslate">Ninja Multi-Config</code> generates
multiple configurations at once with <a class="reference internal" href="../variable/CMAKE_CONFIGURATION_TYPES.html#variable:CMAKE_CONFIGURATION_TYPES" title="CMAKE_CONFIGURATION_TYPES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CONFIGURATION_TYPES</code></a>
instead of only one configuration with <a class="reference internal" href="../variable/CMAKE_BUILD_TYPE.html#variable:CMAKE_BUILD_TYPE" title="CMAKE_BUILD_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_BUILD_TYPE</code></a>. One
<code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> file will be generated for each of these
configurations (with <code class="docutils literal notranslate">&lt;Config&gt;</code> being the configuration name.) These files
are intended to be run with <code class="docutils literal notranslate">ninja -f build-&lt;Config&gt;.ninja</code>. A
<code class="docutils literal notranslate">build.ninja</code> file is also generated, using the configuration from either
<a class="reference internal" href="../variable/CMAKE_DEFAULT_BUILD_TYPE.html#variable:CMAKE_DEFAULT_BUILD_TYPE" title="CMAKE_DEFAULT_BUILD_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_DEFAULT_BUILD_TYPE</code></a> or the first item from
<a class="reference internal" href="../variable/CMAKE_CONFIGURATION_TYPES.html#variable:CMAKE_CONFIGURATION_TYPES" title="CMAKE_CONFIGURATION_TYPES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CONFIGURATION_TYPES</code></a>.
<code class="docutils literal notranslate">cmake --build . --config &lt;Config&gt;</code> will always use <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code>
to build. If no <a class="reference internal" href="../manual/cmake.1.html#cmdoption-cmake-build-config"><code class="xref std std-option docutils literal notranslate">--config</code></a> argument is
specified, <a class="reference internal" href="../manual/cmake.1.html#cmdoption-cmake-build"><code class="xref std std-option docutils literal notranslate">cmake --build .</code></a> will use <code class="docutils literal notranslate">build.ninja</code>.
Each <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> file contains <code class="docutils literal notranslate">&lt;target&gt;</code> targets as well as
<code class="docutils literal notranslate">&lt;target&gt;:&lt;Config&gt;</code> targets, where <code class="docutils literal notranslate">&lt;Config&gt;</code> is the same as the
configuration specified in <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> Additionally, if
cross-config mode is enabled, <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> may contain
<code class="docutils literal notranslate">&lt;target&gt;:&lt;OtherConfig&gt;</code> targets, where <code class="docutils literal notranslate">&lt;OtherConfig&gt;</code> is a cross-config,
as well as <code class="docutils literal notranslate">&lt;target&gt;:all</code>, which builds the target in all cross-configs. See
below for how to enable cross-config mode.
The <code class="docutils literal notranslate">Ninja Multi-Config</code> generator recognizes the following variables:
<dl class="simple">
<dt><a class="reference internal" href="../variable/CMAKE_CONFIGURATION_TYPES.html#variable:CMAKE_CONFIGURATION_TYPES" title="CMAKE_CONFIGURATION_TYPES"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CONFIGURATION_TYPES</code></a></dt><dd>Specifies the total set of configurations to build. Unlike with other
multi-config generators, this variable has a value of
<code class="docutils literal notranslate">Debug;Release;RelWithDebInfo</code> by default.
</dd>
<dt><a class="reference internal" href="../variable/CMAKE_CROSS_CONFIGS.html#variable:CMAKE_CROSS_CONFIGS" title="CMAKE_CROSS_CONFIGS"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CROSS_CONFIGS</code></a></dt><dd>Specifies a <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists">semicolon-separated list</a> of
configurations available from all <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> files.
</dd>
<dt><a class="reference internal" href="../variable/CMAKE_DEFAULT_BUILD_TYPE.html#variable:CMAKE_DEFAULT_BUILD_TYPE" title="CMAKE_DEFAULT_BUILD_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_DEFAULT_BUILD_TYPE</code></a></dt><dd>Specifies the configuration to use by default in a <code class="docutils literal notranslate">build.ninja</code> file.
</dd>
<dt><a class="reference internal" href="../variable/CMAKE_DEFAULT_CONFIGS.html#variable:CMAKE_DEFAULT_CONFIGS" title="CMAKE_DEFAULT_CONFIGS"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_DEFAULT_CONFIGS</code></a></dt><dd>Specifies a <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists">semicolon-separated list</a> of
configurations to build for a target in <code class="docutils literal notranslate">build.ninja</code>
if no <code class="docutils literal notranslate">:&lt;Config&gt;</code> suffix is specified.
</dd>
</dl>
Consider the following example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>cmake_minimum_required(VERSION 3.16)
project(MultiConfigNinja C)

add_executable(generator generator.c)
add_custom_command(OUTPUT generated.c COMMAND generator generated.c)
add_library(generated ${CMAKE_BINARY_DIR}/generated.c)
</pre></div>
</div>
Now assume you configure the project with <code class="docutils literal notranslate">Ninja Multi-Config</code> and run one of
the following commands:
<div class="highlight-shell notranslate"><div class="highlight"><pre>ninja -f build-Debug.ninja generated
# OR
cmake --build . --config Debug --target generated
</pre></div>
</div>
This would build the <code class="docutils literal notranslate">Debug</code> configuration of <code class="docutils literal notranslate">generator</code>, which would be
used to generate <code class="docutils literal notranslate">generated.c</code>, which would be used to build the <code class="docutils literal notranslate">Debug</code>
configuration of <code class="docutils literal notranslate">generated</code>.
But if <a class="reference internal" href="../variable/CMAKE_CROSS_CONFIGS.html#variable:CMAKE_CROSS_CONFIGS" title="CMAKE_CROSS_CONFIGS"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CROSS_CONFIGS</code></a> is set to <code class="docutils literal notranslate">all</code>, and you run the
following instead:
<div class="highlight-shell notranslate"><div class="highlight"><pre>ninja -f build-Release.ninja generated:Debug
# OR
cmake --build . --config Release --target generated:Debug
</pre></div>
</div>
This would build the <code class="docutils literal notranslate">Release</code> configuration of <code class="docutils literal notranslate">generator</code>, which would be
used to generate <code class="docutils literal notranslate">generated.c</code>, which would be used to build the <code class="docutils literal notranslate">Debug</code>
configuration of <code class="docutils literal notranslate">generated</code>. This is useful for running a release-optimized
version of a generator utility while still building the debug version of the
targets built with the generated code.
<section id="custom-commands">
<h2>Custom Commands<a class="headerlink" href="#custom-commands" title="Permalink to this heading">¶</a></h2>
<div class="versionadded">
New in version 3.20.
</div>
The <code class="docutils literal notranslate">Ninja Multi-Config</code> generator adds extra capabilities to
<a class="reference internal" href="../command/add_custom_command.html#command:add_custom_command" title="add_custom_command"><code class="xref cmake cmake-command docutils literal notranslate">add_custom_command()</code></a> and <a class="reference internal" href="../command/add_custom_target.html#command:add_custom_target" title="add_custom_target"><code class="xref cmake cmake-command docutils literal notranslate">add_custom_target()</code></a> through its
cross-config mode. The <code class="docutils literal notranslate">COMMAND</code>, <code class="docutils literal notranslate">DEPENDS</code>, and <code class="docutils literal notranslate">WORKING_DIRECTORY</code>
arguments can be evaluated in the context of either the &quot;command config&quot; (the
&quot;native&quot; configuration of the <code class="docutils literal notranslate">build-&lt;Config&gt;.ninja</code> file in use) or the
&quot;output config&quot; (the configuration used to evaluate the <code class="docutils literal notranslate">OUTPUT</code> and
<code class="docutils literal notranslate">BYPRODUCTS</code>).
If either <code class="docutils literal notranslate">OUTPUT</code> or <code class="docutils literal notranslate">BYPRODUCTS</code> names a path that is common to
more than one configuration (e.g. it does not use any generator expressions),
all arguments are evaluated in the command config by default.
If all <code class="docutils literal notranslate">OUTPUT</code> and <code class="docutils literal notranslate">BYPRODUCTS</code> paths are unique to each configuration
(e.g. by using the <a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:CONFIG" title="CONFIG"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;CONFIG&gt;</code></a> generator expression), the first argument of
<code class="docutils literal notranslate">COMMAND</code> is still evaluated in the command config by default, while all
subsequent arguments, as well as the arguments to <code class="docutils literal notranslate">DEPENDS</code> and
<code class="docutils literal notranslate">WORKING_DIRECTORY</code>, are evaluated in the output config. These defaults can
be overridden with the <a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:OUTPUT_CONFIG" title="OUTPUT_CONFIG"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;OUTPUT_CONFIG:...&gt;</code></a> and <a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:COMMAND_CONFIG" title="COMMAND_CONFIG"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;COMMAND_CONFIG:...&gt;</code></a>
generator-expressions. Note that if a target is specified by its name in
<code class="docutils literal notranslate">DEPENDS</code>, or as the first argument of <code class="docutils literal notranslate">COMMAND</code>, it is always evaluated
in the command config, even if it is wrapped in <a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:OUTPUT_CONFIG" title="OUTPUT_CONFIG"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;OUTPUT_CONFIG:...&gt;</code></a>
(because its plain name is not a generator expression).
As an example, consider the following:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>add_custom_command(
 OUTPUT &quot;$&lt;CONFIG&gt;.txt&quot;
 COMMAND
 generator &quot;$&lt;CONFIG&gt;.txt&quot;
 &quot;$&lt;OUTPUT_CONFIG:$&lt;CONFIG&gt;&gt;&quot;
 &quot;$&lt;COMMAND_CONFIG:$&lt;CONFIG&gt;&gt;&quot;
 DEPENDS
 tgt1
 &quot;$&lt;TARGET_FILE:tgt2&gt;&quot;
 &quot;$&lt;OUTPUT_CONFIG:$&lt;TARGET_FILE:tgt3&gt;&gt;&quot;
 &quot;$&lt;COMMAND_CONFIG:$&lt;TARGET_FILE:tgt4&gt;&gt;&quot;
 )
</pre></div>
</div>
Assume that <code class="docutils literal notranslate">generator</code>, <code class="docutils literal notranslate">tgt1</code>, <code class="docutils literal notranslate">tgt2</code>, <code class="docutils literal notranslate">tgt3</code>, and <code class="docutils literal notranslate">tgt4</code> are all
executable targets, and assume that <code class="docutils literal notranslate">$&lt;CONFIG&gt;.txt</code> is built in the <code class="docutils literal notranslate">Debug</code>
output config using the <code class="docutils literal notranslate">Release</code> command config. The <code class="docutils literal notranslate">Release</code> build of
the <code class="docutils literal notranslate">generator</code> target is called with <code class="docutils literal notranslate">Debug.txt Debug Release</code> as
arguments. The command depends on the <code class="docutils literal notranslate">Release</code> builds of <code class="docutils literal notranslate">tgt1</code> and
<code class="docutils literal notranslate">tgt4</code>, and the <code class="docutils literal notranslate">Debug</code> builds of <code class="docutils literal notranslate">tgt2</code> and <code class="docutils literal notranslate">tgt3</code>.
<code class="docutils literal notranslate">PRE_BUILD</code>, <code class="docutils literal notranslate">PRE_LINK</code>, and <code class="docutils literal notranslate">POST_BUILD</code> custom commands for targets
only get run in their &quot;native&quot; configuration (the <code class="docutils literal notranslate">Release</code> configuration in
the <code class="docutils literal notranslate">build-Release.ninja</code> file) unless they have no <code class="docutils literal notranslate">BYPRODUCTS</code> or their
<code class="docutils literal notranslate">BYPRODUCTS</code> are unique per config. Consider the following example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>add_executable(exe main.c)
add_custom_command(
 TARGET exe
 POST_BUILD
 COMMAND
 ${CMAKE_COMMAND} -E echo &quot;Running no-byproduct command&quot;
 )
add_custom_command(
 TARGET exe
 POST_BUILD
 COMMAND
 ${CMAKE_COMMAND} -E echo
 &quot;Running separate-byproduct command for $&lt;CONFIG&gt;&quot;
 BYPRODUCTS $&lt;CONFIG&gt;.txt
 )
add_custom_command(
 TARGET exe
 POST_BUILD
 COMMAND
 ${CMAKE_COMMAND} -E echo
 &quot;Running common-byproduct command for $&lt;CONFIG&gt;&quot;
 BYPRODUCTS exe.txt
 )
</pre></div>
</div>
In this example, if you build <code class="docutils literal notranslate">exe:Debug</code> in <code class="docutils literal notranslate">build-Release.ninja</code>, the
first and second custom commands get run, since their byproducts are unique
per-config, but the last custom command does not. However, if you build
<code class="docutils literal notranslate">exe:Release</code> in <code class="docutils literal notranslate">build-Release.ninja</code>, all three custom commands get run.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Ninja Multi-Config</a><ul>
<li><a class="reference internal" href="#custom-commands">Custom Commands</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="Ninja.html"
 title="previous chapter">Ninja</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="Visual%20Studio%206.html"
 title="next chapter">Visual Studio 6</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/generator/Ninja Multi-Config.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="Visual%20Studio%206.html" title="Visual Studio 6"
 >next</a> |</li>
 <li class="right" >
 <a href="Ninja.html" title="Ninja"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-generators.7.html" >cmake-generators(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Ninja Multi-Config</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>