echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Help: Add Builtin Targets section to Ninja help

Browse Source
This commit is contained in:
Martin Duffy 2024-05-22 16:07:35 -04:00
parent 6fa8eecfd0
commit daeb8fffa2
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Help/generator/Ninja.rst
View File

@ -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