mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-11 16:32:14 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Clarify variables specifying scripts to execute during packaging

Browse Source 
Relates: #19077
This commit is contained in:
Craig Scott
2020-11-02 14:49:43 +11:00
parent 013c4133f7
commit b77dfa441f
1 changed files with 28 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
Modules/CPack.cmake
View File

@@ -357,7 +357,7 @@ The following variables are for advanced uses of CPack:
.. variable:: CPACK_INSTALL_SCRIPTS
Extra CMake scripts executed by CPack during its local staging
installation, which is done right before packaging the files.
installation. They are executed before installing the files to be packaged.
The scripts are not called by a standalone install (e.g.: ``make install``).
For every script, the following variables will be set:
:variable:`CMAKE_CURRENT_SOURCE_DIR`, :variable:`CMAKE_CURRENT_BINARY_DIR`
@@ -366,6 +366,33 @@ The following variables are for advanced uses of CPack:
an alternative variable for historical reasons, but its value is ignored if
``CMAKE_INSTALL_SCRIPTS`` is set and a warning will be issued.
See also :variable:`CPACK_PRE_BUILD_SCRIPTS` and
:variable:`CPACK_POST_BUILD_SCRIPTS` which can be used to specify scripts
to be executed later in the packaging process.
.. variable:: CPACK_PRE_BUILD_SCRIPTS
List of CMake scripts to execute after CPack has installed the files to
be packaged into a staging directory and before producing the package(s)
from those files. See also :variable:`CPACK_INSTALL_SCRIPTS` and
:variable:`CPACK_POST_BUILD_SCRIPTS`.
.. variable:: CPACK_POST_BUILD_SCRIPTS
List of CMake scripts to execute after CPack has produced the resultant
packages and before copying them back to the build directory.
See also :variable:`CPACK_INSTALL_SCRIPTS`,
:variable:`CPACK_PRE_BUILD_SCRIPTS` and :variable:`CPACK_PACKAGE_FILES`.
.. variable:: CPACK_PACKAGE_FILES
List of package files created in the staging directory, with each file
provided as a full absolute path. This variable is populated by CPack
just before invoking the post-build scripts listed in
:variable:`CPACK_POST_BUILD_SCRIPTS`. It is the preferred way for the
post-build scripts to know the set of package files to operate on.
Projects should not try to set this variable themselves.
.. variable:: CPACK_INSTALLED_DIRECTORIES
Extra directories to install.
@@ -390,21 +417,6 @@ The following variables are for advanced uses of CPack:
select the CPack generator(s) to be used when building the ``package``
target or when running :manual:`cpack <cpack(1)>` without the ``-G`` option.
.. variable:: CPACK_PRE_BUILD_SCRIPTS
List of CMake scripts to execute after CPack has installed the files to
be packed into a staging directory and before producing the result
packages.
.. variable:: CPACK_POST_BUILD_SCRIPTS
List of CMake scripts to execute after CPack has produced the result
packages and before copying them back to a build directory.
.. variable:: CPACK_PACKAGE_FILES
List of resulting package files passed to the ``CPACK_POST_BUILD_SCRIPTS``.
#]=======================================================================]
# Define this var in order to avoid (or warn) concerning multiple inclusion