Help: Use 'deprecated' template, and date deprecation of modules

This commit is contained in:
Joachim Wuttke (o)
2018-10-25 12:23:33 +02:00
parent dc1bb33578
commit 19998d7b3c
10 changed files with 40 additions and 28 deletions

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)