summaryrefslogtreecommitdiff
path: root/Modules
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2020-07-06 10:14:38 -0400
committerBrad King <brad.king@kitware.com>2020-07-06 10:23:20 -0400
commit496ec6036fb2b4ebbae000ee362cdfb7704d08de (patch)
treebe76911aac9636943abd9abde6f756fd1c7d8cd4 /Modules
parent0c87afceab51e59537026b9fc39ed3b290e3e54d (diff)
downloadcmake-496ec6036fb2b4ebbae000ee362cdfb7704d08de.tar.gz
Help: Add Sphinx 'versionadded' directives to each top-level document
Run the `Utilities/Sphinx/update_versions.py` script to add initial markup to every top-level document and find module. Issue: #19715
Diffstat (limited to 'Modules')
-rw-r--r--Modules/AndroidTestUtilities.cmake2
-rw-r--r--Modules/CPackIFW.cmake2
-rw-r--r--Modules/CPackIFWConfigureFile.cmake2
-rw-r--r--Modules/CSharpUtilities.cmake2
-rw-r--r--Modules/CTestCoverageCollectGCOV.cmake2
-rw-r--r--Modules/CheckFortranCompilerFlag.cmake2
-rw-r--r--Modules/CheckFortranSourceCompiles.cmake2
-rw-r--r--Modules/CheckFortranSourceRuns.cmake2
-rw-r--r--Modules/CheckIPOSupported.cmake2
-rw-r--r--Modules/CheckLinkerFlag.cmake2
-rw-r--r--Modules/CheckOBJCCompilerFlag.cmake2
-rw-r--r--Modules/CheckOBJCSourceCompiles.cmake2
-rw-r--r--Modules/CheckOBJCSourceRuns.cmake2
-rw-r--r--Modules/CheckOBJCXXCompilerFlag.cmake2
-rw-r--r--Modules/CheckOBJCXXSourceCompiles.cmake2
-rw-r--r--Modules/CheckOBJCXXSourceRuns.cmake2
-rw-r--r--Modules/CheckPIESupported.cmake2
-rw-r--r--Modules/FetchContent.cmake2
-rw-r--r--Modules/FindCUDAToolkit.cmake2
-rw-r--r--Modules/FindEnvModules.cmake2
-rw-r--r--Modules/FindFontconfig.cmake2
-rw-r--r--Modules/FindGSL.cmake2
-rw-r--r--Modules/FindICU.cmake2
-rw-r--r--Modules/FindIce.cmake2
-rw-r--r--Modules/FindIconv.cmake2
-rw-r--r--Modules/FindIntl.cmake2
-rw-r--r--Modules/FindLTTngUST.cmake2
-rw-r--r--Modules/FindLibinput.cmake2
-rw-r--r--Modules/FindODBC.cmake2
-rw-r--r--Modules/FindOpenACC.cmake2
-rw-r--r--Modules/FindOpenCL.cmake2
-rw-r--r--Modules/FindPatch.cmake2
-rw-r--r--Modules/FindPython.cmake2
-rw-r--r--Modules/FindPython2.cmake2
-rw-r--r--Modules/FindPython3.cmake2
-rw-r--r--Modules/FindSQLite3.cmake2
-rw-r--r--Modules/FindVulkan.cmake2
-rw-r--r--Modules/FindXCTest.cmake2
-rw-r--r--Modules/FindXalanC.cmake2
-rw-r--r--Modules/FindXercesC.cmake2
-rw-r--r--Modules/GoogleTest.cmake2
-rw-r--r--Modules/WriteCompilerDetectionHeader.cmake2
42 files changed, 84 insertions, 0 deletions
diff --git a/Modules/AndroidTestUtilities.cmake b/Modules/AndroidTestUtilities.cmake
index 95e2ef7e94..ddccf586bb 100644
--- a/Modules/AndroidTestUtilities.cmake
+++ b/Modules/AndroidTestUtilities.cmake
@@ -5,6 +5,8 @@
AndroidTestUtilities
------------------------
+.. versionadded:: 3.7
+
Create a test that automatically loads specified data onto an Android device.
Introduction
diff --git a/Modules/CPackIFW.cmake b/Modules/CPackIFW.cmake
index 80a907ffd2..58e6a375f4 100644
--- a/Modules/CPackIFW.cmake
+++ b/Modules/CPackIFW.cmake
@@ -5,6 +5,8 @@
CPackIFW
--------
+.. versionadded:: 3.1
+
This module looks for the location of the command-line utilities supplied with the
`Qt Installer Framework <http://doc.qt.io/qtinstallerframework/index.html>`_
(QtIFW).
diff --git a/Modules/CPackIFWConfigureFile.cmake b/Modules/CPackIFWConfigureFile.cmake
index 0abe0da371..296b13f725 100644
--- a/Modules/CPackIFWConfigureFile.cmake
+++ b/Modules/CPackIFWConfigureFile.cmake
@@ -5,6 +5,8 @@
CPackIFWConfigureFile
---------------------
+.. versionadded:: 3.8
+
The module defines :command:`configure_file` similar command to
configure file templates prepared in QtIFW/SDK/Creator style.
diff --git a/Modules/CSharpUtilities.cmake b/Modules/CSharpUtilities.cmake
index 6a4b5c7f7b..dedb146ac1 100644
--- a/Modules/CSharpUtilities.cmake
+++ b/Modules/CSharpUtilities.cmake
@@ -5,6 +5,8 @@
CSharpUtilities
---------------
+.. versionadded:: 3.8
+
Functions to make configuration of CSharp/.NET targets easier.
A collection of CMake utility functions useful for dealing with CSharp
diff --git a/Modules/CTestCoverageCollectGCOV.cmake b/Modules/CTestCoverageCollectGCOV.cmake
index b1268bebf2..a01a2fea22 100644
--- a/Modules/CTestCoverageCollectGCOV.cmake
+++ b/Modules/CTestCoverageCollectGCOV.cmake
@@ -5,6 +5,8 @@
CTestCoverageCollectGCOV
------------------------
+.. versionadded:: 3.2
+
This module provides the ``ctest_coverage_collect_gcov`` function.
This function runs gcov on all .gcda files found in the binary tree
diff --git a/Modules/CheckFortranCompilerFlag.cmake b/Modules/CheckFortranCompilerFlag.cmake
index 299cd8cfc8..b8fac97cc5 100644
--- a/Modules/CheckFortranCompilerFlag.cmake
+++ b/Modules/CheckFortranCompilerFlag.cmake
@@ -5,6 +5,8 @@
CheckFortranCompilerFlag
------------------------
+.. versionadded:: 3.3
+
Check whether the Fortran compiler supports a given flag.
.. command:: check_fortran_compiler_flag
diff --git a/Modules/CheckFortranSourceCompiles.cmake b/Modules/CheckFortranSourceCompiles.cmake
index 3354bfb25f..d776b0c13b 100644
--- a/Modules/CheckFortranSourceCompiles.cmake
+++ b/Modules/CheckFortranSourceCompiles.cmake
@@ -5,6 +5,8 @@
CheckFortranSourceCompiles
--------------------------
+.. versionadded:: 3.1
+
Check if given Fortran source compiles and links into an executable.
.. command:: check_fortran_source_compiles
diff --git a/Modules/CheckFortranSourceRuns.cmake b/Modules/CheckFortranSourceRuns.cmake
index f858b84a81..a710352325 100644
--- a/Modules/CheckFortranSourceRuns.cmake
+++ b/Modules/CheckFortranSourceRuns.cmake
@@ -5,6 +5,8 @@
CheckFortranSourceRuns
----------------------
+.. versionadded:: 3.14
+
Check if given Fortran source compiles and links into an executable and can
subsequently be run.
diff --git a/Modules/CheckIPOSupported.cmake b/Modules/CheckIPOSupported.cmake
index 90a9f61804..1dd951d83c 100644
--- a/Modules/CheckIPOSupported.cmake
+++ b/Modules/CheckIPOSupported.cmake
@@ -5,6 +5,8 @@
CheckIPOSupported
-----------------
+.. versionadded:: 3.9
+
Check whether the compiler supports an interprocedural optimization (IPO/LTO).
Use this before enabling the :prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` target
property.
diff --git a/Modules/CheckLinkerFlag.cmake b/Modules/CheckLinkerFlag.cmake
index beda5fe3c3..cd7301f941 100644
--- a/Modules/CheckLinkerFlag.cmake
+++ b/Modules/CheckLinkerFlag.cmake
@@ -5,6 +5,8 @@
CheckLinkerFlag
---------------
+.. versionadded:: 3.18
+
Check whether the compiler supports a given link flag.
.. command:: check_linker_flag
diff --git a/Modules/CheckOBJCCompilerFlag.cmake b/Modules/CheckOBJCCompilerFlag.cmake
index 1d975da882..a98f4293c9 100644
--- a/Modules/CheckOBJCCompilerFlag.cmake
+++ b/Modules/CheckOBJCCompilerFlag.cmake
@@ -5,6 +5,8 @@
CheckOBJCCompilerFlag
---------------------
+.. versionadded:: 3.16
+
Check whether the Objective-C compiler supports a given flag.
.. command:: check_objc_compiler_flag
diff --git a/Modules/CheckOBJCSourceCompiles.cmake b/Modules/CheckOBJCSourceCompiles.cmake
index 601f1fa443..502ed74725 100644
--- a/Modules/CheckOBJCSourceCompiles.cmake
+++ b/Modules/CheckOBJCSourceCompiles.cmake
@@ -5,6 +5,8 @@
CheckOBJCSourceCompiles
-----------------------
+.. versionadded:: 3.16
+
Check if given Objective-C source compiles and links into an executable.
.. command:: check_objc_source_compiles
diff --git a/Modules/CheckOBJCSourceRuns.cmake b/Modules/CheckOBJCSourceRuns.cmake
index 6684693916..9d4fb1bacc 100644
--- a/Modules/CheckOBJCSourceRuns.cmake
+++ b/Modules/CheckOBJCSourceRuns.cmake
@@ -5,6 +5,8 @@
CheckOBJCSourceRuns
-------------------
+.. versionadded:: 3.16
+
Check if given Objective-C source compiles and links into an executable and can
subsequently be run.
diff --git a/Modules/CheckOBJCXXCompilerFlag.cmake b/Modules/CheckOBJCXXCompilerFlag.cmake
index c32741b54a..7944ab07a0 100644
--- a/Modules/CheckOBJCXXCompilerFlag.cmake
+++ b/Modules/CheckOBJCXXCompilerFlag.cmake
@@ -5,6 +5,8 @@
CheckOBJCXXCompilerFlag
-----------------------
+.. versionadded:: 3.16
+
Check whether the Objective-C++ compiler supports a given flag.
.. command:: check_objcxx_compiler_flag
diff --git a/Modules/CheckOBJCXXSourceCompiles.cmake b/Modules/CheckOBJCXXSourceCompiles.cmake
index 2ee79f48a7..7b839e4cbf 100644
--- a/Modules/CheckOBJCXXSourceCompiles.cmake
+++ b/Modules/CheckOBJCXXSourceCompiles.cmake
@@ -5,6 +5,8 @@
CheckOBJCXXSourceCompiles
-------------------------
+.. versionadded:: 3.16
+
Check if given Objective-C++ source compiles and links into an executable.
.. command:: check_objcxx_source_compiles
diff --git a/Modules/CheckOBJCXXSourceRuns.cmake b/Modules/CheckOBJCXXSourceRuns.cmake
index 7f7e04f77e..c32759899e 100644
--- a/Modules/CheckOBJCXXSourceRuns.cmake
+++ b/Modules/CheckOBJCXXSourceRuns.cmake
@@ -5,6 +5,8 @@
CheckOBJCXXSourceRuns
---------------------
+.. versionadded:: 3.16
+
Check if given Objective-C++ source compiles and links into an executable and can
subsequently be run.
diff --git a/Modules/CheckPIESupported.cmake b/Modules/CheckPIESupported.cmake
index 6d63f0bada..a99d8c41f1 100644
--- a/Modules/CheckPIESupported.cmake
+++ b/Modules/CheckPIESupported.cmake
@@ -5,6 +5,8 @@
CheckPIESupported
-----------------
+.. versionadded:: 3.14
+
Check whether the linker supports Position Independent Code (PIE) or No
Position Independent Code (NO_PIE) for executables.
Use this to ensure that the :prop_tgt:`POSITION_INDEPENDENT_CODE` target
diff --git a/Modules/FetchContent.cmake b/Modules/FetchContent.cmake
index e05ca96921..c85e2d8370 100644
--- a/Modules/FetchContent.cmake
+++ b/Modules/FetchContent.cmake
@@ -5,6 +5,8 @@
FetchContent
------------------
+.. versionadded:: 3.11
+
.. only:: html
.. contents::
diff --git a/Modules/FindCUDAToolkit.cmake b/Modules/FindCUDAToolkit.cmake
index 47bc5466c0..4e52e0358c 100644
--- a/Modules/FindCUDAToolkit.cmake
+++ b/Modules/FindCUDAToolkit.cmake
@@ -5,6 +5,8 @@
FindCUDAToolkit
---------------
+.. versionadded:: 3.17
+
This script locates the NVIDIA CUDA toolkit and the associated libraries, but
does not require the ``CUDA`` language be enabled for a given project. This
module does not search for the NVIDIA CUDA Samples.
diff --git a/Modules/FindEnvModules.cmake b/Modules/FindEnvModules.cmake
index 4dd5116cd7..a4ac0b47f3 100644
--- a/Modules/FindEnvModules.cmake
+++ b/Modules/FindEnvModules.cmake
@@ -5,6 +5,8 @@
FindEnvModules
--------------
+.. versionadded:: 3.15
+
Locate an environment module implementation and make commands available to
CMake scripts to use them. This is compatible with both Lua-based Lmod
and TCL-based EnvironmentModules.
diff --git a/Modules/FindFontconfig.cmake b/Modules/FindFontconfig.cmake
index a6f0180b37..5228831374 100644
--- a/Modules/FindFontconfig.cmake
+++ b/Modules/FindFontconfig.cmake
@@ -5,6 +5,8 @@
FindFontconfig
--------------
+.. versionadded:: 3.14
+
Find Fontconfig headers and library.
Imported Targets
diff --git a/Modules/FindGSL.cmake b/Modules/FindGSL.cmake
index da1b3c4e4d..3d4e7f939f 100644
--- a/Modules/FindGSL.cmake
+++ b/Modules/FindGSL.cmake
@@ -5,6 +5,8 @@
FindGSL
--------
+.. versionadded:: 3.2
+
Find the native GNU Scientific Library (GSL) includes and libraries.
The GNU Scientific Library (GSL) is a numerical library for C and C++
diff --git a/Modules/FindICU.cmake b/Modules/FindICU.cmake
index 38081f5fa2..c8b3e1fb75 100644
--- a/Modules/FindICU.cmake
+++ b/Modules/FindICU.cmake
@@ -5,6 +5,8 @@
FindICU
-------
+.. versionadded:: 3.7
+
Find the International Components for Unicode (ICU) libraries and
programs.
diff --git a/Modules/FindIce.cmake b/Modules/FindIce.cmake
index 5ce2b42d9f..0f821e886f 100644
--- a/Modules/FindIce.cmake
+++ b/Modules/FindIce.cmake
@@ -5,6 +5,8 @@
FindIce
-------
+.. versionadded:: 3.1
+
Find the ZeroC Internet Communication Engine (ICE) programs,
libraries and datafiles.
diff --git a/Modules/FindIconv.cmake b/Modules/FindIconv.cmake
index bf20f6f7ea..3926a4bcb8 100644
--- a/Modules/FindIconv.cmake
+++ b/Modules/FindIconv.cmake
@@ -5,6 +5,8 @@
FindIconv
---------
+.. versionadded:: 3.11
+
This module finds the ``iconv()`` POSIX.1 functions on the system.
These functions might be provided in the regular C library or externally
in the form of an additional library.
diff --git a/Modules/FindIntl.cmake b/Modules/FindIntl.cmake
index 3818d45ec9..4062a98145 100644
--- a/Modules/FindIntl.cmake
+++ b/Modules/FindIntl.cmake
@@ -5,6 +5,8 @@
FindIntl
--------
+.. versionadded:: 3.2
+
Find the Gettext libintl headers and libraries.
This module reports information about the Gettext libintl
diff --git a/Modules/FindLTTngUST.cmake b/Modules/FindLTTngUST.cmake
index 9cd17eb05c..f478e4d240 100644
--- a/Modules/FindLTTngUST.cmake
+++ b/Modules/FindLTTngUST.cmake
@@ -5,6 +5,8 @@
FindLTTngUST
------------
+.. versionadded:: 3.6
+
Find
`Linux Trace Toolkit Next Generation (LTTng-UST) <http://lttng.org/>`__ library.
diff --git a/Modules/FindLibinput.cmake b/Modules/FindLibinput.cmake
index c1fe45562e..88d5b2fb3a 100644
--- a/Modules/FindLibinput.cmake
+++ b/Modules/FindLibinput.cmake
@@ -5,6 +5,8 @@
FindLibinput
------------
+.. versionadded:: 3.14
+
Find libinput headers and library.
Imported Targets
diff --git a/Modules/FindODBC.cmake b/Modules/FindODBC.cmake
index 3f710dbb95..884653c752 100644
--- a/Modules/FindODBC.cmake
+++ b/Modules/FindODBC.cmake
@@ -5,6 +5,8 @@
FindODBC
--------
+.. versionadded:: 3.12
+
Find an Open Database Connectivity (ODBC) include directory and library.
On Windows, when building with Visual Studio, this module assumes the ODBC
diff --git a/Modules/FindOpenACC.cmake b/Modules/FindOpenACC.cmake
index 398dcf54f3..ed52e3591f 100644
--- a/Modules/FindOpenACC.cmake
+++ b/Modules/FindOpenACC.cmake
@@ -5,6 +5,8 @@
FindOpenACC
-----------
+.. versionadded:: 3.10
+
Detect OpenACC support by the compiler.
This module can be used to detect OpenACC support in a compiler.
diff --git a/Modules/FindOpenCL.cmake b/Modules/FindOpenCL.cmake
index 34a203e137..b3e5a9f8de 100644
--- a/Modules/FindOpenCL.cmake
+++ b/Modules/FindOpenCL.cmake
@@ -5,6 +5,8 @@
FindOpenCL
----------
+.. versionadded:: 3.1
+
Finds Open Computing Language (OpenCL)
IMPORTED Targets
diff --git a/Modules/FindPatch.cmake b/Modules/FindPatch.cmake
index 49988395bc..41086517d9 100644
--- a/Modules/FindPatch.cmake
+++ b/Modules/FindPatch.cmake
@@ -5,6 +5,8 @@
FindPatch
---------
+.. versionadded:: 3.10
+
The module defines the following variables:
``Patch_EXECUTABLE``
diff --git a/Modules/FindPython.cmake b/Modules/FindPython.cmake
index 01b82c4b21..f503ccaa24 100644
--- a/Modules/FindPython.cmake
+++ b/Modules/FindPython.cmake
@@ -5,6 +5,8 @@
FindPython
----------
+.. versionadded:: 3.12
+
Find Python interpreter, compiler and development environment (include
directories and libraries).
diff --git a/Modules/FindPython2.cmake b/Modules/FindPython2.cmake
index 84c0c73b60..42d87c8510 100644
--- a/Modules/FindPython2.cmake
+++ b/Modules/FindPython2.cmake
@@ -5,6 +5,8 @@
FindPython2
-----------
+.. versionadded:: 3.12
+
Find Python 2 interpreter, compiler and development environment (include
directories and libraries).
diff --git a/Modules/FindPython3.cmake b/Modules/FindPython3.cmake
index f142c07ee6..b58ee30c9e 100644
--- a/Modules/FindPython3.cmake
+++ b/Modules/FindPython3.cmake
@@ -5,6 +5,8 @@
FindPython3
-----------
+.. versionadded:: 3.12
+
Find Python 3 interpreter, compiler and development environment (include
directories and libraries).
diff --git a/Modules/FindSQLite3.cmake b/Modules/FindSQLite3.cmake
index 374d7af6c2..88c7dd2098 100644
--- a/Modules/FindSQLite3.cmake
+++ b/Modules/FindSQLite3.cmake
@@ -5,6 +5,8 @@
FindSQLite3
-----------
+.. versionadded:: 3.14
+
Find the SQLite libraries, v3
IMPORTED targets
diff --git a/Modules/FindVulkan.cmake b/Modules/FindVulkan.cmake
index 89510b74fa..0ec60133ce 100644
--- a/Modules/FindVulkan.cmake
+++ b/Modules/FindVulkan.cmake
@@ -5,6 +5,8 @@
FindVulkan
----------
+.. versionadded:: 3.7
+
Find Vulkan, which is a low-overhead, cross-platform 3D graphics
and computing API.
diff --git a/Modules/FindXCTest.cmake b/Modules/FindXCTest.cmake
index 15721e1849..1f6e825138 100644
--- a/Modules/FindXCTest.cmake
+++ b/Modules/FindXCTest.cmake
@@ -5,6 +5,8 @@
FindXCTest
----------
+.. versionadded:: 3.3
+
Functions to help creating and executing XCTest bundles.
An XCTest bundle is a CFBundle with a special product-type
diff --git a/Modules/FindXalanC.cmake b/Modules/FindXalanC.cmake
index 3adaa44d33..ca9195cc14 100644
--- a/Modules/FindXalanC.cmake
+++ b/Modules/FindXalanC.cmake
@@ -5,6 +5,8 @@
FindXalanC
-----------
+.. versionadded:: 3.5
+
Find the Apache Xalan-C++ XSL transform processor headers and libraries.
Imported targets
diff --git a/Modules/FindXercesC.cmake b/Modules/FindXercesC.cmake
index db78b61bdf..abe18c0570 100644
--- a/Modules/FindXercesC.cmake
+++ b/Modules/FindXercesC.cmake
@@ -5,6 +5,8 @@
FindXercesC
-----------
+.. versionadded:: 3.1
+
Find the Apache Xerces-C++ validating XML parser headers and libraries.
Imported targets
diff --git a/Modules/GoogleTest.cmake b/Modules/GoogleTest.cmake
index b210a77153..2ef73821cd 100644
--- a/Modules/GoogleTest.cmake
+++ b/Modules/GoogleTest.cmake
@@ -5,6 +5,8 @@
GoogleTest
----------
+.. versionadded:: 3.9
+
This module defines functions to help use the Google Test infrastructure. Two
mechanisms for adding tests are provided. :command:`gtest_add_tests` has been
around for some time, originally via ``find_package(GTest)``.
diff --git a/Modules/WriteCompilerDetectionHeader.cmake b/Modules/WriteCompilerDetectionHeader.cmake
index 23d81b5fcd..5100035b39 100644
--- a/Modules/WriteCompilerDetectionHeader.cmake
+++ b/Modules/WriteCompilerDetectionHeader.cmake
@@ -5,6 +5,8 @@
WriteCompilerDetectionHeader
----------------------------
+.. versionadded:: 3.1
+
This module provides the function ``write_compiler_detection_header()``.
This function can be used to generate a file suitable for preprocessor