[llvm] 7203497 - [docs] Update LLVM_ENABLE_ZLIB/LLVM_ENABLE_ZSTD (#65218)

via llvm-commits llvm-commits at lists.llvm.org
Sun Sep 3 09:52:18 PDT 2023


Author: Fangrui Song
Date: 2023-09-03T09:52:14-07:00
New Revision: 72034977c0314d7bccf19df9ab71cf4144930ab8

URL: https://github.com/llvm/llvm-project/commit/72034977c0314d7bccf19df9ab71cf4144930ab8
DIFF: https://github.com/llvm/llvm-project/commit/72034977c0314d7bccf19df9ab71cf4144930ab8.diff

LOG: [docs] Update LLVM_ENABLE_ZLIB/LLVM_ENABLE_ZSTD (#65218)

e6c7ed6d2164a0659fd9f6ee44f1375d301e3cad changed LLVM_ENABLE_ZLIB to a
tri-state. Update the doc. Add doc for LLVM_ENABLE_ZSTD.

Close #65201

Added: 
    

Modified: 
    llvm/docs/CMake.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index d04feda0a771c1..67f740447ed7bf 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -600,9 +600,15 @@ enabled sub-projects. Nearly all of these variable names begin with
   If enabled, the Z3 constraint solver is activated for the Clang static analyzer.
   A recent version of the z3 library needs to be available on the system.
 
-**LLVM_ENABLE_ZLIB**:BOOL
-  Enable building with zlib to support compression/uncompression in LLVM tools.
-  Defaults to ON.
+**LLVM_ENABLE_ZLIB**:STRING
+  Used to decide if LLVM tools should support compression/decompression with
+  zlib. Allowed values are ``OFF``, ``ON`` (default, enable if zlib is found),
+  and ``FORCE_ON`` (error if zlib is not found).
+
+**LLVM_ENABLE_ZSTD**:STRING
+  Used to decide if LLVM tools should support compression/decompression with
+  zstd. Allowed values are ``OFF``, ``ON`` (default, enable if zstd is found),
+  and ``FORCE_ON`` (error if zstd is not found).
 
 **LLVM_EXPERIMENTAL_TARGETS_TO_BUILD**:STRING
   Semicolon-separated list of experimental targets to build and linked into


        


More information about the llvm-commits mailing list