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

FindIconv: Update documentation

Browse Source 
- Added examples section.
- Synced variables listing with the rest of the find modules.
- Moved imported targets to the top.
This commit is contained in:
Peter Kokot 2025-04-06 01:40:11 +02:00
parent e2e5303fe2
commit f3c838cce8
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 44 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
Modules/FindIconv.cmake
View File

@ -7,72 +7,82 @@ FindIconv
.. versionadded:: 3.11
This module finds the ``iconv()`` POSIX.1 functions on the system.
These functions might be provided in the regular C library or externally
in the form of an additional library.
This module finds the ``iconv()`` POSIX.1 functions on the system. These
functions might be provided in the standard C library or externally in the form
of an additional library.
The following variables are provided to indicate iconv support:
Imported Targets
^^^^^^^^^^^^^^^^
.. variable:: Iconv_FOUND
This module provides the following :ref:`Imported Targets`:
Variable indicating if the iconv support was found.
``Iconv::Iconv``
Target encapsulating the iconv usage requirements, available only if iconv is
found.
.. variable:: Iconv_INCLUDE_DIRS
Result Variables
^^^^^^^^^^^^^^^^
The directories containing the iconv headers.
This module defines the following variables:
.. variable:: Iconv_LIBRARIES
``Iconv_FOUND``
Boolean indicating if the iconv support was found.
``Iconv_INCLUDE_DIRS``
The include directories containing the iconv headers.
``Iconv_LIBRARIES``
The iconv libraries to be linked.
.. variable:: Iconv_VERSION
``Iconv_VERSION``
.. versionadded:: 3.21
The version of iconv found (x.y)
The version of iconv found (x.y).
.. variable:: Iconv_VERSION_MAJOR
.. note::
Some libiconv implementations don't embed the version in their header files.
In this case the variables ``Iconv_VERSION*`` will be empty.
``Iconv_VERSION_MAJOR``
.. versionadded:: 3.21
The major version of iconv
.. variable:: Iconv_VERSION_MINOR
The major version of iconv.
``Iconv_VERSION_MINOR``
.. versionadded:: 3.21
The minor version of iconv
The minor version of iconv.
.. variable:: Iconv_IS_BUILT_IN
``Iconv_IS_BUILT_IN``
A boolean variable indicating whether iconv support is stemming from the C
standard library or not. Even if the C library provides ``iconv()``, the
presence of an external ``libiconv`` implementation might lead to this being
false.
A variable indicating whether iconv support is stemming from the
C library or not. Even if the C library provides `iconv()`, the presence of
an external `libiconv` implementation might lead to this being false.
Additionally, the following :prop_tgt:`IMPORTED` target is being provided:
.. variable:: Iconv::Iconv
Imported target for using iconv.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
.. variable:: Iconv_INCLUDE_DIR
``Iconv_INCLUDE_DIR``
The directory containing the iconv headers.
.. variable:: Iconv_LIBRARY
``Iconv_LIBRARY``
The iconv library (if not implicitly given in the C library).
.. note::
On POSIX platforms, iconv might be part of the C library and the cache
variables ``Iconv_INCLUDE_DIR`` and ``Iconv_LIBRARY`` might be empty.
.. note::
Some libiconv implementations don't embed the version number in their header files.
In this case the variables ``Iconv_VERSION*`` will be empty.
Examples
^^^^^^^^
Finding iconv and linking it to a project target:
.. code-block:: cmake
find_package(Iconv)
target_link_libraries(project_target PRIVATE Iconv::Iconv)
#]=======================================================================]
cmake_policy(PUSH)