FindLTTngUST: Update documentation

- Added examples section.
- Descriptions synced a bit.
- Separated result and cache variables.
- RST syntax synced.
- LTTngUST_FOUND and the uppercased LTTNGUST_FOUND are always set to the
  same value by the find module in this case - description synced.
This commit is contained in:
Peter Kokot
2025-04-01 00:10:12 +02:00
parent fc3e3cd2e4
commit 26078a7055

View File

@@ -7,34 +7,52 @@ FindLTTngUST
.. versionadded:: 3.6
Find
`Linux Trace Toolkit Next Generation (LTTng-UST) <https://lttng.org/>`__ library.
Finds the `LTTng <https://lttng.org/>`_ (Linux Trace Toolkit: next generation)
user space tracing library (LTTng-UST).
Imported target
^^^^^^^^^^^^^^^
This module defines the following :prop_tgt:`IMPORTED` target:
``LTTng::UST``
The LTTng-UST library, if found
Result variables
Imported Targets
^^^^^^^^^^^^^^^^
This module sets the following
This module defines the following :ref:`Imported Targets`:
``LTTNGUST_FOUND``
``TRUE`` if system has LTTng-UST
``LTTNGUST_INCLUDE_DIRS``
The LTTng-UST include directories
``LTTNGUST_LIBRARIES``
The libraries needed to use LTTng-UST
``LTTng::UST``
Target providing the LTTng-UST library usage requirements. This target is
available only when LTTng-UST is found.
Result Variables
^^^^^^^^^^^^^^^^
This module sets 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.
``LTTNGUST_VERSION_STRING``
The LTTng-UST version
The LTTng-UST version.
``LTTNGUST_HAS_TRACEF``
``TRUE`` if the ``tracef()`` API is available in the system's LTTng-UST
``TRUE`` if the ``tracef()`` API is available in the system's LTTng-UST.
``LTTNGUST_HAS_TRACELOG``
``TRUE`` if the ``tracelog()`` API is available in the system's LTTng-UST
``TRUE`` if the ``tracelog()`` API is available in the system's LTTng-UST.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``LTTNGUST_INCLUDE_DIRS``
The LTTng-UST include directories.
``LTTNGUST_LIBRARIES``
The libraries needed to use LTTng-UST.
Examples
^^^^^^^^
Finding the LTTng-UST library and linking it to a project target:
.. code-block:: cmake
find_package(LTTugNST)
target_link_libraries(project_target PRIVATE LTTng::UST)
#]=======================================================================]
cmake_policy(PUSH)