[llvm-branch-commits] [llvm] [LLVM][docs] Finish MyST migration for remaining docs (batch 10) (PR #223099)

[Kazu Hirata via llvm-branch-commits]

kazutakahirata wrote:

Thank you for working on this!  Since we're both using LLMs here, I'm putting the findings in a plain-text block so GitHub preserves exact backticks/escapes and you can copy-paste it directly to your agent:

```text
1. llvm/docs/HowToSetUpLLVMStyleRTTI.md (lines 93–94, 227–228, 324–325):
   Three cross-references to "Concrete Bases and Deeper Hierarchies" were converted to Markdown reference-style links:
     [Concrete Bases and Deeper Hierarchies][concrete bases and deeper hierarchies]
   However, the reference definition was omitted at the bottom of the file, so all three currently render as literal bracketed text.
   Fix: Either add
     [concrete bases and deeper hierarchies]: #concrete-bases-and-deeper-hierarchies
   at the bottom of the file, or replace the three occurrences inline with:
     [Concrete Bases and Deeper Hierarchies](#concrete-bases-and-deeper-hierarchies)

2. llvm/docs/HowToSubmitABug.md (lines 173–176, "### LTO bugs" section):
   Because the original .rst lacked a blank line before "* Add", rst2myst escaped the bullets as "\*", causing them to render inline with literal asterisks:
     On Windows, use lld-link as the linker. Adjust your compilation
     flags as follows:
     \* Add `/lldsavetemps` to the linker flags.
     \* When linking from the compiler driver, add `/link /lldsavetemps` in order to forward that flag to the linker.
   Fix: Add a blank line after "flags as follows:" and change "\*" to "-".

3. llvm/docs/MLGO.md (accidental definition lists from .rst indentation):
   - Lines 115–118 ("### Example: CMake" section): A 2-space indent on the continuation line in .rst caused rst2myst to split a single sentence in half into a MyST definition list (":"):
       After running CMake and building the project, there should be a

       : `compilation_commands.json` file within the build directory. You can then
         run the following command to create a corpus:
     Fix: Merge this back into a single normal paragraph without ": ".
   - Lines 453–454 ("### IR2Vec" section):
       The core components are:
       : - **Vocabulary**: A mapping from IR entities (opcodes, types, etc.) to their
     Fix: Replace ": - **Vocabulary**:" with a blank line followed by "- **Vocabulary**:" (and unindent the list by 2 spaces, matching "### MIR2Vec" on line 608).

4. Leftover {title-reference} roles that should be single-backtick inline code:
   - llvm/docs/GwpAsan.md:
     - Line 133: {title-reference}`SCUDO_OPTIONS=GWP_ASAN_${OPTION_NAME}=${VALUE}` -> `SCUDO_OPTIONS=GWP_ASAN_${OPTION_NAME}=${VALUE}`
     - Line 134: {title-reference}`SCUDO_OPTIONS=GWP_ASAN_SampleRate=100` -> `SCUDO_OPTIONS=GWP_ASAN_SampleRate=100`
   - llvm/docs/HowToSubmitABug.md:
     - Lines 114, 150: {title-reference}`opt` -> `opt`
     - Lines 153, 154: {title-reference}`llvm-reduce` -> `llvm-reduce`
     - Line 156: {title-reference}`llc` -> `llc`

5. Minor escaped underscores:
   - llvm/docs/ConvergentOperations.md (line 394): is \_not\_ -> is *not*
   - llvm/docs/FuzzingLLVM.md (line 58): fuzzed \_\_cxa_demangle to death -> fuzzed `__cxa_demangle` to death
```

https://github.com/llvm/llvm-project/pull/223099