llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-lldb Author: Med Ismail Bennani (medismailben) <details> <summary>Changes</summary> 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. --- Full diff: https://github.com/llvm/llvm-project/pull/181594.diff 4 Files Affected: - (modified) lldb/docs/CMakeLists.txt (+1) - (modified) lldb/docs/python_extensions.rst (+7) - (modified) lldb/docs/use/python-reference.rst (+1-1) - (renamed) lldb/docs/use/tutorials/hunting-down-symbols.md (+1-1) ``````````diff 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 `````````` </details> https://github.com/llvm/llvm-project/pull/181594 _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
