mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-02 04:09:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Simplify release notes for find module version variables

Browse Source 
Avoid repeating almost identical information for every module.
Document the pattern of the change and refer the reader to individual
modules for details.
This commit is contained in:
Brad King
2025-09-30 14:25:49 -04:00
parent 09aded59f7
commit 7aa81ae324
1 changed files with 4 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/release/dev/find-modules.rst
+4 -130
View File
@@ -5,136 +5,10 @@ Find Modules
are now deprecated in favor of ``<PackageName>_FOUND`` result variables, are now deprecated in favor of ``<PackageName>_FOUND`` result variables,
where appropriate. See documentation of each find module for details. where appropriate. See documentation of each find module for details.
* The :module:`FindALSA` module now provides a ``ALSA_VERSION`` result * Nearly all find modules now provide a ``<PackageName>_VERSION`` result
variable. The ``ALSA_VERSION_STRING`` result variable is deprecated. variable matching the casing of its module name. Existing variants such as
``<PackageName>_VERSION_STRING`` and uppercased ``<PACKAGENAME>_VERSION``
* The :module:`FindArmadillo` module now provides an ``Armadillo_VERSION``, are deprecated. See documentation of each find module for details.
and ``Armadillo_VERSION_NAME`` result variables. The
``ARMADILLO_VERSION_STRING``, ``ARMADILLO_VERSION_MAJOR``,
``ARMADILLO_VERSION_MINOR``, ``ARMADILLO_VERSION_PATCH``, and
``ARMADILLO_VERSION_NAME`` result variables are deprecated.
* The :module:`FindBZip2` module now provides a ``BZip2_VERSION`` result
variable. The ``BZIP2_VERSION`` result variable is deprecated.
* The :module:`FindCups` module now provides a ``Cups_VERSION`` result
variable. The ``CUPS_VERSION_STRING`` result variable is deprecated.
* The :module:`FindDoxygen` module now provides a ``Doxygen_VERSION`` result
variable. The ``DOXYGEN_VERSION`` result variable is deprecated.
* The :module:`FindEXPAT` module now provides a ``EXPAT_VERSION`` result
variable. The ``EXPAT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindFreetype` module now provides a ``Freetype_VERSION`` result
variable. The ``FREETYPE_VERSION_STRING`` result variable is deprecated.
* The :module:`FindGettext` module now provides a ``Gettext_VERSION`` result
variable. The ``GETTEXT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindGit` module now provides a ``Git_VERSION`` result
variable. The ``GIT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindGnuplot` module now provides a ``Gnuplot_VERSION`` result
variable. The ``GNUPLOT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindGnuTLS` module now provides a ``GnuTLS_VERSION`` result
variable. The ``GNUTLS_VERSION`` result variable is deprecated.
* The :module:`FindHg` module now provides a ``Hg_VERSION`` result
variable. The ``HG_VERSION_STRING`` result variable is deprecated.
* The :module:`FindHSPELL` module now provides a ``HSPELL_VERSION`` result
variable. The ``HSPELL_VERSION_STRING`` result variable is deprecated.
* The :module:`FindIcotool` module now provides a ``Icotool_VERSION`` result
variable. The ``ICOTOOL_VERSION_STRING`` result variable is deprecated.
* The :module:`FindImageMagick` module now provides an ``ImageMagick_VERSION``
result variable. The ``ImageMagick_VERSION_STRING`` result variable is
deprecated.
* The :module:`FindJasper` module now provides a ``Jasper_VERSION`` result
variable. The ``JASPER_VERSION_STRING`` result variable is deprecated.
* The :module:`FindLibLZMA` module now provides a ``LibLZMA_VERSION`` result
variable. The ``LIBLZMA_VERSION`` result variable is deprecated.
* The :module:`FindLibXml2` module now provides a ``LibXml2_VERSION`` result
variable. The ``LIBXML2_VERSION_STRING`` result variable is deprecated.
* The :module:`FindLibXslt` module now provides a ``LibXslt_VERSION`` result
variable. The ``LIBXSLT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindLTTngUST` module now provides a ``LTTngUST_VERSION`` result
variable. The ``LTTNGUST_VERSION_STRING`` result variable is deprecated.
* The :module:`FindLua` module now provides ``Lua_VERSION``,
``Lua_VERSION_MAJOR``, ``Lua_VERSION_MINOR``, and ``Lua_VERSION_PATCH``
result variables. The ``LUA_VERSION_STRING``, ``LUA_VERSION_MAJOR``,
``LUA_VERSION_MINOR``, and ``LUA_VERSION_PATCH`` result variables are
deprecated. The :module:`FindLua51` module now similarly provides a
``Lua_VERSION`` instead of the now deprecated ``LUA_VERSION_STRING`` result
variable.
* The :module:`FindOpenCL` module now provides an ``OpenCL_VERSION`` result
variable. The ``OpenCL_VERSION_STRING`` result variable is deprecated.
* The :module:`FindOpenSceneGraph` module now provides an
``OpenSceneGraph_VERSION`` result variable. The ``OPENSCENEGRAPH_VERSION``
result variable is deprecated.
* The :module:`FindOpenSSL` module now provides an ``OpenSSL_VERSION`` result
variable. The ``OPENSSL_VERSION`` result variable is deprecated.
* The :module:`FindPerl` module now provides a ``Perl_VERSION`` result
variable. The ``PERL_VERSION_STRING`` result variable is deprecated.
* The :module:`FindPerlLibs` module now provides a ``PerlLibs_VERSION``
result variable.
* The :module:`FindPkgConfig` module now provides a ``PkgConfig_VERSION``
result variable. The ``PKG_CONFIG_VERSION_STRING`` result variable is
deprecated.
* The :module:`FindPkgConfig` module's result variable ``PKG_CONFIG_FOUND``
is deprecated in favor of ``PkgConfig_FOUND``, which is available since
CMake 3.3 and has the same value.
* The :module:`FindPNG` module now provides a ``PNG_VERSION`` result
variable. The ``PNG_VERSION_STRING`` result variable is deprecated.
* The :module:`FindPostgreSQL` module now provides a ``PostgreSQL_VERSION``
result variable. The ``PostgreSQL_VERSION_STRING`` result variable is
deprecated.
* The :module:`FindQt3` module now provides a ``Qt3_VERSION`` result
variable. The ``QT_VERSION_STRING`` result variable is deprecated.
* The :module:`FindSDL_gfx`, :module:`FindSDL_image`, :module:`FindSDL_mixer`,
:module:`FindSDL_net`, :module:`FindSDL_sound`, and :module:`FindSDL_ttf`
modules now provide their respective ``<PackageName>_VERSION`` result
variables. Previous ``<PACKAGENAME>_VERSION_STRING`` result variables
are deprecated.
* The :module:`FindSquish` module now provides a ``Squish_VERSION`` result
variable. The ``SQUISH_VERSION``, ``SQUISH_VERSION_MAJOR``,
``SQUISH_VERSION_MINOR``, and ``SQUISH_VERSION_PATCH`` result variables
are deprecated.
* The :module:`FindSubversion` module now provides a ``Subversion_VERSION``
result variable. The ``Subversion_VERSION_SVN`` result variable is
deprecated.
* The :module:`FindTclsh` module now provides a ``Tclsh_VERSION`` result
variable. The ``TCLSH_VERSION_STRING`` result variable is deprecated.
* The :module:`FindTIFF` module now provides a ``TIFF_VERSION`` result
variable. The ``TIFF_VERSION_STRING`` result variable is deprecated.
* The :module:`FindwxWidgets` module now provides a ``wxWidgets_VERSION``
result variable. The ``wxWidgets_VERSION_STRING`` result variable is
deprecated.
* The :module:`FindwxWidgets` module's result variable * The :module:`FindwxWidgets` module's result variable
``wxWidgets_USE_FILE`` is now deprecated in favor of including the ``wxWidgets_USE_FILE`` is now deprecated in favor of including the