aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSergio Martins <smartins@kde.org>2019-10-14 12:51:13 +0100
committerSergio Martins <smartins@kde.org>2019-10-14 12:53:17 +0100
commitc3c52e9800fcee0e839f03bc08ce411faea3642d (patch)
tree69beb5fce5067d302975b93ddc40f246191a1a2b
parentb524c739a6cc55b5fe07bf7702e859bf540f96a0 (diff)
heap-allocated-small-trivial-type: Minor README improvement
-rw-r--r--docs/checks/README-heap-allocated-small-trivial-type.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/checks/README-heap-allocated-small-trivial-type.md b/docs/checks/README-heap-allocated-small-trivial-type.md
index 0996a866..b6345350 100644
--- a/docs/checks/README-heap-allocated-small-trivial-type.md
+++ b/docs/checks/README-heap-allocated-small-trivial-type.md
@@ -4,6 +4,9 @@ Warns when you're allocating small trivially copyable/destructible types on the
Example:
```
auto p = new QPoint(1, 1);
+ /// ... p just used locally in the scope
```
-Unneeded memory allocations are costly.
+Unneeded memory allocations are costly. Make sure there's no change in behaviour
+before fixing these warnings. This check is not enabled by default since there's
+a certain amount of known false-positives.