summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Wennborg <hans@hanshq.net>2018-02-27 14:51:16 +0000
committerHans Wennborg <hans@hanshq.net>2018-02-27 14:51:16 +0000
commit0ea5aed4817afebb7fbdea644b723052a0ef370c (patch)
tree455e86768df055ade31b956c61dd1ff13bb0e214
parentb2d630064d8484eb9b4ae2d637a82dc05e624f92 (diff)
ReleaseNotes: tidy up, fix some links etc.upstream/release_60
git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/branches/release_60@326199 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/ReleaseNotes.rst139
1 files changed, 57 insertions, 82 deletions
diff --git a/docs/ReleaseNotes.rst b/docs/ReleaseNotes.rst
index 7cafa019..c304da42 100644
--- a/docs/ReleaseNotes.rst
+++ b/docs/ReleaseNotes.rst
@@ -28,21 +28,6 @@ Some of the major new features and improvements to Extra Clang Tools are listed
here. Generic improvements to Extra Clang Tools as a whole or to its underlying
infrastructure are described first, followed by tool-specific sections.
-Major New Features
-------------------
-
-...
-
-Improvements to clang-query
----------------------------
-
-The improvements are...
-
-Improvements to clang-rename
-----------------------------
-
-The improvements are...
-
Improvements to clang-tidy
--------------------------
@@ -51,62 +36,62 @@ Improvements to clang-tidy
- New module `objc` for Objective-C style checks.
- New `android-cloexec-accept
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-accept.html>`_ check
+ <clang-tidy/checks/android-cloexec-accept.html>`_ check
Detects usage of ``accept()``.
- New `android-cloexec-accept4
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-accept4.html>`_ check
+ <clang-tidy/checks/android-cloexec-accept4.html>`_ check
Checks if the required file flag ``SOCK_CLOEXEC`` is present in the argument of
``accept4()``.
- New `android-cloexec-dup
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-dup.html>`_ check
+ <clang-tidy/checks/android-cloexec-dup.html>`_ check
Detects usage of ``dup()``.
- New `android-cloexec-epoll-create
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-epoll-create.html>`_ check
+ <clang-tidy/checks/android-cloexec-epoll-create.html>`_ check
Detects usage of ``epoll_create()``.
- New `android-cloexec-epoll-create1
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-epoll-create1.html>`_ check
+ <clang-tidy/checks/android-cloexec-epoll-create1.html>`_ check
Checks if the required file flag ``EPOLL_CLOEXEC`` is present in the argument of
``epoll_create1()``.
- New `android-cloexec-inotify-init
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-inotify-init.html>`_ check
+ <clang-tidy/checks/android-cloexec-inotify-init.html>`_ check
Detects usage of ``inotify_init()``.
- New `android-cloexec-inotify-init1
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-inotify-init1.html>`_ check
+ <clang-tidy/checks/android-cloexec-inotify-init1.html>`_ check
Checks if the required file flag ``IN_CLOEXEC`` is present in the argument of
``inotify_init1()``.
- New `android-cloexec-memfd_create
- <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-memfd_create.html>`_ check
+ <clang-tidy/checks/android-cloexec-memfd-create.html>`_ check
Checks if the required file flag ``MFD_CLOEXEC`` is present in the argument
of ``memfd_create()``.
- New `bugprone-copy-constructor-init
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-copy-constructor-init.html>`_ check
+ <clang-tidy/checks/bugprone-copy-constructor-init.html>`_ check
Finds copy constructors which don't call the copy constructor of the base class.
- New `bugprone-integer-division
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-integer-division.html>`_ check
+ <clang-tidy/checks/bugprone-integer-division.html>`_ check
Finds cases where integer division in a floating point context is likely to
cause unintended loss of precision.
- New `bugprone-misplaced-operator-in-strlen-in-alloc
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-misplaced-operator-in-strlen-in-alloc.html>`_ check
+ <clang-tidy/checks/bugprone-misplaced-operator-in-strlen-in-alloc.html>`_ check
Finds cases where ``1`` is added to the string in the argument to
``strlen()``, ``strnlen()``, ``strnlen_s()``, ``wcslen()``, ``wcsnlen()``, and
@@ -114,128 +99,128 @@ Improvements to clang-tidy
a memory allocation function (``malloc()``, ``calloc()``, ``realloc()``,
``alloca()``) or the ``new[]`` operator in `C++`.
-- New `cppcoreguidelines-owning-memory <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-owning-memory.html>`_ check
+- New `cppcoreguidelines-owning-memory <clang-tidy/checks/cppcoreguidelines-owning-memory.html>`_ check
This check implements the type-based semantic of ``gsl::owner<T*>``, but without
flow analysis.
- New `fuchsia-default-arguments
- <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-default-arguments.html>`_ check
+ <clang-tidy/checks/fuchsia-default-arguments.html>`_ check
Warns if a function or method is declared or called with default arguments.
- New `fuchsia-overloaded-operator
- <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-overloaded-operator.html>`_ check
+ <clang-tidy/checks/fuchsia-overloaded-operator.html>`_ check
Warns if an operator is overloaded, except for the assignment (copy and move) operators.
- New `fuchsia-virtual-inheritance
- <http://clang.llvm.org/extra/clang-tidy/checks/fuchsia-virtual-inheritance.html>`_ check
+ <clang-tidy/checks/fuchsia-virtual-inheritance.html>`_ check
Warns if classes are defined with virtual inheritance.
-
+
- New `google-objc-avoid-throwing-exception
- <http://clang.llvm.org/extra/clang-tidy/checks/google-objc-avoid-throwing-exception.html>`_ check
+ <clang-tidy/checks/google-objc-avoid-throwing-exception.html>`_ check
Finds uses of throwing exceptions usages in Objective-C files.
- New `google-objc-global-variable-declaration
- <http://clang.llvm.org/extra/clang-tidy/checks/google-global-variable-declaration.html>`_ check
+ <clang-tidy/checks/google-objc-global-variable-declaration.html>`_ check
Finds global variable declarations in Objective-C files that do not follow the
pattern of variable names in Google's Objective-C Style Guide.
- New `hicpp-exception-baseclass
- <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-exception-baseclass.html>`_ check
+ <clang-tidy/checks/hicpp-exception-baseclass.html>`_ check
- Ensures that all exception will be instances of ``std::exception`` and classes
+ Ensures that all exception will be instances of ``std::exception`` and classes
that are derived from it.
- New `hicpp-signed-bitwise
- <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-signed-bitwise.html>`_ check
+ <clang-tidy/checks/hicpp-signed-bitwise.html>`_ check
- Finds uses of bitwise operations on signed integer types, which may lead to
+ Finds uses of bitwise operations on signed integer types, which may lead to
undefined or implementation defined behaviour.
- New `objc-avoid-nserror-init
- <http://clang.llvm.org/extra/clang-tidy/checks/objc-avoid-nserror-init.html>`_ check
+ <clang-tidy/checks/objc-avoid-nserror-init.html>`_ check
Finds improper initialization of ``NSError`` objects.
- New `objc-avoid-spinlock
- <http://clang.llvm.org/extra/clang-tidy/checks/objc-avoid-spinlock.html>`_ check
+ <clang-tidy/checks/objc-avoid-spinlock.html>`_ check
Finds usages of ``OSSpinlock``, which is deprecated due to potential livelock
problems.
- New `objc-forbidden-subclassing
- <http://clang.llvm.org/extra/clang-tidy/checks/objc-forbidden-subclassing.html>`_ check
+ <clang-tidy/checks/objc-forbidden-subclassing.html>`_ check
Finds Objective-C classes which are subclasses of classes which are not
designed to be subclassed.
- New `objc-property-declaration
- <http://clang.llvm.org/extra/clang-tidy/checks/objc-property-declaration.html>`_ check
+ <clang-tidy/checks/objc-property-declaration.html>`_ check
Finds property declarations in Objective-C files that do not follow the
pattern of property names in Apple's programming guide.
- New `readability-static-accessed-through-instance
- <http://clang.llvm.org/extra/clang-tidy/checks/readability-static-accessed-through-instance.html>`_ check
+ <clang-tidy/checks/readability-static-accessed-through-instance.html>`_ check
Finds member expressions that access static members through instances and
replaces them with uses of the appropriate qualified-id.
- The 'misc-argument-comment' check was renamed to `bugprone-argument-comment
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-argument-comment.html>`_
+ <clang-tidy/checks/bugprone-argument-comment.html>`_
- The 'misc-assert-side-effect' check was renamed to `bugprone-assert-side-effect
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-assert-side-effect.html>`_
+ <clang-tidy/checks/bugprone-assert-side-effect.html>`_
- The 'misc-bool-pointer-implicit-conversion' check was renamed to `bugprone-bool-pointer-implicit-conversion
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-bool-pointer-implicit-conversion.html>`_
+ <clang-tidy/checks/bugprone-bool-pointer-implicit-conversion.html>`_
- The 'misc-dangling-handle' check was renamed to `bugprone-dangling-handle
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-dangling-handle.html>`_
+ <clang-tidy/checks/bugprone-dangling-handle.html>`_
- The 'misc-fold-init-type' check was renamed to `bugprone-fold-init-type
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-fold-init-type.html>`_
+ <clang-tidy/checks/bugprone-fold-init-type.html>`_
- The 'misc-forward-declaration-namespace' check was renamed to `bugprone-forward-declaration-namespace
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-forward-declaration-namespace.html>`_
+ <clang-tidy/checks/bugprone-forward-declaration-namespace.html>`_
- The 'misc-inaccurate-erase' check was renamed to `bugprone-inaccurate-erase
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-inaccurate-erase.html>`_
+ <clang-tidy/checks/bugprone-inaccurate-erase.html>`_
- The 'misc-inefficient-algorithm' check was renamed to `performance-inefficient-algorithm
- <http://clang.llvm.org/extra/clang-tidy/checks/performance-inefficient-algorithm.html>`_
+ <clang-tidy/checks/performance-inefficient-algorithm.html>`_
- The 'misc-move-const-arg' check was renamed to `performance-move-const-arg
- <http://clang.llvm.org/extra/clang-tidy/checks/performance-move-const-arg.html>`_
+ <clang-tidy/checks/performance-move-const-arg.html>`_
- The 'misc-move-constructor-init' check was renamed to `performance-move-constructor-init
- <http://clang.llvm.org/extra/clang-tidy/checks/performance-move-constructor-init.html>`_
+ <clang-tidy/checks/performance-move-constructor-init.html>`_
- The 'misc-move-forwarding-reference' check was renamed to `bugprone-move-forwarding-reference
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-move-forwarding-reference.html>`_
+ <clang-tidy/checks/bugprone-move-forwarding-reference.html>`_
- The 'misc-multiple-statement-macro' check was renamed to `bugprone-multiple-statement-macro
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-multiple-statement-macro.html>`_
+ <clang-tidy/checks/bugprone-multiple-statement-macro.html>`_
- The 'misc-noexcept-move-constructor' check was renamed to `performance-noexcept-move-constructor
- <http://clang.llvm.org/extra/clang-tidy/checks/performance-noexcept-move-constructor.html>`_
+ <clang-tidy/checks/performance-noexcept-move-constructor.html>`_
- The 'misc-string-constructor' check was renamed to `bugprone-string-constructor
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-string-constructor.html>`_
+ <clang-tidy/checks/bugprone-string-constructor.html>`_
- The 'misc-use-after-move' check was renamed to `bugprone-use-after-move
- <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-use-after-move.html>`_
+ <clang-tidy/checks/bugprone-use-after-move.html>`_
- The 'performance-implicit-cast-in-loop' check was renamed to `performance-implicit-conversion-in-loop
- <http://clang.llvm.org/extra/clang-tidy/checks/performance-implicit-conversion-in-loop.html>`_
+ <clang-tidy/checks/performance-implicit-conversion-in-loop.html>`_
- The 'readability-implicit-bool-cast' check was renamed to `readability-implicit-bool-conversion
- <http://clang.llvm.org/extra/clang-tidy/checks/readability-implicit-bool-conversion.html>`_
+ <clang-tidy/checks/readability-implicit-bool-conversion.html>`_
The check's options were renamed as follows:
@@ -243,40 +228,30 @@ Improvements to clang-tidy
- `AllowConditionalPointerCasts` -> `AllowPointerConditions`.
- Added `modernize-use-emplace.IgnoreImplicitConstructors
- <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-emplace.html#cmdoption-arg-IgnoreImplicitConstructors>`_
+ <clang-tidy/checks/modernize-use-emplace.html#cmdoption-arg-IgnoreImplicitConstructors>`_
option.
-- Added aliases for the `High Integrity C++ Coding Standard <http://www.codingstandard.com/section/index/>`_
+- Added aliases for the `High Integrity C++ Coding Standard <http://www.codingstandard.com/section/index/>`_
to already implemented checks in other modules.
- - `hicpp-deprecated-headers <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-deprecated-headers.html>`_
- - `hicpp-move-const-arg <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-move-const-arg.html>`_
- - `hicpp-no-array-decay <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-no-array-decay.html>`_
- - `hicpp-no-malloc <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-no-malloc.html>`_
- - `hicpp-static-assert <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-static-assert.html>`_
- - `hicpp-use-auto <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-use-auto.html>`_
- - `hicpp-use-emplace <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-use-emplace.html>`_
- - `hicpp-use-noexcept <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-use-noexcept.html>`_
- - `hicpp-use-nullptr <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-use-nullptr.html>`_
- - `hicpp-vararg <http://clang.llvm.org/extra/clang-tidy/checks/hicpp-vararg.html>`_
+ - `hicpp-deprecated-headers <clang-tidy/checks/hicpp-deprecated-headers.html>`_
+ - `hicpp-move-const-arg <clang-tidy/checks/hicpp-move-const-arg.html>`_
+ - `hicpp-no-array-decay <clang-tidy/checks/hicpp-no-array-decay.html>`_
+ - `hicpp-no-malloc <clang-tidy/checks/hicpp-no-malloc.html>`_
+ - `hicpp-static-assert <clang-tidy/checks/hicpp-static-assert.html>`_
+ - `hicpp-use-auto <clang-tidy/checks/hicpp-use-auto.html>`_
+ - `hicpp-use-emplace <clang-tidy/checks/hicpp-use-emplace.html>`_
+ - `hicpp-use-noexcept <clang-tidy/checks/hicpp-use-noexcept.html>`_
+ - `hicpp-use-nullptr <clang-tidy/checks/hicpp-use-nullptr.html>`_
+ - `hicpp-vararg <clang-tidy/checks/hicpp-vararg.html>`_
- Added the ability to suppress specific checks (or all checks) in a ``NOLINT`` or ``NOLINTNEXTLINE`` comment.
- Added new functionality to `misc-redundant-expression
- <http://clang.llvm.org/extra/clang-tidy/checks/misc-redundant-expression.html>`_ check
+ <clang-tidy/checks/misc-redundant-expression.html>`_ check
Finds redundant binary operator expressions where the operators are overloaded,
and ones that contain the same macros twice.
Also checks for assignment expressions that do not change the value of the
assigned variable, and expressions that always evaluate to the same value
because of possible operator confusion.
-
-Improvements to include-fixer
------------------------------
-
-The improvements are...
-
-Improvements to modularize
---------------------------
-
-The improvements are...