This is an archive of the discontinued LLVM Phabricator instance.

Differential D134457

Document WarnOnSizeOfPointerToAggregate.
ClosedPublic

Authored by mbenfield on Sep 22 2022, 10:19 AM.

Details

Reviewers
mizvekov
Commits
rG33bc9c3bf2e0: Document WarnOnSizeOfPointerToAggregate.
Summary

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

Diff Detail

Event Timeline

mbenfield created this revision.Sep 22 2022, 10:19 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 22 2022, 10:19 AM
mbenfield requested review of this revision.Sep 22 2022, 10:19 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 22 2022, 10:19 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B188213: Diff 462229.Sep 22 2022, 10:19 AM
mizvekov accepted this revision.Sep 22 2022, 10:28 AM
This revision is now accepted and ready to land.Sep 22 2022, 10:28 AM
Closed by commit rG33bc9c3bf2e0: Document WarnOnSizeOfPointerToAggregate. (authored by mbenfield). · Explain WhySep 22 2022, 10:39 AM
This revision was automatically updated to reflect the committed changes.
mbenfield added a commit: rG33bc9c3bf2e0: Document WarnOnSizeOfPointerToAggregate..

Revision Contents

PathSize
clang-tools-extra/
docs/
clang-tidy/
checks/
bugprone/
6 lines

Diff 462229

clang-tools-extra/docs/clang-tidy/checks/bugprone/sizeof-expression.rst

Show First 20 Lines • Show All 181 Lines • ▼ Show 20 Lines.. option:: WarnOnSizeOfThis
When `true`, the check will warn on an expression like ``sizeof(this)``. When `true`, the check will warn on an expression like ``sizeof(this)``.
Default is `true`. Default is `true`.
.. option:: WarnOnSizeOfCompareToConstant .. option:: WarnOnSizeOfCompareToConstant
When `true`, the check will warn on an expression like When `true`, the check will warn on an expression like
``sizeof(expr) <= k`` for a suspicious constant `k` while `k` is `0` or ``sizeof(expr) <= k`` for a suspicious constant `k` while `k` is `0` or
greater than `0x8000`. Default is `true`. 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`.