[clang-tools-extra] 8727da4 - [clang-tidy][docs] Rename readability check docs to Markdown [1/5] (#221446)

via cfe-commits cfe-commits at lists.llvm.org
Mon Sep 7 03:09:24 PDT 2026


Author: Zeyi Xu
Date: 2026-09-07T18:09:15+08:00
New Revision: 8727da4880d069d0feb0c4346b902dc917500083

URL: https://github.com/llvm/llvm-project/commit/8727da4880d069d0feb0c4346b902dc917500083
DIFF: https://github.com/llvm/llvm-project/commit/8727da4880d069d0feb0c4346b902dc917500083.diff

LOG: [clang-tidy][docs] Rename readability check docs to Markdown [1/5] (#221446)

Tracking issue: #201242

See the [migration guide] for more information.

[migration guide]:

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

This is the first part of the mechanical rename of the check
documentations in readability module.
The rewrite is provided by the next PR in this stack.

Added: 
    clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.md
    clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.md
    clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.md
    clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.md
    clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.md
    clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.md
    clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.md
    clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.md
    clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.md
    clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.md

Modified: 
    

Removed: 
    clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.rst
    clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.rst


################################################################################
diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/ambiguous-smartptr-reset-call.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/avoid-return-with-void-value.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/braces-around-statements.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/container-contains.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/container-size-empty.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/else-after-return.md

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.md
similarity index 100%
rename from clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability/enum-initial-value.md


        


More information about the cfe-commits mailing list