[clang-tools-extra] 164ee45 - [NFC][clang-tidy] Fixup documentation file names for 'readability-container-data-pointer'
via cfe-commits
cfe-commits at lists.llvm.org
Wed Nov 10 01:26:08 PST 2021
Author: Whisperity
Date: 2021-11-10T10:25:54+01:00
New Revision: 164ee457a04daf727ead99b43ad490ea05523652
URL: https://github.com/llvm/llvm-project/commit/164ee457a04daf727ead99b43ad490ea05523652
DIFF: https://github.com/llvm/llvm-project/commit/164ee457a04daf727ead99b43ad490ea05523652.diff
LOG: [NFC][clang-tidy] Fixup documentation file names for 'readability-container-data-pointer'
Added:
clang-tools-extra/docs/clang-tidy/checks/readability-container-data-pointer.rst
Modified:
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/checks/list.rst
Removed:
clang-tools-extra/docs/clang-tidy/checks/readability-data-pointer.rst
################################################################################
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 0019f574802f..b73ea44a82bf 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -95,20 +95,22 @@ New checks
Finds virtual classes whose destructor is neither public and virtual nor
protected and non-virtual.
-- New :doc:`readability-identifier-length
- <clang-tidy/checks/readability-identifier-length>` check.
+- New :doc:`misc-misleading-identifier <clang-tidy/checks/misc-misleading-identifier>` check.
- Reports identifiers whose names are too short. Currently checks local
- variables and function parameters only.
+ Reports identifier with unicode right-to-left characters.
-- New :doc:`readability-data-pointer <clang-tidy/checks/readability-data-pointer>` check.
+- New :doc:`readability-container-data-pointer
+ <clang-tidy/checks/readability-container-data-pointer>` check.
Finds cases where code could use ``data()`` rather than the address of the
element at index 0 in a container.
-- New :doc:`misc-misleading-identifier <clang-tidy/checks/misc-misleading-identifier>` check.
+- New :doc:`readability-identifier-length
+ <clang-tidy/checks/readability-identifier-length>` check.
+
+ Reports identifiers whose names are too short. Currently checks local
+ variables and function parameters only.
- Reports identifier with unicode right-to-left characters.
New check aliases
^^^^^^^^^^^^^^^^^
diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index 80a9639c2ddd..a99dd310bb01 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -288,6 +288,7 @@ Clang-Tidy Checks
`readability-avoid-const-params-in-decls <readability-avoid-const-params-in-decls.html>`_,
`readability-braces-around-statements <readability-braces-around-statements.html>`_, "Yes"
`readability-const-return-type <readability-const-return-type.html>`_, "Yes"
+ `readability-container-data-pointer <readability-container-data-pointer.html>`_, "Yes"
`readability-container-size-empty <readability-container-size-empty.html>`_, "Yes"
`readability-convert-member-functions-to-static <readability-convert-member-functions-to-static.html>`_,
`readability-delete-null-pointer <readability-delete-null-pointer.html>`_, "Yes"
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-data-pointer.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-container-data-pointer.rst
similarity index 77%
rename from clang-tools-extra/docs/clang-tidy/checks/readability-data-pointer.rst
rename to clang-tools-extra/docs/clang-tidy/checks/readability-container-data-pointer.rst
index 4855e4b42b43..fc5d0a5ec747 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-data-pointer.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-container-data-pointer.rst
@@ -1,7 +1,7 @@
-.. title:: clang-tidy - readability-data-pointer
+.. title:: clang-tidy - readability-container-data-pointer
-readability-data-pointer
-========================
+readability-container-data-pointer
+==================================
Finds cases where code could use ``data()`` rather than the address of the
element at index 0 in a container. This pattern is commonly used to materialize
More information about the cfe-commits
mailing list