aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-qstring-varargs.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-qstring-varargs.md')
-rw-r--r--docs/checks/README-qstring-varargs.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/checks/README-qstring-varargs.md b/docs/checks/README-qstring-varargs.md
new file mode 100644
index 00000000..aa029e46
--- /dev/null
+++ b/docs/checks/README-qstring-varargs.md
@@ -0,0 +1,13 @@
+# qstring-varagars
+
+This implements the equivalent of `-Wnon-pod-varargs` but only for `QString`.
+
+This check is disabled by default and is only useful in cases where you don't want
+to enable `-Wnon-pod-varargs`. For example on projects with thousands of benign warnings
+(like with CString), where you might only want to fix the `QString` cases.
+
+#### Example
+ QString s = (...)
+ LogError("error %s", s);
+
+