[all-commits] [llvm/llvm-project] 52a439: [lldb][docs] Convert use/ RST docs to Markdown (NF...

[Jonas Devlieghere via All-commits]

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

  Changed paths:
    A lldb/docs/use/formatting.md
    R lldb/docs/use/formatting.rst
    A lldb/docs/use/intel_pt.md
    R lldb/docs/use/intel_pt.rst
    A lldb/docs/use/map.md
    R lldb/docs/use/map.rst
    A lldb/docs/use/remote.md
    R lldb/docs/use/remote.rst
    A lldb/docs/use/symbolfilejson.md
    R lldb/docs/use/symbolfilejson.rst
    A lldb/docs/use/symbolication.md
    R lldb/docs/use/symbolication.rst
    A lldb/docs/use/symbols.md
    R lldb/docs/use/symbols.rst
    A lldb/docs/use/troubleshooting.md
    R lldb/docs/use/troubleshooting.rst
    A lldb/docs/use/tutorial.md
    R lldb/docs/use/tutorial.rst
    A lldb/docs/use/variable.md
    R lldb/docs/use/variable.rst

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

Convert the ten user-facing RST docs under lldb/docs/use/ to MyST
Markdown. This is the third batch of an incremental RST -> Markdown
migration; PR1 covered the small leaf pages and PR2 covered the
contributor-facing docs under resources/.

Files: formatting, intel_pt, map, remote, symbolfilejson, symbolication,
symbols, troubleshooting, tutorial, variable.

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. Seven of the ten pages are byte-identical. The three
that differ (symbolication, tutorial, variable) differ only in
CommonMark collapsing two-spaces-after-period to one and MyST renaming
auto-numbered footnote IDs (`id6` -> `footnote-1`) plus adding an `<hr>`
separator before footnote sections.

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

- variable.md lost cross-reference behavior on single-backtick refs to
`SBValue` and `SBData`. RST's default role is `any`, so single backticks
attempted xrefs; in MyST single backticks are plain code spans.
Converted these occurrences to explicit `{any}`...``.
- map.md emitted bare `[Section Name]` for the page TOC, which
CommonMark treats as an undefined reference shortcut and falls through
to literal text. Converted to `[Section Name](#slug)`.
- variable.md emitted `[format name][format name]` as a similar
undefined reference shortcut. Converted to `[format name](#format-
name)` to match the new `(format-name)=` anchor.

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