Index: clang-tidy/add_new_check.py =================================================================== --- clang-tidy/add_new_check.py +++ clang-tidy/add_new_check.py @@ -211,8 +211,8 @@ elif header_found: if not line.startswith('----'): f.write(""" -- New `%s - `_ check +- New :doc:`%s + ` check FIXME: add release notes. """ % (check_name_dashes, check_name_dashes)) Index: clang-tidy/rename_check.py =================================================================== --- clang-tidy/rename_check.py +++ clang-tidy/rename_check.py @@ -171,8 +171,8 @@ elif header_found: if not line.startswith('----'): f.write(""" -- The '%s' check was renamed to `%s - `_ +- The '%s' check was renamed to :doc:`%s + ` """ % (old_check_name, new_check_name, new_check_name)) note_added = True Index: docs/ReleaseNotes.rst =================================================================== --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -57,136 +57,136 @@ Improvements to clang-tidy -------------------------- +- New module `abseil` for checks related to the `Abseil `_ + library. + - New module ``portability``. - New module ``zircon`` for checks related to Fuchsia's Zircon kernel. -- New `bugprone-throw-keyword-missing - `_ check +- New :doc:`bugprone-throw-keyword-missing + ` check Diagnoses when a temporary object that appears to be an exception is constructed but not thrown. -- New `bugprone-unused-return-value - `_ check +- New :doc:`bugprone-unused-return-value + ` check Warns on unused function return values. -- New `cppcoreguidelines-avoid-goto - `_ check +- New :doc:`cppcoreguidelines-avoid-goto + ` check The usage of ``goto`` for control flow is error prone and should be replaced with looping constructs. Every backward jump is rejected. Forward jumps are only allowed in nested loops. -- New `fuchsia-multiple-inheritance - `_ check +- New :doc:`fuchsia-multiple-inheritance + ` check Warns if a class inherits from multiple classes that are not pure virtual. -- New `abseil` module for checks related to the `Abseil `_ - library. - -- New `abseil-string-find-startswith - `_ check +- New :doc:`abseil-string-find-startswith + ` check Checks whether a ``std::string::find()`` result is compared with 0, and suggests replacing with ``absl::StartsWith()``. -- New `fuchsia-statically-constructed-objects - `_ check +- New :doc:`fuchsia-statically-constructed-objects + ` 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. -- New `fuchsia-trailing-return - `_ check +- New :doc:`fuchsia-trailing-return + ` check Functions that have trailing returns are disallowed, except for those using ``decltype`` specifiers and lambda with otherwise unutterable return types. -- New `hicpp-multiway-paths-covered - `_ check +- New :doc:`hicpp-multiway-paths-covered + ` check Checks on ``switch`` and ``if`` - ``else if`` constructs that do not cover all possible code paths. -- New `modernize-use-uncaught-exceptions - `_ check +- New :doc:`modernize-use-uncaught-exceptions + ` check Finds and replaces deprecated uses of ``std::uncaught_exception`` to ``std::uncaught_exceptions``. -- New `portability-simd-intrinsics - `_ check +- New :doc:`portability-simd-intrinsics + ` check Warns or suggests alternatives if SIMD intrinsics are used which can be replaced by ``std::experimental::simd`` operations. -- New `zircon-temporary-objects - `_ check +- New :doc:`zircon-temporary-objects + ` check Warns on construction of specific temporary objects in the Zircon kernel. -- New alias `hicpp-avoid-goto - `_ to - `cppcoreguidelines-avoid-goto `_ +- New alias :doc:`hicpp-avoid-goto + ` to :doc:`cppcoreguidelines-avoid-goto + ` added. -- The 'misc-forwarding-reference-overload' check was renamed to `bugprone-forwarding-reference-overload - `_ +- The 'misc-forwarding-reference-overload' check was renamed to :doc:`bugprone-forwarding-reference-overload + ` -- The 'misc-incorrect-roundings' check was renamed to `bugprone-incorrect-roundings - `_ +- The 'misc-incorrect-roundings' check was renamed to :doc:`bugprone-incorrect-roundings + ` -- The 'misc-lambda-function-name' check was renamed to `bugprone-lambda-function-name - `_ +- The 'misc-lambda-function-name' check was renamed to :doc:`bugprone-lambda-function-name + ` -- The 'misc-macro-parentheses' check was renamed to `bugprone-macro-parentheses - `_ +- The 'misc-macro-parentheses' check was renamed to :doc:`bugprone-macro-parentheses + ` -- The 'misc-macro-repeated-side-effects' check was renamed to `bugprone-macro-repeated-side-effects - `_ +- The 'misc-macro-repeated-side-effects' check was renamed to :doc:`bugprone-macro-repeated-side-effects + ` -- The 'misc-misplaced-widening-cast' check was renamed to `bugprone-misplaced-widening-cast - `_ +- The 'misc-misplaced-widening-cast' check was renamed to :doc:`bugprone-misplaced-widening-cast + ` -- The 'misc-sizeof-container' check was renamed to `bugprone-sizeof-container - `_ +- The 'misc-sizeof-container' check was renamed to :doc:`bugprone-sizeof-container + ` -- The 'misc-sizeof-expression' check was renamed to `bugprone-sizeof-expression - `_ +- The 'misc-sizeof-expression' check was renamed to :doc:`bugprone-sizeof-expression + ` -- The 'misc-string-compare' check was renamed to `readability-string-compare - `_ +- The 'misc-string-compare' check was renamed to :doc:`readability-string-compare + ` -- The 'misc-string-integer-assignment' check was renamed to `bugprone-string-integer-assignment - `_ +- The 'misc-string-integer-assignment' check was renamed to :doc:`bugprone-string-integer-assignment + ` -- The 'misc-string-literal-with-embedded-nul' check was renamed to `bugprone-string-literal-with-embedded-nul - `_ +- The 'misc-string-literal-with-embedded-nul' check was renamed to :doc:`bugprone-string-literal-with-embedded-nul + ` -- The 'misc-suspicious-enum-usage' check was renamed to `bugprone-suspicious-enum-usage - `_ +- The 'misc-suspicious-enum-usage' check was renamed to :doc:`bugprone-suspicious-enum-usage + ` -- The 'misc-suspicious-missing-comma' check was renamed to `bugprone-suspicious-missing-comma - `_ +- The 'misc-suspicious-missing-comma' check was renamed to :doc:`bugprone-suspicious-missing-comma + ` -- The 'misc-suspicious-semicolon' check was renamed to `bugprone-suspicious-semicolon - `_ +- The 'misc-suspicious-semicolon' check was renamed to :doc:`bugprone-suspicious-semicolon + ` -- The 'misc-suspicious-string-compare' check was renamed to `bugprone-suspicious-string-compare - `_ +- The 'misc-suspicious-string-compare' check was renamed to :doc:`bugprone-suspicious-string-compare + ` -- The 'misc-swapped-arguments' check was renamed to `bugprone-swapped-arguments - `_ +- The 'misc-swapped-arguments' check was renamed to :doc:`bugprone-swapped-arguments + ` -- The 'misc-undelegated-constructor' check was renamed to `bugprone-undelegated-constructor - `_ +- The 'misc-undelegated-constructor' check was renamed to :doc:`bugprone-undelegated-constructor + ` -- The 'misc-unused-raii' check was renamed to `bugprone-unused-raii - `_ +- The 'misc-unused-raii' check was renamed to :doc:`bugprone-unused-raii + ` Improvements to include-fixer -----------------------------