diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 53cef2deab..86f135d4e1 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -361,10 +361,10 @@ reStructuredText-format documentation. For example: Result Variables ^^^^^^^^^^^^^^^^ - This will define the following variables: + This module defines the following variables: ``Foo_FOUND`` - True if the system has the Foo library. + Boolean indicating whether (the requested version of) Foo was found. ``Foo_VERSION`` The version of the Foo library which was found. ``Foo_INCLUDE_DIRS`` diff --git a/Help/release/dev/find-modules.rst b/Help/release/dev/find-modules.rst index 7417b4a26f..42d81e219b 100644 --- a/Help/release/dev/find-modules.rst +++ b/Help/release/dev/find-modules.rst @@ -1,6 +1,10 @@ Find Modules ------------ +* The uppercased ``_FOUND`` result variables of find modules + are now deprecated in favor of ``_FOUND`` result variables, + where appropriate. See documentation of each find module for details. + * The :module:`FindALSA` module now provides a ``ALSA_VERSION`` result variable. The ``ALSA_VERSION_STRING`` result variable is deprecated. diff --git a/Modules/FindALSA.cmake b/Modules/FindALSA.cmake index d7e822bc14..7a5edcebf7 100644 --- a/Modules/FindALSA.cmake +++ b/Modules/FindALSA.cmake @@ -28,7 +28,8 @@ Result Variables This module defines the following variables: ``ALSA_FOUND`` - Boolean indicating whether (the requested version of) ALSA library is found. + Boolean indicating whether the (requested version of) ALSA library was + found. ``ALSA_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindASPELL.cmake b/Modules/FindASPELL.cmake index 3d712d659f..5d612cd1df 100644 --- a/Modules/FindASPELL.cmake +++ b/Modules/FindASPELL.cmake @@ -60,7 +60,8 @@ Result Variables This module defines the following variables: ``ASPELL_FOUND`` - Boolean indicating whether the requested Aspell components have been found. + Boolean indicating whether (the requested version of) Aspell and all + requested components were found. ``ASPELL_VERSION`` .. versionadded:: 4.1 diff --git a/Modules/FindAVIFile.cmake b/Modules/FindAVIFile.cmake index f5c27862e5..b6cfe7e565 100644 --- a/Modules/FindAVIFile.cmake +++ b/Modules/FindAVIFile.cmake @@ -21,10 +21,13 @@ Result Variables This module defines the following variables: ``AVIFile_FOUND`` - Boolean indicating whether AVIFile is found. For backward compatibility, - the ``AVIFILE_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether AVIFile was found. + ``AVIFILE_LIBRARIES`` The libraries to link against. + ``AVIFILE_DEFINITIONS`` Definitions to use when compiling. @@ -36,6 +39,17 @@ The following cache variables may also be set: ``AVIFILE_INCLUDE_DIR`` Directory containing ``avifile.h`` and other AVIFile headers. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``AVIFILE_FOUND`` + .. deprecated:: 4.2 + Use ``AVIFile_FOUND``, which has the same value. + + Boolean indicating whether AVIFile was found. + Examples ^^^^^^^^ diff --git a/Modules/FindArmadillo.cmake b/Modules/FindArmadillo.cmake index 96fb1394c2..901ea229af 100644 --- a/Modules/FindArmadillo.cmake +++ b/Modules/FindArmadillo.cmake @@ -24,9 +24,10 @@ Result Variables This module defines the following variables: ``Armadillo_FOUND`` - Boolean indicating whether the (requested version of) Armadillo library is - found. For backward compatibility, the ``ARMADILLO_FOUND`` variable is - also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Armadillo library + was found. ``Armadillo_VERSION`` .. versionadded:: 4.2 @@ -49,6 +50,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``ARMADILLO_FOUND`` + .. deprecated:: 4.2 + Use ``Armadillo_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Armadillo library + was found. + ``ARMADILLO_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Armadillo_VERSION``. diff --git a/Modules/FindBISON.cmake b/Modules/FindBISON.cmake index 6acebc8716..38ea407754 100644 --- a/Modules/FindBISON.cmake +++ b/Modules/FindBISON.cmake @@ -23,7 +23,7 @@ Result Variables This module defines the following variables: ``BISON_FOUND`` - Boolean indicating whether (the requested version of) Bison is found. + Boolean indicating whether (the requested version of) Bison was found. ``BISON_VERSION`` The version of Bison found. diff --git a/Modules/FindBLAS.cmake b/Modules/FindBLAS.cmake index fde39f3a2a..715c174731 100644 --- a/Modules/FindBLAS.cmake +++ b/Modules/FindBLAS.cmake @@ -33,8 +33,8 @@ Result Variables This module defines the following variables: ``BLAS_FOUND`` - Boolean indicating whether the library implementing the BLAS interface is - found. + Boolean indicating whether the library implementing the BLAS interface + was found. ``BLAS_LINKER_FLAGS`` Uncached list of required linker flags (excluding ``-l`` and ``-L``). ``BLAS_LIBRARIES`` @@ -45,7 +45,7 @@ This module defines the following variables: to use BLAS95 interface. ``BLAS95_FOUND`` Boolean indicating whether the library implementing the BLAS95 interface - is found. + was found. Input Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindBZip2.cmake b/Modules/FindBZip2.cmake index 6432ec56c1..344aa1b761 100644 --- a/Modules/FindBZip2.cmake +++ b/Modules/FindBZip2.cmake @@ -28,9 +28,10 @@ Result Variables This module defines the following variables: ``BZip2_FOUND`` - Boolean indicating whether (the requested version of) BZip2 library is - found. For backward compatibility, the ``BZIP2_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) BZip2 library was + found. ``BZip2_VERSION`` .. versionadded:: 4.2 @@ -69,6 +70,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``BZIP2_FOUND`` + .. deprecated:: 4.2 + Use ``BZip2_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) BZip2 library was + found. + ``BZIP2_VERSION_STRING`` .. deprecated:: 3.26 Superseded by the ``BZIP2_VERSION`` (and ``BZip2_VERSION``). diff --git a/Modules/FindBullet.cmake b/Modules/FindBullet.cmake index 7ae571f2e0..d2ef0d45eb 100644 --- a/Modules/FindBullet.cmake +++ b/Modules/FindBullet.cmake @@ -17,10 +17,13 @@ Result Variables This module defines the following variables: ``Bullet_FOUND`` - Boolean indicating whether Bullet was found. For backward compatibility, - the ``BULLET_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Bullet was found. + ``BULLET_INCLUDE_DIRS`` The Bullet include directories. + ``BULLET_LIBRARIES`` Libraries needed to link to Bullet. By default, all Bullet components (Dynamics, Collision, LinearMath, and SoftBody) are added. @@ -34,6 +37,17 @@ This module accepts the following variables: Can be set to Bullet install path or Windows build path to specify where to find Bullet. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``BULLET_FOUND`` + .. deprecated:: 4.2 + Use ``Bullet_FOUND``, which has the same value. + + Boolean indicating whether Bullet was found. + Examples ^^^^^^^^ diff --git a/Modules/FindCUDAToolkit.cmake b/Modules/FindCUDAToolkit.cmake index 1784e1d126..fa356f507d 100644 --- a/Modules/FindCUDAToolkit.cmake +++ b/Modules/FindCUDAToolkit.cmake @@ -524,9 +524,11 @@ Target Created: **Note**: direct usage of this target by consumers should not be necessary. -Result variables +Result Variables ^^^^^^^^^^^^^^^^ +This module defines the following variables: + ``CUDAToolkit_FOUND`` A boolean specifying whether or not the CUDA Toolkit was found. diff --git a/Modules/FindCURL.cmake b/Modules/FindCURL.cmake index d041098d4b..9af420fcd7 100644 --- a/Modules/FindCURL.cmake +++ b/Modules/FindCURL.cmake @@ -72,8 +72,8 @@ Result Variables This module defines the following variables: ``CURL_FOUND`` - Boolean indicating whether the (requested version of) curl and all required - components are found. + Boolean indicating whether (the requested version of) curl and all required + components were found. ``CURL_VERSION`` .. versionadded:: 4.0 @@ -84,7 +84,7 @@ This module defines the following variables: .. versionadded:: 3.14 Boolean indicating whether the specified component (curl protocol or feature) - is found. + was found. ``CURL_INCLUDE_DIRS`` Include directories containing the ``curl/curl.h`` and other headers needed to diff --git a/Modules/FindCVS.cmake b/Modules/FindCVS.cmake index de64370d83..b79f5f1c99 100644 --- a/Modules/FindCVS.cmake +++ b/Modules/FindCVS.cmake @@ -17,7 +17,7 @@ Result Variables This module defines the following variables: ``CVS_FOUND`` - Boolean indicating whether the command-line client was found. + Boolean indicating whether the ``cvs`` command-line client was found. Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindCoin3D.cmake b/Modules/FindCoin3D.cmake index 8fd939b7a5..07cbb69e26 100644 --- a/Modules/FindCoin3D.cmake +++ b/Modules/FindCoin3D.cmake @@ -20,8 +20,9 @@ Result Variables This module defines the following variables: ``Coin3D_FOUND`` - Boolean indicating whether Coin3D, Open Inventor is found. For backward - compatibility, the ``COIN3D_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Coin3D, Open Inventor was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -33,6 +34,17 @@ The following cache variables may also be set: ``COIN3D_LIBRARIES`` Coin3D libraries required for linking. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``COIN3D_FOUND`` + .. deprecated:: 4.2 + Use ``Coin3D_FOUND``, which has the same value. + + Boolean indicating whether Coin3D, Open Inventor was found. + Examples ^^^^^^^^ diff --git a/Modules/FindCups.cmake b/Modules/FindCups.cmake index 2e2e1995e4..e9c5587955 100644 --- a/Modules/FindCups.cmake +++ b/Modules/FindCups.cmake @@ -28,9 +28,9 @@ Result Variables This module defines the following variables: ``Cups_FOUND`` - Boolean indicating whether (the requested version of) CUPS is found. For - backward compatibility, the ``CUPS_FOUND`` variable is also set to the - same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) CUPS was found. ``Cups_VERSION`` .. versionadded:: 4.2 @@ -65,6 +65,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``CUPS_FOUND`` + .. deprecated:: 4.2 + Use ``Cups_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) CUPS was found. + ``CUPS_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Cups_VERSION``. diff --git a/Modules/FindCurses.cmake b/Modules/FindCurses.cmake index 51e98d87aa..de79bbbec8 100644 --- a/Modules/FindCurses.cmake +++ b/Modules/FindCurses.cmake @@ -22,8 +22,9 @@ Result Variables This module defines the following variables: ``Curses_FOUND`` - Boolean indicating whether the Curses is found. For backward compatibility, - the ``CURSES_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Curses was found. ``CURSES_INCLUDE_DIRS`` .. versionadded:: 3.1 @@ -68,7 +69,13 @@ This module accepts the following variables: Deprecated Variables ^^^^^^^^^^^^^^^^^^^^ -The following legacy variables are provided for backward compatibility: +The following variables are provided for backward compatibility: + +``CURSES_FOUND`` + .. deprecated:: 4.2 + Use ``Curses_FOUND``, which has the same value. + + Boolean indicating whether Curses was found. ``CURSES_INCLUDE_DIR`` .. deprecated:: 3.1 diff --git a/Modules/FindCxxTest.cmake b/Modules/FindCxxTest.cmake index 4e46cf4583..973647c569 100644 --- a/Modules/FindCxxTest.cmake +++ b/Modules/FindCxxTest.cmake @@ -20,7 +20,7 @@ Result Variables This module defines the following variables: ``CXXTEST_FOUND`` - Boolean indicating whether the CxxTest framework is found. + Boolean indicating whether the CxxTest framework was found. ``CXXTEST_INCLUDE_DIRS`` Include directories containing headers needed to use CxxTest. diff --git a/Modules/FindDCMTK.cmake b/Modules/FindDCMTK.cmake index 710fac83b7..181142c4bb 100644 --- a/Modules/FindDCMTK.cmake +++ b/Modules/FindDCMTK.cmake @@ -73,7 +73,7 @@ Result Variables This module defines the following variables: ``DCMTK_FOUND`` - Boolean indicating whether DCMTK is found. + Boolean indicating whether DCMTK was found. ``DCMTK_INCLUDE_DIRS`` Include directories containing headers needed to use DCMTK. diff --git a/Modules/FindDevIL.cmake b/Modules/FindDevIL.cmake index 019d45fb4d..923fe45e33 100644 --- a/Modules/FindDevIL.cmake +++ b/Modules/FindDevIL.cmake @@ -66,7 +66,9 @@ Result Variables This module defines the following variables: ``DevIL_FOUND`` - Boolean indicating whether the (requested version of) DevIL package is + .. versionadded:: 3.8 + + Boolean indicating whether the (requested version of) DevIL package was found, including the IL and ILU libraries. ``DevIL_VERSION`` @@ -77,8 +79,8 @@ This module defines the following variables: ``DevIL_ILUT_FOUND`` .. versionadded:: 3.21 - Boolean indicating whether the ILUT library is found. On most systems, ILUT - is found when both IL and ILU are available. + Boolean indicating whether the ILUT library was found. On most systems, + ILUT is found when both IL and ILU are available. Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindDoxygen.cmake b/Modules/FindDoxygen.cmake index c417b20772..e72110c97e 100644 --- a/Modules/FindDoxygen.cmake +++ b/Modules/FindDoxygen.cmake @@ -90,10 +90,10 @@ Result Variables This module defines the following variables: ``Doxygen_FOUND`` - Boolean indicating whether (the requested version of) ``doxygen`` executable - and all requested required components are found. For backward compatibility, - the ``DOXYGEN_FOUND`` variable is also set, except it has boolean value of - ``YES`` or ``NO``. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) ``doxygen`` executable + and all requested required components were found. ``Doxygen_VERSION`` .. versionadded:: 4.2 @@ -492,6 +492,14 @@ Deprecated Variables For compatibility with previous versions of CMake, the following variables are also defined but they are deprecated and should no longer be used: +``DOXYGEN_FOUND`` + .. deprecated:: 4.2 + Use ``Doxygen_FOUND``. + + Boolean indicating whether the (requested version of) ``doxygen`` executable + and all requested required components were found. It has a boolean value + of ``YES`` or ``NO``. + ``DOXYGEN_EXECUTABLE`` .. deprecated:: 3.9 Use ``Doxygen::doxygen`` imported target instead of referring to the @@ -501,8 +509,9 @@ are also defined but they are deprecated and should no longer be used: ``DOXYGEN_DOT_FOUND`` .. deprecated:: 3.9 + Use ``Doxygen_dot_FOUND``. - Boolean result variable indicating whether ``dot`` executable is found. + Boolean result variable indicating whether ``dot`` executable was found. ``DOXYGEN_DOT_EXECUTABLE`` .. deprecated:: 3.9 diff --git a/Modules/FindEXPAT.cmake b/Modules/FindEXPAT.cmake index 49e1099065..bcb604fd99 100644 --- a/Modules/FindEXPAT.cmake +++ b/Modules/FindEXPAT.cmake @@ -30,7 +30,7 @@ Result Variables This module defines the following variables: ``EXPAT_FOUND`` - Boolean indicating whether (the requested version of) Expat is found. + Boolean indicating whether (the requested version of) Expat was found. ``EXPAT_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindEnvModules.cmake b/Modules/FindEnvModules.cmake index 3e7d800984..bb19d045da 100644 --- a/Modules/FindEnvModules.cmake +++ b/Modules/FindEnvModules.cmake @@ -43,7 +43,7 @@ Result Variables This module defines the following variables: ``EnvModules_FOUND`` - Boolean indicating whether a compatible Environment Modules framework is + Boolean indicating whether a compatible Environment Modules framework was found. Cache Variables diff --git a/Modules/FindFLEX.cmake b/Modules/FindFLEX.cmake index a25b083c2a..c76e0527c5 100644 --- a/Modules/FindFLEX.cmake +++ b/Modules/FindFLEX.cmake @@ -23,7 +23,7 @@ Result Variables This module defines the following variables: ``FLEX_FOUND`` - Boolean indicating whether (the requested version of) Flex is found. + Boolean indicating whether (the requested version of) Flex was found. ``FLEX_VERSION`` The version of Flex found. diff --git a/Modules/FindFLTK.cmake b/Modules/FindFLTK.cmake index adeb57b153..eed585cf07 100644 --- a/Modules/FindFLTK.cmake +++ b/Modules/FindFLTK.cmake @@ -31,7 +31,7 @@ Result Variables This module defines the following variables: ``FLTK_FOUND`` - Boolean indicating whether FLTK is found. + Boolean indicating whether FLTK was found. ``FLTK_LIBRARIES`` Libraries needed to link against to use FLTK. diff --git a/Modules/FindFLTK2.cmake b/Modules/FindFLTK2.cmake index f70c0f036d..a276ed8948 100644 --- a/Modules/FindFLTK2.cmake +++ b/Modules/FindFLTK2.cmake @@ -26,7 +26,7 @@ Result Variables This module defines the following variables: ``FLTK2_FOUND`` - Boolean indicating whether FLTK 2.x is found. + Boolean indicating whether FLTK 2.x was found. ``FLTK2_LIBRARIES`` Libraries needed to link against to use FLTK 2.x. diff --git a/Modules/FindFontconfig.cmake b/Modules/FindFontconfig.cmake index d89a6bd9e0..1e37c7c4eb 100644 --- a/Modules/FindFontconfig.cmake +++ b/Modules/FindFontconfig.cmake @@ -28,7 +28,7 @@ Result Variables This module defines the following variables: ``Fontconfig_FOUND`` - Boolean indicating whether the (requested version of) Fontconfig is found. + Boolean indicating whether (the requested version of) Fontconfig was found. ``Fontconfig_VERSION`` The version of Fontconfig found. ``Fontconfig_LIBRARIES`` diff --git a/Modules/FindFreetype.cmake b/Modules/FindFreetype.cmake index d2be44f618..436a62ad1b 100644 --- a/Modules/FindFreetype.cmake +++ b/Modules/FindFreetype.cmake @@ -31,9 +31,9 @@ Result Variables This module defines the following variables: ``Freetype_FOUND`` - Boolean indicating whether (the requested version of) Freetype is found. - For backward compatibility, the ``FREETYPE_FOUND`` variable is also set - to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Freetype was found. ``Freetype_VERSION`` .. versionadded:: 4.2 @@ -76,6 +76,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``FREETYPE_FOUND`` + .. deprecated:: 4.2 + Use ``Freetype_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Freetype was found. + ``FREETYPE_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Freetype_VERSION``. diff --git a/Modules/FindGDAL.cmake b/Modules/FindGDAL.cmake index d5f42b5c69..71883daebc 100644 --- a/Modules/FindGDAL.cmake +++ b/Modules/FindGDAL.cmake @@ -34,7 +34,7 @@ Result Variables This module defines the following variables: ``GDAL_FOUND`` - Boolean indicating whether (the requested version of) GDAL is found. + Boolean indicating whether (the requested version of) GDAL was found. ``GDAL_VERSION`` .. versionadded:: 3.14 diff --git a/Modules/FindGIF.cmake b/Modules/FindGIF.cmake index e3a751b7ed..70059549f5 100644 --- a/Modules/FindGIF.cmake +++ b/Modules/FindGIF.cmake @@ -28,7 +28,7 @@ Result Variables This module defines the following variables: ``GIF_FOUND`` - Boolean indicating whether (the requested version of) GIF library was found. + Boolean indicating whether the (requested version of) GIF library was found. ``GIF_VERSION`` Version string of the GIF library found (for example, ``5.1.4``). For GIF diff --git a/Modules/FindGLEW.cmake b/Modules/FindGLEW.cmake index b9fe2616af..644b33248e 100644 --- a/Modules/FindGLEW.cmake +++ b/Modules/FindGLEW.cmake @@ -57,7 +57,7 @@ Result Variables This module defines the following variables: ``GLEW_FOUND`` - Boolean indicating whether (the requested version of) GLEW is found. + Boolean indicating whether (the requested version of) GLEW was found. ``GLEW_VERSION`` .. versionadded:: 3.15 diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake index 341968d058..dcb0359f1c 100644 --- a/Modules/FindGLUT.cmake +++ b/Modules/FindGLUT.cmake @@ -29,7 +29,7 @@ Result Variables This module defines the following variables: ``GLUT_FOUND`` - Boolean indicating whether GLUT is found. + Boolean indicating whether GLUT was found. ``GLUT_INCLUDE_DIRS`` .. versionadded:: 3.23 diff --git a/Modules/FindGSL.cmake b/Modules/FindGSL.cmake index 4118f543b1..041e9d1403 100644 --- a/Modules/FindGSL.cmake +++ b/Modules/FindGSL.cmake @@ -37,7 +37,7 @@ Result Variables This module defines the following variables: ``GSL_FOUND`` - Boolean indicating whether (the requested version of) GSL is found on the + Boolean indicating whether (the requested version of) GSL was found on the local system. ``GSL_VERSION`` The version of the discovered GSL installation. diff --git a/Modules/FindGTK.cmake b/Modules/FindGTK.cmake index c46af4f1c1..87325e25b5 100644 --- a/Modules/FindGTK.cmake +++ b/Modules/FindGTK.cmake @@ -32,9 +32,9 @@ Result Variables This module defines the following variables: ``GTK_FOUND`` - Boolean indicating whether GTK is found. + Boolean indicating whether GTK was found. ``GTK_GL_FOUND`` - Boolean indicating whether GTK's GL features are found. + Boolean indicating whether GTK's GL features were found. ``GTK_INCLUDE_DIR`` Include directories containing headers needed to use GTK. ``GTK_LIBRARIES`` diff --git a/Modules/FindGTK2.cmake b/Modules/FindGTK2.cmake index 9a0d974cd0..2cbb3a6075 100644 --- a/Modules/FindGTK2.cmake +++ b/Modules/FindGTK2.cmake @@ -97,7 +97,8 @@ Result Variables This module defines the following variables: ``GTK2_FOUND`` - Boolean indicating whether GTK and all specified components are found. + Boolean indicating whether (the requested version of) GTK 2 and all + specified components were found. ``GTK2_VERSION`` The version of GTK found (x.y.z). ``GTK2_MAJOR_VERSION`` diff --git a/Modules/FindGTest.cmake b/Modules/FindGTest.cmake index 3043768c3c..f8fda89344 100644 --- a/Modules/FindGTest.cmake +++ b/Modules/FindGTest.cmake @@ -78,7 +78,9 @@ Result Variables This module defines the following variables: ``GTest_FOUND`` - Boolean indicating whether GoogleTest is found. + .. versionadded:: 3.3 + + Boolean indicating whether GoogleTest was found. Hints ^^^^^ @@ -150,6 +152,12 @@ The following variables are provided for backward compatibility: Result variable providing both ``gtest`` and ``gtest_main`` libraries combined. +``GTEST_FOUND`` + .. deprecated:: 4.2 + Use ``GTest_FOUND``, which has the same value. + + Boolean indicating whether GoogleTest was found. + Deprecated Imported Targets """"""""""""""""""""""""""" diff --git a/Modules/FindGettext.cmake b/Modules/FindGettext.cmake index 49f27b7cdb..347d30d057 100644 --- a/Modules/FindGettext.cmake +++ b/Modules/FindGettext.cmake @@ -36,9 +36,9 @@ Result Variables This module defines the following variables: ``Gettext_FOUND`` - Boolean indicating whether (the requested version of) gettext is found. For - backward compatibility, the ``GETTEXT_FOUND`` variable is also set to the same - value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) gettext was found. ``Gettext_VERSION`` .. versionadded:: 4.2 @@ -201,6 +201,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``GETTEXT_FOUND`` + .. deprecated:: 4.2 + Use ``Gettext_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) gettext was found. + ``GETTEXT_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Gettext_VERSION``. diff --git a/Modules/FindGit.cmake b/Modules/FindGit.cmake index 2056a8a64d..978746b517 100644 --- a/Modules/FindGit.cmake +++ b/Modules/FindGit.cmake @@ -31,9 +31,9 @@ Result Variables This module defines the following variables: ``Git_FOUND`` - Boolean indicating whether (the requested version of) Git was found. For - backward compatibility, the ``GIT_FOUND`` variable is also set to the same - value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Git was found. ``Git_VERSION`` .. versionadded:: 4.2 @@ -53,6 +53,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``GIT_FOUND`` + .. deprecated:: 4.2 + Use ``Git_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Git was found. + ``GIT_VERSION_STRING`` .. deprecated:: 4.2 Use ``Git_VERSION``, which has the same value. diff --git a/Modules/FindGnuTLS.cmake b/Modules/FindGnuTLS.cmake index c677328beb..a0c2c852ce 100644 --- a/Modules/FindGnuTLS.cmake +++ b/Modules/FindGnuTLS.cmake @@ -34,9 +34,9 @@ Result Variables This module defines the following variables: ``GnuTLS_FOUND`` - Boolean indicating whether (the requested version of) GnuTLS is found. For - backward compatibility, the ``GNUTLS_FOUND`` variable is also set to the same - value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) GnuTLS was found. ``GnuTLS_VERSION`` .. versionadded:: 4.2 @@ -68,6 +68,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``GNUTLS_FOUND`` + .. deprecated:: 4.2 + Use ``GnuTLS_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) GnuTLS was found. + ``GNUTLS_VERSION_STRING`` .. deprecated:: 3.16 Use the ``GnuTLS_VERSION``, which has the same value. diff --git a/Modules/FindGnuplot.cmake b/Modules/FindGnuplot.cmake index c8e788602d..f5bf309f0d 100644 --- a/Modules/FindGnuplot.cmake +++ b/Modules/FindGnuplot.cmake @@ -18,9 +18,9 @@ Result Variables This module defines the following variables: ``Gnuplot_FOUND`` - Boolean indicating whether (the requested version of) Gnuplot has been - found. For backward compatibility, the ``GNUPLOT_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Gnuplot was found. ``Gnuplot_VERSION`` .. versionadded:: 4.2 @@ -45,6 +45,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``GNUPLOT_FOUND`` + .. deprecated:: 4.2 + Use ``Gnuplot_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Gnuplot was found. + ``GNUPLOT_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Gnuplot_VERSION``. diff --git a/Modules/FindHDF5.cmake b/Modules/FindHDF5.cmake index a203858307..380b9fa6a9 100644 --- a/Modules/FindHDF5.cmake +++ b/Modules/FindHDF5.cmake @@ -127,7 +127,7 @@ Result Variables This module defines the following variables: ``HDF5_FOUND`` - Boolean indicating whether (the requested version of) HDF5 is found. + Boolean indicating whether (the requested version of) HDF5 was found. ``HDF5_VERSION`` .. versionadded:: 3.3 diff --git a/Modules/FindHSPELL.cmake b/Modules/FindHSPELL.cmake index dab21cd127..d759216fc3 100644 --- a/Modules/FindHSPELL.cmake +++ b/Modules/FindHSPELL.cmake @@ -17,7 +17,7 @@ Result Variables This module defines the following variables: ``HSPELL_FOUND`` - Boolean indicating whether (the requested version of) Hspell is found. + Boolean indicating whether (the requested version of) Hspell was found. ``HSPELL_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindHg.cmake b/Modules/FindHg.cmake index 1c04f0b788..06fe7dcbac 100644 --- a/Modules/FindHg.cmake +++ b/Modules/FindHg.cmake @@ -18,9 +18,10 @@ Result Variables This module defines the following variables: ``Hg_FOUND`` - Boolean indicating whether (the requested version of) Mercurial client is - found. For backward compatibility, the ``HG_FOUND`` variable is also set - to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Mercurial client was + found. ``Hg_VERSION`` .. versionadded:: 4.2 @@ -65,10 +66,19 @@ Deprecated Variables The following variables are provided for backward compatibility: +``HG_FOUND`` + .. deprecated:: 4.2 + Use ``Hg_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Mercurial client was + found. + ``HG_VERSION_STRING`` .. deprecated:: 4.2 Use ``Hg_VERSION``, which has the same value. + The version of Mercurial found. + Examples ^^^^^^^^ diff --git a/Modules/FindIce.cmake b/Modules/FindIce.cmake index aec8485560..a0be791926 100644 --- a/Modules/FindIce.cmake +++ b/Modules/FindIce.cmake @@ -93,8 +93,8 @@ Result Variables This module defines the following variables: ``Ice_FOUND`` - Boolean indicating whether the main programs, libraries and all requested - components for using Ice were found. + Boolean indicating whether the (requested version of) main programs, + libraries and all requested components for using Ice were found. ``Ice_VERSION`` The version of Ice release found. @@ -112,7 +112,7 @@ This module defines the following variables: Ice component libraries are stored in: ``Ice__FOUND`` - Boolean indicating whether the specified Ice component is found. The + Boolean indicating whether the specified Ice component was found. The ```` should be written in uppercase. ``Ice__LIBRARIES`` diff --git a/Modules/FindIcotool.cmake b/Modules/FindIcotool.cmake index 2e28642b59..ea9cb043ae 100644 --- a/Modules/FindIcotool.cmake +++ b/Modules/FindIcotool.cmake @@ -18,9 +18,10 @@ Result Variables This module defines the following variables: ``Icotool_FOUND`` - Boolean indicating whether (the requested version of) ``icotool`` has been - found. For backward compatibility, the ``ICOTOOL_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) ``icotool`` was + found. ``Icotool_VERSION`` .. versionadded:: 4.2 @@ -40,6 +41,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``ICOTOOL_FOUND`` + .. deprecated:: 4.2 + Use ``Icotool_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) ``icotool`` was + found. + ``ICOTOOL_VERSION_STRING`` .. deprecated:: 4.2 Use ``Icotool_VERSION``, which has the same value. diff --git a/Modules/FindImageMagick.cmake b/Modules/FindImageMagick.cmake index b72755b90b..15593280f3 100644 --- a/Modules/FindImageMagick.cmake +++ b/Modules/FindImageMagick.cmake @@ -83,7 +83,7 @@ This module defines the following variables: ``ImageMagick_FOUND`` Boolean indicating whether (the requested version of) ImageMagick and all - its requested components are found. + its requested components were found. ``ImageMagick_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindIntl.cmake b/Modules/FindIntl.cmake index 4b0808a2b0..7fd0afd371 100644 --- a/Modules/FindIntl.cmake +++ b/Modules/FindIntl.cmake @@ -34,7 +34,7 @@ Result Variables This module defines the following variables: ``Intl_FOUND`` - Boolean indicating whether (the requested version of) Intl is found. + Boolean indicating whether (the requested version of) Intl was found. ``Intl_VERSION`` .. versionadded:: 3.21 diff --git a/Modules/FindJNI.cmake b/Modules/FindJNI.cmake index 477ff7a159..ff865a0d66 100644 --- a/Modules/FindJNI.cmake +++ b/Modules/FindJNI.cmake @@ -99,12 +99,12 @@ Result Variables This module defines the following variables: ``JNI_FOUND`` - Boolean indicating whether the JNI is found. + Boolean indicating whether (the requested version of) JNI was found. ``JNI__FOUND`` .. versionadded:: 3.24 - Boolean indicating whether the ```` is found. + Boolean indicating whether the ```` was found. ``JNI_VERSION`` Full Android NDK package version (including suffixes such as ``-beta3`` and diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake index b44612f73c..c5687ea945 100644 --- a/Modules/FindJPEG.cmake +++ b/Modules/FindJPEG.cmake @@ -31,7 +31,8 @@ Result Variables This module defines the following variables: ``JPEG_FOUND`` - Boolean indicating whether (the requested version of) JPEG library is found. + Boolean indicating whether the (requested version of) JPEG library was + found. ``JPEG_VERSION`` .. versionadded:: 3.12 diff --git a/Modules/FindJasper.cmake b/Modules/FindJasper.cmake index 6fed81b600..a19179c002 100644 --- a/Modules/FindJasper.cmake +++ b/Modules/FindJasper.cmake @@ -29,9 +29,9 @@ Result Variables This module defines the following variables: ``Jasper_FOUND`` - Boolean indicating whether (the requested version of) JasPer is found. - For backward compatibility, the ``JASPER_FOUND`` variable is also set to - the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) JasPer was found. ``Jasper_VERSION`` .. versionadded:: 4.2 @@ -66,6 +66,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``JASPER_FOUND`` + .. deprecated:: 4.2 + Use ``Jasper_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) JasPer was found. + ``JASPER_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Jasper_VERSION``. diff --git a/Modules/FindJava.cmake b/Modules/FindJava.cmake index acd624f598..09e9fd7a7a 100644 --- a/Modules/FindJava.cmake +++ b/Modules/FindJava.cmake @@ -55,10 +55,13 @@ Result Variables This module defines the following variables: ``Java_FOUND`` - Boolean indicating whether Java with all specified components is found. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Java with all + specified components was found. ``Java__FOUND`` - Boolean indicating whether the ```` is found. + Boolean indicating whether the ```` was found. ``Java_VERSION`` Version of Java found. This is set to: diff --git a/Modules/FindKDE3.cmake b/Modules/FindKDE3.cmake index 438c0b0649..bc6b0e420e 100644 --- a/Modules/FindKDE3.cmake +++ b/Modules/FindKDE3.cmake @@ -29,7 +29,7 @@ Result Variables This module defines the following variables: ``KDE3_FOUND`` - Boolean indicating whether KDE 3 is found. + Boolean indicating whether KDE 3 was found. ``KDE3_DEFINITIONS`` Compiler definitions required for compiling KDE 3 software. ``KDE3_INCLUDE_DIRS`` diff --git a/Modules/FindLAPACK.cmake b/Modules/FindLAPACK.cmake index 5733ec8c79..d4486f2b57 100644 --- a/Modules/FindLAPACK.cmake +++ b/Modules/FindLAPACK.cmake @@ -34,7 +34,7 @@ This module defines the following variables: ``LAPACK_FOUND`` Boolean indicating whether the library implementing the LAPACK interface - is found. + was found. ``LAPACK_LINKER_FLAGS`` Uncached list of required linker flags (excluding ``-l`` and ``-L``). ``LAPACK_LIBRARIES`` @@ -45,7 +45,7 @@ This module defines the following variables: LAPACK95. ``LAPACK95_FOUND`` Boolean indicating whether the library implementing the LAPACK95 interface - is found. + was found. Input Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindLATEX.cmake b/Modules/FindLATEX.cmake index 613898495e..e49a0ccd0d 100644 --- a/Modules/FindLATEX.cmake +++ b/Modules/FindLATEX.cmake @@ -73,10 +73,10 @@ This module defines the following variables: ``LATEX_FOUND`` Boolean indicating whether the LaTex compiler and all its required components - are found. + were found. ``LATEX__FOUND`` - Boolean indicating whether the LaTeX ```` is found. + Boolean indicating whether the LaTeX ```` was found. Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindLTTngUST.cmake b/Modules/FindLTTngUST.cmake index 6ca7b8527c..6d024bc0c5 100644 --- a/Modules/FindLTTngUST.cmake +++ b/Modules/FindLTTngUST.cmake @@ -29,8 +29,8 @@ Result Variables This module defines the following variables: ``LTTngUST_FOUND`` - Boolean indicating whether the LTTng-UST library is found. For backward - compatibility, the ``LTTNGUST_FOUND`` variable is also set to the same value. + Boolean indicating whether the (requested version of) LTTng-UST library + was found. ``LTTngUST_VERSION`` .. versionadded:: 4.2 @@ -58,6 +58,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LTTNGUST_FOUND`` + .. deprecated:: 4.2 + Use ``LTTngUST_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) LTTng-UST library + was found. + ``LTTNGUST_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``LTTngUST_VERSION``. diff --git a/Modules/FindLibLZMA.cmake b/Modules/FindLibLZMA.cmake index 38ff888de3..4a39d2ca28 100644 --- a/Modules/FindLibLZMA.cmake +++ b/Modules/FindLibLZMA.cmake @@ -29,9 +29,9 @@ Result Variables This module defines the following variables: ``LibLZMA_FOUND`` - Boolean indicating whether (the requested version of) liblzma is found. - For backward compatibility, the ``LIBLZMA_FOUND`` variable is also set to - the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) liblzma was found. ``LibLZMA_VERSION`` .. versionadded:: 4.2 @@ -66,6 +66,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LIBLZMA_FOUND`` + .. deprecated:: 4.2 + Use ``LibLZMA_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) liblzma was found. + ``LIBLZMA_VERSION`` .. versionadded:: 3.26 .. deprecated:: 4.2 diff --git a/Modules/FindLibXml2.cmake b/Modules/FindLibXml2.cmake index ea19e8ed10..67d20e4244 100644 --- a/Modules/FindLibXml2.cmake +++ b/Modules/FindLibXml2.cmake @@ -34,7 +34,9 @@ Result Variables This module defines the following variables: ``LibXml2_FOUND`` - Boolean indicating whether (the requested version of) libxml2 library is + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) libxml2 library was found. ``LibXml2_VERSION`` @@ -70,6 +72,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LIBXML2_FOUND`` + .. deprecated:: 4.2 + Use ``LibXml2_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) libxml2 library was + found. + ``LIBXML2_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``LibXml2_VERSION``. diff --git a/Modules/FindLibXslt.cmake b/Modules/FindLibXslt.cmake index 9ea13f0f32..c102e93f62 100644 --- a/Modules/FindLibXslt.cmake +++ b/Modules/FindLibXslt.cmake @@ -40,9 +40,9 @@ Result Variables This module defines the following variables: ``LibXslt_FOUND`` - Boolean indicating whether (the requested version of) libxslt is found. - For backward compatibility, the ``LIBXSLT_FOUND`` variable is also set to - the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) libxslt was found. ``LibXslt_VERSION`` .. versionadded:: 4.2 @@ -82,6 +82,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LIBXSLT_FOUND`` + .. deprecated:: 4.2 + Use ``LibXslt_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) libxslt was found. + ``LIBXSLT_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``LibXslt_VERSION``. diff --git a/Modules/FindLibinput.cmake b/Modules/FindLibinput.cmake index fdfa2cb28a..5c420e9ed0 100644 --- a/Modules/FindLibinput.cmake +++ b/Modules/FindLibinput.cmake @@ -29,7 +29,7 @@ Result Variables This module defines the following variables: ``Libinput_FOUND`` - Boolean indicating whether the (requested version of) libinput library is + Boolean indicating whether the (requested version of) libinput library was found. ``Libinput_VERSION`` The version of the libinput found. diff --git a/Modules/FindLua.cmake b/Modules/FindLua.cmake index 720981d06c..33fd8fde9f 100644 --- a/Modules/FindLua.cmake +++ b/Modules/FindLua.cmake @@ -38,9 +38,9 @@ Result Variables This module defines the following variables: ``Lua_FOUND`` - Boolean indicating whether (the requested version of) Lua is found. For - backward compatibility, the ``LUA_FOUND`` variable is also set to the same - value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Lua was found. ``Lua_VERSION`` .. versionadded:: 4.2 @@ -80,6 +80,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LUA_FOUND`` + .. deprecated:: 4.2 + Use ``Lua_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Lua was found. + ``LUA_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Lua_VERSION``. diff --git a/Modules/FindLua50.cmake b/Modules/FindLua50.cmake index b512d37bbe..1979f30a83 100644 --- a/Modules/FindLua50.cmake +++ b/Modules/FindLua50.cmake @@ -41,8 +41,9 @@ Result Variables This module defines the following variables: ``Lua50_FOUND`` - Boolean indicating whether Lua is found. For backward compatibility, the - ``LUA50_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Lua was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -57,6 +58,17 @@ The following cache variables may also be set: Libraries needed to link against to use Lua. This list includes both ``lua`` and ``lualib`` libraries. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``LUA50_FOUND`` + .. deprecated:: 4.2 + Use ``Lua50_FOUND``, which has the same value. + + Boolean indicating whether Lua was found. + Examples ^^^^^^^^ diff --git a/Modules/FindLua51.cmake b/Modules/FindLua51.cmake index 8f105ed933..d5edeb0970 100644 --- a/Modules/FindLua51.cmake +++ b/Modules/FindLua51.cmake @@ -41,9 +41,9 @@ Result Variables This module defines the following variables: ``Lua51_FOUND`` - Boolean indicating whether (the requested version of) Lua is found. For - backward compatibility, the ``LUA51_FOUND`` variable is also set to the - same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Lua was found. ``Lua_VERSION`` .. versionadded:: 4.2 @@ -67,6 +67,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``LUA51_FOUND`` + .. deprecated:: 4.2 + Use ``Lua51_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Lua was found. + ``LUA_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Lua_VERSION``. diff --git a/Modules/FindMFC.cmake b/Modules/FindMFC.cmake index 70f73fb257..77adebf2ce 100644 --- a/Modules/FindMFC.cmake +++ b/Modules/FindMFC.cmake @@ -26,7 +26,7 @@ Result Variables This module defines the following variables: ``MFC_FOUND`` - Boolean indicating whether MFC support is found. + Boolean indicating whether MFC support was found. Examples ^^^^^^^^ diff --git a/Modules/FindMPEG.cmake b/Modules/FindMPEG.cmake index a84c9b4586..824ae14a80 100644 --- a/Modules/FindMPEG.cmake +++ b/Modules/FindMPEG.cmake @@ -28,7 +28,7 @@ Result Variables This module defines the following variables: ``MPEG_FOUND`` - Boolean indicating whether the libmpeg2 library is found. + Boolean indicating whether the libmpeg2 library was found. ``MPEG_LIBRARIES`` Libraries needed to link against to use libmpeg2. diff --git a/Modules/FindMPEG2.cmake b/Modules/FindMPEG2.cmake index 9ffd0dfa73..2e647bac92 100644 --- a/Modules/FindMPEG2.cmake +++ b/Modules/FindMPEG2.cmake @@ -23,7 +23,7 @@ Result Variables This module defines the following variables: ``MPEG2_FOUND`` - Boolean indicating whether the libmpeg2 library is found. + Boolean indicating whether the libmpeg2 library was found. ``MPEG2_LIBRARIES`` Libraries needed to link against to use libmpeg2. diff --git a/Modules/FindMPI.cmake b/Modules/FindMPI.cmake index afc322cb5b..ebfd79fe3e 100644 --- a/Modules/FindMPI.cmake +++ b/Modules/FindMPI.cmake @@ -75,10 +75,11 @@ Result Variables This module defines the following variables: ``MPI_FOUND`` - Boolean variable indicating that MPI settings for all requested components - (languages) have been found. If no components are specified, this is - true if MPI settings for all enabled languages were detected. Note that - the ``MPICXX`` component does not affect this variable. + Boolean indicating that MPI settings for all requested components + (languages) were found. If no components are specified, this variable is + set to boolean true if MPI settings for all enabled languages were + detected. Note that the ``MPICXX`` component does not affect this + variable. ``MPI_VERSION`` Minimal version of MPI detected among the requested languages, or all @@ -88,8 +89,8 @@ This module will set the following variables per language in CMake project, where ```` is one of C, CXX, or Fortran: ``MPI__FOUND`` - Boolean variable indicating the MPI settings for ```` were found - and that simple MPI test programs compile with the provided settings. + Boolean indicating the MPI settings for ```` were found and that + simple MPI test programs compile with the provided settings. ``MPI__COMPILER`` MPI compiler for ```` if such a program exists. @@ -115,8 +116,8 @@ The following variables indicating which bindings are present will be defined: ``MPI_MPICXX_FOUND`` - Boolean variable indicating whether the MPI-2 C++ bindings are present - (introduced in MPI-2, removed with MPI-3). + Boolean indicating whether the MPI-2 C++ bindings are present (introduced + in MPI-2, removed with MPI-3). ``MPI_Fortran_HAVE_F77_HEADER`` True if the Fortran 77 header ```` is available. diff --git a/Modules/FindMatlab.cmake b/Modules/FindMatlab.cmake index 487ba4050c..8acc6f38fc 100644 --- a/Modules/FindMatlab.cmake +++ b/Modules/FindMatlab.cmake @@ -152,8 +152,11 @@ Result variables """""""""""""""" ``Matlab_FOUND`` - ``TRUE`` if the Matlab installation is found, ``FALSE`` - otherwise. All variable below are defined if Matlab is found. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Matlab installation + was found. All variables below are defined if Matlab is found. + ``Matlab_VERSION`` .. versionadded:: 3.27 diff --git a/Modules/FindMotif.cmake b/Modules/FindMotif.cmake index e68ed73452..1ce164c157 100644 --- a/Modules/FindMotif.cmake +++ b/Modules/FindMotif.cmake @@ -17,8 +17,9 @@ Result Variables This module defines the following variables: ``Motif_FOUND`` - Boolean indicating whether the Motif was found. For backward compatibility, - the ``MOTIF_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Motif was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -31,6 +32,17 @@ The following cache variables may also be set: ``MOTIF_LIBRARIES`` Libraries needed to link to Motif. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``MOTIF_FOUND`` + .. deprecated:: 4.2 + Use ``Motif_FOUND``, which has the same value. + + Boolean indicating whether Motif was found. + Examples ^^^^^^^^ diff --git a/Modules/FindODBC.cmake b/Modules/FindODBC.cmake index bcb9cd3bba..e8692bd219 100644 --- a/Modules/FindODBC.cmake +++ b/Modules/FindODBC.cmake @@ -41,7 +41,7 @@ Result Variables This module defines the following variables: ``ODBC_FOUND`` - Boolean indicating whether ODBC is found. + Boolean indicating whether ODBC was found. ``ODBC_INCLUDE_DIRS`` Include directories containing headers needed to use ODBC. diff --git a/Modules/FindOpenACC.cmake b/Modules/FindOpenACC.cmake index 84c7bf023a..efecb6a946 100644 --- a/Modules/FindOpenACC.cmake +++ b/Modules/FindOpenACC.cmake @@ -37,14 +37,15 @@ This module defines the following variables: ``OpenACC_FOUND`` .. versionadded:: 3.25 - Boolean variable indicating that OpenACC flags for at least one languages - have been found. + Boolean indicating that OpenACC flags for at least one language were + found. This module will set the following variables per language in the project, where ```` is one of C, CXX, or Fortran: ``OpenACC__FOUND`` - Boolean variable indicating if OpenACC support for ```` was detected. + Boolean indicating whether OpenACC support for language ```` was + detected. ``OpenACC__FLAGS`` OpenACC compiler flags for ````, separated by spaces. ``OpenACC__OPTIONS`` diff --git a/Modules/FindOpenAL.cmake b/Modules/FindOpenAL.cmake index fa4c8bfd35..4181482892 100644 --- a/Modules/FindOpenAL.cmake +++ b/Modules/FindOpenAL.cmake @@ -38,8 +38,10 @@ Result Variables This module defines the following variables: ``OpenAL_FOUND`` - Boolean indicating whether the OpenAL is found. For backward compatibility, - the ``OPENAL_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) OpenAL was found. + ``OPENAL_VERSION_STRING`` Human-readable string containing the version of OpenAL found. @@ -53,6 +55,17 @@ The following cache variables may also be set: ``OPENAL_LIBRARY`` The path to the OpenAL library. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OPENAL_FOUND`` + .. deprecated:: 4.2 + Use ``OpenAL_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) OpenAL was found. + Hints ^^^^^ diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index b32bbccffb..da010720d5 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -125,38 +125,38 @@ This module defines the following variables: ``OpenGL_FOUND`` .. versionadded:: 3.3 - Boolean indicating whether the OpenGL and all requested components are found. + Boolean indicating whether OpenGL and all requested components were found. ``OPENGL_XMESA_FOUND`` - Boolean indicating whether OpenGL XMESA is found. + Boolean indicating whether OpenGL XMESA was found. ``OPENGL_GLU_FOUND`` - Boolean indicating whether GLU is found. + Boolean indicating whether GLU was found. ``OpenGL_OpenGL_FOUND`` .. versionadded:: 3.10 - Boolean indicating whether GLVND OpenGL library is found. + Boolean indicating whether the GLVND OpenGL library was found. ``OpenGL_GLX_FOUND`` .. versionadded:: 3.10 - Boolean indicating whether GLVND GLX is found. + Boolean indicating whether GLVND GLX was found. ``OpenGL_EGL_FOUND`` .. versionadded:: 3.10 - Boolean indicating whether GLVND EGL is found. + Boolean indicating whether GLVND EGL was found. ``OpenGL_GLES2_FOUND`` .. versionadded:: 3.27 - Boolean indicating whether GLES2 is found. + Boolean indicating whether GLES2 was found. ``OpenGL_GLES3_FOUND`` .. versionadded:: 3.27 - Boolean indicating whether GLES3 is found. + Boolean indicating whether GLES3 was found. ``OPENGL_INCLUDE_DIRS`` .. versionadded:: 3.29 @@ -301,8 +301,10 @@ Deprecated Variables The following variables are provided for backward compatibility: ``OPENGL_FOUND`` - .. deprecated:: 3.3 - Superseded by the ``OpenGL_FOUND``, which has the same value. + .. deprecated:: 4.2 + Use ``OpenGL_FOUND``, which has the same value. + + Boolean indicating whether OpenGL and all requested components were found. Examples ^^^^^^^^ diff --git a/Modules/FindOpenMP.cmake b/Modules/FindOpenMP.cmake index 9fd9e09a65..46ab90509d 100644 --- a/Modules/FindOpenMP.cmake +++ b/Modules/FindOpenMP.cmake @@ -78,9 +78,12 @@ Result Variables This module defines the following variables: ``OpenMP_FOUND`` - Boolean variable indicating that OpenMP flags for all requested languages - have been found. If no components are specified, this is true if OpenMP - settings for all enabled languages were detected. + .. versionadded:: 3.10 + + Boolean indicating that OpenMP flags for all requested languages were + found. If no components are specified, this variable is set to boolean + true if OpenMP settings for all enabled languages were detected. + ``OpenMP_VERSION`` Minimal version of the OpenMP standard detected among the requested languages, or all enabled languages if no components were specified. diff --git a/Modules/FindOpenSSL.cmake b/Modules/FindOpenSSL.cmake index f04d34ecef..458eac3fd2 100644 --- a/Modules/FindOpenSSL.cmake +++ b/Modules/FindOpenSSL.cmake @@ -99,9 +99,10 @@ Result Variables This module defines the following variables: ``OpenSSL_FOUND`` - Boolean indicating whether (the requested version of) OpenSSL library has - been found. For backward compatibility, the ``OPENSSL_FOUND`` variableđ - is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) OpenSSL library was + found. ``OpenSSL_VERSION`` .. versionadded:: 4.2 @@ -162,6 +163,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``OPENSSL_FOUND`` + .. deprecated:: 4.2 + Use ``OpenSSL_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) OpenSSL library was + found. + ``OPENSSL_VERSION`` .. deprecated:: 4.2 Superseded by the ``OpenSSL_VERSION``. diff --git a/Modules/FindOpenSceneGraph.cmake b/Modules/FindOpenSceneGraph.cmake index 5cd0d16bef..4bcedc0333 100644 --- a/Modules/FindOpenSceneGraph.cmake +++ b/Modules/FindOpenSceneGraph.cmake @@ -157,9 +157,10 @@ Result Variables This module defines the following variables: ``OpenSceneGraph_FOUND`` - Boolean indicating whether (the requested version of) OpenSceneGraph with all - specified components is found. For backward compatibility, the - ``OPENSCENEGRAPH_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) OpenSceneGraph with + all specified components was found. ``OpenSceneGraph_VERSION`` .. versionadded:: 4.2 @@ -208,6 +209,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``OPENSCENEGRAPH_FOUND`` + .. deprecated:: 4.2 + Use ``OpenSceneGraph_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) OpenSceneGraph with + all specified components was found. + ``OPENSCENEGRAPH_VERSION`` .. deprecated:: 4.2 Superseded by the ``OpenSceneGraph_VERSION``. diff --git a/Modules/FindOpenThreads.cmake b/Modules/FindOpenThreads.cmake index 91d4b06c03..5e01ac21b0 100644 --- a/Modules/FindOpenThreads.cmake +++ b/Modules/FindOpenThreads.cmake @@ -24,9 +24,9 @@ Result Variables This module defines the following variables: ``OpenThreads_FOUND`` - Boolean indicating whether OpenThreads library is found. For backward - compatibility, the ``OPENTHREADS_FOUND`` variable is also set to the same - value. + .. versionadded:: 3.3 + + Boolean indicating whether the OpenThreads library was found. ``OPENTHREADS_LIBRARY`` Libraries needed to link against to use OpenThreads. This provides either @@ -71,6 +71,17 @@ OpenSceneGraph, this module also honors the following variables for convenience: ``OSGDIR`` Environment variable treated the same as ``OPENTHREADS_DIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OPENTHREADS_FOUND`` + .. deprecated:: 4.2 + Use ``OpenThreads_FOUND``, which has the same value. + + Boolean indicating whether the OpenThreads library was found. + Examples ^^^^^^^^ diff --git a/Modules/FindPHP4.cmake b/Modules/FindPHP4.cmake index 4a8862c90d..46509fed52 100644 --- a/Modules/FindPHP4.cmake +++ b/Modules/FindPHP4.cmake @@ -19,6 +19,14 @@ Finds PHP version 4, a general-purpose scripting language: This module checks if PHP 4 is installed and determines the locations of the include directories and the PHP command-line interpreter. +Result Variables +^^^^^^^^^^^^^^^^ + +This module defines the following variables: + +``PHP4_FOUND`` + Boolean indicating whether PHP 4 was found. + Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindPNG.cmake b/Modules/FindPNG.cmake index a95452754a..f7d5eb9a6b 100644 --- a/Modules/FindPNG.cmake +++ b/Modules/FindPNG.cmake @@ -33,7 +33,7 @@ Result Variables This module defines the following variables: ``PNG_FOUND`` - Boolean indicating whether (the requested version of) PNG library is found. + Boolean indicating whether the (requested version of) PNG library was found. ``PNG_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindPatch.cmake b/Modules/FindPatch.cmake index 63099010e6..cb81b6fd67 100644 --- a/Modules/FindPatch.cmake +++ b/Modules/FindPatch.cmake @@ -33,7 +33,7 @@ Result Variables This module defines the following variables: ``Patch_FOUND`` - Boolean indicating whether the ``patch`` command-line executable is found. + Boolean indicating whether the ``patch`` command-line executable was found. Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindPerl.cmake b/Modules/FindPerl.cmake index b1c4f51121..1214a18a63 100644 --- a/Modules/FindPerl.cmake +++ b/Modules/FindPerl.cmake @@ -19,9 +19,10 @@ Result Variables This module defines the following variables: ``Perl_FOUND`` - Boolean indicating whether the (requested version of) Perl executable is - found. For backward compatibility, the ``PERL_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Perl executable was + found. ``Perl_VERSION`` .. versionadded:: 4.2 @@ -41,6 +42,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``PERL_FOUND`` + .. deprecated:: 4.2 + Use ``Perl_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Perl executable was + found. + ``PERL_VERSION_STRING`` .. deprecated:: 4.2 Superseded by the ``Perl_VERSION``. diff --git a/Modules/FindPerlLibs.cmake b/Modules/FindPerlLibs.cmake index ab6b33300e..fbe1aade72 100644 --- a/Modules/FindPerlLibs.cmake +++ b/Modules/FindPerlLibs.cmake @@ -23,9 +23,10 @@ Result Variables This module defines the following variables: ``PerlLibs_FOUND`` - Boolean indicating whether the (requested version of) Perl library - (``perl.h`` and ``libperl``) is found. For backward compatibility, the - ``PERLLIBS_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) ```` and + ``libperl`` were found. ``PerlLibs_VERSION`` .. versionadded:: 4.2 @@ -65,6 +66,18 @@ The following cache variables may also be set: ``PERL_EXECUTABLE`` Full path to the ``perl`` executable. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``PERLLIBS_FOUND`` + .. deprecated:: 4.2 + Use ``PerlLibs_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) ```` and + ``libperl`` were found. + Examples ^^^^^^^^ diff --git a/Modules/FindPhysFS.cmake b/Modules/FindPhysFS.cmake index fae44218b4..6031d17bf9 100644 --- a/Modules/FindPhysFS.cmake +++ b/Modules/FindPhysFS.cmake @@ -17,8 +17,9 @@ Result Variables This module defines the following variables: ``PhysFS_FOUND`` - Boolean indicating whether PhysicsFS library is found. For backward - compatibility, the ``PHYSFS_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the PhysicsFS library was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -42,6 +43,17 @@ This module accepts the following variables: destination that was used when configuring, building, and installing PhysicsFS library: ``./configure --prefix=$PHYSFSDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``PHYSFS_FOUND`` + .. deprecated:: 4.2 + Use the ``PhysFS_FOUND``, which has the same value. + + Boolean indicating whether the PhysicsFS library was found. + Examples ^^^^^^^^ diff --git a/Modules/FindPkgConfig.cmake b/Modules/FindPkgConfig.cmake index 70b4a61972..924284a46e 100644 --- a/Modules/FindPkgConfig.cmake +++ b/Modules/FindPkgConfig.cmake @@ -30,7 +30,7 @@ This module defines the following variables: .. versionadded:: 3.3 Boolean indicating whether the (requested version of) ``pkg-config`` - executable is found. + executable was found. ``PkgConfig_VERSION`` .. versionadded:: 4.2 @@ -342,7 +342,7 @@ The following variables are provided for backward compatibility: Use ``PkgConfig_FOUND``, which has the same value. Boolean indicating whether the (requested version of) ``pkg-config`` - executable is found. + executable was found. ``PKG_CONFIG_VERSION_STRING`` .. deprecated:: 4.2 diff --git a/Modules/FindPostgreSQL.cmake b/Modules/FindPostgreSQL.cmake index 11368d3510..fccc000f3e 100644 --- a/Modules/FindPostgreSQL.cmake +++ b/Modules/FindPostgreSQL.cmake @@ -31,7 +31,7 @@ This module defines the following variables: ``PostgreSQL_FOUND`` Boolean indicating whether the minimum required version and components of - PostgreSQL have been found. + PostgreSQL were found. ``PostgreSQL_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindProducer.cmake b/Modules/FindProducer.cmake index 1400c2aa55..7fbd837344 100644 --- a/Modules/FindProducer.cmake +++ b/Modules/FindProducer.cmake @@ -35,8 +35,9 @@ Result Variables This module defines the following variables: ``Producer_FOUND`` - Boolean indicating whether Producer is found. For backward compatibility, the - ``PRODUCER_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether Producer was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -72,6 +73,17 @@ multiple OpenSceneGraph-related libraries at once: ``OSG_DIR`` Environment variable treated the same as ``PRODUCER_DIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``PRODUCER_FOUND`` + .. deprecated:: 4.2 + Use ``Producer_FOUND``, which has the same value. + + Boolean indicating whether Producer was found. + Examples ^^^^^^^^ diff --git a/Modules/FindProtobuf.cmake b/Modules/FindProtobuf.cmake index 4402afa43a..62baba1deb 100644 --- a/Modules/FindProtobuf.cmake +++ b/Modules/FindProtobuf.cmake @@ -78,8 +78,11 @@ Result Variables This module defines the following variables: ``Protobuf_FOUND`` - Boolean indicating whether (the requested version of) Protobuf library is - found. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Protobuf library + was found. + ``Protobuf_VERSION`` .. versionadded:: 3.6 diff --git a/Modules/FindPython.cmake b/Modules/FindPython.cmake index be155579fb..46a8cbbbf2 100644 --- a/Modules/FindPython.cmake +++ b/Modules/FindPython.cmake @@ -155,9 +155,9 @@ This module defines the following variables (see :ref:`Standard Variable Names `): ``Python_FOUND`` - System has the Python requested components. + Boolean indicating whether system has the Python requested components. ``Python_Interpreter_FOUND`` - System has the Python interpreter. + Boolean indicating whether system has the Python interpreter. ``Python_EXECUTABLE`` Path to the Python interpreter. ``Python_EXECUTABLE_DEBUG`` @@ -219,7 +219,7 @@ This module defines the following variables string. ``Python_Compiler_FOUND`` - System has the Python compiler. + Boolean indicating whether system has the Python compiler. ``Python_COMPILER`` Path to the Python compiler. Only offered by IronPython. ``Python_COMPILER_ID`` @@ -232,23 +232,25 @@ This module defines the following variables The ``.Net`` interpreter. Only used by ``IronPython`` implementation. ``Python_Development_FOUND`` - System has the Python development artifacts. + Boolean indicating whether system has the Python development artifacts. ``Python_Development.Module_FOUND`` .. versionadded:: 3.18 - System has the Python development artifacts for Python module. + Boolean indicating whether system has the Python development artifacts + for Python module. ``Python_Development.SABIModule_FOUND`` .. versionadded:: 3.26 - System has the Python development artifacts for Python module using the - Stable Application Binary Interface. + Boolean indicating whether system has the Python development artifacts + for Python module using the Stable Application Binary Interface. ``Python_Development.Embed_FOUND`` .. versionadded:: 3.18 - System has the Python development artifacts for Python embedding. + Boolean indicating whether system has the Python development artifacts + for Python embedding. ``Python_INCLUDE_DIRS`` @@ -306,7 +308,7 @@ This module defines the following variables ``Python_NumPy_FOUND`` .. versionadded:: 3.14 - System has the NumPy. + Boolean indicating whether system has the NumPy. ``Python_NumPy_INCLUDE_DIRS`` .. versionadded:: 3.14 diff --git a/Modules/FindPython2.cmake b/Modules/FindPython2.cmake index 26d5794c79..adcfe63de8 100644 --- a/Modules/FindPython2.cmake +++ b/Modules/FindPython2.cmake @@ -142,9 +142,9 @@ This module defines the following variables (see :ref:`Standard Variable Names `): ``Python2_FOUND`` - System has the Python 2 requested components. + Boolean indicating whether system has the Python 2 requested components. ``Python2_Interpreter_FOUND`` - System has the Python 2 interpreter. + Boolean indicating whether system has the Python 2 interpreter. ``Python2_EXECUTABLE`` Path to the Python 2 interpreter. ``Python2_EXECUTABLE_DEBUG`` @@ -190,7 +190,7 @@ This module defines the following variables Information returned by ``sysconfig.get_path('platlib')`` or else ``distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False)``. ``Python2_Compiler_FOUND`` - System has the Python 2 compiler. + Boolean indicating whether system has the Python 2 compiler. ``Python2_COMPILER`` Path to the Python 2 compiler. Only offered by IronPython. ``Python2_COMPILER_ID`` @@ -203,17 +203,19 @@ This module defines the following variables The ``.Net`` interpreter. Only used by ``IronPython`` implementation. ``Python2_Development_FOUND`` - System has the Python 2 development artifacts. + Boolean indicating whether system has the Python 2 development artifacts. ``Python2_Development.Module_FOUND`` .. versionadded:: 3.18 - System has the Python 2 development artifacts for Python module. + Boolean indicating whether system has the Python 2 development artifacts + for Python module. ``Python2_Development.Embed_FOUND`` .. versionadded:: 3.18 - System has the Python 2 development artifacts for Python embedding. + Boolean indicating whether system has the Python 2 development artifacts + for Python embedding. ``Python2_INCLUDE_DIRS`` The Python 2 include directories. @@ -253,7 +255,7 @@ This module defines the following variables ``Python2_NumPy_FOUND`` .. versionadded:: 3.14 - System has the NumPy. + Boolean indicating whether system has the NumPy. ``Python2_NumPy_INCLUDE_DIRS`` .. versionadded:: 3.14 diff --git a/Modules/FindPython3.cmake b/Modules/FindPython3.cmake index aaa6193fe2..ee6715d11c 100644 --- a/Modules/FindPython3.cmake +++ b/Modules/FindPython3.cmake @@ -157,9 +157,9 @@ This module defines the following variables (see :ref:`Standard Variable Names `): ``Python3_FOUND`` - System has the Python 3 requested components. + Boolean indicating whether system has the Python 3 requested components. ``Python3_Interpreter_FOUND`` - System has the Python 3 interpreter. + Boolean indicating whether system has the Python 3 interpreter. ``Python3_EXECUTABLE`` Path to the Python 3 interpreter. ``Python3_EXECUTABLE_DEBUG`` @@ -221,7 +221,7 @@ This module defines the following variables string. ``Python3_Compiler_FOUND`` - System has the Python 3 compiler. + Boolean indicating whether system has the Python 3 compiler. ``Python3_COMPILER`` Path to the Python 3 compiler. Only offered by IronPython. ``Python3_COMPILER_ID`` @@ -235,23 +235,25 @@ This module defines the following variables ``Python3_Development_FOUND`` - System has the Python 3 development artifacts. + Boolean indicating whether system has the Python 3 development artifacts. ``Python3_Development.Module_FOUND`` .. versionadded:: 3.18 - System has the Python 3 development artifacts for Python module. + Boolean indicating whether system has the Python 3 development artifacts + for Python module. ``Python3_Development.SABIModule_FOUND`` .. versionadded:: 3.26 - System has the Python 3 development artifacts for Python module using the - Stable Application Binary Interface. + Boolean indicating whether system has the Python 3 development artifacts + for Python module using the Stable Application Binary Interface. ``Python3_Development.Embed_FOUND`` .. versionadded:: 3.18 - System has the Python 3 development artifacts for Python embedding. + Boolean indicating whether system has the Python 3 development artifacts + for Python embedding. ``Python3_INCLUDE_DIRS`` @@ -309,7 +311,7 @@ This module defines the following variables ``Python3_NumPy_FOUND`` .. versionadded:: 3.14 - System has the NumPy. + Boolean indicating whether system has the NumPy. ``Python3_NumPy_INCLUDE_DIRS`` .. versionadded:: 3.14 diff --git a/Modules/FindPythonInterp.cmake b/Modules/FindPythonInterp.cmake index b924ca61ac..1f09f7f5c0 100644 --- a/Modules/FindPythonInterp.cmake +++ b/Modules/FindPythonInterp.cmake @@ -39,9 +39,11 @@ Result Variables This module defines the following variables: ``PythonInterp_FOUND`` - Boolean indicating whether the (requested version of) Python executable is - found. For backward compatibility, the ``PYTHONINTERP_FOUND`` variable is - also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Python executable + was found. + ``PYTHON_VERSION_STRING`` Python version found (e.g., ``2.5.2``). ``PYTHON_VERSION_MAJOR`` @@ -69,6 +71,18 @@ This module accepts the following variables before calling This variable can be used to specify a list of version numbers that should be taken into account when searching for Python. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``PYTHONINTERP_FOUND`` + .. deprecated:: 3.12 + Use ``PythonInterp_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Python executable + was found. + Examples ^^^^^^^^ diff --git a/Modules/FindPythonLibs.cmake b/Modules/FindPythonLibs.cmake index 00581e1cc1..869c113ca7 100644 --- a/Modules/FindPythonLibs.cmake +++ b/Modules/FindPythonLibs.cmake @@ -34,9 +34,10 @@ Result Variables This module defines the following variables: ``PythonLibs_FOUND`` - Boolean indicating whether the (requested version of) Python libraries have - been found. For backward compatibility, the ``PYTHONLIBS_FOUND`` variable is - also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) Python libraries + were found. ``PYTHONLIBS_VERSION_STRING`` The version of the Python libraries found. @@ -72,7 +73,14 @@ This module accepts the following variables before calling Deprecated Variables ^^^^^^^^^^^^^^^^^^^^ -These variables are provided for backward compatibility: +The following variables are provided for backward compatibility: + +``PYTHONLIBS_FOUND`` + .. deprecated:: 3.12 + Use ``PythonLibs_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Python libraries + were found. ``PYTHON_DEBUG_LIBRARIES`` .. deprecated:: 2.8.8 diff --git a/Modules/FindQt.cmake b/Modules/FindQt.cmake index 0d0d4912a8..9fc83e6279 100644 --- a/Modules/FindQt.cmake +++ b/Modules/FindQt.cmake @@ -39,9 +39,9 @@ Result Variables This module defines the following variables: ``QT4_INSTALLED`` - ``TRUE`` if Qt4 is found. + ``TRUE`` if Qt4 was found. ``QT3_INSTALLED`` - ``TRUE`` if Qt3 is found. + ``TRUE`` if Qt3 was found. Hints ^^^^^ diff --git a/Modules/FindQt3.cmake b/Modules/FindQt3.cmake index 40590026f8..f72261ea0e 100644 --- a/Modules/FindQt3.cmake +++ b/Modules/FindQt3.cmake @@ -26,11 +26,11 @@ This module defines the following variables: ``Qt3_FOUND`` .. versionadded:: 3.3 - Boolean indicating whether (the requested version of) Qt3 is found. + Boolean indicating whether (the requested version of) Qt3 was found. ``QT_FOUND`` Same as ``Qt3_FOUND``. Boolean indicating whether (the requested version - of) Qt3 is found. This variable is provided for compatibility with other + of) Qt3 was found. This variable is provided for compatibility with other Qt find modules. ``Qt3_VERSION`` diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake index a38fd937c1..4951175606 100644 --- a/Modules/FindQt4.cmake +++ b/Modules/FindQt4.cmake @@ -127,11 +127,11 @@ Result Variables This module defines the following variables: ``Qt4_FOUND`` - Boolean indicating whether (the requested version of) Qt4 is found. + Boolean indicating whether (the requested version of) Qt4 was found. ``QT_FOUND`` Same as ``Qt4_FOUND``. Boolean indicating whether (the requested version - of) Qt4 is found. This variable is available for compatibility with + of) Qt4 was found. This variable is available for compatibility with other Qt find modules. ``QT_VERSION_MAJOR`` diff --git a/Modules/FindQuickTime.cmake b/Modules/FindQuickTime.cmake index 55d98d3489..640efa0fa2 100644 --- a/Modules/FindQuickTime.cmake +++ b/Modules/FindQuickTime.cmake @@ -24,8 +24,9 @@ Result Variables This module defines the following variables: ``QuickTime_FOUND`` - Boolean indicating whether the QuickTime is found. For backward - compatibility, the ``QUICKTIME_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether QuickTime was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -49,6 +50,17 @@ This module accepts the following variables: destination that was used when configuring, building, and installing QuickTime library: ``./configure --prefix=$QUICKTIME_DIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``QUICKTIME_FOUND`` + .. deprecated:: 4.2 + Use ``QuickTime_FOUND``, which has the same value. + + Boolean indicating whether QuickTime was found. + Examples ^^^^^^^^ diff --git a/Modules/FindRTI.cmake b/Modules/FindRTI.cmake index 87c97c3b4b..aad4c20ce7 100644 --- a/Modules/FindRTI.cmake +++ b/Modules/FindRTI.cmake @@ -23,7 +23,7 @@ Result Variables This module defines the following variables: ``RTI_FOUND`` - Boolean indicating whether HLA RTI is found. + Boolean indicating whether HLA RTI was found. ``RTI_LIBRARIES`` The libraries to link against to use RTI. ``RTI_DEFINITIONS`` diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index 166727100e..0ede27a738 100644 --- a/Modules/FindRuby.cmake +++ b/Modules/FindRuby.cmake @@ -21,7 +21,9 @@ Result Variables This module defines the following variables: ``Ruby_FOUND`` - Boolean indicating whether (the requested version of) ruby is found. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) ruby was found. ``Ruby_VERSION`` The version of ruby which was found, e.g. ``3.2.6``. diff --git a/Modules/FindSDL.cmake b/Modules/FindSDL.cmake index a47e8c1c06..5bd34bb642 100644 --- a/Modules/FindSDL.cmake +++ b/Modules/FindSDL.cmake @@ -51,7 +51,7 @@ Result Variables This module defines the following variables: ``SDL_FOUND`` - Boolean indicating whether the (requested version of) SDL is found. + Boolean indicating whether (the requested version of) SDL was found. ``SDL_VERSION`` .. versionadded:: 3.19 diff --git a/Modules/FindSDL_gfx.cmake b/Modules/FindSDL_gfx.cmake index e4cadc8821..04a32b6e54 100644 --- a/Modules/FindSDL_gfx.cmake +++ b/Modules/FindSDL_gfx.cmake @@ -34,9 +34,8 @@ Result Variables This module defines the following variables: ``SDL_gfx_FOUND`` - Boolean indicating whether (the requested version of) SDL_gfx library is - found. For backward compatibility, the ``SDL_GFX_FOUND`` variable is also set - to the same value. + Boolean indicating whether the (requested version of) SDL_gfx library was + found. ``SDL_gfx_VERSION`` .. versionadded:: 4.2 @@ -70,6 +69,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``SDL_GFX_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_gfx_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) SDL_gfx library was + found. + ``SDL_GFX_VERSION_STRING`` .. deprecated:: 4.2 Use the ``SDL_gfx_VERSION``. diff --git a/Modules/FindSDL_image.cmake b/Modules/FindSDL_image.cmake index 395c128dd8..404d5aa459 100644 --- a/Modules/FindSDL_image.cmake +++ b/Modules/FindSDL_image.cmake @@ -27,9 +27,10 @@ Result Variables This module defines the following variables: ``SDL_image_FOUND`` - Boolean indicating whether the (requested version of) SDL_image library is - found. For backward compatibility, the ``SDL_IMAGE_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) SDL_image library + was found. ``SDL_image_VERSION`` .. versionadded:: 4.2 @@ -60,21 +61,25 @@ The following variables are provided for backward compatibility: ``SDL_IMAGE_VERSION_STRING`` .. deprecated:: 4.2 - Use the ``SDL_image_VERSION``. + Use ``SDL_image_VERSION``, which has the same value. The human-readable string containing the version of SDL_image found. +``SDL_IMAGE_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_image_FOUND``, which has the same value. + ``SDLIMAGE_FOUND`` .. deprecated:: 2.8.10 - Use the ``SDL_image_FOUND``, which has the same value. + Use ``SDL_image_FOUND``, which has the same value. ``SDLIMAGE_INCLUDE_DIR`` .. deprecated:: 2.8.10 - Use the ``SDL_IMAGE_INCLUDE_DIRS``, which has the same value. + Use ``SDL_IMAGE_INCLUDE_DIRS``, which has the same value. ``SDLIMAGE_LIBRARY`` .. deprecated:: 2.8.10 - Use the ``SDL_IMAGE_LIBRARIES``, which has the same value. + Use ``SDL_IMAGE_LIBRARIES``, which has the same value. Examples ^^^^^^^^ diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake index 00dbb174a6..7bfbc4f492 100644 --- a/Modules/FindSDL_mixer.cmake +++ b/Modules/FindSDL_mixer.cmake @@ -26,9 +26,10 @@ Result Variables This module defines the following variables: ``SDL_mixer_FOUND`` - Boolean indicating whether the (requested version of) SDL_mixer library is - found. For backward compatibility, the ``SDL_MIXER_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) SDL_mixer library + was found. ``SDL_mixer_VERSION`` .. versionadded:: 4.2 @@ -59,10 +60,14 @@ The following variables are provided for backward compatibility: ``SDL_MIXER_VERSION_STRING`` .. deprecated:: 4.2 - Use the ``SDL_mixer_VERSION``. + Use ``SDL_mixer_VERSION``, which has the same value. The human-readable string containing the version of SDL_mixer found. +``SDL_MIXER_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_mixer_FOUND``, which has the same value. + ``SDLMIXER_FOUND`` .. deprecated:: 2.8.10 Use ``SDL_mixer_FOUND``, which has the same value. diff --git a/Modules/FindSDL_net.cmake b/Modules/FindSDL_net.cmake index 5d3694527b..6a56d9f2dc 100644 --- a/Modules/FindSDL_net.cmake +++ b/Modules/FindSDL_net.cmake @@ -26,9 +26,10 @@ Result Variables This module defines the following variables: ``SDL_net_FOUND`` - Boolean indicating whether the (requested version of) SDL_net library is - found. For backward compatibility, the ``SDL_NET_FOUND`` variable is also set - to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) SDL_net library was + found. ``SDL_net_VERSION`` ..versionadded:: 4.2 @@ -59,21 +60,25 @@ The following variables are provided for backward compatibility: ``SDL_NET_VERSION_STRING`` .. deprecated:: 4.2 - Use the ``SDL_net_VERSION``. + Use ``SDL_net_VERSION``, which has the same value. The human-readable string containing the version of SDL_net found. +``SDL_NET_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_net_FOUND``, which has the same value. + ``SDLNET_FOUND`` .. deprecated:: 2.8.10 - Use the ``SDL_net_FOUND``, which has the same value. + Use ``SDL_net_FOUND``, which has the same value. ``SDLNET_INCLUDE_DIR`` .. deprecated:: 2.8.10 - Use the ``SDL_NET_INCLUDE_DIRS``, which has the same value. + Use ``SDL_NET_INCLUDE_DIRS``, which has the same value. ``SDLNET_LIBRARY`` .. deprecated:: 2.8.10 - Use the ``SDL_NET_LIBRARIES``, which has the same value. + Use ``SDL_NET_LIBRARIES``, which has the same value. Examples ^^^^^^^^ diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake index 03f20b2c39..19fc2cd081 100644 --- a/Modules/FindSDL_sound.cmake +++ b/Modules/FindSDL_sound.cmake @@ -35,9 +35,10 @@ Result Variables This module defines the following variables: ``SDL_sound_FOUND`` - Boolean indicating whether the (requested version of) SDL_sound library is - found. For backward compatibility, the ``SDL_SOUND_FOUND`` variable is also - set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) SDL_sound library + was found. ``SDL_sound_VERSION`` .. versionadded:: 4.2 @@ -111,9 +112,16 @@ Deprecated Variables The following variables are provided for backward compatibility: +``SDL_SOUND_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_sound_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) SDL_sound library + was found. + ``SDL_SOUND_VERSION_STRING`` .. deprecated:: 4.2 - Use the ``SDL_sound_VERSION``. + Use ``SDL_sound_VERSION``, which has the same value. The human-readable string containing the version of SDL_sound found. diff --git a/Modules/FindSDL_ttf.cmake b/Modules/FindSDL_ttf.cmake index 25332ddaf9..bac34788f1 100644 --- a/Modules/FindSDL_ttf.cmake +++ b/Modules/FindSDL_ttf.cmake @@ -27,9 +27,10 @@ Result Variables This module defines the following variables: ``SDL_ttf_FOUND`` - Boolean indicating whether the (requested version of) SDL_ttf library is - found. For backward compatibility, the ``SDL_TTF_FOUND`` variable is also set - to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the (requested version of) SDL_ttf library was + found. ``SDL_ttf_VERSION`` .. versionadded:: 4.2 @@ -60,10 +61,14 @@ The following variables are provided for backward compatibility: ``SDL_TTF_VERSION_STRING`` .. deprecated:: 4.2 - Use the ``SDL_ttf_VERSION``. + Use ``SDL_ttf_VERSION``, which has the same value. The human-readable string containing the version of SDL_ttf found. +``SDL_TTF_FOUND`` + .. deprecated:: 4.2 + Use ``SDL_ttf_FOUND``, which has the same value. + ``SDLTTF_FOUND`` .. deprecated:: 2.8.10 Replaced with ``SDL_ttf_FOUND``, which has the same value. diff --git a/Modules/FindSQLite3.cmake b/Modules/FindSQLite3.cmake index d572dc0e75..ea859e6c56 100644 --- a/Modules/FindSQLite3.cmake +++ b/Modules/FindSQLite3.cmake @@ -31,7 +31,7 @@ Result Variables This module defines the following variables: ``SQLite3_FOUND`` - Boolean indicating whether (the requested version of) SQLite library is + Boolean indicating whether the (requested version of) SQLite library was found. ``SQLite3_VERSION`` diff --git a/Modules/FindSWIG.cmake b/Modules/FindSWIG.cmake index 23154eba4d..ea6677c92c 100644 --- a/Modules/FindSWIG.cmake +++ b/Modules/FindSWIG.cmake @@ -46,7 +46,7 @@ This module defines the following variables: ``SWIG_FOUND`` Boolean indicating whether (the requested version of) SWIG and any required - components are found on the system. + components were found on the system. ``SWIG_VERSION`` SWIG executable version (result of ``swig -version``). ``SWIG__FOUND`` diff --git a/Modules/FindSquish.cmake b/Modules/FindSquish.cmake index 4b72a8d99e..f405e45a26 100644 --- a/Modules/FindSquish.cmake +++ b/Modules/FindSquish.cmake @@ -21,9 +21,9 @@ Result Variables This module defines the following variables: ``Squish_FOUND`` - Boolean indicating whether (the requested version of) Squish is found. - For backward compatibility, the ``SQUISH_FOUND`` variable is also set to - the same value. + .. versionadded:: 3.3 + + Boolean indicating whether (the requested version of) Squish was found. ``Squish_VERSION`` .. versionadded:: 4.2 @@ -31,13 +31,13 @@ This module defines the following variables: The full version of the Squish found. ``SQUISH_INSTALL_DIR_FOUND`` - Boolean indicating whether the Squish installation directory is found. + Boolean indicating whether the Squish installation directory was found. ``SQUISH_SERVER_EXECUTABLE_FOUND`` - Boolean indicating whether the Squish server executable is found. + Boolean indicating whether the Squish server executable was found. ``SQUISH_CLIENT_EXECUTABLE_FOUND`` - Boolean indicating whether the Squish client executable is found. + Boolean indicating whether the Squish client executable was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -166,6 +166,12 @@ Deprecated Variables The following variables are provided for backward compatibility: +``SQUISH_FOUND`` + .. deprecated:: 4.2 + Use ``Squish_FOUND``, which has the same value. + + Boolean indicating whether (the requested version of) Squish was found. + ``SQUISH_VERSION`` .. deprecated:: 4.2 Superseded by the ``Squish_VERSION``. diff --git a/Modules/FindSubversion.cmake b/Modules/FindSubversion.cmake index 47e775f84b..e102b182aa 100644 --- a/Modules/FindSubversion.cmake +++ b/Modules/FindSubversion.cmake @@ -18,9 +18,8 @@ Result Variables This module defines the following variables: ``Subversion_FOUND`` - Boolean indicating whether (the requested version of) Subversion command-line - client is found. For backward compatibility, the ``SUBVERSION_FOUND`` - variable is also set to the same value. + Boolean indicating whether the (requested version of) Subversion + command-line client was found. ``Subversion_VERSION`` .. versionadded:: 4.2 @@ -100,6 +99,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``SUBVERSION_FOUND`` + .. deprecated:: 4.2 + Use ``Subversion_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) Subversion + command-line client was found. + ``Subversion_VERSION_SVN`` .. deprecated:: 4.2 Use the ``Subversion_VERSION``. diff --git a/Modules/FindTCL.cmake b/Modules/FindTCL.cmake index 7765c9e1a6..d5931f3e07 100644 --- a/Modules/FindTCL.cmake +++ b/Modules/FindTCL.cmake @@ -22,11 +22,11 @@ Result Variables This module defines the following variables: ``TCL_FOUND`` - Boolean indicating whether the Tcl is found. + Boolean indicating whether Tcl was found. ``TK_FOUND`` - Boolean indicating whether the Tk is found. + Boolean indicating whether Tk was found. ``TCLTK_FOUND`` - Boolean indicating whether both Tcl and Tk are found. + Boolean indicating whether both Tcl and Tk were found. Cache Variables ^^^^^^^^^^^^^^^ diff --git a/Modules/FindTclsh.cmake b/Modules/FindTclsh.cmake index 334616dfb8..81a2cbf168 100644 --- a/Modules/FindTclsh.cmake +++ b/Modules/FindTclsh.cmake @@ -18,9 +18,10 @@ Result Variables This module defines the following variables: ``Tclsh_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the (requested version of) ``tclsh`` executable - is found. For backward compatibility, the ``TCLSH_FOUND`` variable is - also set to the same value. + was found. ``Tclsh_VERSION`` .. versionadded:: 4.2 @@ -40,6 +41,13 @@ Deprecated Variables The following variables are provided for backward compatibility: +``TCLSH_FOUND`` + .. deprecated:: 4.2 + Use ``Tclsh_FOUND``, which has the same value. + + Boolean indicating whether the (requested version of) ``tclsh`` executable + was found. + ``TCLSH_VERSION_STRING`` .. deprecated:: 4.2 Use ``Tclsh_VERSION``, which has the same value. diff --git a/Modules/FindVulkan.cmake b/Modules/FindVulkan.cmake index 5c8545838f..4bbcb27e85 100644 --- a/Modules/FindVulkan.cmake +++ b/Modules/FindVulkan.cmake @@ -160,7 +160,7 @@ This module defines the following variables: ``Vulkan_FOUND`` Boolean indicating whether (the requested version of) Vulkan and all required - components are found. + components were found. ``Vulkan_VERSION`` .. versionadded:: 3.23 diff --git a/Modules/FindWget.cmake b/Modules/FindWget.cmake index dafbc379f6..73715f210e 100644 --- a/Modules/FindWget.cmake +++ b/Modules/FindWget.cmake @@ -18,7 +18,9 @@ Result Variables This module defines the following variables: ``Wget_FOUND`` - Boolean indicating whether ``wget`` has been found. + .. versionadded:: 3.3 + + Boolean indicating whether ``wget`` was found. Cache Variables ^^^^^^^^^^^^^^^ @@ -28,6 +30,17 @@ The following cache variables may also be set: ``WGET_EXECUTABLE`` The full path to the ``wget`` tool. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``WGET_FOUND`` + .. deprecated:: 4.2 + Use ``Wget_FOUND``, which has the same value. + + Boolean indicating whether ``wget`` was found. + Examples ^^^^^^^^ diff --git a/Modules/FindX11.cmake b/Modules/FindX11.cmake index cc80f8b10d..93aa9329ea 100644 --- a/Modules/FindX11.cmake +++ b/Modules/FindX11.cmake @@ -11,13 +11,22 @@ Finds the X11 installation on Unix-like systems: find_package(X11 [COMPONENTS ...] [...]) -The following values are defined +Result Variables +^^^^^^^^^^^^^^^^ -:: +This module defines the following variables: - X11_FOUND - True if X11 is available - X11_INCLUDE_DIR - include directories to use X11 - X11_LIBRARIES - link against these to use X11 +``X11_FOUND`` + Boolean indicating whether X11 was found. + +``X11__FOUND`` + Boolean indicating whether the ```` was found. + +``X11_INCLUDE_DIR`` + Include directories needed to use X11. + +``X11_LIBRARIES`` + Libraries needed to link against to use X11. and also the following more fine grained variables and targets: diff --git a/Modules/FindXCTest.cmake b/Modules/FindXCTest.cmake index e345fa4a01..7b4cc415e7 100644 --- a/Modules/FindXCTest.cmake +++ b/Modules/FindXCTest.cmake @@ -30,7 +30,7 @@ Result Variables This module defines the following variables: ``XCTest_FOUND`` - Boolean indicating whether the XCTest framework and executable are found. + Boolean indicating whether the XCTest framework and executable were found. ``XCTest_INCLUDE_DIRS`` Include directories containing the XCTest framework headers needed to use diff --git a/Modules/FindXMLRPC.cmake b/Modules/FindXMLRPC.cmake index dc833f9c08..bce4c83ba5 100644 --- a/Modules/FindXMLRPC.cmake +++ b/Modules/FindXMLRPC.cmake @@ -66,7 +66,7 @@ This module defines the following variables: ``XMLRPC_FOUND`` Boolean indicating whether the XML-RPC library and all its requested - components are found. + components were found. ``XMLRPC_INCLUDE_DIRS`` Include directories containing ``xmlrpc.h`` and other headers needed to use the XML-RPC library. diff --git a/Modules/FindXalanC.cmake b/Modules/FindXalanC.cmake index 69594951b5..88f2a36af6 100644 --- a/Modules/FindXalanC.cmake +++ b/Modules/FindXalanC.cmake @@ -33,7 +33,7 @@ Result Variables This module defines the following variables: ``XalanC_FOUND`` - Boolean indicating whether (the requested version of) Xalan-C++ is found. + Boolean indicating whether (the requested version of) Xalan-C++ was found. ``XalanC_VERSION`` The version of the found Xalan-C++ library. ``XalanC_INCLUDE_DIRS`` diff --git a/Modules/FindXercesC.cmake b/Modules/FindXercesC.cmake index d33868b5be..bc6967066f 100644 --- a/Modules/FindXercesC.cmake +++ b/Modules/FindXercesC.cmake @@ -30,7 +30,7 @@ Result Variables This module defines the following variables: ``XercesC_FOUND`` - Boolean indicating whether (the requested version of) Xerces-C++ is found. + Boolean indicating whether (the requested version of) Xerces-C++ was found. ``XercesC_VERSION`` The version of the found Xerces-C++ library. ``XercesC_INCLUDE_DIRS`` diff --git a/Modules/FindZLIB.cmake b/Modules/FindZLIB.cmake index cfb1acd178..6e6674e827 100644 --- a/Modules/FindZLIB.cmake +++ b/Modules/FindZLIB.cmake @@ -28,7 +28,7 @@ Result Variables This module defines the following variables: ``ZLIB_FOUND`` - Boolean indicating whether (the requested version of) zlib is found. + Boolean indicating whether (the requested version of) zlib was found. ``ZLIB_VERSION`` .. versionadded:: 3.26 diff --git a/Modules/Findosg.cmake b/Modules/Findosg.cmake index dfcb0cdd34..5418a92550 100644 --- a/Modules/Findosg.cmake +++ b/Modules/Findosg.cmake @@ -44,8 +44,9 @@ Result Variables This module defines the following variables: ``osg_FOUND`` - Boolean indicating whether osg library is found. For backward - compatibility, the ``OSG_FOUND`` variable is also set to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the osg library was found. ``OSG_LIBRARIES`` The libraries needed to link against to use osg library. @@ -76,6 +77,17 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSG_FOUND`` + .. deprecated:: 4.2 + Use ``osg_FOUND``, which has the same value. + + Boolean indicating whether the osg library was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgAnimation.cmake b/Modules/FindosgAnimation.cmake index b2d506d5a0..8cb7729c7d 100644 --- a/Modules/FindosgAnimation.cmake +++ b/Modules/FindosgAnimation.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgAnimation_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgAnimation library of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGANIMATION_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGANIMATION_LIBRARIES`` The libraries needed to link against to use osgAnimation. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGANIMATION_FOUND`` + .. deprecated:: 4.2 + Use ``osgAnimation_FOUND``, which has the same value. + + Boolean indicating whether the osgAnimation library of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgDB.cmake b/Modules/FindosgDB.cmake index dadc27cd26..e5d96cca73 100644 --- a/Modules/FindosgDB.cmake +++ b/Modules/FindosgDB.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgDB_FOUND`` - Boolean indicating whether the osgDB library of the OpenSceneGraph toolkit is - found. For backward compatibility, the ``OSGDB_FOUND`` variable is also set - to the same value. + .. versionadded:: 3.3 + + Boolean indicating whether the osgDB library of the OpenSceneGraph toolkit + was found. ``OSGDB_LIBRARIES`` The libraries needed to link against to use osgDB. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGDB_FOUND`` + .. deprecated:: 4.2 + Use ``osgDB_FOUND``, which has the same value. + + Boolean indicating whether the osgDB library of the OpenSceneGraph toolkit + was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgFX.cmake b/Modules/FindosgFX.cmake index 28a13cbced..c229227b36 100644 --- a/Modules/FindosgFX.cmake +++ b/Modules/FindosgFX.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgFX_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgFX NodeKit of the OpenSceneGraph toolkit - is found. For backward compatibility, the ``OSGFX_FOUND`` variable is also - set to the same value. + was found. ``OSGFX_LIBRARIES`` The libraries needed to link against to use osgFX. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGFX_FOUND`` + .. deprecated:: 4.2 + Use ``osgFX_FOUND``, which has the same value. + + Boolean indicating whether the osgFX NodeKit of the OpenSceneGraph toolkit + was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgGA.cmake b/Modules/FindosgGA.cmake index 3c5ceb63cd..7a3b7dfdb9 100644 --- a/Modules/FindosgGA.cmake +++ b/Modules/FindosgGA.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgGA_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgGA library of the OpenSceneGraph toolkit - is found. For backward compatibility, the ``OSGGA_FOUND`` variable is also - set to the same value. + was found. ``OSGGA_LIBRARIES`` The libraries needed to link against to use osgGA. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGGA_FOUND`` + .. deprecated:: 4.2 + Use ``osgGA_FOUND``, which has the same value. + + Boolean indicating whether the osgGA library of the OpenSceneGraph toolkit + was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgIntrospection.cmake b/Modules/FindosgIntrospection.cmake index 2b87a95ad3..887ba14209 100644 --- a/Modules/FindosgIntrospection.cmake +++ b/Modules/FindosgIntrospection.cmake @@ -52,9 +52,10 @@ Result Variables This module defines the following variables: ``osgIntrospection_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgIntrospection library of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGINTROSPECTION_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGINTROSPECTION_LIBRARIES`` The libraries needed to link against to use osgIntrospection. @@ -85,6 +86,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGINTROSPECTION_FOUND`` + .. deprecated:: 4.2 + Use ``osgIntrospection_FOUND``, which has the same value. + + Boolean indicating whether the osgIntrospection library of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgManipulator.cmake b/Modules/FindosgManipulator.cmake index 34fc23aa8b..275dcd975e 100644 --- a/Modules/FindosgManipulator.cmake +++ b/Modules/FindosgManipulator.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgManipulator_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgManipulator NodeKit of the - OpenSceneGraph toolkit is found. For backward compatibility, the - ``OSGMANIPULATOR_FOUND`` variable is also set to the same value. + OpenSceneGraph toolkit was found. ``OSGMANIPULATOR_LIBRARIES`` The libraries needed to link against to use osgManipulator. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGMANIPULATOR_FOUND`` + .. deprecated:: 4.2 + Use ``osgManipulator_FOUND``, which has the same value. + + Boolean indicating whether the osgManipulator NodeKit of the + OpenSceneGraph toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgParticle.cmake b/Modules/FindosgParticle.cmake index 637a8932cc..01c6427ae9 100644 --- a/Modules/FindosgParticle.cmake +++ b/Modules/FindosgParticle.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgParticle_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgParticle NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGPARTICLE_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGPARTICLE_LIBRARIES`` The libraries needed to link against to use the osgParticle NodeKit @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGPARTICLE_FOUND`` + .. deprecated:: 4.2 + Use ``osgParticle_FOUND``, which has the same value. + + Boolean indicating whether the osgParticle NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgPresentation.cmake b/Modules/FindosgPresentation.cmake index 4a74de54cf..87858e2575 100644 --- a/Modules/FindosgPresentation.cmake +++ b/Modules/FindosgPresentation.cmake @@ -48,9 +48,10 @@ Result Variables This module defines the following variables: ``osgPresentation_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgPresentation NodeKit of the - OpenSceneGraph toolkit is found. For backward compatibility, the - ``OSGPRESENTATION_FOUND`` variable is also set to the same value. + OpenSceneGraph toolkit was found. ``OSGPRESENTATION_LIBRARIES`` The libraries needed to link against to use osgPresentation. @@ -81,6 +82,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGPRESENTATION_FOUND`` + .. deprecated:: 4.2 + Use ``osgPresentation_FOUND``, which has the same value. + + Boolean indicating whether the osgPresentation NodeKit of the + OpenSceneGraph toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgProducer.cmake b/Modules/FindosgProducer.cmake index 69f86d201e..241ffb70b8 100644 --- a/Modules/FindosgProducer.cmake +++ b/Modules/FindosgProducer.cmake @@ -54,9 +54,10 @@ Result Variables This module defines the following variables: ``osgProducer_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgProducer library of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGPRODUCER_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGPRODUCER_LIBRARIES`` The libraries needed to link against to use osgProducer. @@ -87,6 +88,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGPRODUCER_FOUND`` + .. deprecated:: 4.2 + Use ``osgProducer_FOUND``, which has the same value. + + Boolean indicating whether the osgProducer library of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgQt.cmake b/Modules/FindosgQt.cmake index 3fd817db4f..c701baa53a 100644 --- a/Modules/FindosgQt.cmake +++ b/Modules/FindosgQt.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgQt_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgQt library of the OpenSceneGraph toolkit - is found. For backward compatibility, the ``OSGQT_FOUND`` variable is also - set to the same value. + was found. ``OSGQT_LIBRARIES`` The libraries needed to link against to use osgQt. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGQT_FOUND`` + .. deprecated:: 4.2 + Use ``osgQt_FOUND``, which has the same value. + + Boolean indicating whether the osgQt library of the OpenSceneGraph toolkit + was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgShadow.cmake b/Modules/FindosgShadow.cmake index d2f2ea7943..9939832a6f 100644 --- a/Modules/FindosgShadow.cmake +++ b/Modules/FindosgShadow.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgShadow_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgShadow NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGSHADOW_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGSHADOW_LIBRARIES`` The libraries needed to link against to use osgShadow. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGSHADOW_FOUND`` + .. deprecated:: 4.2 + Use ``osgShadow_FOUND``, which has the same value. + + Boolean indicating whether the osgShadow NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgSim.cmake b/Modules/FindosgSim.cmake index d981d7d1da..ab9342b5ff 100644 --- a/Modules/FindosgSim.cmake +++ b/Modules/FindosgSim.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgSim_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgSim NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGSIM_FOUND`` variable - is also set to the same value. + toolkit was found. ``OSGSIM_LIBRARIES`` The libraries needed to link against to use osgSim. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGSIM_FOUND`` + .. deprecated:: 4.2 + Use ``osgSim_FOUND``, which has the same value. + + Boolean indicating whether the osgSim NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgTerrain.cmake b/Modules/FindosgTerrain.cmake index ed0d858f29..ab418b5ef7 100644 --- a/Modules/FindosgTerrain.cmake +++ b/Modules/FindosgTerrain.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgTerrain_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgTerrain NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGTERRAIN_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGTERRAIN_LIBRARIES`` The libraries needed to link against to use osgTerrain. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGTERRAIN_FOUND`` + .. deprecated:: 4.2 + Use ``osgTerrain_FOUND``, which has the same value. + + Boolean indicating whether the osgTerrain NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgText.cmake b/Modules/FindosgText.cmake index 67f532aece..52da20db28 100644 --- a/Modules/FindosgText.cmake +++ b/Modules/FindosgText.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgText_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgText NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGTEXT_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGTEXT_LIBRARIES`` The libraries needed to link against to use osgText. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGTEXT_FOUND`` + .. deprecated:: 4.2 + Use ``osgText_FOUND``, which has the same value. + + Boolean indicating whether the osgText NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgUtil.cmake b/Modules/FindosgUtil.cmake index 2b6bc23613..f302d564d9 100644 --- a/Modules/FindosgUtil.cmake +++ b/Modules/FindosgUtil.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgUtil_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgUtil library of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGUTIL_FOUND`` variable - is also set to the same value. + toolkit was found. ``OSGUTIL_LIBRARIES`` The libraries needed to link against to use osgUtil. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGUTIL_FOUND`` + .. deprecated:: 4.2 + Use ``osgUtil_FOUND``, which has the same value. + + Boolean indicating whether the osgUtil library of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgViewer.cmake b/Modules/FindosgViewer.cmake index bb4e676a99..ec16fc8e39 100644 --- a/Modules/FindosgViewer.cmake +++ b/Modules/FindosgViewer.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgViewer_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgViewer library of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGVIEWER_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGVIEWER_LIBRARIES`` The libraries needed to link against to use osgViewer. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGVIEWER_FOUND`` + .. deprecated:: 4.2 + Use ``osgViewer_FOUND``, which has the same value. + + Boolean indicating whether the osgViewer library of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgVolume.cmake b/Modules/FindosgVolume.cmake index 0e447e9320..15c6728e14 100644 --- a/Modules/FindosgVolume.cmake +++ b/Modules/FindosgVolume.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgVolume_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgVolume NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGVOLUME_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGVOLUME_LIBRARIES`` The libraries needed to link against to use osgVolume. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGVOLUME_FOUND`` + .. deprecated:: 4.2 + Use ``osgVolume_FOUND``, which has the same value. + + Boolean indicating whether the osgVolume NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindosgWidget.cmake b/Modules/FindosgWidget.cmake index cd5da96d72..cec8ff8a66 100644 --- a/Modules/FindosgWidget.cmake +++ b/Modules/FindosgWidget.cmake @@ -47,9 +47,10 @@ Result Variables This module defines the following variables: ``osgWidget_FOUND`` + .. versionadded:: 3.3 + Boolean indicating whether the osgWidget NodeKit of the OpenSceneGraph - toolkit is found. For backward compatibility, the ``OSGWIDGET_FOUND`` - variable is also set to the same value. + toolkit was found. ``OSGWIDGET_LIBRARIES`` The libraries needed to link against to use osgWidget. @@ -80,6 +81,18 @@ This module accepts the following variables: location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed: ``./configure --prefix=$OSGDIR``. +Deprecated Variables +^^^^^^^^^^^^^^^^^^^^ + +The following variables are provided for backward compatibility: + +``OSGWIDGET_FOUND`` + .. deprecated:: 4.2 + Use ``osgWidget_FOUND``, which has the same value. + + Boolean indicating whether the osgWidget NodeKit of the OpenSceneGraph + toolkit was found. + Examples ^^^^^^^^ diff --git a/Modules/FindwxWidgets.cmake b/Modules/FindwxWidgets.cmake index ae1203bec3..dbbfb3c1c4 100644 --- a/Modules/FindwxWidgets.cmake +++ b/Modules/FindwxWidgets.cmake @@ -90,7 +90,7 @@ This module defines the following variables: ``wxWidgets_FOUND`` Boolean indicating whether (the requested version of) wxWidgets and all - its requested components are found. + its requested components were found. ``wxWidgets_VERSION`` .. versionadded:: 4.2 diff --git a/Modules/FindwxWindows.cmake b/Modules/FindwxWindows.cmake index a9126c8389..90cb0b7a05 100644 --- a/Modules/FindwxWindows.cmake +++ b/Modules/FindwxWindows.cmake @@ -30,7 +30,7 @@ Result Variables This module defines the following variables: ``WXWINDOWS_FOUND`` - Boolean indicating whether the wxWidgets is found. + Boolean indicating whether the wxWidgets was found. ``WXWINDOWS_LIBRARIES`` Libraries needed to link against to use wxWidgets. This includes paths to the wxWidgets libraries and any additional linker flags, typically derived diff --git a/Source/Modules/FindLibRHash.cmake b/Source/Modules/FindLibRHash.cmake index 7cd2006ead..6ed0385ca3 100644 --- a/Source/Modules/FindLibRHash.cmake +++ b/Source/Modules/FindLibRHash.cmake @@ -19,7 +19,7 @@ Result Variables This module defines the following variables: ``LibRHash_FOUND`` - True if LibRHash was found, false otherwise. + Boolean indicating whether LibRHash was found. ``LibRHash_INCLUDE_DIRS`` Include directories needed to include LibRHash headers. ``LibRHash_LIBRARIES`` diff --git a/Source/Modules/FindLibUUID.cmake b/Source/Modules/FindLibUUID.cmake index cc8168a0b9..3fb5e14559 100644 --- a/Source/Modules/FindLibUUID.cmake +++ b/Source/Modules/FindLibUUID.cmake @@ -19,7 +19,7 @@ Result Variables This module defines the following variables: ``LibUUID_FOUND`` - True if LibUUID was found, false otherwise. + Boolean indicating whether LibUUID was found. ``LibUUID_INCLUDE_DIRS`` Include directories needed to include LibUUID headers. ``LibUUID_LIBRARIES`` diff --git a/Source/Modules/FindLibUV.cmake b/Source/Modules/FindLibUV.cmake index 049d31bf01..a866111ad6 100644 --- a/Source/Modules/FindLibUV.cmake +++ b/Source/Modules/FindLibUV.cmake @@ -19,11 +19,7 @@ Result Variables This module defines the following variables: ``LibUV_FOUND`` - True if libuv was found, false otherwise. -``LibUV_INCLUDE_DIRS`` - Include directories needed to include libuv headers. -``LibUV_LIBRARIES`` - Libraries needed to link to libuv. + Boolean indicating whether (the requested version of) libuv was found. ``LibUV_VERSION`` The version of libuv found. ``LibUV_VERSION_MAJOR`` @@ -32,6 +28,10 @@ This module defines the following variables: The minor version of libuv. ``LibUV_VERSION_PATCH`` The patch version of libuv. +``LibUV_INCLUDE_DIRS`` + Include directories needed to include libuv headers. +``LibUV_LIBRARIES`` + Libraries needed to link to libuv. Cache Variables ^^^^^^^^^^^^^^^