[clang] [clang][docs] Rename selected Clang docs {.rst, .md} (PR #208307)
via cfe-commits
cfe-commits at lists.llvm.org
Thu Jul 9 08:26:20 PDT 2026
llvmorg-github-actions[bot] wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-clang-codegen
Author: Reid Kleckner (rnk)
<details>
<summary>Changes</summary>
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
This is a rename-only commit that will temporarily break the docs build, but it will fix after the follow-up PR lands.
---
Full diff: https://github.com/llvm/llvm-project/pull/208307.diff
24 Files Affected:
- (renamed) clang/docs/HIPSupport.md ()
- (renamed) clang/docs/HLSL/HLSLDocs.md ()
- (modified) clang/docs/InternalsManual.rst (+1-1)
- (renamed) clang/docs/LTOVisibility.md ()
- (renamed) clang/docs/MSVCCompatibility.md ()
- (renamed) clang/docs/MisExpect.md ()
- (renamed) clang/docs/Modules.md ()
- (renamed) clang/docs/OpenCLSupport.md ()
- (renamed) clang/docs/OpenMPSupport.md ()
- (renamed) clang/docs/OverflowBehaviorTypes.md ()
- (renamed) clang/docs/PointerAuthentication.md ()
- (renamed) clang/docs/SYCLSupport.md ()
- (renamed) clang/docs/SafeStack.md ()
- (renamed) clang/docs/SanitizerSpecialCaseList.md ()
- (renamed) clang/docs/SanitizerStats.md ()
- (renamed) clang/docs/ShadowCallStack.md ()
- (renamed) clang/docs/SourceBasedCodeCoverage.md ()
- (renamed) clang/docs/StandardCPlusPlusModules.md ()
- (renamed) clang/docs/StructureProtection.md ()
- (renamed) clang/docs/ThinLTO.md ()
- (renamed) clang/docs/UsersManual.md ()
- (modified) clang/lib/CodeGen/CodeGenModule.cpp (+1-1)
- (modified) clang/lib/Driver/ToolChains/MSVC.cpp (+1-1)
- (modified) clang/test/CodeGen/ubsan-type-ignorelist-category.test (+1-2)
``````````diff
diff --git a/clang/docs/HIPSupport.rst b/clang/docs/HIPSupport.md
similarity index 100%
rename from clang/docs/HIPSupport.rst
rename to clang/docs/HIPSupport.md
diff --git a/clang/docs/HLSL/HLSLDocs.rst b/clang/docs/HLSL/HLSLDocs.md
similarity index 100%
rename from clang/docs/HLSL/HLSLDocs.rst
rename to clang/docs/HLSL/HLSLDocs.md
diff --git a/clang/docs/InternalsManual.rst b/clang/docs/InternalsManual.rst
index a09e23063858c..27adfae06416d 100644
--- a/clang/docs/InternalsManual.rst
+++ b/clang/docs/InternalsManual.rst
@@ -692,7 +692,7 @@ deterministic manner. This enables features such as implicitly discovered,
explicitly built modules.
..
- TODO: Create and link corresponding section in Modules.rst.
+ TODO: Create and link corresponding section in Modules.md.
Adding new Command Line Option
------------------------------
diff --git a/clang/docs/LTOVisibility.rst b/clang/docs/LTOVisibility.md
similarity index 100%
rename from clang/docs/LTOVisibility.rst
rename to clang/docs/LTOVisibility.md
diff --git a/clang/docs/MSVCCompatibility.rst b/clang/docs/MSVCCompatibility.md
similarity index 100%
rename from clang/docs/MSVCCompatibility.rst
rename to clang/docs/MSVCCompatibility.md
diff --git a/clang/docs/MisExpect.rst b/clang/docs/MisExpect.md
similarity index 100%
rename from clang/docs/MisExpect.rst
rename to clang/docs/MisExpect.md
diff --git a/clang/docs/Modules.rst b/clang/docs/Modules.md
similarity index 100%
rename from clang/docs/Modules.rst
rename to clang/docs/Modules.md
diff --git a/clang/docs/OpenCLSupport.rst b/clang/docs/OpenCLSupport.md
similarity index 100%
rename from clang/docs/OpenCLSupport.rst
rename to clang/docs/OpenCLSupport.md
diff --git a/clang/docs/OpenMPSupport.rst b/clang/docs/OpenMPSupport.md
similarity index 100%
rename from clang/docs/OpenMPSupport.rst
rename to clang/docs/OpenMPSupport.md
diff --git a/clang/docs/OverflowBehaviorTypes.rst b/clang/docs/OverflowBehaviorTypes.md
similarity index 100%
rename from clang/docs/OverflowBehaviorTypes.rst
rename to clang/docs/OverflowBehaviorTypes.md
diff --git a/clang/docs/PointerAuthentication.rst b/clang/docs/PointerAuthentication.md
similarity index 100%
rename from clang/docs/PointerAuthentication.rst
rename to clang/docs/PointerAuthentication.md
diff --git a/clang/docs/SYCLSupport.rst b/clang/docs/SYCLSupport.md
similarity index 100%
rename from clang/docs/SYCLSupport.rst
rename to clang/docs/SYCLSupport.md
diff --git a/clang/docs/SafeStack.rst b/clang/docs/SafeStack.md
similarity index 100%
rename from clang/docs/SafeStack.rst
rename to clang/docs/SafeStack.md
diff --git a/clang/docs/SanitizerSpecialCaseList.rst b/clang/docs/SanitizerSpecialCaseList.md
similarity index 100%
rename from clang/docs/SanitizerSpecialCaseList.rst
rename to clang/docs/SanitizerSpecialCaseList.md
diff --git a/clang/docs/SanitizerStats.rst b/clang/docs/SanitizerStats.md
similarity index 100%
rename from clang/docs/SanitizerStats.rst
rename to clang/docs/SanitizerStats.md
diff --git a/clang/docs/ShadowCallStack.rst b/clang/docs/ShadowCallStack.md
similarity index 100%
rename from clang/docs/ShadowCallStack.rst
rename to clang/docs/ShadowCallStack.md
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.md
similarity index 100%
rename from clang/docs/SourceBasedCodeCoverage.rst
rename to clang/docs/SourceBasedCodeCoverage.md
diff --git a/clang/docs/StandardCPlusPlusModules.rst b/clang/docs/StandardCPlusPlusModules.md
similarity index 100%
rename from clang/docs/StandardCPlusPlusModules.rst
rename to clang/docs/StandardCPlusPlusModules.md
diff --git a/clang/docs/StructureProtection.rst b/clang/docs/StructureProtection.md
similarity index 100%
rename from clang/docs/StructureProtection.rst
rename to clang/docs/StructureProtection.md
diff --git a/clang/docs/ThinLTO.rst b/clang/docs/ThinLTO.md
similarity index 100%
rename from clang/docs/ThinLTO.rst
rename to clang/docs/ThinLTO.md
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.md
similarity index 100%
rename from clang/docs/UsersManual.rst
rename to clang/docs/UsersManual.md
diff --git a/clang/lib/CodeGen/CodeGenModule.cpp b/clang/lib/CodeGen/CodeGenModule.cpp
index e155fdd752d7f..8e75ac4dd650f 100644
--- a/clang/lib/CodeGen/CodeGenModule.cpp
+++ b/clang/lib/CodeGen/CodeGenModule.cpp
@@ -5109,7 +5109,7 @@ void CodeGenModule::emitMultiVersionFunctions() {
}
// Symbols with this prefix are used as deactivation symbols for PFP fields.
-// See clang/docs/StructureProtection.rst for more information.
+// See clang/docs/StructureProtection.md for more information.
static const char PFPDeactivationSymbolPrefix[] = "__pfp_ds_";
llvm::GlobalValue *
diff --git a/clang/lib/Driver/ToolChains/MSVC.cpp b/clang/lib/Driver/ToolChains/MSVC.cpp
index fd3c225d27f03..2b428c56ed1be 100644
--- a/clang/lib/Driver/ToolChains/MSVC.cpp
+++ b/clang/lib/Driver/ToolChains/MSVC.cpp
@@ -944,7 +944,7 @@ VersionTuple MSVCToolChain::computeMSVCVersion(const Driver *D,
IsWindowsMSVC)) {
// -fms-compatibility-version=19.33 is default, aka 2022, 17.3
// NOTE: when changing this value, also update
- // clang/docs/CommandGuide/clang.rst and clang/docs/UsersManual.rst
+ // clang/docs/CommandGuide/clang.rst and clang/docs/UsersManual.md
// accordingly.
MSVT = VersionTuple(19, 33);
}
diff --git a/clang/test/CodeGen/ubsan-type-ignorelist-category.test b/clang/test/CodeGen/ubsan-type-ignorelist-category.test
index 70a89d3e31249..480279c7c32bc 100644
--- a/clang/test/CodeGen/ubsan-type-ignorelist-category.test
+++ b/clang/test/CodeGen/ubsan-type-ignorelist-category.test
@@ -101,7 +101,7 @@ void ignore_all_except_myty_divrem(int A, int B, myty C, myty D) {
(void)(A%B);
}
-// Matches the example from clang/docs/SanitizerSpecialCaseList.rst
+// Matches the example from clang/docs/SanitizerSpecialCaseList.md
typedef char T;
typedef char U;
// TRUNC2-LABEL: docs_example
@@ -113,4 +113,3 @@ void docs_example(int toobig) {
// TRUNC2-NOT: %handler.implicit_conversion
char c = toobig;
}
-
``````````
</details>
https://github.com/llvm/llvm-project/pull/208307
More information about the cfe-commits
mailing list