[analyzer] Extend the documentation of MallocOverflow
authorBalazs Benics <balazs.benics@sigmatechnology.se>
Thu, 26 Aug 2021 16:15:10 +0000 (18:15 +0200)
committerBalazs Benics <balazs.benics@sigmatechnology.se>
Thu, 26 Aug 2021 16:15:10 +0000 (18:15 +0200)
commitaf79f1bff90bee957ec9f963b68226e0b33eb169
treeca1022b3ce4bcdf5702f8de733d9cdbb62039449
parentcce49dcb8578a18e34557c0be7daa6c9a6336283
[analyzer] Extend the documentation of MallocOverflow

Previously by following the documentation it was not immediately clear
what the capabilities of this checker are.

In this patch, I add some clarification on when does the checker issue a
report and what it's limitations are.
I'm also advertising suppressing such reports by adding an assertion, as
demonstrated by the test3().
I'm highlighting that this checker might produce an extensive amount of
findings, but it might be still useful for code audits.

Reviewed By: martong

Differential Revision: https://reviews.llvm.org/D107756
clang/docs/analyzer/checkers.rst