summaryrefslogtreecommitdiff
path: root/share/cmake-3.18/Help/generator/Ninja.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.18/Help/generator/Ninja.rst')
-rw-r--r--share/cmake-3.18/Help/generator/Ninja.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/share/cmake-3.18/Help/generator/Ninja.rst b/share/cmake-3.18/Help/generator/Ninja.rst
new file mode 100644
index 0000000..08ee81b
--- /dev/null
+++ b/share/cmake-3.18/Help/generator/Ninja.rst
@@ -0,0 +1,42 @@
+Ninja
+-----
+
+Generates ``build.ninja`` files.
+
+A ``build.ninja`` file is generated into the build tree. Use the ninja
+program to build the project through the ``all`` target and install the
+project through the ``install`` (or ``install/strip``) target.
+
+For each subdirectory ``sub/dir`` of the project, additional targets
+are generated:
+
+``sub/dir/all``
+ Depends on all targets required by the subdirectory.
+
+``sub/dir/install``
+ Runs the install step in the subdirectory, if any.
+
+``sub/dir/install/strip``
+ Runs the install step in the subdirectory followed by a ``CMAKE_STRIP`` command,
+ if any.
+
+ The ``CMAKE_STRIP`` variable will contain the platform's ``strip`` utility, which
+ removes symbols information from generated binaries.
+
+``sub/dir/test``
+ Runs the test step in the subdirectory, if any.
+
+``sub/dir/package``
+ Runs the package step in the subdirectory, if any.
+
+Fortran Support
+^^^^^^^^^^^^^^^
+
+The ``Ninja`` generator conditionally supports Fortran when the ``ninja``
+tool is at least version 1.10 (which has the required features).
+
+See Also
+^^^^^^^^
+
+The :generator:`Ninja Multi-Config` generator is similar to the ``Ninja``
+generator, but generates multiple configurations at once.