[llvm] docs: Add documentation for LLVM_ENABLE_LIBEDIT CMake flag (PR #147112)
Murat Toprak via llvm-commits
llvm-commits at lists.llvm.org
Fri Jul 4 14:27:25 PDT 2025
https://github.com/toprakmurat created https://github.com/llvm/llvm-project/pull/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
>From bb6273d001b09073da5491198c9f86ad259bebf7 Mon Sep 17 00:00:00 2001
From: Murat Toprak <murattoprak2004 at gmail.com>
Date: Sat, 5 Jul 2025 00:25:26 +0300
Subject: [PATCH] docs: Add documentation for LLVM_ENABLE_LIBEDIT CMake flag
---
llvm/docs/CMake.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index 2f03421c92230..17be41b20a12a 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -540,6 +540,13 @@ enabled sub-projects. Nearly all of these variable names begin with
passed to invocations of both so that the project is built using libc++
instead of stdlibc++. Defaults to OFF.
+**LLVM_ENABLE_LIBEDIT**:BOOL
+ Controls whether to enable libedit support for command-line editing and history
+ in LLVM tools. When ``ON``, forces libedit support to be enabled and will cause a
+ CMake configuration error if libedit cannot be found. When ``OFF``, disables
+ libedit support entirely. If not specified, LLVM will auto-detect libedit
+ availability. Defaults to auto-detection.
+
**LLVM_ENABLE_LIBPFM**:BOOL
Enable building with libpfm to support hardware counter measurements in LLVM
tools.
More information about the llvm-commits
mailing list