From 71af911facd88e41df273a95d658c3293aa4edee Mon Sep 17 00:00:00 2001 From: Med Ismail Bennani Date: Thu, 30 Jul 2026 16:11:11 -0700 Subject: [PATCH] [lldb/docs] Document the remaining scripted-extension plugin categories (#213140) `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 --- lldb/docs/CMakeLists.txt | 1 + lldb/docs/python_extensions.md | 82 ++++++++++++++++++++++++++++++++-- 2 files changed, 80 insertions(+), 3 deletions(-) diff --git a/lldb/docs/CMakeLists.txt b/lldb/docs/CMakeLists.txt index 1b172b3c8564..f6d91daff384 100644 --- a/lldb/docs/CMakeLists.txt +++ b/lldb/docs/CMakeLists.txt @@ -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.") diff --git a/lldb/docs/python_extensions.md b/lldb/docs/python_extensions.md index ae3ca6245f6a..8d24d65d9af4 100644 --- a/lldb/docs/python_extensions.md +++ b/lldb/docs/python_extensions.md @@ -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}