[PATCH] D23728: [Clang-tidy] Fix style in some checks documentation

Alexander Kornienko via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 22 16:35:16 PDT 2016


alexfh added inline comments.

================
Comment at: docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst:9
@@ -8,3 +8,3 @@
 are out of bounds (for ``std::array``). For out-of-bounds checking of static
-arrays, see the clang-diagnostic-array-bounds check.
+arrays, see the `clang-diagnostic-array-bounds` check.
 
----------------
Eugene.Zelenko wrote:
> Unfortunately not. Historically Clang warnings options documentation is very poor in comparison with GCC's.
> 
> Probably some descriptions could be extracted from release notes, but I'm not sure that clang-diagnostic-array-bounds is described there.
Ah, I completely missed the fact it's a clang diagnostic. The wording is off here. Should be "see the -Warray-bounds clang diagnostic" instead. The fact that clang diagnostics map to `clang-diagnostic-...` is described in the main doc (http://clang.llvm.org/extra/clang-tidy/).


Repository:
  rL LLVM

https://reviews.llvm.org/D23728





More information about the cfe-commits mailing list