kolan/CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'doc-CTEST_USE_LAUNCHERS-ninja'

Browse Source 
7244e845 ctest: Consolidate documentation of CTEST_USE_LAUNCHERS (#15533)
f693c136 Modules/CTest: Improve documentation formatting
5cbedd6b Modules/CTest: Use bracket comment for documentation block
This commit is contained in:
Brad King 2015-04-28 13:55:46 -04:00 committed by CMake Topic Stage
commit dd675d45fa
2 changed files with 54 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Help/manual/ctest.1.rst
View File

@ -372,6 +372,8 @@ Options
.. include:: OPTIONS_HELP.txt .. include:: OPTIONS_HELP.txt
.. _`Dashboard Client`:
Dashboard Client Dashboard Client
================ ================
@ -749,8 +751,9 @@ Configuration settings include:
initialized by the :command:`build_command` command initialized by the :command:`build_command` command
``UseLaunchers`` ``UseLaunchers``
For build trees generated by CMake using a Makefile generator For build trees generated by CMake using one of the
or the :generator:`Ninja` generator, specify whether the :ref:`Makefile Generators` or the :generator:`Ninja`
generator, specify whether the
``CTEST_USE_LAUNCHERS`` feature is enabled by the ``CTEST_USE_LAUNCHERS`` feature is enabled by the
:module:`CTestUseLaunchers` module (also included by the :module:`CTestUseLaunchers` module (also included by the
:module:`CTest` module). When enabled, the generated build :module:`CTest` module). When enabled, the generated build

114
Modules/CTest.cmake
View File

@ -1,68 +1,52 @@
#.rst: #[=======================================================================[.rst:
# CTest CTest
# ----- -----
#
# Configure a project for testing with CTest/CDash Configure a project for testing with CTest/CDash
#
# Include this module in the top CMakeLists.txt file of a project to Include this module in the top CMakeLists.txt file of a project to
# enable testing with CTest and dashboard submissions to CDash: enable testing with CTest and dashboard submissions to CDash::
#
# :: project(MyProject)
# ...
# project(MyProject) include(CTest)
# ...
# include(CTest) The module automatically creates a ``BUILD_TESTING`` option that selects
# whether to enable testing support (``ON`` by default). After including
# The module automatically creates a BUILD_TESTING option that selects the module, use code like::
# whether to enable testing support (ON by default). After including
# the module, use code like if(BUILD_TESTING)
# # ... CMake code to create tests ...
# :: endif()
#
# if(BUILD_TESTING) to creating tests when testing is enabled.
# # ... CMake code to create tests ...
# endif() To enable submissions to a CDash server, create a ``CTestConfig.cmake``
# file at the top of the project with content such as::
# to creating tests when testing is enabled.
# set(CTEST_PROJECT_NAME "MyProject")
# To enable submissions to a CDash server, create a CTestConfig.cmake set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC")
# file at the top of the project with content such as set(CTEST_DROP_METHOD "http")
# set(CTEST_DROP_SITE "my.cdash.org")
# :: set(CTEST_DROP_LOCATION "/submit.php?project=MyProject")
# set(CTEST_DROP_SITE_CDASH TRUE)
# set(CTEST_PROJECT_NAME "MyProject")
# set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") (the CDash server can provide the file to a project administrator who
# set(CTEST_DROP_METHOD "http") configures ``MyProject``). Settings in the config file are shared by
# set(CTEST_DROP_SITE "my.cdash.org") both this ``CTest`` module and the :manual:`ctest(1)` command-line
# set(CTEST_DROP_LOCATION "/submit.php?project=MyProject") :ref:`Dashboard Client` mode (``ctest -S``).
# set(CTEST_DROP_SITE_CDASH TRUE)
# While building a project for submission to CDash, CTest scans the
# (the CDash server can provide the file to a project administrator who build output for errors and warnings and reports them with surrounding
# configures 'MyProject'). Settings in the config file are shared by context from the build log. This generic approach works for all build
# both this CTest module and the CTest command-line tool's dashboard tools, but does not give details about the command invocation that
# script mode (ctest -S). produced a given problem. One may get more detailed reports by setting
# the :variable:`CTEST_USE_LAUNCHERS` variable::
# While building a project for submission to CDash, CTest scans the
# build output for errors and warnings and reports them with surrounding set(CTEST_USE_LAUNCHERS 1)
# context from the build log. This generic approach works for all build
# tools, but does not give details about the command invocation that in the ``CTestConfig.cmake`` file.
# produced a given problem. One may get more detailed reports by adding #]=======================================================================]
#
# ::
#
# set(CTEST_USE_LAUNCHERS 1)
#
# to the CTestConfig.cmake file. When this option is enabled, the CTest
# module tells CMake's Makefile generators to invoke every command in
# the generated build system through a CTest launcher program.
# (Currently the CTEST_USE_LAUNCHERS option is ignored on non-Makefile
# generators.) During a manual build each launcher transparently runs
# the command it wraps. During a CTest-driven build for submission to
# CDash each launcher reports detailed information when its command
# fails or warns. (Setting CTEST_USE_LAUNCHERS in CTestConfig.cmake is
# convenient, but also adds the launcher overhead even for manual
# builds. One may instead set it in a CTest dashboard script and add it
# to the CMake cache for the build tree.)
#============================================================================= #=============================================================================
# Copyright 2005-2009 Kitware, Inc. # Copyright 2005-2009 Kitware, Inc.