[analyzer] Extend the documentation of MallocOverflow
authorBalazs Benics <balazs.benics@sigmatechnology.se>
Thu, 26 Aug 2021 12:31:09 +0000 (14:31 +0200)
committerBalazs Benics <balazs.benics@sigmatechnology.se>
Thu, 26 Aug 2021 13:20:41 +0000 (15:20 +0200)
commit6097a41924584b613153237d8e66e9660001ce7d
tree7bfd4db0cdfe1114bf66a1fe7838d9765d379532
parent99c4336374bf8b296aacac18168b229bb295c12d
[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