shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add documentation for LLVM_ENABLE_LIBEDIT CMake flag (#147112)

Browse Source 
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
This commit is contained in:
Murat Toprak 2025-07-09 07:11:14 +03:00 committed by GitHub
parent 18b409558a
commit d14062ee7a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
llvm/docs/CMake.rst
View File

@ -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.