[clang-tools-extra] 9948020 - [clang-tidy] Organize the release notes a little better

via cfe-commits cfe-commits at lists.llvm.org
Sat Jan 29 19:35:35 PST 2022 

Author: Richard
Date: 2022-01-29T20:32:25-07:00
New Revision: 9948020682679653dad81c6350d9900c22dc2951

URL: https://github.com/llvm/llvm-project/commit/9948020682679653dad81c6350d9900c22dc2951
DIFF: https://github.com/llvm/llvm-project/commit/9948020682679653dad81c6350d9900c22dc2951.diff

LOG: [clang-tidy] Organize the release notes a little better

- Sort new checks by check name
- Sort changes to existing checks by check name
- Add docs for changes to readability-simplify-boolean-expr
- Move check changes from "Improvements to clang-tidy" to
  "Changes in existing checks" section

Differential Revision: https://reviews.llvm.org/D118519

Added: 
    

Modified: 
    clang-tools-extra/docs/ReleaseNotes.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index eceed8749c950..115855c759d68 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -67,10 +67,6 @@ The improvements are...
 Improvements to clang-tidy
 --------------------------
 
-- Make the `cppcoreguidelines-pro-bounds-array-to-pointer-decay` check accept
-  string literal to pointer decay in conditional operator even if operands are
-  of the same length.
-
 - Ignore warnings from macros defined in system headers, if not using the
   `-system-headers` flag.
 
@@ -80,23 +76,11 @@ Improvements to clang-tidy
 - Added support for `NOLINTBEGIN` ... `NOLINTEND` comments to suppress
   Clang-Tidy warnings over multiple lines.
 
-- Generalized the `modernize-use-default-member-init` check to handle non-default
-  constructors.
-
-- Eliminated false positives for `cppcoreguidelines-macro-usage` by restricting
-  the warning about using constants to only macros that expand to literals.
-
 - Added support for external plugin checks with `-load`.
 
 New checks
 ^^^^^^^^^^
 
-- New :doc:`bugprone-stringview-nullptr
-  <clang-tidy/checks/bugprone-stringview-nullptr>` check.
-
-  Checks for various ways that the ``const CharT*`` constructor of
-  ``std::basic_string_view`` can be passed a null argument.
-
 - New :doc:`abseil-cleanup-ctad
   <clang-tidy/checks/abseil-cleanup-ctad>` check.
 
@@ -104,6 +88,12 @@ New checks
   instances from the factory function to class template argument
   deduction (CTAD), in C++17 and higher.
 
+- New :doc:`bugprone-stringview-nullptr
+  <clang-tidy/checks/bugprone-stringview-nullptr>` check.
+
+  Checks for various ways that the ``const CharT*`` constructor of
+  ``std::basic_string_view`` can be passed a null argument.
+
 - New :doc:`bugprone-suspicious-memory-comparison
   <clang-tidy/checks/bugprone-suspicious-memory-comparison>` check.
 
@@ -116,6 +106,11 @@ New checks
   Finds virtual classes whose destructor is neither public and virtual nor
   protected and non-virtual.
 
+- New :doc:`misc-misleading-bidirectional <clang-tidy/checks/misc-misleading-bidirectional>` check.
+
+  Inspects string literal and comments for unterminated bidirectional Unicode
+  characters.
+
 - New :doc:`misc-misleading-identifier <clang-tidy/checks/misc-misleading-identifier>` check.
 
   Reports identifier with unicode right-to-left characters.
@@ -143,11 +138,6 @@ New checks
   Reports identifiers whose names are too short. Currently checks local
   variables and function parameters only.
 
-- New :doc:`misc-misleading-bidirectional <clang-tidy/checks/misc-misleading-bidirectional>` check.
-
-  Inspects string literal and comments for unterminated bidirectional Unicode
-  characters.
-
 New check aliases
 ^^^^^^^^^^^^^^^^^
 
@@ -169,40 +159,66 @@ New check aliases
 Changes in existing checks
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`bugprone-assert-side-effect <clang-tidy/checks/bugprone-assert-side-effect>`
-  check now supports an ``IgnoredFunctions`` option to explicitly consider
-  the specified semicolon-separated functions list as not having any
-  side-effects. Regular expressions for the list items are also accepted.
+- :doc:`bugprone-assert-side-effect
+  <clang-tidy/checks/bugprone-assert-side-effect>` check now supports an
+  ``IgnoredFunctions`` option to explicitly consider the specified
+  semicolon-separated functions list as not having any side-effects.
+  Regular expressions for the list items are also accepted.
+
+- Fixed a false positive in :doc:`bugprone-throw-keyword-missing
+  <clang-tidy/checks/bugprone-throw-keyword-missing>` when creating an
+  exception object using placement new.
 
 - Removed default setting ``cppcoreguidelines-explicit-virtual-functions.IgnoreDestructors = "true"``,
-  from :doc:`cppcoreguidelines-explicit-virtual-functions <clang-tidy/checks/cppcoreguidelines-explicit-virtual-functions>`
+  from :doc:`cppcoreguidelines-explicit-virtual-functions
+  <clang-tidy/checks/cppcoreguidelines-explicit-virtual-functions>`
   to match the current state of the C++ Core Guidelines.
 
-- Removed suggestion ``use gsl::at`` from warning message in the
-  ``cppcoreguidelines-pro-bounds-constant-array-index`` check, since that is not
-  a requirement from the C++ Core Guidelines. This allows people to choose
-  their own safe indexing strategy. The fix-it is kept for those who want to
-  use the GSL library.
+- Eliminated false positives for :doc:`cppcoreguidelines-macro-usage
+  <clang-tidy/checks/cppcoreguidelines-macro-usage>` by restricting
+  the warning about using constants to only macros that expand to literals.
 
-- Updated :doc:`google-readability-casting
-  <clang-tidy/checks/google-readability-casting>` to diagnose and fix functional
-  casts, to achieve feature parity with the corresponding ``cpplint.py`` check.
+- :doc:`cppcoreguidelines-narrowing-conversions
+  <clang-tidy/checks/cppcoreguidelines-narrowing-conversions>`
+  check now supports a ``WarnOnIntegerToFloatingPointNarrowingConversion``
+  option to control whether to warn on narrowing integer to floating-point
+  conversions.
+
+- Make the :doc:`cppcoreguidelines-pro-bounds-array-to-pointer-decay
+  <clang-tidy/checks/cppcoreguidelines-pro-bounds-array-to-pointer-decay>`
+  check accept string literal to pointer decay in conditional operator even
+  if operands are of the same length.
+
+- Removed suggestion ``use gsl::at`` from warning message in the
+  :doc:`cppcoreguidelines-pro-bounds-constant-array-index
+  <clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index>`
+  check, since that is not a requirement from the C++ Core Guidelines.
+  This allows people to choose their own safe indexing strategy. The
+  fix-it is kept for those who want to use the GSL library.
 
 - Fixed a false positive in :doc:`fuchsia-trailing-return
   <clang-tidy/checks/fuchsia-trailing-return>` for C++17 deduction guides.
 
-- Fixed a false positive in :doc:`bugprone-throw-keyword-missing
-  <clang-tidy/checks/bugprone-throw-keyword-missing>` when creating an exception object
-  using placement new.
+- Updated :doc:`google-readability-casting
+  <clang-tidy/checks/google-readability-casting>` to diagnose and fix
+  functional casts, to achieve feature parity with the corresponding
+  ``cpplint.py`` check.
 
-- :doc:`cppcoreguidelines-narrowing-conversions <clang-tidy/checks/cppcoreguidelines-narrowing-conversions>`
-  check now supports a ``WarnOnIntegerToFloatingPointNarrowingConversion``
-  option to control whether to warn on narrowing integer to floating-point
-  conversions.
+- Generalized the :doc:`modernize-use-default-member-init
+  <clang-tidy/checks/modernize-use-default-member-init>` check to handle
+  non-default constructors.
+
+- Improved :doc:`performance-move-const-arg
+  <clang-tidy/checks/performance-move-const-arg>` check.
 
-- Improved :doc:`performance-move-const-arg <clang-tidy/checks/performance-move-const-arg>` check.
+  Removed a wrong FixIt for trivially copyable objects wrapped by
+  ``std::move()`` and passed to an rvalue reference parameter. Removal of
+  ``std::move()`` would break the code.
 
-  Removed a wrong FixIt for trivially copyable objects wrapped by ``std::move()`` and passed to an rvalue reference parameter. Removal of ``std::move()`` would break the code.
+- :doc:`readability-simplify-boolean-expr
+  <clang-tidy/checks/readability-simplify-boolean-expr>` now simplifies
+  return statements associated with ``case``, ``default`` and labeled
+  statements.
 
 Removed checks
 ^^^^^^^^^^^^^^

More information about the cfe-commits mailing list