[all-commits] [llvm/llvm-project] f70a28: [lldb][docs] Convert resources/ RST docs to Markdo...

[Jonas Devlieghere via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: f70a28f4d1b5d17d94fca03fb74387ad800560de
      https://github.com/llvm/llvm-project/commit/f70a28f4d1b5d17d94fca03fb74387ad800560de
  Author: Jonas Devlieghere <jonas at devlieghere.com>
  Date:   2026-06-03 (Wed, 03 Jun 2026)

  Changed paths:
    A lldb/docs/resources/build.md
    R lldb/docs/resources/build.rst
    A lldb/docs/resources/dataformatters.md
    R lldb/docs/resources/dataformatters.rst
    A lldb/docs/resources/debugging.md
    R lldb/docs/resources/debugging.rst
    A lldb/docs/resources/extensions.md
    R lldb/docs/resources/extensions.rst
    A lldb/docs/resources/formatterbytecode.md
    R lldb/docs/resources/formatterbytecode.rst
    A lldb/docs/resources/overview.md
    R lldb/docs/resources/overview.rst
    A lldb/docs/resources/projects.md
    R lldb/docs/resources/projects.rst
    A lldb/docs/resources/qemu-testing.md
    R lldb/docs/resources/qemu-testing.rst
    A lldb/docs/resources/sbapi.md
    R lldb/docs/resources/sbapi.rst
    A lldb/docs/resources/test.md
    R lldb/docs/resources/test.rst

  Log Message:
  -----------
  [lldb][docs] Convert resources/ RST docs to Markdown (NFC) (#201442)

Convert the ten contributor-facing RST docs under lldb/docs/resources/
to MyST Markdown. This is the second batch of an incremental RST ->
Markdown migration. The previous PR (#201256) covered nine small leaf
pages.

Files: build, dataformatters, debugging, extensions, formatterbytecode,
overview, projects, qemu-testing, sbapi, test.

Verified by building the docs on origin/main and on this branch with
identical sphinx flags and diffing both the warnings and the rendered
HTML. After file extension and line numbers are normalized, the warning
sets match exactly. Six of the ten pages are byte-identical. The four
that differ (dataformatters, projects, sbapi, test) differ only in:

  - CommonMark collapsing two-spaces-after-period to one.
- MyST adding a `myst` CSS class to `<dl>` elements and an `<hr>`
separator before footnote sections.
  - Footnote IDs renamed from auto `id3` to named `footnote-1`.

The diff also surfaced two semantic regressions in the conversion, fixed
here:

- build.md `{ref}` to `Optional Dependencies` did not match the new
`(optional-dependencies)=` anchor; updated to use the new label.
- test.md and build.md lost cross-reference behavior on single- backtick
refs to SB-class names and `lldb`. RST's default role is `any`, so
single backticks attempted xrefs; in MyST single backticks are plain
code spans. Converted these 14 occurrences to explicit `{any}`...``
syntax.

Several `eval-rst` blocks remain in formatterbytecode.md and test.md to
preserve grid tables that MyST does not render natively.

Context: https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/

Assisted-by: Claude



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