summaryrefslogtreecommitdiff
path: root/Modules/FindLibLZMA.cmake
diff options
context:
space:
mode:
authorMarc Chevrier <marc.chevrier@gmail.com>2018-12-20 15:26:51 +0100
committerMarc Chevrier <marc.chevrier@gmail.com>2018-12-20 15:26:51 +0100
commitfeafc7f3fed89d1a77ea7e3602b8e6eb57fec9d9 (patch)
treece8fc6d789f77b39682924398a62bcfcdff7c3b0 /Modules/FindLibLZMA.cmake
parent0495ce4f98497ba607c5d297f2d5dee70d9a36c6 (diff)
downloadcmake-feafc7f3fed89d1a77ea7e3602b8e6eb57fec9d9.tar.gz
Help: FindLibLZMA: update formatting.
Diffstat (limited to 'Modules/FindLibLZMA.cmake')
-rw-r--r--Modules/FindLibLZMA.cmake40
1 files changed, 23 insertions, 17 deletions
diff --git a/Modules/FindLibLZMA.cmake b/Modules/FindLibLZMA.cmake
index b7e581503f..6225744388 100644
--- a/Modules/FindLibLZMA.cmake
+++ b/Modules/FindLibLZMA.cmake
@@ -5,34 +5,40 @@
FindLibLZMA
-----------
-Find LibLZMA
+Find LZMA compression algorithm headers and library.
-Find LibLZMA headers and library
-
-IMPORTED Targets
+Imported Targets
^^^^^^^^^^^^^^^^
This module defines :prop_tgt:`IMPORTED` target ``LibLZMA::LibLZMA``, if
-LibLZMA has been found.
+liblzma has been found.
Result variables
^^^^^^^^^^^^^^^^
This module will set the following variables in your project:
-::
-
- LIBLZMA_FOUND - True if liblzma is found.
- LIBLZMA_INCLUDE_DIRS - Directory where liblzma headers are located.
- LIBLZMA_LIBRARIES - Lzma libraries to link against.
- LIBLZMA_HAS_AUTO_DECODER - True if lzma_auto_decoder() is found (required).
- LIBLZMA_HAS_EASY_ENCODER - True if lzma_easy_encoder() is found (required).
- LIBLZMA_HAS_LZMA_PRESET - True if lzma_lzma_preset() is found (required).
- LIBLZMA_VERSION_MAJOR - The major version of lzma
- LIBLZMA_VERSION_MINOR - The minor version of lzma
- LIBLZMA_VERSION_PATCH - The patch version of lzma
- LIBLZMA_VERSION_STRING - version number as a string (ex: "5.0.3")
+``LIBLZMA_FOUND``
+ True if liblzma headers and library were found.
+``LIBLZMA_INCLUDE_DIRS``
+ Directory where liblzma headers are located.
+``LIBLZMA_LIBRARIES``
+ Lzma libraries to link against.
+``LIBLZMA_HAS_AUTO_DECODER``
+ True if lzma_auto_decoder() is found (required).
+``LIBLZMA_HAS_EASY_ENCODER``
+ True if lzma_easy_encoder() is found (required).
+``LIBLZMA_HAS_LZMA_PRESET``
+ True if lzma_lzma_preset() is found (required).
+``LIBLZMA_VERSION_MAJOR``
+ The major version of lzma
+``LIBLZMA_VERSION_MINOR``
+ The minor version of lzma
+``LIBLZMA_VERSION_PATCH``
+ The patch version of lzma
+``LIBLZMA_VERSION_STRING``
+ version number as a string (ex: "5.0.3")
#]=======================================================================]
find_path(LIBLZMA_INCLUDE_DIR lzma.h )