Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-05-08 14:29:03 +08:00
Code Issues Projects Releases Wiki Activity

FindGnuTLS: Update documentation

Browse Source 
- Added examples section.
- Synced module documentation with other similar find modules.
- Documented some missing variables to make the result variables and
  cache variables sections consistent. The imported target is
  highlighted in the example.
- Added deprecated variables section.
- GnuTLS_FOUND variable used. GNUTLS_FOUND is also set to the same value
  as of CMake 3.3.
This commit is contained in:
Peter Kokot 2025-04-14 12:47:03 +02:00
parent 66a33b6663
commit 6dff939916
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 64 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
Modules/FindGnuTLS.cmake
View File

@ -5,34 +5,81 @@
FindGnuTLS
----------
Find the GNU Transport Layer Security library (gnutls)
Finds the GNU Transport Layer Security library (GnuTLS). The GnuTLS
package includes the main libraries (libgnutls and libdane), as well as the
optional gnutls-openssl compatibility extra library. They are all distributed
as part of the same release. This module checks for the presence of the main
libgnutls library and provides usage requirements for integrating GnuTLS into
CMake projects.
Imported Targets
^^^^^^^^^^^^^^^^
.. versionadded:: 3.16
This module provides the following :ref:`Imported Targets`:
This module defines :prop_tgt:`IMPORTED` target ``GnuTLS::GnuTLS``, if
gnutls has been found.
``GnuTLS::GnuTLS``
.. versionadded:: 3.16
Target encapsulating the GnuTLS usage requirements, available if GnuTLS is
found.
Result Variables
^^^^^^^^^^^^^^^^
``GNUTLS_FOUND``
System has gnutls
``GNUTLS_INCLUDE_DIR``
The gnutls include directory
``GNUTLS_LIBRARIES``
The libraries needed to use gnutls
``GNUTLS_DEFINITIONS``
Compiler switches required for using gnutls
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.
``GNUTLS_VERSION``
version of gnutls.
.. versionadded:: 3.16
The version of GnuTLS found.
``GNUTLS_INCLUDE_DIRS``
Include directories needed to use GnuTLS.
``GNUTLS_LIBRARIES``
Libraries needed to link against to use GnuTLS.
``GNUTLS_DEFINITIONS``
Compiler options required for using GnuTLS.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``GNUTLS_INCLUDE_DIR``
The directory containing the ``gnutls/gnutls.h`` header file.
``GNUTLS_LIBRARY``
The path to the GnuTLS library.
Deprecated Variables
^^^^^^^^^^^^^^^^^^^^
These variables are provided for backward compatibility:
``GNUTLS_VERSION_STRING``
.. deprecated:: 3.16
Superseded by ``GNUTLS_VERSION``.
The version of GnuTLS found.
Examples
^^^^^^^^
Finding GnuTLS and linking it to a project target:
.. code-block:: cmake
find_package(GnuTLS)
target_link_libraries(project_target PRIVATE GnuTLS::GnuTLS)
#]=======================================================================]
# Note that this doesn't try to find the gnutls-extra package.
if (GNUTLS_INCLUDE_DIR AND GNUTLS_LIBRARY)
# in cache already
set(gnutls_FIND_QUIETLY TRUE)
@ -71,7 +118,7 @@ find_package_handle_standard_args(GnuTLS
REQUIRED_VARS GNUTLS_LIBRARY GNUTLS_INCLUDE_DIR
VERSION_VAR GNUTLS_VERSION_STRING)
if(GNUTLS_FOUND)
if(GnuTLS_FOUND)
set(GNUTLS_LIBRARIES ${GNUTLS_LIBRARY})
set(GNUTLS_INCLUDE_DIRS ${GNUTLS_INCLUDE_DIR})