[clang] f53db00 - [docs] Rename selected clang docs to Markdown (#206181)
via cfe-commits
cfe-commits at lists.llvm.org
Mon Jun 29 13:48:08 PDT 2026
Author: Reid Kleckner
Date: 2026-06-29T13:48:02-07:00
New Revision: f53db0093959cc0b7b02194789b38de7ca718373
URL: https://github.com/llvm/llvm-project/commit/f53db0093959cc0b7b02194789b38de7ca718373
DIFF: https://github.com/llvm/llvm-project/commit/f53db0093959cc0b7b02194789b38de7ca718373.diff
LOG: [docs] Rename selected clang docs to Markdown (#206181)
Tracking issue: https://github.com/llvm/llvm-project/issues/201242
Migration guide docs:
https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines
RFC:
https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/90840
Rename 20 selected clang docs from reStructuredText to MyST Markdown
filenames.
This PR is intentionally limited to the rename phase and required
reference updates. The mechanical conversion and follow-up MyST cleanup
are in the stacked PR.
Added:
clang/docs/AddressSanitizer.md
clang/docs/ClangStaticAnalyzer.md
clang/docs/CrossCompilation.md
clang/docs/DataFlowSanitizer.md
clang/docs/FunctionEffectAnalysis.md
clang/docs/LanguageExtensions.md
clang/docs/LeakSanitizer.md
clang/docs/LifetimeSafety.md
clang/docs/MemorySanitizer.md
clang/docs/RealtimeSanitizer.md
clang/docs/ReleaseNotes.md
clang/docs/SafeBuffers.md
clang/docs/SanitizerCoverage.md
clang/docs/ScalableStaticAnalysis/index.md
clang/docs/ThreadSafetyAnalysis.md
clang/docs/ThreadSanitizer.md
clang/docs/Toolchain.md
clang/docs/TypeSanitizer.md
clang/docs/UndefinedBehaviorSanitizer.md
clang/docs/WarningSuppressionMappings.md
Modified:
llvm/utils/release/clear-release-notes.py
Removed:
clang/docs/AddressSanitizer.rst
clang/docs/ClangStaticAnalyzer.rst
clang/docs/CrossCompilation.rst
clang/docs/DataFlowSanitizer.rst
clang/docs/FunctionEffectAnalysis.rst
clang/docs/LanguageExtensions.rst
clang/docs/LeakSanitizer.rst
clang/docs/LifetimeSafety.rst
clang/docs/MemorySanitizer.rst
clang/docs/RealtimeSanitizer.rst
clang/docs/ReleaseNotes.rst
clang/docs/SafeBuffers.rst
clang/docs/SanitizerCoverage.rst
clang/docs/ScalableStaticAnalysis/index.rst
clang/docs/ThreadSafetyAnalysis.rst
clang/docs/ThreadSanitizer.rst
clang/docs/Toolchain.rst
clang/docs/TypeSanitizer.rst
clang/docs/UndefinedBehaviorSanitizer.rst
clang/docs/WarningSuppressionMappings.rst
################################################################################
diff --git a/clang/docs/AddressSanitizer.rst b/clang/docs/AddressSanitizer.md
similarity index 100%
rename from clang/docs/AddressSanitizer.rst
rename to clang/docs/AddressSanitizer.md
diff --git a/clang/docs/ClangStaticAnalyzer.rst b/clang/docs/ClangStaticAnalyzer.md
similarity index 100%
rename from clang/docs/ClangStaticAnalyzer.rst
rename to clang/docs/ClangStaticAnalyzer.md
diff --git a/clang/docs/CrossCompilation.rst b/clang/docs/CrossCompilation.md
similarity index 100%
rename from clang/docs/CrossCompilation.rst
rename to clang/docs/CrossCompilation.md
diff --git a/clang/docs/DataFlowSanitizer.rst b/clang/docs/DataFlowSanitizer.md
similarity index 100%
rename from clang/docs/DataFlowSanitizer.rst
rename to clang/docs/DataFlowSanitizer.md
diff --git a/clang/docs/FunctionEffectAnalysis.rst b/clang/docs/FunctionEffectAnalysis.md
similarity index 100%
rename from clang/docs/FunctionEffectAnalysis.rst
rename to clang/docs/FunctionEffectAnalysis.md
diff --git a/clang/docs/LanguageExtensions.rst b/clang/docs/LanguageExtensions.md
similarity index 100%
rename from clang/docs/LanguageExtensions.rst
rename to clang/docs/LanguageExtensions.md
diff --git a/clang/docs/LeakSanitizer.rst b/clang/docs/LeakSanitizer.md
similarity index 100%
rename from clang/docs/LeakSanitizer.rst
rename to clang/docs/LeakSanitizer.md
diff --git a/clang/docs/LifetimeSafety.rst b/clang/docs/LifetimeSafety.md
similarity index 100%
rename from clang/docs/LifetimeSafety.rst
rename to clang/docs/LifetimeSafety.md
diff --git a/clang/docs/MemorySanitizer.rst b/clang/docs/MemorySanitizer.md
similarity index 100%
rename from clang/docs/MemorySanitizer.rst
rename to clang/docs/MemorySanitizer.md
diff --git a/clang/docs/RealtimeSanitizer.rst b/clang/docs/RealtimeSanitizer.md
similarity index 100%
rename from clang/docs/RealtimeSanitizer.rst
rename to clang/docs/RealtimeSanitizer.md
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.md
similarity index 100%
rename from clang/docs/ReleaseNotes.rst
rename to clang/docs/ReleaseNotes.md
diff --git a/clang/docs/SafeBuffers.rst b/clang/docs/SafeBuffers.md
similarity index 100%
rename from clang/docs/SafeBuffers.rst
rename to clang/docs/SafeBuffers.md
diff --git a/clang/docs/SanitizerCoverage.rst b/clang/docs/SanitizerCoverage.md
similarity index 100%
rename from clang/docs/SanitizerCoverage.rst
rename to clang/docs/SanitizerCoverage.md
diff --git a/clang/docs/ScalableStaticAnalysis/index.rst b/clang/docs/ScalableStaticAnalysis/index.md
similarity index 100%
rename from clang/docs/ScalableStaticAnalysis/index.rst
rename to clang/docs/ScalableStaticAnalysis/index.md
diff --git a/clang/docs/ThreadSafetyAnalysis.rst b/clang/docs/ThreadSafetyAnalysis.md
similarity index 100%
rename from clang/docs/ThreadSafetyAnalysis.rst
rename to clang/docs/ThreadSafetyAnalysis.md
diff --git a/clang/docs/ThreadSanitizer.rst b/clang/docs/ThreadSanitizer.md
similarity index 100%
rename from clang/docs/ThreadSanitizer.rst
rename to clang/docs/ThreadSanitizer.md
diff --git a/clang/docs/Toolchain.rst b/clang/docs/Toolchain.md
similarity index 100%
rename from clang/docs/Toolchain.rst
rename to clang/docs/Toolchain.md
diff --git a/clang/docs/TypeSanitizer.rst b/clang/docs/TypeSanitizer.md
similarity index 100%
rename from clang/docs/TypeSanitizer.rst
rename to clang/docs/TypeSanitizer.md
diff --git a/clang/docs/UndefinedBehaviorSanitizer.rst b/clang/docs/UndefinedBehaviorSanitizer.md
similarity index 100%
rename from clang/docs/UndefinedBehaviorSanitizer.rst
rename to clang/docs/UndefinedBehaviorSanitizer.md
diff --git a/clang/docs/WarningSuppressionMappings.rst b/clang/docs/WarningSuppressionMappings.md
similarity index 100%
rename from clang/docs/WarningSuppressionMappings.rst
rename to clang/docs/WarningSuppressionMappings.md
diff --git a/llvm/utils/release/clear-release-notes.py b/llvm/utils/release/clear-release-notes.py
index 3ea0298b43d43..f737df063361d 100755
--- a/llvm/utils/release/clear-release-notes.py
+++ b/llvm/utils/release/clear-release-notes.py
@@ -41,7 +41,7 @@ def process_file(fpath: Path) -> None:
source_root = Path(args.source_root).resolve()
files_to_update = (
- "clang/docs/ReleaseNotes.rst",
+ "clang/docs/ReleaseNotes.md",
"clang-tools-extra/docs/ReleaseNotes.rst",
"flang/docs/ReleaseNotes.md",
"lld/docs/ReleaseNotes.rst",
More information about the cfe-commits
mailing list