[Lldb-commits] [lldb] f383369 - [lldb][docs] Document the script interpreter plugin build options (#212655)

[via lldb-commits]

Author: Jonas Devlieghere
Date: 2026-07-30T09:12:42-07:00
New Revision: f38336987beb7f173e448e50578208b37027c035

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

LOG: [lldb][docs] Document the script interpreter plugin build options (#212655)

Describe LLDB_ENABLE_DYNAMIC_SCRIPTINTERPRETERS and how it interacts
with LLDB_ENABLE_PYTHON_LIMITED_API, including the platform defaults for
both and why the Python Limited API requires dynamic script interpreter
plugins everywhere but Windows.

Added: 
    

Modified: 
    lldb/docs/resources/build.md

Removed: 
    


################################################################################
diff  --git a/lldb/docs/resources/build.md b/lldb/docs/resources/build.md
index 2ad5fb8c91bda..aa819483f47a1 100644
--- a/lldb/docs/resources/build.md
+++ b/lldb/docs/resources/build.md
@@ -266,6 +266,21 @@ $ cmake -G Ninja \
 It is strongly recommend to use a release build for the compiler to speed up
 test execution.
 
+#### Script Interpreter Plugins
+
+LLDB's script interpreter plugins (for Python and  Lua) can be built as static
+or dynamic libraries. This is controlled by
+`LLDB_ENABLE_DYNAMIC_SCRIPTINTERPRETERS`, which defaults to `ON` on masOS and
+FreeBSD, and `OFF` everywhere else.
+
+`LLDB_ENABLE_PYTHON_LIMITED_API` makes LLDB use the Python
+[Limited API](https://docs.python.org/3/c-api/stable.html). It defaults to `ON`
+when using SWIG 4.2 or later.
+
+When both of these options are enabled, LLDB can use, and be used from, a
+
diff erent version of Python (3.8 or later) than it was built against. Note that
+on Windows, `LLDB_ENABLE_DYNAMIC_SCRIPTINTERPRETERS` is not required.
+
 #### Windows
 
 On Windows the LLDB test suite requires lld. Either add `lld` to