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
This commit is contained in:
Kitware Robot
2020-07-06 10:14:38 -04:00
committed by Brad King
parent 0c87afceab
commit 496ec6036f
744 changed files with 1488 additions and 0 deletions

View File

@@ -5,6 +5,8 @@
AndroidTestUtilities
------------------------
.. versionadded:: 3.7
Create a test that automatically loads specified data onto an Android device.
Introduction

View File

@@ -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).

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -5,6 +5,8 @@
CheckFortranCompilerFlag
------------------------
.. versionadded:: 3.3
Check whether the Fortran compiler supports a given flag.
.. command:: check_fortran_compiler_flag

View File

@@ -5,6 +5,8 @@
CheckFortranSourceCompiles
--------------------------
.. versionadded:: 3.1
Check if given Fortran source compiles and links into an executable.
.. command:: check_fortran_source_compiles

View File

@@ -5,6 +5,8 @@
CheckFortranSourceRuns
----------------------
.. versionadded:: 3.14
Check if given Fortran source compiles and links into an executable and can
subsequently be run.

View File

@@ -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.

View File

@@ -5,6 +5,8 @@
CheckLinkerFlag
---------------
.. versionadded:: 3.18
Check whether the compiler supports a given link flag.
.. command:: check_linker_flag

View File

@@ -5,6 +5,8 @@
CheckOBJCCompilerFlag
---------------------
.. versionadded:: 3.16
Check whether the Objective-C compiler supports a given flag.
.. command:: check_objc_compiler_flag

View File

@@ -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

View File

@@ -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.

View File

@@ -5,6 +5,8 @@
CheckOBJCXXCompilerFlag
-----------------------
.. versionadded:: 3.16
Check whether the Objective-C++ compiler supports a given flag.
.. command:: check_objcxx_compiler_flag

View File

@@ -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

View File

@@ -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.

View File

@@ -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

View File

@@ -5,6 +5,8 @@
FetchContent
------------------
.. versionadded:: 3.11
.. only:: html
.. contents::

View File

@@ -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.

View File

@@ -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.

View File

@@ -5,6 +5,8 @@
FindFontconfig
--------------
.. versionadded:: 3.14
Find Fontconfig headers and library.
Imported Targets

View File

@@ -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++

View File

@@ -5,6 +5,8 @@
FindICU
-------
.. versionadded:: 3.7
Find the International Components for Unicode (ICU) libraries and
programs.

View File

@@ -5,6 +5,8 @@
FindIce
-------
.. versionadded:: 3.1
Find the ZeroC Internet Communication Engine (ICE) programs,
libraries and datafiles.

View File

@@ -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.

View File

@@ -5,6 +5,8 @@
FindIntl
--------
.. versionadded:: 3.2
Find the Gettext libintl headers and libraries.
This module reports information about the Gettext libintl

View File

@@ -5,6 +5,8 @@
FindLTTngUST
------------
.. versionadded:: 3.6
Find
`Linux Trace Toolkit Next Generation (LTTng-UST) <http://lttng.org/>`__ library.

View File

@@ -5,6 +5,8 @@
FindLibinput
------------
.. versionadded:: 3.14
Find libinput headers and library.
Imported Targets

View File

@@ -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

View File

@@ -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.

View File

@@ -5,6 +5,8 @@
FindOpenCL
----------
.. versionadded:: 3.1
Finds Open Computing Language (OpenCL)
IMPORTED Targets

View File

@@ -5,6 +5,8 @@
FindPatch
---------
.. versionadded:: 3.10
The module defines the following variables:
``Patch_EXECUTABLE``

View File

@@ -5,6 +5,8 @@
FindPython
----------
.. versionadded:: 3.12
Find Python interpreter, compiler and development environment (include
directories and libraries).

View File

@@ -5,6 +5,8 @@
FindPython2
-----------
.. versionadded:: 3.12
Find Python 2 interpreter, compiler and development environment (include
directories and libraries).

View File

@@ -5,6 +5,8 @@
FindPython3
-----------
.. versionadded:: 3.12
Find Python 3 interpreter, compiler and development environment (include
directories and libraries).

View File

@@ -5,6 +5,8 @@
FindSQLite3
-----------
.. versionadded:: 3.14
Find the SQLite libraries, v3
IMPORTED targets

View File

@@ -5,6 +5,8 @@
FindVulkan
----------
.. versionadded:: 3.7
Find Vulkan, which is a low-overhead, cross-platform 3D graphics
and computing API.

View File

@@ -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

View File

@@ -5,6 +5,8 @@
FindXalanC
-----------
.. versionadded:: 3.5
Find the Apache Xalan-C++ XSL transform processor headers and libraries.
Imported targets

View File

@@ -5,6 +5,8 @@
FindXercesC
-----------
.. versionadded:: 3.1
Find the Apache Xerces-C++ validating XML parser headers and libraries.
Imported targets

View File

@@ -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)``.

View File

@@ -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