Cold-Air-Networks/mirror-llvm-project
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 7

[lldb/docs] Document the remaining scripted-extension plugin categories (#213140)

Browse source 
`python_extensions.md` only covered the first five plugin categories.

This commit adds the missing sections for every plugin category added
since: `ScriptedBreakpointResolver`, `ScriptedHook`,
`ScriptedStackFrameRecognizer`, `ScriptedCommand`, `ParsedCommand`,
`ScriptedStringSummary`, and `ScriptedSyntheticChildren`.

Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
This commit is contained in:
Med Ismail Bennani 2026-07-30 16:11:11 -07:00 committed by GitHub
parent 4912831bc3
commit 71af911fac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 80 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
lldb/docs/CMakeLists.txt
View file

@ -34,6 +34,7 @@ if (LLDB_ENABLE_PYTHON AND SPHINX_FOUND)
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_hook.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_stackframe_recognizer.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_command.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/parsed_cmd.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_string_summary.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_synthetic_children.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/"
COMMENT "Copying lldb.py to pretend its a Python package.")

82
lldb/docs/python_extensions.md
View file

@ -16,6 +16,38 @@ This page describes some of these scripting extensions:
:skip: ScriptedThread
```
## Parsed Command Plugins
```{eval-rst}
.. automodule:: lldb.plugins.parsed_cmd
.. automodsumm:: lldb.plugins.parsed_cmd
:classes-only:
:toctree: python_api
```
## Scripted Breakpoint Resolver Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_breakpoint
.. automodsumm:: lldb.plugins.scripted_breakpoint
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted Command Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_command
.. automodsumm:: lldb.plugins.scripted_command
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted Frame Provider Plugins
```{eval-rst}
@ -27,12 +59,12 @@ This page describes some of these scripting extensions:
:skip: ABCMeta
```
## Scripted Process Plugins
## Scripted Hook Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_process
.. automodule:: lldb.plugins.scripted_hook
.. automodsumm:: lldb.plugins.scripted_process
.. automodsumm:: lldb.plugins.scripted_hook
:classes-only:
:toctree: python_api
:skip: ABCMeta
@ -49,6 +81,50 @@ This page describes some of these scripting extensions:
:skip: ABCMeta
```
## Scripted Process Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_process
.. automodsumm:: lldb.plugins.scripted_process
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted Stack Frame Recognizer Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_stackframe_recognizer
.. automodsumm:: lldb.plugins.scripted_stackframe_recognizer
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted String Summary Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_string_summary
.. automodsumm:: lldb.plugins.scripted_string_summary
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted Synthetic Children Plugins
```{eval-rst}
.. automodule:: lldb.plugins.scripted_synthetic_children
.. automodsumm:: lldb.plugins.scripted_synthetic_children
:classes-only:
:toctree: python_api
:skip: ABCMeta
```
## Scripted Thread Plan Plugins
```{eval-rst}