[Clang-tidy] Update release notes with list of checks added since 3.8

[Eugene.Zelenko]

Summary

Descriptions of checks were extracted from documentations. If style is wrong, will be good idea if native English speaker will fix both release notes and documentation.

I also mentioned fix of crash on compile database with relative paths.

[alexfh]

Looks good with a nit. Thank you!

docs/ReleaseNotes.rst

129

nit: Double backquotes should be used for inline code snippets.

[alexfh]

A few more nits.

docs/ReleaseNotes.rst

68

I'd remove "This check" at the start of all check descriptions.

85

nit: Double backquotes should be used for inline code snippets.

112

nit: Double backquotes should be used for inline code snippets.

117

nit: "with a loop variable"

139

nit: Should be :program:<backquote>clang-tidy<backquote>

[LegalizeAdulthood]

docs/ReleaseNotes.rst

143

The formatting here has been changed on trunk. Please rebase with a full file context so we can see the whole file in phabricator.

[Eugene.Zelenko]

Which style I should use? Suggested by Richard or just provide links to documentation as in updated version?

[LegalizeAdulthood]

docs/ReleaseNotes.rst

143

Alex changed:

Improvements to ``modularize``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

to

Improvements to modularize
--------------------------

(See raw version on github mirror)

and your diff is against the old version, so you will want to rebase the changeset and post a full context diff when you update this review.

[Eugene.Zelenko]

Sections headers are not problem :-)

See newly added "Clang-tidy changes from 3.7 to 3.8" section. It contains only names of checks with link to documentation page without brief description.

[alexfh]

In D18582#387525, @Eugene.Zelenko wrote:

Sections headers are not problem :-)

See newly added "Clang-tidy changes from 3.7 to 3.8" section. It contains only names of checks with link to documentation page without brief description.

The summaries + links to the check docs would probably be the most useful format (btw, it makes sense to add the links to the new entries as well). I was just too lazy to manually write/copy-paste-edit the summaries for the ~40 checks in the 3.7->3.8 section.

[Eugene.Zelenko]

Which links should I use, since it should point to release specific location, but 3.9 is not branched yet?

[Eugene.Zelenko]

Addressed Alex and Richard comments except links.

Also fixed spotted issues in checks documentation. Looks like better documentation proofreading during code review is needed.

[etienneb]

thanks for taking care of this.

docs/ReleaseNotes.rst

132

I just landed this one: http://reviews.llvm.org/D18457

I'll appreciate if you can add the entry here.

Thanks.

• New misc-suspicious-missing-comma check
  
  Warns about 'probably' missing comma in string literals initializer list.

137

Crash when running with the `-fdelayed-template-parsing` flag.

see: http://reviews.llvm.org/D18238

[Eugene.Zelenko]

Updated per Etienne comments.

Links are still need to be added, but I'm not clear about address.

[alexfh]

In D18582#388496, @Eugene.Zelenko wrote:

Updated per Etienne comments.

Links are still need to be added, but I'm not clear about address.

I'd point the links to the live version (e.g. http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-string-init.html) and then update them once the next release is branched.

[alexfh]

docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst

4

Did you mean 'in a range-based loop with a loop variable of const ref type'?

[Eugene.Zelenko]

Added links. Fix typo spotted by Alexander.

[alexfh]

docs/ReleaseNotes.rst

67

Should these lines be indented to New ... (i.e. with just two spaces)?

[alexfh]

One more nit.

docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst

4

nit: 'range-based loops' or 'a range-based loop'.

[Eugene.Zelenko]

I align them as in 3.8 changes, to first `. If you think that alignment should be other way, I'll change it.

[Eugene.Zelenko]

Updated to trunk. Changed per Alexander comments.

[alexfh]

In D18582#388931, @Eugene.Zelenko wrote:

I align them as in 3.8 changes, to first `. If you think that alignment should be other way, I'll change it.

This observation doesn't capture the intent correctly. They are aligned with the first column after the "- ", which in some cases happens to contain the first backquote.

[Eugene.Zelenko]

I fixed indentation.

Should I commit changes?

[alexfh]

Good to submit now. Thank you for working on this!

docs/ReleaseNotes.rst

 explain them more clearly, and provide more accurate fix-its for the issues
 identified.  The improvements since the 3.8 release include:
 
-- New ``modernize-raw-string-literal`` check
+- New `cert-env33-c
+      <http://clang.llvm.org/extra/clang-tidy/checks/cert-env33-c.html>`_ check
 
-  This check selectively replaces string literals containing escaped
-  characters with raw string literals.
+  Flags calls to ``system()``, ``popen()``, and ``_popen()``, which execute a
+  command processor.
 
+- New `cert-flp30-c
+      <http://clang.llvm.org/extra/clang-tidy/checks/cert-flp30-c.html>`_ check
+
+  Flags ``for`` loops where the induction expression has a floating-point type.
+
+- New `cppcoreguidelines-pro-type-member-init
+      <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-pro-type-member-init.html>`_ check
+
+  Flags user-defined constructor definitions that do not initialize all builtin
+  and pointer fields which leaves their memory in an undefined state.
+
+- New `misc-dangling-handle
+      <http://clang.llvm.org/extra/clang-tidy/checks/misc-dangling-handle.html>`_ check
+
+  Detects dangling references in value handlers like
+  ``std::experimental::string_view``.
+
+- New `misc-forward-declaration-namespace
+      <http://clang.llvm.org/extra/clang-tidy/checks/misc-forward-declaration-namespace.html>`_ check
+
+  Checks if an unused forward declaration is in a wrong namespace.
+
+- New `misc-misplaced-widening-cast
+      <http://clang.llvm.org/extra/clang-tidy/checks/misc-misplaced-widening-cast.html>`_ check
+
+  Warns when there is a explicit redundant cast of a calculation result to a
+  bigger type.
+
+- New `misc-suspicious-missing-comma
+      <http://clang.llvm.org/extra/clang-tidy/checks/misc-suspicious-missing-comma.html>`_ check
+
+  Warns about 'probably' missing comma in string literals initializer list.
+
+- New `misc-suspicious-semicolon
+      <http://clang.llvm.org/extra/clang-tidy/checks/misc-suspicious-semicolon.html>`_ check
+
+  Finds most instances of stray semicolons that unexpectedly alter the meaning
+  of the code.
+
+- New `modernize-deprecated-headers
+      <http://clang.llvm.org/extra/clang-tidy/checks/modernize-deprecated-headers.html>`_ check
+
+  Replaces C standard library headers with their C++ alternatives.
+
+- New `modernize-raw-string-literal
+      <http://clang.llvm.org/extra/clang-tidy/checks/modernize-raw-string-literal.html>`_ check
+
+  Selectively replaces string literals containing escaped characters with raw
+  string literals.
+
+- New `performance-faster-string-find
+      <http://clang.llvm.org/extra/clang-tidy/checks/performance-faster-string-find.html>`_ check
+
+  Optimize calls to ``std::string::find()`` and friends when the needle passed
+  is a single character string literal.
+
+- New `performance-implicit-cast-in-loop
+      <http://clang.llvm.org/extra/clang-tidy/checks/performance-implicit-cast-in-loop.html>`_ check
+
+  Warns about range-based loop with a loop variable of const ref type where the
+  type of the variable does not match the one returned by the iterator.
+
+- New `performance-unnecessary-value-param
+      <http://clang.llvm.org/extra/clang-tidy/checks/performance-unnecessary-value-param.html>`_ check
+
+  Flags value parameter declarations of expensive to copy types that are copied
+  for each invocation but it would suffice to pass them by const reference.
+
+- New `readability-redundant-control-flow
+      <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-control-flow.html>`_ check
+
+  Looks for procedures (functions returning no value) with ``return`` statements
+  at the end of the function.  Such `return` statements are redundant.
+
+- New `readability-redundant-string-init
+      <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-string-init.html>`_ check
+
+  Finds unnecessary string initializations.
+
+Fixed bugs:
+
+  Crash when running on compile database with relative source files paths.
+
+  Crash when running with the `-fdelayed-template-parsing` flag.
+
 Clang-tidy changes from 3.7 to 3.8
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

docs/clang-tidy/checks/misc-dangling-handle.rst

 ====================
 
 Detect dangling references in value handlers like
-`std::experimental::string_view`.
+``std::experimental::string_view``.
 These dangling references can come from constructing handles from temporary
 values, where the temporary is destroyed soon after the handle is created.
 
-By default only `std::experimental::basic_string_view` is considered.
-This list can be modified by passing a ; separated list of class names using
+By default only ``std::experimental::basic_string_view`` is considered.
+This list can be modified by passing a `;` separated list of class names using
 the HandleClasses option.
 
 Examples:

docs/clang-tidy/checks/performance-faster-string-find.rst

 performance-faster-string-find
 ==============================
 
-Optimize calls to std::string::find() and friends when the needle passed is
+Optimize calls to ``std::string::find()`` and friends when the needle passed is
 a single character string literal.
 The character literal overload is more efficient.
 
-By default only `std::basic_string` is considered. This list can be modified by
+By default only ``std::basic_string`` is considered. This list can be modified by
 passing a `;` separated list of class names using the `StringLikeClasses`
 option. The methods to consired are fixed, though.
 

docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst

 performance-implicit-cast-in-loop
 =================================
 
-This warning appears in range-based loop with loop variable of const ref type
+This warning appears in range-based loop with a loop variable of const ref type
 where the type of the variable does not match the one returned by the iterator.
 This means that an implicit cast has been added, which can for example result in
 expensive deep copies.

docs/clang-tidy/checks/readability-redundant-control-flow.rst

 readability-redundant-control-flow
 ==================================
 
-This check looks for procedures (functions returning no value) with `return`
-statements at the end of the function.  Such `return` statements are redundant.
+This check looks for procedures (functions returning no value) with ``return``
+statements at the end of the function.  Such ``return`` statements are
+redundant.
 
-Loop statements (`for`, `while`, `do while`) are checked for redundant
-`continue` statements at the end of the loop body.
+Loop statements (``for``, ``while``, ``do while``) are checked for redundant
+``continue`` statements at the end of the loop body.
 
 Examples: