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

[via lldb-commits]

llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-lldb

Author: Jonas Devlieghere (JDevlieghere)

<details>
<summary>Changes</summary>

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.

---
Full diff: https://github.com/llvm/llvm-project/pull/212655.diff


1 Files Affected:

- (modified) lldb/docs/resources/build.md (+14) 


``````````diff
diff --git a/lldb/docs/resources/build.md b/lldb/docs/resources/build.md
index 2ad5fb8c91bda..349b8ed29e6c1 100644
--- a/lldb/docs/resources/build.md
+++ b/lldb/docs/resources/build.md
@@ -266,6 +266,20 @@ $ 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 can be built as static or dynamic libraries.
+This is controlled by `LLDB_ENABLE_DYNAMIC_SCRIPTINTERPRETERS`, which defaults
+to `ON` on Darwin and FreeBSD and `OFF` everywhere else.
+
+This option is used in combination with `LLDB_ENABLE_PYTHON_LIMITED_API`, which
+defaults to `ON` when using SWIG 4.2 or later. When enabled, LLDB uses the
+Python [Limited API](https://docs.python.org/3/c-api/stable.html).
+
+The Python Limited API allows LLDB to use, and be used from, a different
+version of Python (3.8 or later) than it was built against. Except on Windows,
+this also requires the script interpreters to be built as dynamic libraries.
+
 #### Windows
 
 On Windows the LLDB test suite requires lld. Either add `lld` to

``````````

</details>


https://github.com/llvm/llvm-project/pull/212655