[docs] Rename 22 popular LLVM docs .rst -> .md#201243
Open
rnk wants to merge 2 commits into
Open
Conversation
Update filename references, but leave the docs with reST syntax to ensure rename detection works. I updated filename references so that the docs build to pass premerge checks.
|
@llvm/pr-subscribers-testing-tools @llvm/pr-subscribers-debuginfo Author: Reid Kleckner (rnk) ChangesTracking issue: #201242 Update filename references, but leave the docs with reST syntax to ensure rename detection works. I updated filename references so that the docs build to pass premerge checks. Full diff: https://github.com/llvm/llvm-project/pull/201243.diff 32 Files Affected:
diff --git a/llvm/README.txt b/llvm/README.txt
index b9b71a3b6daff..aa43033da462e 100644
--- a/llvm/README.txt
+++ b/llvm/README.txt
@@ -9,7 +9,7 @@ LLVM is open source software. You may freely distribute it under the terms of
the license agreement found in LICENSE.txt.
Please see the documentation provided in docs/ for further
-assistance with LLVM, and in particular docs/GettingStarted.rst for getting
+assistance with LLVM, and in particular docs/GettingStarted.md for getting
started with LLVM and docs/README.txt for an overview of LLVM's
documentation setup.
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.md
similarity index 100%
rename from llvm/docs/CMake.rst
rename to llvm/docs/CMake.md
diff --git a/llvm/docs/CodeGenerator.rst b/llvm/docs/CodeGenerator.md
similarity index 100%
rename from llvm/docs/CodeGenerator.rst
rename to llvm/docs/CodeGenerator.md
diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.md
similarity index 100%
rename from llvm/docs/CodingStandards.rst
rename to llvm/docs/CodingStandards.md
diff --git a/llvm/docs/CommandGuide/index.rst b/llvm/docs/CommandGuide/index.md
similarity index 100%
rename from llvm/docs/CommandGuide/index.rst
rename to llvm/docs/CommandGuide/index.md
diff --git a/llvm/docs/Contributing.rst b/llvm/docs/Contributing.md
similarity index 100%
rename from llvm/docs/Contributing.rst
rename to llvm/docs/Contributing.md
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.md
similarity index 100%
rename from llvm/docs/DeveloperPolicy.rst
rename to llvm/docs/DeveloperPolicy.md
diff --git a/llvm/docs/GettingInvolved.rst b/llvm/docs/GettingInvolved.md
similarity index 100%
rename from llvm/docs/GettingInvolved.rst
rename to llvm/docs/GettingInvolved.md
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.md
similarity index 100%
rename from llvm/docs/GettingStarted.rst
rename to llvm/docs/GettingStarted.md
diff --git a/llvm/docs/GettingStartedTutorials.rst b/llvm/docs/GettingStartedTutorials.md
similarity index 100%
rename from llvm/docs/GettingStartedTutorials.rst
rename to llvm/docs/GettingStartedTutorials.md
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.md
similarity index 100%
rename from llvm/docs/GitHub.rst
rename to llvm/docs/GitHub.md
diff --git a/llvm/docs/GitRepositoryPolicy.md b/llvm/docs/GitRepositoryPolicy.md
index 10859243fc1cc..3ee81f7996dfa 100644
--- a/llvm/docs/GitRepositoryPolicy.md
+++ b/llvm/docs/GitRepositoryPolicy.md
@@ -22,7 +22,7 @@ Requirements for *new* repositories as part of the
If you want to integrate your project as part of the Monorepo, please take a
look at the
-[Developer Policy](project:DeveloperPolicy.rst#Adding an Established Project To the LLVM Monorepo).
+[Developer Policy](project:DeveloperPolicy.md#Adding an Established Project To the LLVM Monorepo).
To request a new repository, please create an issue with in
[LLVM's Github Issue Tracker](https://github.com/llvm/llvm-project/issues) and
diff --git a/llvm/docs/InstrRefDebugInfo.md b/llvm/docs/InstrRefDebugInfo.md
index e0a85f99cb4f3..7124ee26de68c 100644
--- a/llvm/docs/InstrRefDebugInfo.md
+++ b/llvm/docs/InstrRefDebugInfo.md
@@ -191,4 +191,4 @@ instruction number of any cloned instruction, to avoid duplicate numbers
appearing to `LiveDebugValues`. Dealing with duplicated instructions is a
natural extension to instruction referencing that's currently unimplemented.
-[LiveDebugValues]: project:SourceLevelDebugging.rst#LiveDebugValues expansion of variable locations
+[LiveDebugValues]: project:SourceLevelDebugging.md#LiveDebugValues expansion of variable locations
diff --git a/llvm/docs/Passes.rst b/llvm/docs/Passes.md
similarity index 100%
rename from llvm/docs/Passes.rst
rename to llvm/docs/Passes.md
diff --git a/llvm/docs/ProgrammersManual.rst b/llvm/docs/ProgrammersManual.md
similarity index 100%
rename from llvm/docs/ProgrammersManual.rst
rename to llvm/docs/ProgrammersManual.md
diff --git a/llvm/docs/RFCProcess.rst b/llvm/docs/RFCProcess.md
similarity index 100%
rename from llvm/docs/RFCProcess.rst
rename to llvm/docs/RFCProcess.md
diff --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.md
similarity index 100%
rename from llvm/docs/Reference.rst
rename to llvm/docs/Reference.md
diff --git a/llvm/docs/RemoveDIsDebugInfo.md b/llvm/docs/RemoveDIsDebugInfo.md
index 7d07352f99420..cb787c72bce2c 100644
--- a/llvm/docs/RemoveDIsDebugInfo.md
+++ b/llvm/docs/RemoveDIsDebugInfo.md
@@ -206,7 +206,7 @@ Below is a brief overview of the new representation that replaces debug intrinsi
### What exactly have you replaced debug intrinsics with?
-We're using a dedicated C++ class called `DbgRecord` to store debug info, with a one-to-one relationship between each instance of a debug intrinsic and each `DbgRecord` object in any LLVM IR program; these `DbgRecord`s are represented in the IR as non-instruction debug records, as described in the [Source Level Debugging](project:SourceLevelDebugging.rst#Debug Records) document. This class has a set of subclasses that store exactly the same information as is stored in debugging intrinsics. Each one also has almost entirely the same set of methods, that behave in the same way:
+We're using a dedicated C++ class called `DbgRecord` to store debug info, with a one-to-one relationship between each instance of a debug intrinsic and each `DbgRecord` object in any LLVM IR program; these `DbgRecord`s are represented in the IR as non-instruction debug records, as described in the [Source Level Debugging](project:SourceLevelDebugging.md#Debug Records) document. This class has a set of subclasses that store exactly the same information as is stored in debugging intrinsics. Each one also has almost entirely the same set of methods, that behave in the same way:
https://llvm.org/docs/doxygen/classllvm_1_1DbgRecord.html
https://llvm.org/docs/doxygen/classllvm_1_1DbgVariableRecord.html
diff --git a/llvm/docs/SourceLevelDebugging.rst b/llvm/docs/SourceLevelDebugging.md
similarity index 100%
rename from llvm/docs/SourceLevelDebugging.rst
rename to llvm/docs/SourceLevelDebugging.md
diff --git a/llvm/docs/SphinxQuickstartTemplate.md b/llvm/docs/SphinxQuickstartTemplate.md
index ceeb297bedf3a..9b17c332e807b 100644
--- a/llvm/docs/SphinxQuickstartTemplate.md
+++ b/llvm/docs/SphinxQuickstartTemplate.md
@@ -23,7 +23,7 @@ See the {ref}`migration <markdown_migration_guidelines>` section for more inform
This article is located in `docs/SphinxQuickstartTemplate.md`.
To use it as a template, make a copy and open it in a text editor.
-You can then write your docs, and open a [GitHub PR](project:GitHub.rst) to request a review.
+You can then write your docs, and open a [GitHub PR](project:GitHub.md) to request a review.
To view the Markdown source file for this article, click **Show Source** on the right sidebar.
@@ -167,7 +167,7 @@ without any syntax highlighting like this:
You can generate the HTML documentation from the sources locally if you want to
see what they would look like. In addition to the normal
-[build tools](project:GettingStarted.rst)
+[build tools](project:GettingStarted.md)
you need to install [Sphinx] and the necessary extensions
using the following command inside the `llvm-project` checkout:
diff --git a/llvm/docs/TableGen/index.rst b/llvm/docs/TableGen/index.md
similarity index 100%
rename from llvm/docs/TableGen/index.rst
rename to llvm/docs/TableGen/index.md
diff --git a/llvm/docs/TestingGuide.rst b/llvm/docs/TestingGuide.md
similarity index 100%
rename from llvm/docs/TestingGuide.rst
rename to llvm/docs/TestingGuide.md
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.md
similarity index 100%
rename from llvm/docs/UserGuides.rst
rename to llvm/docs/UserGuides.md
diff --git a/llvm/docs/WritingAnLLVMBackend.rst b/llvm/docs/WritingAnLLVMBackend.md
similarity index 100%
rename from llvm/docs/WritingAnLLVMBackend.rst
rename to llvm/docs/WritingAnLLVMBackend.md
diff --git a/llvm/docs/WritingAnLLVMNewPMPass.rst b/llvm/docs/WritingAnLLVMNewPMPass.md
similarity index 100%
rename from llvm/docs/WritingAnLLVMNewPMPass.rst
rename to llvm/docs/WritingAnLLVMNewPMPass.md
diff --git a/llvm/docs/WritingAnLLVMPass.rst b/llvm/docs/WritingAnLLVMPass.md
similarity index 100%
rename from llvm/docs/WritingAnLLVMPass.rst
rename to llvm/docs/WritingAnLLVMPass.md
diff --git a/llvm/docs/conf.py b/llvm/docs/conf.py
index 29b1024ff482e..ca750dded019f 100644
--- a/llvm/docs/conf.py
+++ b/llvm/docs/conf.py
@@ -292,7 +292,7 @@ def process_rst(name):
for name in os.listdir(command_guide_path):
# Process Markdown files
- if name.endswith(".md"):
+ if name.endswith(".md") and name != "index.md":
process_md(name)
# Process ReST files apart from the index page.
elif name.endswith(".rst") and name != "index.rst":
diff --git a/llvm/docs/index.rst b/llvm/docs/index.md
similarity index 100%
rename from llvm/docs/index.rst
rename to llvm/docs/index.md
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFAcceleratorTable.cpp b/llvm/lib/DebugInfo/DWARF/DWARFAcceleratorTable.cpp
index 7787261bc2162..b0ee4cc7b715c 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFAcceleratorTable.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFAcceleratorTable.cpp
@@ -57,7 +57,7 @@ Error AppleAcceleratorTable::extract() {
FormParams = {Hdr.Version, 0, dwarf::DwarfFormat::DWARF32};
// Check that we can read all the hashes and offsets from the
- // section (see SourceLevelDebugging.rst for the structure of the index).
+ // section (see SourceLevelDebugging.md for the structure of the index).
if (!AccelSection.isValidOffset(getIthBucketBase(Hdr.BucketCount - 1)))
return createStringError(
errc::illegal_byte_sequence,
diff --git a/llvm/lib/IR/DebugInfo.cpp b/llvm/lib/IR/DebugInfo.cpp
index 7889de7ebb49a..0cd8351c52469 100644
--- a/llvm/lib/IR/DebugInfo.cpp
+++ b/llvm/lib/IR/DebugInfo.cpp
@@ -2381,7 +2381,7 @@ bool AssignmentTrackingPass::runOnFunction(Function &F) {
// Note: trackAssignments doesn't respect dbg.declare's IR positions (as it
// doesn't "understand" dbg.declares). However, this doesn't appear to break
// any rules given this description of dbg.declare from
- // llvm/docs/SourceLevelDebugging.rst:
+ // llvm/docs/SourceLevelDebugging.md:
//
// It is not control-dependent, meaning that if a call to llvm.dbg.declare
// exists and has a valid location argument, that address is considered to
diff --git a/llvm/tools/reduce-chunk-list/reduce-chunk-list.cpp b/llvm/tools/reduce-chunk-list/reduce-chunk-list.cpp
index eaf173d4a88a2..b41cad32a5c28 100644
--- a/llvm/tools/reduce-chunk-list/reduce-chunk-list.cpp
+++ b/llvm/tools/reduce-chunk-list/reduce-chunk-list.cpp
@@ -6,7 +6,7 @@
//
//===----------------------------------------------------------------------===//
//
-// See the llvm-project/llvm/docs/ProgrammersManual.rst to see how to use this
+// See the llvm-project/llvm/docs/ProgrammersManual.md to see how to use this
// tool
//
//===----------------------------------------------------------------------===//
diff --git a/llvm/utils/lit/tests/Inputs/shtest-define/examples/param-subst.txt b/llvm/utils/lit/tests/Inputs/shtest-define/examples/param-subst.txt
index 91418cd5e88c4..14e43772f50f9 100644
--- a/llvm/utils/lit/tests/Inputs/shtest-define/examples/param-subst.txt
+++ b/llvm/utils/lit/tests/Inputs/shtest-define/examples/param-subst.txt
@@ -1,4 +1,4 @@
-; This example originally appeared in TestingGuide.rst except here we've added
+; This example originally appeared in TestingGuide.md except here we've added
; echo to the clang/FileCheck command line to be executed.
; DEFINE: %{cflags} =
|
Contributor
Author
jh7370
reviewed
Jun 3, 2026
jh7370
left a comment
jh7370
left a comment
Contributor
There was a problem hiding this comment.
Looks like the pre-merge docs build is failing with this change?
| if name.endswith(".md") and name != "index.md": | ||
| process_md(name) | ||
| # Process ReST files apart from the index page. | ||
| elif name.endswith(".rst") and name != "index.rst": |
Contributor
There was a problem hiding this comment.
Seems like the name != "index.rst" bit is redundant now?
Contributor
Author
I think, given the migration plan, it's expected, and I should bypass the checks and land anyway. I can't direct push two commits because we now have a PR-per-commit policy, but this should be fixed up in #201244. |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tracking issue: #201242
Update filename references, but leave the docs with reST syntax to ensure rename detection works.
I updated filename references so that the docs build to pass premerge checks.