aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-old-style-connect.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-old-style-connect.md')
-rw-r--r--docs/checks/README-old-style-connect.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/checks/README-old-style-connect.md b/docs/checks/README-old-style-connect.md
new file mode 100644
index 00000000..2cad4e8d
--- /dev/null
+++ b/docs/checks/README-old-style-connect.md
@@ -0,0 +1,18 @@
+# old-style-connect
+
+Finds usages of old style connects.
+Connecting with old style syntax (`SIGNAL`/`SLOT`) is much slower than using pointer to member syntax (PMF).
+
+Here's however a non-exhaustive list of caveats you should be aware of:
+- You can't disconnect with new-syntax if the connect was made with old-syntax (and vice-versa)
+- You can't disconnect from a static slot with new-syntax (although connecting works)
+- Difference in behaviour when calling slots of partially destroyed objects (<https://codereview.qt-project.org/#/c/83800>)
+
+#### Fixits
+
+You can convert the most simple cases with `export CLAZY_FIXIT=fix-old-style-connect`.
+Be careful, as PMF is not a 100% drop-in replacement.
+
+#### Pitfalls
+
+Although this check doesn't have false-positives it's a level2 check, that's because some connects are tricky to convert to PMF syntax and might introduce bugs if you don't know what you're doing.