diff options
| author | Eugene Zelenko <eugene.zelenko@gmail.com> | 2018-02-28 19:15:49 +0000 |
|---|---|---|
| committer | Eugene Zelenko <eugene.zelenko@gmail.com> | 2018-02-28 19:15:49 +0000 |
| commit | 3fd89019281400a0ae62eabf3ec3cb5a410d4416 (patch) | |
| tree | d9fb9190b5fd54c3f00a5e9990066b3ee4161b09 | |
| parent | 2a99fa2c084b1439c7473032f4af0808d5faabc6 (diff) | |
| download | bcm5719-llvm-3fd89019281400a0ae62eabf3ec3cb5a410d4416.tar.gz bcm5719-llvm-3fd89019281400a0ae62eabf3ec3cb5a410d4416.zip | |
[Documentation] Split Clang-tidy changes in Release Notes into sections: new checks, new aliases, renamed checks; sort all of them alphabetically. Enforce 80 characters line length limit. Highlight C++ keywords.
llvm-svn: 326354
3 files changed, 33 insertions, 31 deletions
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 0e8ef01340a..af682516c98 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -57,23 +57,11 @@ The improvements are... Improvements to clang-tidy -------------------------- -- The 'misc-misplaced-widening-cast' check was renamed to `bugprone-misplaced-widening-cast - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-misplaced-widening-cast.html>`_ - -- The 'misc-lambda-function-name' check was renamed to `bugprone-lambda-function-name - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-lambda-function-name.html>`_ - -- The 'misc-macro-repeated-side-effects' check was renamed to `bugprone-macro-repeated-side-effects - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-macro-repeated-side-effects.html>`_ - -- The 'misc-forwarding-reference-overload' check was renamed to `bugprone-forwarding-reference-overload - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-forwarding-reference-overload.html>`_ - -- The 'misc-incorrect-roundings' check was renamed to `bugprone-incorrect-roundings - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-incorrect-roundings.html>`_ +- New `bugprone-throw-keyword-missing + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-throw-keyword-missing.html>`_ check -- The 'misc-string-compare' check was renamed to `readability-string-compare - <http://clang.llvm.org/extra/clang-tidy/checks/readability-string-compare.html>`_ + Diagnoses when a temporary object that appears to be an exception is + constructed but not thrown. - New `cppcoreguidelines-avoid-goto <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-avoid-goto.html>`_ check @@ -90,17 +78,23 @@ Improvements to clang-tidy - New `fuchsia-statically-constructed-objects <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-statically-constructed-objects.html>`_ check - Warns if global, non-trivial objects with static storage are constructed, unless the - object is statically initialized with a ``constexpr`` constructor or has no - explicit constructor. + Warns if global, non-trivial objects with static storage are constructed, + unless the object is statically initialized with a ``constexpr`` constructor + or has no explicit constructor. - New `fuchsia-trailing-return <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-trailing-return.html>`_ check Functions that have trailing returns are disallowed, except for those - using decltype specifiers and lambda with otherwise unutterable + using ``decltype`` specifiers and lambda with otherwise unutterable return types. +- New `modernize-use-uncaught-exceptions + <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-uncaught-exceptions.html>`_ check + + Finds and replaces deprecated uses of ``std::uncaught_exception`` to + ``std::uncaught_exceptions``. + - New `readability-simd-intrinsics <http://clang.llvm.org/extra/clang-tidy/checks/readability-simd-intrinsics.html>`_ check @@ -112,15 +106,23 @@ Improvements to clang-tidy `cppcoreguidelines-avoid-goto <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-avoid-goto.html>`_ added. -- New `bugprone-throw-keyword-missing - <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-throw-keyword-missing.html>`_ check +- The 'misc-forwarding-reference-overload' check was renamed to `bugprone-forwarding-reference-overload + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-forwarding-reference-overload.html>`_ - Diagnoses when a temporary object that appears to be an exception is constructed but not thrown. +- The 'misc-incorrect-roundings' check was renamed to `bugprone-incorrect-roundings + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-incorrect-roundings.html>`_ -- New `modernize-use-uncaught-exceptions - <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-uncaught-exceptions.html>`_ check +- The 'misc-lambda-function-name' check was renamed to `bugprone-lambda-function-name + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-lambda-function-name.html>`_ + +- The 'misc-macro-repeated-side-effects' check was renamed to `bugprone-macro-repeated-side-effects + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-macro-repeated-side-effects.html>`_ - Finds and replaces deprecated uses of std::uncaught_exception to std::uncaught_exceptions() +- The 'misc-misplaced-widening-cast' check was renamed to `bugprone-misplaced-widening-cast + <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-misplaced-widening-cast.html>`_ + +- The 'misc-string-compare' check was renamed to `readability-string-compare + <http://clang.llvm.org/extra/clang-tidy/checks/readability-string-compare.html>`_ Improvements to include-fixer ----------------------------- diff --git a/clang-tools-extra/docs/clang-tidy/checks/fuchsia-trailing-return.rst b/clang-tools-extra/docs/clang-tidy/checks/fuchsia-trailing-return.rst index 42e85c20e22..e67f4772889 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/fuchsia-trailing-return.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/fuchsia-trailing-return.rst @@ -4,7 +4,7 @@ fuchsia-trailing-return ======================= Functions that have trailing returns are disallowed, except for those using -decltype specifiers and lambda with otherwise unutterable return types. +``decltype`` specifiers and lambda with otherwise unutterable return types. For example: @@ -18,7 +18,7 @@ For example: return add_one; } -Exceptions are made for lambdas and decltype specifiers: +Exceptions are made for lambdas and ``decltype`` specifiers: .. code-block:: c++ diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-uncaught-exceptions.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-uncaught-exceptions.rst index ca2a09ee31c..615f2e3f4a2 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-uncaught-exceptions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-uncaught-exceptions.rst @@ -3,9 +3,9 @@ modernize-use-uncaught-exceptions ==================================== -This check will warn on calls to ``std::uncaught_exception`` and replace them with -calls to ``std::uncaught_exceptions``, since ``std::uncaught_exception`` was deprecated -in C++17. +This check will warn on calls to ``std::uncaught_exception`` and replace them +with calls to ``std::uncaught_exceptions``, since ``std::uncaught_exception`` +was deprecated in C++17. Below are a few examples of what kind of occurrences will be found and what they will be replaced with. |

