[all-commits] [llvm/llvm-project] 0f5a12: [libc++][docs] Rename documentation files to Markd...

Reid Kleckner via All-commits all-commits at lists.llvm.org
Sun Sep 27 08:53:55 PDT 2026


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 0f5a125bad555b6bf4bb2318b9f1ea7936adf19d
      https://github.com/llvm/llvm-project/commit/0f5a125bad555b6bf4bb2318b9f1ea7936adf19d
  Author: Reid Kleckner <rkleckner at nvidia.com>
  Date:   2026-09-27 (Sun, 27 Sep 2026)

  Changed paths:
    A libcxx/docs/ABIGuarantees.md
    R libcxx/docs/ABIGuarantees.rst
    A libcxx/docs/AddingNewCIJobs.md
    R libcxx/docs/AddingNewCIJobs.rst
    A libcxx/docs/CodingGuidelines.md
    R libcxx/docs/CodingGuidelines.rst
    A libcxx/docs/Contributing.md
    R libcxx/docs/Contributing.rst
    A libcxx/docs/Contributing/NewStandardProcedure.md
    R libcxx/docs/Contributing/NewStandardProcedure.rst
    A libcxx/docs/Contributing/PostMeetingProcedure.md
    R libcxx/docs/Contributing/PostMeetingProcedure.rst
    A libcxx/docs/Contributing/ReleaseProcedure.md
    R libcxx/docs/Contributing/ReleaseProcedure.rst
    A libcxx/docs/DesignDocs/ABIVersioning.md
    R libcxx/docs/DesignDocs/ABIVersioning.rst
    A libcxx/docs/DesignDocs/AtomicDesign.md
    R libcxx/docs/DesignDocs/AtomicDesign.rst
    A libcxx/docs/DesignDocs/CapturingConfigInfo.md
    R libcxx/docs/DesignDocs/CapturingConfigInfo.rst
    A libcxx/docs/DesignDocs/ExperimentalFeatures.md
    R libcxx/docs/DesignDocs/ExperimentalFeatures.rst
    A libcxx/docs/DesignDocs/ExtendedCXX03Support.md
    R libcxx/docs/DesignDocs/ExtendedCXX03Support.rst
    A libcxx/docs/DesignDocs/FeatureTestMacros.md
    R libcxx/docs/DesignDocs/FeatureTestMacros.rst
    A libcxx/docs/DesignDocs/FileTimeType.md
    R libcxx/docs/DesignDocs/FileTimeType.rst
    A libcxx/docs/DesignDocs/HeaderRemovalPolicy.md
    R libcxx/docs/DesignDocs/HeaderRemovalPolicy.rst
    M libcxx/include/__configuration/abi.h

  Log Message:
  -----------
  [libc++][docs] Rename documentation files to Markdown (batch 1) (#221512)

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.


  Commit: 61b428e0edfe674b84d77f7b55aa687fce3b501e
      https://github.com/llvm/llvm-project/commit/61b428e0edfe674b84d77f7b55aa687fce3b501e
  Author: Reid Kleckner <rkleckner at nvidia.com>
  Date:   2026-09-27 (Sun, 27 Sep 2026)

  Changed paths:
    M libcxx/docs/ABIGuarantees.md
    M libcxx/docs/AddingNewCIJobs.md
    M libcxx/docs/CodingGuidelines.md
    M libcxx/docs/Contributing.md
    M libcxx/docs/Contributing/NewStandardProcedure.md
    M libcxx/docs/Contributing/PostMeetingProcedure.md
    M libcxx/docs/Contributing/ReleaseProcedure.md
    M libcxx/docs/DesignDocs/ABIVersioning.md
    M libcxx/docs/DesignDocs/AtomicDesign.md
    M libcxx/docs/DesignDocs/CapturingConfigInfo.md
    M libcxx/docs/DesignDocs/ExperimentalFeatures.md
    M libcxx/docs/DesignDocs/ExtendedCXX03Support.md
    M libcxx/docs/DesignDocs/FeatureTestMacros.md
    M libcxx/docs/DesignDocs/FileTimeType.md
    M libcxx/docs/DesignDocs/HeaderRemovalPolicy.md
    M libcxx/docs/conf.py

  Log Message:
  -----------
  [libc++][docs] Convert documentation from reST to Markdown (batch 1) (#221513)

This is the first batch of changes to migrate libc++ documentation from
rst to markdown.

I use a local pixel diff tool to compare the rendered HTML, and all
diffs seem like fixes. They tend to fall into the following categories:

- dashed bullet lists were previously not rendered, but now they are
- extra indentation interpreted as blockquotes has been removed
- single backticks are now codefont spans, not italic spans

Tracking issue: #201242
See the [migration guide] for more information. 

[migration guide]:
https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines
This is a stacked PR based on #221512, which will be a standalone commit
that
renames *.rst -> *.md before this PR lands for history preservation
purposes.

-----

Before/after validation links:
| Source file | Before HTML | After HTML |
| --- | --- | --- |
| `libcxx/docs/ABIGuarantees.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/ABIGuarantees.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/ABIGuarantees.html)
|
| `libcxx/docs/AddingNewCIJobs.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/AddingNewCIJobs.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/AddingNewCIJobs.html)
|
| `libcxx/docs/CodingGuidelines.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/CodingGuidelines.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/CodingGuidelines.html)
|
| `libcxx/docs/Contributing/NewStandardProcedure.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/Contributing/NewStandardProcedure.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/Contributing/NewStandardProcedure.html)
|
| `libcxx/docs/Contributing/PostMeetingProcedure.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/Contributing/PostMeetingProcedure.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/Contributing/PostMeetingProcedure.html)
|
| `libcxx/docs/Contributing/ReleaseProcedure.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/Contributing/ReleaseProcedure.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/Contributing/ReleaseProcedure.html)
|
| `libcxx/docs/Contributing.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/Contributing.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/Contributing.html)
|
| `libcxx/docs/DesignDocs/ABIVersioning.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/ABIVersioning.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/ABIVersioning.html)
|
| `libcxx/docs/DesignDocs/AtomicDesign.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/AtomicDesign.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/AtomicDesign.html)
|
| `libcxx/docs/DesignDocs/CapturingConfigInfo.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/CapturingConfigInfo.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/CapturingConfigInfo.html)
|
| `libcxx/docs/DesignDocs/ExperimentalFeatures.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/ExperimentalFeatures.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/ExperimentalFeatures.html)
|
| `libcxx/docs/DesignDocs/ExtendedCXX03Support.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/ExtendedCXX03Support.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/ExtendedCXX03Support.html)
|
| `libcxx/docs/DesignDocs/FeatureTestMacros.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/FeatureTestMacros.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/FeatureTestMacros.html)
|
| `libcxx/docs/DesignDocs/FileTimeType.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/FileTimeType.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/FileTimeType.html)
|
| `libcxx/docs/DesignDocs/HeaderRemovalPolicy.md` |
[before](https://llvmdocs.staging.reidkleckner.dev/before/libcxx/docs/DesignDocs/HeaderRemovalPolicy.html)
|
[after](https://llvmdocs.staging.reidkleckner.dev/after/libcxx/docs/DesignDocs/HeaderRemovalPolicy.html)
|


Compare: https://github.com/llvm/llvm-project/compare/1345a4fa8d60...61b428e0edfe

To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list