diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-17 11:02:00 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2021-04-23 17:49:14 +0000 |
| commit | 5512e03562694ebfe571a3b6068a7d35d9ddfd7a (patch) | |
| tree | 3caca041d3526c8427ec3065642b41a52ad8578c /modules/ECMMarkAsTest.cmake | |
| parent | 38b5d046c4d42232d45bf4464167b2e6feea4cf7 (diff) | |
| download | extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.gz extra-cmake-modules-5512e03562694ebfe571a3b6068a7d35d9ddfd7a.tar.bz2 | |
Modules docs: move rst docs into bracket comments
CMake >= 3.0 supports bracket comments, and the reStructuredText
integration code in sphinx/ext/ecm.py already supports extracting
the docs from a bracket comment instead.
Editing documentation without leading line comment markers is more simple,
e,g. when reflowing text over lines.
With ECM meanwhile requiring CMake 3.5 now it is possible to switch
(and thus follow also the approach used by cmake itself).
NO_CHANGELOG
Diffstat (limited to 'modules/ECMMarkAsTest.cmake')
| -rw-r--r-- | modules/ECMMarkAsTest.cmake | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/modules/ECMMarkAsTest.cmake b/modules/ECMMarkAsTest.cmake index d30dd1b1..8ac5e8ba 100644 --- a/modules/ECMMarkAsTest.cmake +++ b/modules/ECMMarkAsTest.cmake @@ -1,27 +1,27 @@ -#.rst: -# ECMMarkAsTest -# ------------- -# -# Marks a target as only being required for tests. -# -# :: -# -# ecm_mark_as_test(<target1> [<target2> [...]]) -# -# This will cause the specified targets to not be built unless either -# BUILD_TESTING is set to ON or the user invokes the ``buildtests`` target. -# -# BUILD_TESTING is created as a cache variable by the CTest module and by the -# :kde-module:`KDECMakeSettings` module. -# -# Since pre-1.0.0. - -#============================================================================= # SPDX-FileCopyrightText: 2012 Stephen Kelly <steveire@gmail.com> # SPDX-FileCopyrightText: 2012 Alex Neundorf <neundorf@kde.org> # # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +ECMMarkAsTest +------------- + +Marks a target as only being required for tests. + +:: + + ecm_mark_as_test(<target1> [<target2> [...]]) + +This will cause the specified targets to not be built unless either +BUILD_TESTING is set to ON or the user invokes the ``buildtests`` target. + +BUILD_TESTING is created as a cache variable by the CTest module and by the +:kde-module:`KDECMakeSettings` module. + +Since pre-1.0.0. +#]=======================================================================] + if (NOT BUILD_TESTING) if(NOT TARGET buildtests) add_custom_target(buildtests) |