diff options
| author | Cristian Adam <cristian.adam@gmail.com> | 2019-10-04 16:40:54 +0200 |
|---|---|---|
| committer | Cristian Adam <cristian.adam@gmail.com> | 2019-10-04 17:00:18 +0200 |
| commit | 12368e6d15c4fd7a682aad8127fb4168971d0013 (patch) | |
| tree | 1a59314a1ac16ba335d2b268bb4ff008c05ec78a | |
| parent | 65020633e62eaf0d86f85bcf1240caacd2095de9 (diff) | |
| download | cmake-12368e6d15c4fd7a682aad8127fb4168971d0013.tar.gz | |
Help: Document install/strip targets for Ninja/UNIX Makefiles generators
| -rw-r--r-- | Help/generator/Ninja.rst | 13 | ||||
| -rw-r--r-- | Help/generator/Unix Makefiles.rst | 29 |
2 files changed, 36 insertions, 6 deletions
diff --git a/Help/generator/Ninja.rst b/Help/generator/Ninja.rst index 51ef49b014..c75d2c4cf3 100644 --- a/Help/generator/Ninja.rst +++ b/Help/generator/Ninja.rst @@ -3,9 +3,9 @@ Ninja Generates build.ninja files. -A build.ninja file is generated into the build tree. Recent versions -of the ninja program can build the project through the ``all`` target. -An ``install`` target is also provided. +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: @@ -16,6 +16,13 @@ are generated: ``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. diff --git a/Help/generator/Unix Makefiles.rst b/Help/generator/Unix Makefiles.rst index 1e65ee133b..dfe4ecbd9e 100644 --- a/Help/generator/Unix Makefiles.rst +++ b/Help/generator/Unix Makefiles.rst @@ -3,6 +3,29 @@ Unix Makefiles Generates standard UNIX makefiles. -A hierarchy of UNIX makefiles is generated into the build tree. Any -standard UNIX-style make program can build the project through the -default ``all`` target. An ``install`` target is also provided. +A hierarchy of UNIX makefiles is generated into the build tree. Use +any standard UNIX-style make 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 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. |