Author: Reid Kleckner Date: 2026-08-07T06:12:43-07:00 New Revision: ab9aaf5ea6d0c92d282be5bdf0676cb58c1f252f
URL: https://github.com/llvm/llvm-project/commit/ab9aaf5ea6d0c92d282be5bdf0676cb58c1f252f DIFF: https://github.com/llvm/llvm-project/commit/ab9aaf5ea6d0c92d282be5bdf0676cb58c1f252f.diff LOG: [clang-tools-extra][docs] Rename top-level docs/*.rst to *.md (#214351) 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. Added: clang-tools-extra/docs/ModularizeUsage.md clang-tools-extra/docs/ReleaseNotes.md clang-tools-extra/docs/clang-change-namespace.md clang-tools-extra/docs/clang-doc.md clang-tools-extra/docs/clang-include-fixer.md clang-tools-extra/docs/clang-modernize.md clang-tools-extra/docs/clang-reorder-fields.md clang-tools-extra/docs/clang-tidy.md clang-tools-extra/docs/clangd.md clang-tools-extra/docs/cpp11-migrate.md clang-tools-extra/docs/index.md clang-tools-extra/docs/modularize.md clang-tools-extra/docs/pp-trace.md Modified: clang-tools-extra/clang-tidy/add_new_check.py clang-tools-extra/clang-tidy/rename_check.py clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py clang-tools-extra/test/clang-tidy/infrastructure/alphabetical-order.test Removed: clang-tools-extra/docs/ModularizeUsage.rst clang-tools-extra/docs/ReleaseNotes.rst clang-tools-extra/docs/clang-change-namespace.rst clang-tools-extra/docs/clang-doc.rst clang-tools-extra/docs/clang-include-fixer.rst clang-tools-extra/docs/clang-modernize.rst clang-tools-extra/docs/clang-reorder-fields.rst clang-tools-extra/docs/clang-tidy.rst clang-tools-extra/docs/clangd.rst clang-tools-extra/docs/cpp11-migrate.rst clang-tools-extra/docs/index.rst clang-tools-extra/docs/modularize.rst clang-tools-extra/docs/pp-trace.rst ################################################################################ diff --git a/clang-tools-extra/clang-tidy/add_new_check.py b/clang-tools-extra/clang-tidy/add_new_check.py index 1c3ead6d4b1e5..e26699ead3536 100755 --- a/clang-tools-extra/clang-tidy/add_new_check.py +++ b/clang-tools-extra/clang-tidy/add_new_check.py @@ -257,9 +257,7 @@ def add_release_notes( ) ) check_name_dashes = f"{module}-{check_name}" - filename = os.path.normpath( - os.path.join(module_path, "../../docs/ReleaseNotes.rst") - ) + filename = os.path.normpath(os.path.join(module_path, "../../docs/ReleaseNotes.md")) with open(filename, "r", encoding="utf8") as f: lines = f.readlines() diff --git a/clang-tools-extra/clang-tidy/rename_check.py b/clang-tools-extra/clang-tidy/rename_check.py index 6bb274f873dad..64365a6c811ed 100755 --- a/clang-tools-extra/clang-tidy/rename_check.py +++ b/clang-tools-extra/clang-tidy/rename_check.py @@ -80,7 +80,7 @@ def deleteMatchingLines(fileName: str, pattern: str) -> bool: def getListOfFiles(clang_tidy_path: str) -> List[str]: files = glob.glob(os.path.join(clang_tidy_path, "**"), recursive=True) files += [ - os.path.normpath(os.path.join(clang_tidy_path, "../docs/ReleaseNotes.rst")) + os.path.normpath(os.path.join(clang_tidy_path, "../docs/ReleaseNotes.md")) ] files += glob.glob( os.path.join(clang_tidy_path, "..", "test", "clang-tidy", "checkers", "**"), @@ -183,7 +183,7 @@ def add_release_notes( clang_tidy_path: str, old_check_name: str, new_check_name: str ) -> None: filename = os.path.normpath( - os.path.join(clang_tidy_path, "../docs/ReleaseNotes.rst") + os.path.join(clang_tidy_path, "../docs/ReleaseNotes.md") ) with io.open(filename, "r", encoding="utf8") as f: lines = f.readlines() diff --git a/clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py b/clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py index 56dc0fafa31b2..6e646e05020bc 100644 --- a/clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py +++ b/clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py @@ -17,7 +17,7 @@ Behavior: - Sort entries in docs/clang-tidy/checks/list.md Markdown tables. -- Sort key sections in docs/ReleaseNotes.rst. +- Sort key sections in docs/ReleaseNotes.md. - Detect duplicated entries in 'Changes in existing checks'. Flags: @@ -57,7 +57,7 @@ CLANG_TIDY_DOCS_DIR: Final = os.path.join(DOCS_DIR, "clang-tidy") CHECKS_DOCS_DIR: Final = os.path.join(CLANG_TIDY_DOCS_DIR, "checks") LIST_DOC: Final = os.path.join(CHECKS_DOCS_DIR, "list.md") -RELEASE_NOTES_DOC: Final = os.path.join(DOCS_DIR, "ReleaseNotes.rst") +RELEASE_NOTES_DOC: Final = os.path.join(DOCS_DIR, "ReleaseNotes.md") # Label extracted from :doc:`...`. @@ -383,7 +383,7 @@ def process_release_notes(out_path: str, rn_doc: str) -> int: # Prefer reporting ordering issues first; let diff fail the test. if text != normalized: sys.stderr.write( - "\nEntries in 'clang-tools-extra/docs/ReleaseNotes.rst' are not alphabetically sorted.\n" + "\nEntries in 'clang-tools-extra/docs/ReleaseNotes.md' are not alphabetically sorted.\n" "Fix the ordering by applying diff printed below.\n\n" ) return 0 diff --git a/clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py b/clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py index 24f154c12ffec..9fa942905fb85 100644 --- a/clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py +++ b/clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py @@ -132,8 +132,8 @@ def test_process_release_notes_with_unsorted_content(self) -> None: """ ) with tempfile.TemporaryDirectory() as td: - rn_doc = os.path.join(td, "ReleaseNotes.rst") - out_path = os.path.join(td, "out.rst") + rn_doc = os.path.join(td, "ReleaseNotes.md") + out_path = os.path.join(td, "out.md") with open(rn_doc, "w", encoding="utf-8") as f: f.write(rn_text) @@ -191,8 +191,8 @@ def test_process_release_notes_prioritizes_sorting_over_duplicates(self) -> None """ ) with tempfile.TemporaryDirectory() as td: - rn_doc = os.path.join(td, "ReleaseNotes.rst") - out_path = os.path.join(td, "out.rst") + rn_doc = os.path.join(td, "ReleaseNotes.md") + out_path = os.path.join(td, "out.md") with open(rn_doc, "w", encoding="utf-8") as f: f.write(rn_text) @@ -201,7 +201,7 @@ def test_process_release_notes_prioritizes_sorting_over_duplicates(self) -> None rc = _mod.process_release_notes(out_path, rn_doc) self.assertEqual(rc, 0) self.assertIn( - "Entries in 'clang-tools-extra/docs/ReleaseNotes.rst' are not alphabetically sorted.", + "Entries in 'clang-tools-extra/docs/ReleaseNotes.md' are not alphabetically sorted.", buf.getvalue(), ) @@ -256,8 +256,8 @@ def test_process_release_notes_with_duplicates_fails(self) -> None: """ ) with tempfile.TemporaryDirectory() as td: - rn_doc = os.path.join(td, "ReleaseNotes.rst") - out_path = os.path.join(td, "out.rst") + rn_doc = os.path.join(td, "ReleaseNotes.md") + out_path = os.path.join(td, "out.md") with open(rn_doc, "w", encoding="utf-8") as f: f.write(rn_text) diff --git a/clang-tools-extra/docs/ModularizeUsage.rst b/clang-tools-extra/docs/ModularizeUsage.md similarity index 100% rename from clang-tools-extra/docs/ModularizeUsage.rst rename to clang-tools-extra/docs/ModularizeUsage.md diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.md similarity index 100% rename from clang-tools-extra/docs/ReleaseNotes.rst rename to clang-tools-extra/docs/ReleaseNotes.md diff --git a/clang-tools-extra/docs/clang-change-namespace.rst b/clang-tools-extra/docs/clang-change-namespace.md similarity index 100% rename from clang-tools-extra/docs/clang-change-namespace.rst rename to clang-tools-extra/docs/clang-change-namespace.md diff --git a/clang-tools-extra/docs/clang-doc.rst b/clang-tools-extra/docs/clang-doc.md similarity index 100% rename from clang-tools-extra/docs/clang-doc.rst rename to clang-tools-extra/docs/clang-doc.md diff --git a/clang-tools-extra/docs/clang-include-fixer.rst b/clang-tools-extra/docs/clang-include-fixer.md similarity index 100% rename from clang-tools-extra/docs/clang-include-fixer.rst rename to clang-tools-extra/docs/clang-include-fixer.md diff --git a/clang-tools-extra/docs/clang-modernize.rst b/clang-tools-extra/docs/clang-modernize.md similarity index 100% rename from clang-tools-extra/docs/clang-modernize.rst rename to clang-tools-extra/docs/clang-modernize.md diff --git a/clang-tools-extra/docs/clang-reorder-fields.rst b/clang-tools-extra/docs/clang-reorder-fields.md similarity index 100% rename from clang-tools-extra/docs/clang-reorder-fields.rst rename to clang-tools-extra/docs/clang-reorder-fields.md diff --git a/clang-tools-extra/docs/clang-tidy.rst b/clang-tools-extra/docs/clang-tidy.md similarity index 100% rename from clang-tools-extra/docs/clang-tidy.rst rename to clang-tools-extra/docs/clang-tidy.md diff --git a/clang-tools-extra/docs/clangd.rst b/clang-tools-extra/docs/clangd.md similarity index 100% rename from clang-tools-extra/docs/clangd.rst rename to clang-tools-extra/docs/clangd.md diff --git a/clang-tools-extra/docs/cpp11-migrate.rst b/clang-tools-extra/docs/cpp11-migrate.md similarity index 100% rename from clang-tools-extra/docs/cpp11-migrate.rst rename to clang-tools-extra/docs/cpp11-migrate.md diff --git a/clang-tools-extra/docs/index.rst b/clang-tools-extra/docs/index.md similarity index 100% rename from clang-tools-extra/docs/index.rst rename to clang-tools-extra/docs/index.md diff --git a/clang-tools-extra/docs/modularize.rst b/clang-tools-extra/docs/modularize.md similarity index 100% rename from clang-tools-extra/docs/modularize.rst rename to clang-tools-extra/docs/modularize.md diff --git a/clang-tools-extra/docs/pp-trace.rst b/clang-tools-extra/docs/pp-trace.md similarity index 100% rename from clang-tools-extra/docs/pp-trace.rst rename to clang-tools-extra/docs/pp-trace.md diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/alphabetical-order.test b/clang-tools-extra/test/clang-tidy/infrastructure/alphabetical-order.test index f1ab229f7ae98..6cc999d59cb03 100644 --- a/clang-tools-extra/test/clang-tidy/infrastructure/alphabetical-order.test +++ b/clang-tools-extra/test/clang-tidy/infrastructure/alphabetical-order.test @@ -1,5 +1,5 @@ // RUN: %python %S/../../../clang-tidy/tool/check_alphabetical_order.py -o %t.clang-tidy-checks-list.md // RUN: diff --strip-trailing-cr %S/../../../docs/clang-tidy/checks/list.md %t.clang-tidy-checks-list.md -// RUN: %python %S/../../../clang-tidy/tool/check_alphabetical_order.py -o %t.ReleaseNotes.rst -// RUN: diff --strip-trailing-cr %S/../../../docs/ReleaseNotes.rst %t.ReleaseNotes.rst +// RUN: %python %S/../../../clang-tidy/tool/check_alphabetical_order.py -o %t.ReleaseNotes.md +// RUN: diff --strip-trailing-cr %S/../../../docs/ReleaseNotes.md %t.ReleaseNotes.md _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
