Merge topic 'deprecation'

c8e8c9cc7c Help: Date deprecation of deprecated commands.
19998d7b3c Help: Use 'deprecated' template, and date deprecation of modules
dc1bb33578 Help: Add version number to deprecation note

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2523
This commit is contained in:
Brad King
2018-10-25 15:00:20 +00:00
committed by Kitware Robot
27 changed files with 75 additions and 46 deletions

View File

@@ -1,7 +1,7 @@
build_name
----------
Disallowed. See CMake Policy :policy:`CMP0036`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0036`.
Use ``${CMAKE_SYSTEM}`` and ``${CMAKE_CXX_COMPILER}`` instead.

View File

@@ -1,7 +1,9 @@
exec_program
------------
Deprecated. Use the :command:`execute_process` command instead.
.. deprecated:: 3.0
Use the :command:`execute_process` command instead.
Run an executable program during the processing of the CMakeList.txt
file.

View File

@@ -1,7 +1,7 @@
export_library_dependencies
---------------------------
Disallowed. See CMake Policy :policy:`CMP0033`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0033`.
Use :command:`install(EXPORT)` or :command:`export` command.

View File

@@ -1,7 +1,9 @@
install_files
-------------
Deprecated. Use the :command:`install(FILES)` command instead.
.. deprecated:: 3.0
Use the :command:`install(FILES)` command instead.
This command has been superceded by the :command:`install` command. It is
provided for compatibility with older CMake code. The ``FILES`` form is

View File

@@ -1,7 +1,9 @@
install_programs
----------------
Deprecated. Use the :command:`install(PROGRAMS)` command instead.
.. deprecated:: 3.0
Use the :command:`install(PROGRAMS)` command instead.
This command has been superceded by the :command:`install` command. It is
provided for compatibility with older CMake code. The ``FILES`` form is

View File

@@ -1,7 +1,9 @@
install_targets
---------------
Deprecated. Use the :command:`install(TARGETS)` command instead.
.. deprecated:: 3.0
Use the :command:`install(TARGETS)` command instead.
This command has been superceded by the :command:`install` command. It is
provided for compatibility with older CMake code.

View File

@@ -1,7 +1,7 @@
load_command
------------
Disallowed. See CMake Policy :policy:`CMP0031`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0031`.
Load a command into a running CMake.

View File

@@ -1,7 +1,9 @@
make_directory
--------------
Deprecated. Use the :command:`file(MAKE_DIRECTORY)` command instead.
.. deprecated:: 3.0
Use the :command:`file(MAKE_DIRECTORY)` command instead.
::

View File

@@ -1,7 +1,7 @@
output_required_files
---------------------
Disallowed. See CMake Policy :policy:`CMP0032`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0032`.
Approximate C preprocessor dependency scanning.

View File

@@ -1,7 +1,9 @@
remove
------
Deprecated. Use the :command:`list(REMOVE_ITEM)` command instead.
.. deprecated:: 3.0
Use the :command:`list(REMOVE_ITEM)` command instead.
::

View File

@@ -1,7 +1,7 @@
subdir_depends
--------------
Disallowed. See CMake Policy :policy:`CMP0029`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0029`.
Does nothing.

View File

@@ -1,7 +1,9 @@
subdirs
-------
Deprecated. Use the :command:`add_subdirectory` command instead.
.. deprecated:: 3.0
Use the :command:`add_subdirectory` command instead.
Add a list of subdirectories to the build.

View File

@@ -1,7 +1,7 @@
use_mangled_mesa
----------------
Disallowed. See CMake Policy :policy:`CMP0030`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0030`.
Copy mesa headers for use in combination with system GL.

View File

@@ -1,7 +1,7 @@
utility_source
--------------
Disallowed. See CMake Policy :policy:`CMP0034`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0034`.
Specify the source tree of a third-party utility.

View File

@@ -1,7 +1,7 @@
variable_requires
-----------------
Disallowed. See CMake Policy :policy:`CMP0035`.
Disallowed since version 3.0. See CMake Policy :policy:`CMP0035`.
Use the :command:`if` command instead.

View File

@@ -1,7 +1,9 @@
write_file
----------
Deprecated. Use the :command:`file(WRITE)` command instead.
.. deprecated:: 3.0
Use the :command:`file(WRITE)` command instead.
::

View File

@@ -145,8 +145,9 @@ These commands are available only in CTest scripts.
Deprecated Commands
===================
These commands are available only for compatibility with older
versions of CMake. Do not use them in new code.
These commands are deprecated since CMake version 3.0.
They are available only for backward compatibility.
Do not use them in new code.
.. toctree::
:maxdepth: 1

View File

@@ -5,7 +5,9 @@
CMakeDetermineVSServicePack
---------------------------
Deprecated. Do not use.
.. deprecated:: 3.0
Do not use.
The functionality of this module has been superseded by the
:variable:`CMAKE_<LANG>_COMPILER_VERSION` variable that contains
@@ -170,4 +172,3 @@ function(DetermineVSServicePack _pack)
endif()
endif()
endfunction()

View File

@@ -5,7 +5,9 @@
CMakeExpandImportedTargets
--------------------------
Deprecated. Do not use.
.. deprecated:: 3.4
Do not use.
This module was once needed to expand imported targets to the underlying
libraries they reference on disk for use with the :command:`try_compile`

View File

@@ -5,7 +5,9 @@
CMakeForceCompiler
------------------
Deprecated. Do not use.
.. deprecated:: 3.6
Do not use.
The macros provided by this module were once intended for use by
cross-compiling toolchain files when CMake was not able to automatically

View File

@@ -2,19 +2,22 @@
FindCUDA
--------
.. note::
.. deprecated:: 3.10
The FindCUDA module has been superseded by first-class support
for the CUDA language in CMake. It is no longer necessary to
use this module or call ``find_package(CUDA)``. This module
now exists only for compatibility with projects that have not
been ported.
Superseded by first-class support for the CUDA language in CMake.
Instead, list ``CUDA`` among the languages named in the top-level
call to the :command:`project` command, or call the
:command:`enable_language` command with ``CUDA``.
Then one can add CUDA (``.cu``) sources to programs directly
in calls to :command:`add_library` and :command:`add_executable`.
Replacement
^^^^^^^^^^^
It is no longer necessary to use this module or call ``find_package(CUDA)``.
Instead, list ``CUDA`` among the languages named in the top-level
call to the :command:`project` command, or call the
:command:`enable_language` command with ``CUDA``.
Then one can add CUDA (``.cu``) sources to programs directly
in calls to :command:`add_library` and :command:`add_executable`.
Documentation of Deprecated Usage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Tools for building CUDA C files: libraries and build dependencies.

View File

@@ -5,12 +5,12 @@
FindPythonInterp
----------------
Find python interpreter
.. deprecated:: 3.12
Use :module:`FindPython3`, :module:`FindPython2` or :module:`FindPython` instead.
Find python interpreter
This module finds if Python interpreter is installed and determines
where the executables are. This code sets the following variables:

View File

@@ -5,12 +5,12 @@
FindPythonLibs
--------------
Find python libraries
.. deprecated:: 3.12
Use :module:`FindPython3`, :module:`FindPython2` or :module:`FindPython` instead.
Find python libraries
This module finds if Python is installed and determines where the
include files and libraries are. It also determines what the name of
the library is. This code sets the following variables:

View File

@@ -5,13 +5,15 @@
FindwxWindows
-------------
.. deprecated:: 3.0
Replaced by :module:`FindwxWidgets`.
Find wxWindows (wxWidgets) installation
This module finds if wxWindows/wxWidgets is installed and determines
where the include files and libraries are. It also determines what
the name of the library is. Please note this file is DEPRECATED and
replaced by FindwxWidgets.cmake. This code sets the following
variables:
the name of the library is. This code sets the following variables:
::

View File

@@ -5,7 +5,9 @@
TestCXXAcceptsFlag
------------------
Deprecated. See :module:`CheckCXXCompilerFlag`.
.. deprecated:: 3.0
See :module:`CheckCXXCompilerFlag`.
Check if the CXX compiler accepts a flag.

View File

@@ -5,9 +5,9 @@
Use_wxWindows
-------------
Deprecated. Use ``find_package(wxWidgets)`` and
``include(${wxWidgets_USE_FILE})`` instead.
.. deprecated:: 3.14
Use ``find_package(wxWidgets)`` and ``include(${wxWidgets_USE_FILE})`` instead.
This convenience include finds if wxWindows is installed and set the
appropriate libs, incdirs, flags etc. author Jan Woetzel <jw -at-
@@ -67,4 +67,3 @@ if(WXWINDOWS_FOUND)
else()
message(SEND_ERROR "wxWindows not found by Use_wxWindows.cmake")
endif()

View File

@@ -5,7 +5,10 @@
WriteBasicConfigVersionFile
---------------------------
.. deprecated:: 3.0
Use the identical command :command:`write_basic_package_version_file()`
from module :module:`CMakePackageConfigHelpers`.
::
@@ -15,8 +18,6 @@ WriteBasicConfigVersionFile
)
Deprecated, see WRITE_BASIC_PACKAGE_VERSION_FILE(), it is identical.
#]=======================================================================]
function(WRITE_BASIC_CONFIG_VERSION_FILE _filename)