[Openmp-commits] [lldb] [llvm] [openmp] [docs] Rename leftover rst docs to md (PR #234786)

[via Openmp-commits]

llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-lldb

Author: Reid Kleckner (rnk)

<details>
<summary>Changes</summary>

Tracking issue: #<!-- -->201242
See the [migration guide] for more information. 

[migration guide]: https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines

This is the initial straight rename commit. It will probably break the docs build, but it has to be a separate PR for blame preservation purposes.

Besides the renames, this updates the references that name the old files: the lldb help test (which reads the man page source), a comment in the lldb driver option definitions, `llvm/utils/lit/setup.py`, and a comment in a GN build file. The lit README is also lit's PyPI `long_description`, so `setup.py` now reads `README.md`.


---
Full diff: https://github.com/llvm/llvm-project/pull/234786.diff


11 Files Affected:

- (renamed) cmake/README.md () 
- (renamed) lldb/docs/man/lldb-server.md () 
- (renamed) lldb/docs/man/lldb.md () 
- (modified) lldb/test/Shell/Driver/TestHelp.test (+1-1) 
- (modified) lldb/tools/driver/Options.td (+1-1) 
- (renamed) llvm/docs/Proposals/VariableNames.md () 
- (renamed) llvm/utils/gn/README.md () 
- (modified) llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn (+1-1) 
- (renamed) llvm/utils/lit/README.md () 
- (modified) llvm/utils/lit/setup.py (+1-1) 
- (renamed) openmp/tools/Modules/README.md () 


``````````diff
diff --git a/cmake/README.rst b/cmake/README.md
similarity index 100%
rename from cmake/README.rst
rename to cmake/README.md
diff --git a/lldb/docs/man/lldb-server.rst b/lldb/docs/man/lldb-server.md
similarity index 100%
rename from lldb/docs/man/lldb-server.rst
rename to lldb/docs/man/lldb-server.md
diff --git a/lldb/docs/man/lldb.rst b/lldb/docs/man/lldb.md
similarity index 100%
rename from lldb/docs/man/lldb.rst
rename to lldb/docs/man/lldb.md
diff --git a/lldb/test/Shell/Driver/TestHelp.test b/lldb/test/Shell/Driver/TestHelp.test
index 703000b6452e96..aede361c935e98 100644
--- a/lldb/test/Shell/Driver/TestHelp.test
+++ b/lldb/test/Shell/Driver/TestHelp.test
@@ -1,5 +1,5 @@
 RUN: %lldb --help | FileCheck %s
-RUN: cat %S/../../../docs/man/lldb.rst | FileCheck %s
+RUN: cat %S/../../../docs/man/lldb.md | FileCheck %s
 
 CHECK: ATTACHING
 CHECK: --attach-name
diff --git a/lldb/tools/driver/Options.td b/lldb/tools/driver/Options.td
index e8f1bd993176ea..a157ff1eeace26 100644
--- a/lldb/tools/driver/Options.td
+++ b/lldb/tools/driver/Options.td
@@ -5,7 +5,7 @@ class S<string name> : Separate<["--", "-"], name>;
 class R<list<string> prefixes, string name>
     : Option<prefixes, name, KIND_REMAINING_ARGS>;
 
-// Please keep this in sync with the man page in docs/man/lldb.rst
+// Please keep this in sync with the man page in docs/man/lldb.md
 
 // Attaching options.
 def grp_attach : OptionGroup<"attaching">, HelpText<"ATTACHING">;
diff --git a/llvm/docs/Proposals/VariableNames.rst b/llvm/docs/Proposals/VariableNames.md
similarity index 100%
rename from llvm/docs/Proposals/VariableNames.rst
rename to llvm/docs/Proposals/VariableNames.md
diff --git a/llvm/utils/gn/README.rst b/llvm/utils/gn/README.md
similarity index 100%
rename from llvm/utils/gn/README.rst
rename to llvm/utils/gn/README.md
diff --git a/llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn b/llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
index 051d8425756997..229dbabe764504 100644
--- a/llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
+++ b/llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
@@ -28,7 +28,7 @@ import("//llvm/version.gni")
 # to keep the gn build close to the cmake build.
 
 # Other than in the cmake build, header generation doesn't do any feature
-# checking. See also "Philosophy" in llvm/utils/gn/README.rst.
+# checking. See also "Philosophy" in llvm/utils/gn/README.md.
 
 ##############################################################################
 # config.h, llvm-config.h, abi-breaking.h
diff --git a/llvm/utils/lit/README.rst b/llvm/utils/lit/README.md
similarity index 100%
rename from llvm/utils/lit/README.rst
rename to llvm/utils/lit/README.md
diff --git a/llvm/utils/lit/setup.py b/llvm/utils/lit/setup.py
index b11e3eafb2a354..51b705e3cd7e69 100644
--- a/llvm/utils/lit/setup.py
+++ b/llvm/utils/lit/setup.py
@@ -12,7 +12,7 @@
 
 import lit
 
-with open("README.rst", "r", encoding="utf-8") as f:
+with open("README.md", "r", encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
diff --git a/openmp/tools/Modules/README.rst b/openmp/tools/Modules/README.md
similarity index 100%
rename from openmp/tools/Modules/README.rst
rename to openmp/tools/Modules/README.md

``````````

</details>


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