diff options
author | Martin Duffy <martin.duffy@kitware.com> | 2024-05-22 20:07:35 (GMT) |
---|---|---|
committer | Martin Duffy <martin.duffy@kitware.com> | 2024-05-22 20:07:35 (GMT) |
commit | daeb8fffa2d30cf6737c60f22c151d10581783ac (patch) | |
tree | 2ae6c8e2295d50aeb2e5a288c0c63228b8b8dbed | |
parent | 6fa8eecfd04dee3b5ee11695cd08826841a7e09d (diff) | |
download | CMake-daeb8fffa2d30cf6737c60f22c151d10581783ac.zip CMake-daeb8fffa2d30cf6737c60f22c151d10581783ac.tar.gz CMake-daeb8fffa2d30cf6737c60f22c151d10581783ac.tar.bz2 |
Help: Add Builtin Targets section to Ninja help
-rw-r--r-- | Help/generator/Ninja.rst | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/Help/generator/Ninja.rst b/Help/generator/Ninja.rst index f3ba222..0b4ec57 100644 --- a/Help/generator/Ninja.rst +++ b/Help/generator/Ninja.rst @@ -1,11 +1,28 @@ Ninja ----- -Generates ``build.ninja`` files. +Generates a ``build.ninja`` file into the build tree. -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. +Builtin Targets +^^^^^^^^^^^^^^^ + +``all`` + + Depends on all targets required by the project, except those with + :prop_tgt:`EXCLUDE_FROM_ALL` set to true. + +``install`` + + Runs the install step. + +``install/strip`` + + .. versionadded:: 3.7 + + Runs the install 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. For each subdirectory ``sub/dir`` of the project, additional targets are generated: @@ -25,12 +42,10 @@ are generated: ``sub/dir/install/strip`` .. versionadded:: 3.7 + 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`` .. versionadded:: 3.7 |