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

@ -1,6 +1,8 @@
add_compile_definitions
-----------------------
.. versionadded:: 3.12
Add preprocessor definitions to the compilation of source files.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
add_link_options
----------------
.. versionadded:: 3.13
Add options to the link step for executable, shared library or module
library targets in the current directory and below that are added after
this command is invoked.

View File

@ -1,6 +1,8 @@
cmake_language
--------------
.. versionadded:: 3.18
Call meta-operations on CMake commands.
Synopsis

View File

@ -1,6 +1,8 @@
cmake_parse_arguments
---------------------
.. versionadded:: 3.5
Parse function or macro arguments.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
continue
--------
.. versionadded:: 3.2
Continue to the top of enclosing foreach or while loop.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
include_guard
-------------
.. versionadded:: 3.10
Provides an include guard for the file currently being processed by CMake.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
target_compile_features
-----------------------
.. versionadded:: 3.1
Add expected compiler features to a target.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
target_link_directories
-----------------------
.. versionadded:: 3.13
Add link directories to a target.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
target_link_options
-------------------
.. versionadded:: 3.13
Add options to the link step for an executable, shared library or module
library target.

View File

@ -1,6 +1,8 @@
target_precompile_headers
-------------------------
.. versionadded:: 3.16
Add a list of header files to precompile.
Precompiling header files can speed up compilation by creating a partially

View File

@ -1,6 +1,8 @@
target_sources
--------------
.. versionadded:: 3.1
Add sources to a target.
.. code-block:: cmake

View File

@ -1,6 +1,8 @@
ASM<DIALECT>
------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling a specific dialect of assembly language

View File

@ -1,6 +1,8 @@
ASM<DIALECT>FLAGS
-----------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling a specific dialect of an

View File

@ -1,6 +1,8 @@
CC
--
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``C`` language files. Will only be used by

View File

@ -1,6 +1,8 @@
CCMAKE_COLORS
-------------
.. versionadded:: 3.18
Determines what colors are used by the CMake curses interface,
when run on a terminal that supports colors.
The syntax follows the same conventions as ``LS_COLORS``;

View File

@ -1,6 +1,8 @@
CFLAGS
------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling ``C`` files. Will only be

View File

@ -1,6 +1,8 @@
CMAKE_BUILD_PARALLEL_LEVEL
--------------------------
.. versionadded:: 3.12
.. include:: ENV_VAR.txt
Specifies the maximum number of concurrent processes to use when building

View File

@ -1,6 +1,8 @@
CMAKE_CONFIG_TYPE
-----------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
The default build configuration for :ref:`Build Tool Mode` and

View File

@ -1,6 +1,8 @@
CMAKE_EXPORT_COMPILE_COMMANDS
-----------------------------
.. versionadded:: 3.17
.. include:: ENV_VAR.txt
The default value for :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` when there

View File

@ -1,6 +1,8 @@
CMAKE_GENERATOR
---------------
.. versionadded:: 3.15
.. include:: ENV_VAR.txt
Specifies the CMake default generator to use when no generator is supplied

View File

@ -1,6 +1,8 @@
CMAKE_GENERATOR_INSTANCE
------------------------
.. versionadded:: 3.15
.. include:: ENV_VAR.txt
Default value for :variable:`CMAKE_GENERATOR_INSTANCE` if no Cache entry is

View File

@ -1,6 +1,8 @@
CMAKE_GENERATOR_PLATFORM
------------------------
.. versionadded:: 3.15
.. include:: ENV_VAR.txt
Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry

View File

@ -1,6 +1,8 @@
CMAKE_GENERATOR_TOOLSET
-----------------------
.. versionadded:: 3.15
.. include:: ENV_VAR.txt
Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry

View File

@ -1,6 +1,8 @@
CMAKE_<LANG>_COMPILER_LAUNCHER
------------------------------
.. versionadded:: 3.17
.. include:: ENV_VAR.txt
Default compiler launcher to use for the specified language. Will only be used

View File

@ -1,6 +1,8 @@
CMAKE_MSVCIDE_RUN_PATH
----------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Extra PATH locations for custom commands when using

View File

@ -1,6 +1,8 @@
CMAKE_NO_VERBOSE
----------------
.. versionadded:: 3.14
Disables verbose output from CMake when :envvar:`VERBOSE` environment variable
is set.

View File

@ -1,6 +1,8 @@
CMAKE_OSX_ARCHITECTURES
-----------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Target specific architectures for macOS.

View File

@ -1,6 +1,8 @@
CMAKE_PREFIX_PATH
-----------------
.. versionadded:: 3.18
.. include:: ENV_VAR.txt
The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of

View File

@ -1,6 +1,8 @@
CSFLAGS
-------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``CSharp`` language files. Will only be

View File

@ -1,6 +1,8 @@
CTEST_INTERACTIVE_DEBUG_MODE
----------------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Environment variable that will exist and be set to ``1`` when a test executed

View File

@ -1,6 +1,8 @@
CTEST_OUTPUT_ON_FAILURE
-----------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Boolean environment variable that controls if the output should be logged for

View File

@ -1,6 +1,8 @@
CTEST_PARALLEL_LEVEL
--------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Specify the number of tests for CTest to run in parallel. See :manual:`ctest(1)`

View File

@ -1,6 +1,8 @@
CTEST_PROGRESS_OUTPUT
---------------------
.. versionadded:: 3.13
.. include:: ENV_VAR.txt
Boolean environment variable that affects how :manual:`ctest <ctest(1)>`

View File

@ -1,6 +1,8 @@
CTEST_USE_LAUNCHERS_DEFAULT
---------------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined.

View File

@ -1,6 +1,8 @@
CUDACXX
-------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``CUDA`` language files. Will only be used by

View File

@ -1,6 +1,8 @@
CUDAFLAGS
---------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling ``CUDA`` files. Will only be

View File

@ -1,6 +1,8 @@
CUDAHOSTCXX
-----------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling host code when compiling ``CUDA``

View File

@ -1,6 +1,8 @@
CXX
---
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``CXX`` language files. Will only be used by

View File

@ -1,6 +1,8 @@
CXXFLAGS
--------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling ``CXX`` (C++) files. Will

View File

@ -1,6 +1,8 @@
DASHBOARD_TEST_FROM_CTEST
-------------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Environment variable that will exist when a test executed by :manual:`ctest(1)`

View File

@ -1,6 +1,8 @@
DESTDIR
-------
.. versionadded:: 3.12
.. include:: ENV_VAR.txt
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the

View File

@ -1,6 +1,8 @@
FC
--
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``Fortran`` language files. Will only be used

View File

@ -1,6 +1,8 @@
FFLAGS
------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling ``Fortran`` files. Will only

View File

@ -1,6 +1,8 @@
LDFLAGS
-------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Will only be used by CMake on the first configuration to determine the default

View File

@ -1,6 +1,8 @@
MACOSX_DEPLOYMENT_TARGET
------------------------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Specify the minimum version of macOS on which the target binaries are

View File

@ -1,6 +1,8 @@
OBJC
----
.. versionadded:: 3.16.7
.. include:: ENV_VAR.txt
Preferred executable for compiling ``OBJC`` language files. Will only be used

View File

@ -1,6 +1,8 @@
OBJCXX
------
.. versionadded:: 3.16.7
.. include:: ENV_VAR.txt
Preferred executable for compiling ``OBJCXX`` language files. Will only be used

View File

@ -1,6 +1,8 @@
<PackageName>_ROOT
------------------
.. versionadded:: 3.12.1
.. include:: ENV_VAR.txt
Calls to :command:`find_package(<PackageName>)` will search in prefixes

View File

@ -1,6 +1,8 @@
RC
--
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Preferred executable for compiling ``resource`` files. Will only be used by CMake

View File

@ -1,6 +1,8 @@
RCFLAGS
-------
.. versionadded:: 3.10
.. include:: ENV_VAR.txt
Default compilation flags to be used when compiling ``resource`` files. Will

View File

@ -1,6 +1,8 @@
SWIFTC
------
.. versionadded:: 3.15
.. include:: ENV_VAR.txt
Preferred executable for compiling ``Swift`` language files. Will only be used by

View File

@ -1,6 +1,8 @@
VERBOSE
-------
.. versionadded:: 3.14
Activates verbose output from CMake and your build tools of choice when
you start to actually build your project.

View File

@ -1,6 +1,8 @@
Green Hills MULTI
-----------------
.. versionadded:: 3.3
Generates Green Hills MULTI project files (experimental, work-in-progress).
The buildsystem has predetermined build-configuration settings that can be controlled

View File

@ -1,6 +1,8 @@
Ninja Multi-Config
------------------
.. versionadded:: 3.17
Generates multiple ``build-<Config>.ninja`` files.
This generator is very much like the :generator:`Ninja` generator, but with

View File

@ -1,6 +1,8 @@
Visual Studio 14 2015
---------------------
.. versionadded:: 3.1
Generates Visual Studio 14 (VS 2015) project files.
Project Types

View File

@ -1,6 +1,8 @@
Visual Studio 15 2017
---------------------
.. versionadded:: 3.7.1
Generates Visual Studio 15 (VS 2017) project files.
Project Types

View File

@ -1,6 +1,8 @@
Visual Studio 16 2019
---------------------
.. versionadded:: 3.14
Generates Visual Studio 16 (VS 2019) project files.
Project Types

View File

@ -1,4 +1,6 @@
CPackArchive
------------
.. versionadded:: 3.9
The documentation for the CPack Archive generator has moved here: :cpack_gen:`CPack Archive Generator`

View File

@ -1,4 +1,6 @@
CPackFreeBSD
------------
.. versionadded:: 3.10
The documentation for the CPack FreeBSD generator has moved here: :cpack_gen:`CPack FreeBSD Generator`

View File

@ -1,4 +1,6 @@
CPackNuGet
----------
.. versionadded:: 3.12
The documentation for the CPack NuGet generator has moved here: :cpack_gen:`CPack NuGet Generator`

View File

@ -1,4 +1,6 @@
CPackProductBuild
-----------------
.. versionadded:: 3.7
The documentation for the CPack productbuild generator has moved here: :cpack_gen:`CPack productbuild Generator`

View File

@ -1,6 +1,8 @@
CMP0051
-------
.. versionadded:: 3.1
List TARGET_OBJECTS in SOURCES target property.
CMake 3.0 and lower did not include the ``TARGET_OBJECTS``

View File

@ -1,6 +1,8 @@
CMP0052
-------
.. versionadded:: 3.1
Reject source and build dirs in installed
:prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`.

View File

@ -1,6 +1,8 @@
CMP0053
-------
.. versionadded:: 3.1
Simplify variable reference and escape sequence evaluation.
CMake 3.1 introduced a much faster implementation of evaluation of the

View File

@ -1,6 +1,8 @@
CMP0054
-------
.. versionadded:: 3.1
Only interpret :command:`if` arguments as variables or keywords when unquoted.
CMake 3.1 and above no longer implicitly dereference variables or

View File

@ -1,6 +1,8 @@
CMP0055
-------
.. versionadded:: 3.2
Strict checking for the :command:`break` command.
CMake 3.1 and lower allowed calls to the :command:`break` command

View File

@ -1,6 +1,8 @@
CMP0056
-------
.. versionadded:: 3.2
Honor link flags in :command:`try_compile` source-file signature.
The :command:`try_compile` command source-file signature generates a

View File

@ -1,6 +1,8 @@
CMP0057
-------
.. versionadded:: 3.3
Support new :command:`if` IN_LIST operator.
CMake 3.3 adds support for the new IN_LIST operator.

View File

@ -1,6 +1,8 @@
CMP0058
-------
.. versionadded:: 3.3
Ninja requires custom command byproducts to be explicit.
When an intermediate file generated during the build is consumed

View File

@ -1,6 +1,8 @@
CMP0059
-------
.. versionadded:: 3.3
Do not treat ``DEFINITIONS`` as a built-in directory property.
CMake 3.3 and above no longer make a list of definitions available through

View File

@ -1,6 +1,8 @@
CMP0060
-------
.. versionadded:: 3.3
Link libraries by full path even in implicit directories.
Policy :policy:`CMP0003` was introduced with the intention of always

View File

@ -1,6 +1,8 @@
CMP0061
-------
.. versionadded:: 3.3
CTest does not by default tell ``make`` to ignore errors (``-i``).
The :command:`ctest_build` and :command:`build_command` commands no

View File

@ -1,6 +1,8 @@
CMP0062
-------
.. versionadded:: 3.3
Disallow :command:`install` of :command:`export` result.
The :command:`export()` command generates a file containing

View File

@ -1,6 +1,8 @@
CMP0063
-------
.. versionadded:: 3.3
Honor visibility properties for all target types.
The :prop_tgt:`<LANG>_VISIBILITY_PRESET` and

View File

@ -1,6 +1,8 @@
CMP0064
-------
.. versionadded:: 3.4
Recognize ``TEST`` as a operator for the :command:`if` command.
The ``TEST`` operator was added to the :command:`if` command to determine if a

View File

@ -1,6 +1,8 @@
CMP0065
-------
.. versionadded:: 3.4
Do not add flags to export symbols from executables without
the :prop_tgt:`ENABLE_EXPORTS` target property.

View File

@ -1,6 +1,8 @@
CMP0066
-------
.. versionadded:: 3.7
Honor per-config flags in :command:`try_compile` source-file signature.
The source file signature of the :command:`try_compile` command uses the value

View File

@ -1,6 +1,8 @@
CMP0067
-------
.. versionadded:: 3.8
Honor language standard in :command:`try_compile` source-file signature.
The :command:`try_compile` source file signature is intended to allow

View File

@ -1,6 +1,8 @@
CMP0068
-------
.. versionadded:: 3.9
``RPATH`` settings on macOS do not affect ``install_name``.
CMake 3.9 and newer remove any effect the following settings may have on the

View File

@ -1,6 +1,8 @@
CMP0069
-------
.. versionadded:: 3.9
:prop_tgt:`INTERPROCEDURAL_OPTIMIZATION` is enforced when enabled.
CMake 3.9 and newer prefer to add IPO flags whenever the

View File

@ -1,6 +1,8 @@
CMP0070
-------
.. versionadded:: 3.10
Define :command:`file(GENERATE)` behavior for relative paths.
CMake 3.10 and newer define that relative paths given to ``INPUT`` and

View File

@ -1,6 +1,8 @@
CMP0071
-------
.. versionadded:: 3.10
Let :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` process
:prop_sf:`GENERATED` files.

View File

@ -1,6 +1,8 @@
CMP0072
-------
.. versionadded:: 3.11
:module:`FindOpenGL` prefers GLVND by default when available.
The :module:`FindOpenGL` module provides an ``OpenGL::GL`` target and an

View File

@ -1,6 +1,8 @@
CMP0073
-------
.. versionadded:: 3.12
Do not produce legacy ``_LIB_DEPENDS`` cache entries.
Ancient CMake versions once used ``<tgt>_LIB_DEPENDS`` cache entries to

View File

@ -1,6 +1,8 @@
CMP0074
-------
.. versionadded:: 3.12
:command:`find_package` uses ``<PackageName>_ROOT`` variables.
In CMake 3.12 and above the :command:`find_package(<PackageName>)` command now

View File

@ -1,6 +1,8 @@
CMP0075
-------
.. versionadded:: 3.12
Include file check macros honor ``CMAKE_REQUIRED_LIBRARIES``.
In CMake 3.12 and above, the

View File

@ -1,6 +1,8 @@
CMP0076
-------
.. versionadded:: 3.13
The :command:`target_sources` command converts relative paths to absolute.
In CMake 3.13 and above, the :command:`target_sources` command now converts

View File

@ -1,6 +1,8 @@
CMP0077
-------
.. versionadded:: 3.13
:command:`option` honors normal variables.
The :command:`option` command is typically used to create a cache entry

View File

@ -1,6 +1,8 @@
CMP0078
-------
.. versionadded:: 3.13
:module:`UseSWIG` generates standard target names.
Starting with CMake 3.13, :module:`UseSWIG` generates now standard target

View File

@ -1,6 +1,8 @@
CMP0079
-------
.. versionadded:: 3.13
:command:`target_link_libraries` allows use with targets in other directories.
Prior to CMake 3.13 the :command:`target_link_libraries` command did not

View File

@ -1,6 +1,8 @@
CMP0080
-------
.. versionadded:: 3.13
:module:`BundleUtilities` cannot be included at configure time.
The macros provided by :module:`BundleUtilities` are intended to be invoked

View File

@ -1,6 +1,8 @@
CMP0081
-------
.. versionadded:: 3.13
Relative paths not allowed in :prop_tgt:`LINK_DIRECTORIES` target property.
CMake 3.12 and lower allowed the :prop_dir:`LINK_DIRECTORIES` directory

View File

@ -1,6 +1,8 @@
CMP0082
-------
.. versionadded:: 3.14
Install rules from :command:`add_subdirectory` calls are interleaved with
those in caller.

View File

@ -1,6 +1,8 @@
CMP0083
-------
.. versionadded:: 3.14
To control generation of Position Independent Executable (``PIE``) or not, some
flags are required at link time.

View File

@ -1,6 +1,8 @@
CMP0084
-------
.. versionadded:: 3.14
The :module:`FindQt` module does not exist for :command:`find_package`.
The existence of :module:`FindQt` means that for Qt upstream to provide

View File

@ -1,6 +1,8 @@
CMP0085
-------
.. versionadded:: 3.14
``$<IN_LIST:...>`` handles empty list items.
In CMake 3.13 and lower, the ``$<IN_LIST:...>`` generator expression always

View File

@ -1,6 +1,8 @@
CMP0086
-------
.. versionadded:: 3.14
:module:`UseSWIG` honors ``SWIG_MODULE_NAME`` via ``-module`` flag.
Starting with CMake 3.14, :module:`UseSWIG` passes option

View File

@ -1,6 +1,8 @@
CMP0087
-------
.. versionadded:: 3.14
:command:`install(CODE)` and :command:`install(SCRIPT)` support generator
expressions.

View File

@ -1,6 +1,8 @@
CMP0088
-------
.. versionadded:: 3.14
:module:`FindBISON` runs bison in :variable:`CMAKE_CURRENT_BINARY_DIR`
when executing.

View File

@ -1,6 +1,8 @@
CMP0089
-------
.. versionadded:: 3.15
Compiler id for IBM Clang-based XL compilers is now ``XLClang``.
CMake 3.15 and above recognize that IBM's Clang-based XL compilers

Some files were not shown because too many files have changed in this diff Show More