Skip to content

Commit d14062e

Browse files
authored
docs: Add documentation for LLVM_ENABLE_LIBEDIT CMake flag (#147112)
This adds missing documentation for the LLVM_ENABLE_LIBEDIT flag to the CMake documentation page, addressing the issue that this flag was undocumented despite being used in the build system. The documentation explains: - Purpose: Controls libedit support for command-line editing - Supported values: ON, OFF, or auto-detection - Default behavior: Auto-detection when not specified Fixes: #146477
1 parent 18b4095 commit d14062e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

llvm/docs/CMake.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,13 @@ enabled sub-projects. Nearly all of these variable names begin with
540540
passed to invocations of both so that the project is built using libc++
541541
instead of stdlibc++. Defaults to OFF.
542542

543+
**LLVM_ENABLE_LIBEDIT**:BOOL
544+
Controls whether to enable libedit support for command-line editing and history
545+
in LLVM tools. When ``ON``, forces libedit support to be enabled and will cause a
546+
CMake configuration error if libedit cannot be found. When ``OFF``, disables
547+
libedit support entirely. If not specified, LLVM will auto-detect libedit
548+
availability. Defaults to auto-detection.
549+
543550
**LLVM_ENABLE_LIBPFM**:BOOL
544551
Enable building with libpfm to support hardware counter measurements in LLVM
545552
tools.

0 commit comments

Comments
 (0)