[all-commits] [llvm/llvm-project] ce8251: [LLDB][Docs] List available settings (#168245)

[Nerixyz via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: ce8251e60a367d8c65c74795b354dfaa4f387ec3
      https://github.com/llvm/llvm-project/commit/ce8251e60a367d8c65c74795b354dfaa4f387ec3
  Author: Nerixyz <nerixdev at outlook.de>
  Date:   2026-04-14 (Tue, 14 Apr 2026)

  Changed paths:
    M lldb/cmake/modules/AddLLDB.cmake
    M lldb/docs/CMakeLists.txt
    A lldb/docs/_ext/build_include.py
    A lldb/docs/_ext/lldb_setting.py
    A lldb/docs/_static/lldb-setting.css
    M lldb/docs/conf.py
    M lldb/docs/index.rst
    A lldb/docs/use/settings.md
    A lldb/scripts/gen-property-docs-from-json.py
    M lldb/source/Core/CMakeLists.txt
    M lldb/source/Interpreter/CMakeLists.txt
    M lldb/source/Plugins/DynamicLoader/Darwin-Kernel/CMakeLists.txt
    M lldb/source/Plugins/JITLoader/GDB/CMakeLists.txt
    M lldb/source/Plugins/Language/CPlusPlus/CMakeLists.txt
    M lldb/source/Plugins/ObjectFile/PECOFF/CMakeLists.txt
    M lldb/source/Plugins/Platform/Android/CMakeLists.txt
    M lldb/source/Plugins/Platform/MacOSX/CMakeLists.txt
    M lldb/source/Plugins/Platform/QemuUser/CMakeLists.txt
    M lldb/source/Plugins/Platform/WebAssembly/CMakeLists.txt
    M lldb/source/Plugins/Process/CMakeLists.txt
    M lldb/source/Plugins/Process/FreeBSD-Kernel-Core/CMakeLists.txt
    M lldb/source/Plugins/Process/MacOSX-Kernel/CMakeLists.txt
    M lldb/source/Plugins/Process/gdb-remote/CMakeLists.txt
    M lldb/source/Plugins/StructuredData/DarwinLog/CMakeLists.txt
    M lldb/source/Plugins/SymbolFile/DWARF/CMakeLists.txt
    M lldb/source/Plugins/SymbolFile/PDB/CMakeLists.txt
    M lldb/source/Plugins/SymbolLocator/Debuginfod/CMakeLists.txt
    M lldb/source/Plugins/Trace/CMakeLists.txt
    M lldb/source/Plugins/Trace/intel-pt/CMakeLists.txt
    M lldb/source/Target/CMakeLists.txt

  Log Message:
  -----------
  [LLDB][Docs] List available settings (#168245)

This PR adds a documentation page that lists all available settings. The
page is automatically generated.

Having the settings listed in the online documentation makes it easier
to search for users. It also has the advantage of being indexed by
search engines.

To generate the docs, we first generate JSON out of the TableGen
definitions with `-dump-json`.

Once all properties are available as JSON, a Markdown file with the
merged documentation (`settings.md`) is generated. I chose Markdown over
RST, because some descriptions already use backticks, which would become
references in RST.

Currently, enum names/descriptions are not visible, because they're
defined in C++. In the future, these could be moved to TableGen as well.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications