https://github.com/medismailben created https://github.com/llvm/llvm-project/pull/181594
This patch adds documentation for the Scripted Symbol Locator plugin system, including tutorial (renamed to hunting-down-symbols.md to match other tutorial naming conventions) and cleans up API reference for the website. >From ddbf1c4191233cbe3052f3c24477985a059158e3 Mon Sep 17 00:00:00 2001 From: Med Ismail Bennani <[email protected]> Date: Sun, 15 Feb 2026 18:44:47 -0800 Subject: [PATCH] [lldb/docs] Add Scripted Symbol Locator to website documentation This patch adds documentation for the Scripted Symbol Locator plugin system, including tutorial (renamed to hunting-down-symbols.md to match other tutorial naming conventions) and cleans up API reference for the website. Signed-off-by: Med Ismail Bennani <[email protected]> --- lldb/docs/CMakeLists.txt | 1 + lldb/docs/python_extensions.rst | 7 +++++++ lldb/docs/use/python-reference.rst | 2 +- ...{scripted-symbol-locator.md => hunting-down-symbols.md} | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) rename lldb/docs/use/tutorials/{scripted-symbol-locator.md => hunting-down-symbols.md} (99%) diff --git a/lldb/docs/CMakeLists.txt b/lldb/docs/CMakeLists.txt index bbecf606f1f8f..51fe9635cc4a3 100644 --- a/lldb/docs/CMakeLists.txt +++ b/lldb/docs/CMakeLists.txt @@ -33,6 +33,7 @@ if (LLDB_ENABLE_PYTHON AND SPHINX_FOUND) COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_platform.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/" COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/operating_system.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/" COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_thread_plan.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/" + COMMAND "${CMAKE_COMMAND}" -E copy "${LLDB_SOURCE_DIR}/examples/python/templates/scripted_symbol_locator.py" "${CMAKE_CURRENT_BINARY_DIR}/lldb/plugins/" COMMENT "Copying lldb.py to pretend its a Python package.") add_dependencies(lldb-python-doc-package swig_wrapper_python) diff --git a/lldb/docs/python_extensions.rst b/lldb/docs/python_extensions.rst index 8420187efcdcc..f42681281b8e2 100644 --- a/lldb/docs/python_extensions.rst +++ b/lldb/docs/python_extensions.rst @@ -45,3 +45,10 @@ Scripted Thread Plan Plugins :no-heading: :no-inheritance-diagram: +Scripted Symbol Locator Plugins +------------------------------- + +.. automodapi:: lldb.plugins.scripted_symbol_locator + :no-heading: + :skip: ABCMeta, LocalCacheSymbolLocator + :no-inheritance-diagram: diff --git a/lldb/docs/use/python-reference.rst b/lldb/docs/use/python-reference.rst index 2b345a7cd3bbf..b14b2b67e6055 100644 --- a/lldb/docs/use/python-reference.rst +++ b/lldb/docs/use/python-reference.rst @@ -28,4 +28,4 @@ The following tutorials and documentation demonstrate various Python capabilitie tutorials/implementing-standalone-scripts tutorials/custom-frame-recognizers tutorials/extending-target-stop-hooks - tutorials/scripted-symbol-locator + tutorials/hunting-down-symbols diff --git a/lldb/docs/use/tutorials/scripted-symbol-locator.md b/lldb/docs/use/tutorials/hunting-down-symbols.md similarity index 99% rename from lldb/docs/use/tutorials/scripted-symbol-locator.md rename to lldb/docs/use/tutorials/hunting-down-symbols.md index eaba91d9b444b..8ef7beb5c6284 100644 --- a/lldb/docs/use/tutorials/scripted-symbol-locator.md +++ b/lldb/docs/use/tutorials/hunting-down-symbols.md @@ -1,4 +1,4 @@ -# Scripted Symbol Locator Tutorial +# Hunting down symbols with Scripted Symbol Locator The **Scripted Symbol Locator** lets you write a Python class that tells LLDB where to find executables, symbol files, and source files for your debug _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
