Document WarnOnSizeOfPointerToAggregate.

This option was just landed in D134381. It would make sense to actually
document it.

Differential Revision: https://reviews.llvm.org/D134457
This commit is contained in:
Michael Benfield 2022-09-22 17:17:34 +00:00
parent c997fe6586
commit 33bc9c3bf2
1 changed files with 6 additions and 0 deletions

View File

@ -187,3 +187,9 @@ Options
When `true`, the check will warn on an expression like
``sizeof(expr) <= k`` for a suspicious constant `k` while `k` is `0` or
greater than `0x8000`. Default is `true`.
.. option:: WarnOnSizeOfPointerToAggregate
When `true, the check will warn on an expression like
``sizeof(expr)`` where the expression is a pointer
to aggregate. Default is `true`.