diff options
| author | Murat Toprak <64306017+toprakmurat@users.noreply.github.com> | 2025-07-09 07:11:14 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-09 09:41:14 +0530 |
| commit | d14062ee7a5b1c97f2a1d98f52c7a9d178cbceff (patch) | |
| tree | abfe74334bd3b2e62357ee865ae4b9ec007e897c | |
| parent | 18b409558a9936cc7367f9cc59eaae4867a31e2b (diff) | |
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
| -rw-r--r-- | llvm/docs/CMake.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst index 2f03421c9223..17be41b20a12 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. |