[PATCH] D65706: [docs] Better documentation for -Weverything
JF Bastien via Phabricator via cfe-commits
cfe-commits at lists.llvm.org
Sun Aug 4 20:37:56 PDT 2019
jfb updated this revision to Diff 213278.
jfb marked 5 inline comments as done.
jfb added a comment.
- Address Aaron's comments.
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
@@ -992,13 +992,24 @@
Enabling All Diagnostics
-In addition to the traditional ``-W`` flags, one can enable **all**
-diagnostics by passing :option:`-Weverything`. This works as expected
-:option:`-Werror`, and also includes the warnings from :option:`-pedantic`.
-Note that when combined with :option:`-w` (which disables all warnings), that
+In addition to the traditional ``-W`` flags, one can enable **all** diagnostics
+by passing :option:`-Weverything`. This works as expected with
+:option:`-Werror`, and also includes the warnings from :option:`-pedantic`. Some
+diagnostics contradict each other, therefore, users of :option:`-Weverything`
+often disable many diagnostics such as :option:`-Wno-c++98-compat`
+:option:`-Wno-c++-compat` because they contradict recent C++ standards.
+Since :option:`-Weverything` enables every diagnostic, we generally don't
+recommend using it. :option:`-Wall` :option:`-Wextra` are a better choice for
+most projects. Using :option:`-Weverything` means that updating your compiler is
+more difficult because you're exposed to experimental diagnostics which might be
+of lower quality than the default ones. If you do use :option:`-Weverything`
+then we advise that you address all new compiler diagnostics as they get added
+to Clang, either by fixing everything they find or explicitly disabling that
+diagnostic with its corresponding `Wno-` option.
+Note that when combined with :option:`-w` (which disables all warnings),
+disabling all warnings wins.
Controlling Static Analyzer Diagnostics
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 1808 bytes
Desc: not available
More information about the cfe-commits