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

[David Spickett via lldb-commits]

================
@@ -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.
----------------
DavidSpickett wrote:

This sentence is difficult to understand because it's an exception to a rule you stated in the previous paragraph, it would be better if it was all here in the final paragraph.

Perhaps you can not talk about the combination until the final paragraph.

Keep the first paragraph as is.
Second one, delete "in combination with" and just state what the option does.
Third one, "When both of these options are enabled....". And finish with "note: On Windows `LLDB_ENABLE_DYNAMIC_SCRIPTINTERPRETERS` is not required.".

The information given is exactly what I was looking for, just re-order it a bit.

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