aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-thread-with-slots.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-thread-with-slots.md')
-rw-r--r--docs/checks/README-thread-with-slots.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/checks/README-thread-with-slots.md b/docs/checks/README-thread-with-slots.md
new file mode 100644
index 00000000..0643364c
--- /dev/null
+++ b/docs/checks/README-thread-with-slots.md
@@ -0,0 +1,8 @@
+# thread-with-slots
+
+slots in a `QThread` derived class are usually a code smell, because
+they'll run in the thread where the `QThread` `QObject` lives and not in
+the thread itself.
+
+Disabled by default since it's very hard to avoid for false-positives. You'll
+have to explicitly enable it and check case by case for races.