diff options
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst')
| -rw-r--r-- | clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst new file mode 100644 index 00000000000..9738fc3cf16 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst @@ -0,0 +1,14 @@ +cppcoreguidelines-pro-bounds-constant-array-index +================================================= + +This check flags all array subscript expressions on static arrays and +std::arrays that either do not have a constant integer expression index or +are out of bounds (for std::array). For out-of-bounds checking of static +arrays, see the clang-diagnostic-array-bounds check. + +The check can generate fixes after the option +cppcoreguidelines-pro-bounds-constant-array-index.GslHeader has been +set to the name of the include file that contains gsl::at(), e.g. "gsl/gsl.h". + +This rule is part of the "Bounds safety" profile of the C++ Core Guidelines, see +https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#-bounds2-only-index-into-arrays-using-constant-expressions. |
