kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Modules/CTestUseLaunchers.cmake

68 lines
2.6 KiB
CMake
Raw Normal View History

Simplify CMake per-source license notices Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
2016-09-27 22:01:08 +03:00
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
#.rst:
# CTestUseLaunchers
# -----------------
#
# Set the RULE_LAUNCH_* global properties when CTEST_USE_LAUNCHERS is on.
#
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
# CTestUseLaunchers is automatically included when you include(CTest).
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# However, it is split out into its own module file so projects can use
# the CTEST_USE_LAUNCHERS functionality independently.
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
#
# To use launchers, set CTEST_USE_LAUNCHERS to ON in a ctest -S
# dashboard script, and then also set it in the cache of the configured
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# project. Both cmake and ctest need to know the value of it for the
# launchers to work properly. CMake needs to know in order to generate
# proper build rules, and ctest, in order to produce the proper error
# and warning analysis.
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
#
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
# For convenience, you may set the ENV variable
# CTEST_USE_LAUNCHERS_DEFAULT in your ctest -S script, too. Then, as
# long as your CMakeLists uses include(CTest) or
# include(CTestUseLaunchers), it will use the value of the ENV variable
# to initialize a CTEST_USE_LAUNCHERS cache variable. This cache
# variable initialization only occurs if CTEST_USE_LAUNCHERS is not
# already defined.
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
if(NOT DEFINED CTEST_USE_LAUNCHERS AND DEFINED ENV{CTEST_USE_LAUNCHERS_DEFAULT})
set(CTEST_USE_LAUNCHERS "$ENV{CTEST_USE_LAUNCHERS_DEFAULT}"
CACHE INTERNAL "CTEST_USE_LAUNCHERS initial value from ENV")
endif()
enable CTEST_USE_LAUNCHERS with Ninja too
2012-11-30 05:21:35 +04:00
if(NOT "${CMAKE_GENERATOR}" MATCHES "Make|Ninja")
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
set(CTEST_USE_LAUNCHERS 0)
endif()
if(CTEST_USE_LAUNCHERS)
CTest: filter /showIncludes output from ninja compile launcher Teach "ctest --launch" a new "--filter-prefix" option. Set it using the CMAKE_CL_SHOWINCLUDES_PREFIX value with the Ninja generator.
2013-12-02 02:16:06 +04:00
set(__launch_common_options
"--target-name <TARGET_NAME> --build-dir <CMAKE_CURRENT_BINARY_DIR>")
set(__launch_compile_options
"${__launch_common_options} --output <OBJECT> --source <SOURCE> --language <LANGUAGE>")
set(__launch_link_options
"${__launch_common_options} --output <TARGET> --target-type <TARGET_TYPE> --language <LANGUAGE>")
set(__launch_custom_options
"${__launch_common_options} --output <OUTPUT>")
if("${CMAKE_GENERATOR}" MATCHES "Ninja")
Use string(APPEND) in Modules Automate with: find Modules -type f -print0 | xargs -0 perl -i -0pe \ 's/set\(([a-zA-Z0-9_]+)(\s+)"\$\{\1\}([^"])/string(APPEND \1\2"\3/g'
2016-07-28 01:41:13 +03:00
string(APPEND __launch_compile_options " --filter-prefix <CMAKE_CL_SHOWINCLUDES_PREFIX>")
CTest: filter /showIncludes output from ninja compile launcher Teach "ctest --launch" a new "--filter-prefix" option. Set it using the CMAKE_CL_SHOWINCLUDES_PREFIX value with the Ninja generator.
2013-12-02 02:16:06 +04:00
endif()
set(CTEST_LAUNCH_COMPILE
"\"${CMAKE_CTEST_COMMAND}\" --launch ${__launch_compile_options} --")
set(CTEST_LAUNCH_LINK
"\"${CMAKE_CTEST_COMMAND}\" --launch ${__launch_link_options} --")
set(CTEST_LAUNCH_CUSTOM
"\"${CMAKE_CTEST_COMMAND}\" --launch ${__launch_custom_options} --")
CTest: Ensure CTEST_USE_LAUNCHERS behaves nicely in Superbuild setup When building a project relying on External projects, the launchers were not used in subprojects built without testing enabled. This was preventing errors and warnings associated with these subprojects from being reported on the dashboard. This commit allows enabling the launchers independently of the value of "BUILD_TESTING" using one of these two approaches: 1) By setting both CTEST_USE_LAUNCHERS and the env variable "CTEST_USE_LAUNCHERS_DEFAULT" to 1 in the ctest dashboard driver scripts. 2) By enabling the variable CTEST_USE_LAUNCHERS in the ctest dashboard driver script and also by ensuring every external project passes the option -DCMAKE_PROJECT_<projectname>_INCLUDE:FILEPATH=${CMAKE_ROOT}/Modules/CTestUseLaunchers.cmake
2012-10-15 22:34:01 +04:00
set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CTEST_LAUNCH_COMPILE}")
set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK "${CTEST_LAUNCH_LINK}")
set_property(GLOBAL PROPERTY RULE_LAUNCH_CUSTOM "${CTEST_LAUNCH_CUSTOM}")
endif()