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

Help: Document install/strip targets for Ninja/UNIX Makefiles generators

Browse Source
This commit is contained in:
Cristian Adam 2019-10-04 16:40:54 +02:00
parent 65020633e6
commit 12368e6d15
2 changed files with 36 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Help/generator/Ninja.rst
View File

@ -3,9 +3,9 @@ Ninja
Generates build.ninja files. Generates build.ninja files.
A build.ninja file is generated into the build tree. Recent versions A ``build.ninja`` file is generated into the build tree. Use the ninja
of the ninja program can build the project through the ``all`` target. program to build the project through the ``all`` target and install the
An ``install`` target is also provided. project through the ``install`` (or ``install/strip``) target.
For each subdirectory ``sub/dir`` of the project, additional targets For each subdirectory ``sub/dir`` of the project, additional targets
are generated: are generated:
@ -16,6 +16,13 @@ are generated:
``sub/dir/install`` ``sub/dir/install``
Runs the install step in the subdirectory, if any. 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`` ``sub/dir/test``
Runs the test step in the subdirectory, if any. Runs the test step in the subdirectory, if any.

29
Help/generator/Unix Makefiles.rst
View File

@ -3,6 +3,29 @@ Unix Makefiles
Generates standard UNIX makefiles. Generates standard UNIX makefiles.
A hierarchy of UNIX makefiles is generated into the build tree. Any A hierarchy of UNIX makefiles is generated into the build tree. Use
standard UNIX-style make program can build the project through the any standard UNIX-style make program to build the project through
default ``all`` target. An ``install`` target is also provided. the ``all`` target and install the project through the ``install``
(or ``install/strip``) target.
For each subdirectory ``sub/dir`` of the project a UNIX makefile will
be created, containing the following targets:
``all``
Depends on all targets required by the subdirectory.
``install``
Runs the install step in the subdirectory, if any.
``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.
``test``
Runs the test step in the subdirectory, if any.
``package``
Runs the package step in the subdirectory, if any.