mirrors/llvm-project
0
0 Fork 0
mirror of https://github.com/llvm/llvm-project.git synced 2026-10-26 13:53:31 +08:00
Code Activity
Files
main
llvm-project/llvm/docs/CompilerWriterInfo.md
T
Reid Kleckner bebff2a2e9 [docs] Prefer colon fences to delineate blocks containing markup (#214921) 
Myst has an extension,
[colon_fence](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-colon-fence),
that we enable in our docs. There are many Markdown-aware tools out
there that know to interpret triple backtick as a code block fence, so
they highlight them as pre-formatted text. Colon fences are an
unrecognized Myst extension, and if the Sphinx directive contains a
block of markdown formatted text, that's the desired behavior.
Therefore, at some point during the migration, I started using them.
However, I didn't document this guideline, and I didn't apply it
consistently to the early docs. This PR does that: documents the
guideline, and applies it to our docs.

After this change:
```
❯ rg '```\{(option|note|todo|admonition|warning)\}' | cut -d / -f 1 | sort | uniq -c
     72 clang-tools-extra
```

The generated HTML was byte-identical.

I plan to leave clang-tools-extra untouched since there are PRs in
flight.

LLM-assisted
2026-08-08 14:31:46 -07:00

9.1 KiB
Raw Permalink Blame History

Architecture & Platform Information for Compiler Writers

:::{note} This document is a work-in-progress. Additions and clarifications are welcome. :::

Hardware

AArch64 & ARM

Itanium (ia64)

Lanai

MIPS

PowerPC

IBM - Official manuals and docs

Embedded PowerPC Processors manuals and docs

Other documents, collections, notes

AMDGPU

Refer to {doc}AMDGPUUsage for additional documentation.

RISC-V

C-SKY

LoongArch

SPARC

SystemZ

VE

X86

XCore

Hexagon

Other relevant lists

ABI

Linux

macOS

Windows

NVPTX

SPIR-V

Miscellaneous Resources

View Git Blame Copy Permalink