From 52bbdad7d63fd060d102b3591b433d116a982255 Mon Sep 17 00:00:00 2001 From: Jonathan Roelofs Date: Mon, 9 Mar 2020 16:51:41 -0600 Subject: [PATCH] [clang-tidy][docs] Post-commit feedback on D74669 --- clang-tools-extra/docs/ReleaseNotes.rst | 13 +++++++------ .../docs/clang-tidy/checks/bugprone-suspicious-include.rst | 8 ++++---- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index aa9ff71..3da1433 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -82,6 +82,13 @@ New checks Checks for usages of identifiers reserved for use by the implementation. +- New :doc:`bugprone-suspicious-include + ` check. + + Finds cases where an include refers to what appears to be an implementation + file, which often leads to hard-to-track-down ODR violations, and diagnoses + them. + - New :doc:`cert-oop57-cpp ` check. @@ -98,12 +105,6 @@ New checks Finds recursive functions and diagnoses them. -- New :doc:`bugprone-suspicious-include - ` check. - - Finds includes that appear to be referring to implementation files (which - tends to cause ODR violations), and diagnoses them. - New check aliases ^^^^^^^^^^^^^^^^^ diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst index 95a90c4..9d6c41d 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone-suspicious-include.rst @@ -3,8 +3,8 @@ bugprone-suspicious-include =========================== -The checker detects various cases when an include refers to what appears to be -an implementation file, which often leads to hard-to-track-down ODR violations. +The check detects various cases when an include refers to what appears to be an +implementation file, which often leads to hard-to-track-down ODR violations. Examples: @@ -20,7 +20,7 @@ Options ------- .. option:: HeaderFileExtensions - Default value: ";h;hh;hpp;hxx" + Default value: `";h;hh;hpp;hxx"` A semicolon-separated list of filename extensions of header files (the filename extensions should not contain a "." prefix). For extension-less header files, use an empty string or leave an empty string between ";" @@ -28,6 +28,6 @@ Options .. option:: ImplementationFileExtensions - Default value: "c;cc;cpp;cxx" + Default value: `"c;cc;cpp;cxx"` Likewise, a semicolon-separated list of filename extensions of implementation files. -- 2.7.4