r367918 - [docs] don't use :option: for Wall Wextra

JF Bastien via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 5 12:59:07 PDT 2019


Author: jfb
Date: Mon Aug  5 12:59:07 2019
New Revision: 367918

URL: http://llvm.org/viewvc/llvm-project?rev=367918&view=rev
Log:
[docs] don't use :option: for Wall Wextra

The bots are sad that they're not documented.

Modified:
    cfe/trunk/docs/UsersManual.rst

Modified: cfe/trunk/docs/UsersManual.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/UsersManual.rst?rev=367918&r1=367917&r2=367918&view=diff
==============================================================================
--- cfe/trunk/docs/UsersManual.rst (original)
+++ cfe/trunk/docs/UsersManual.rst Mon Aug  5 12:59:07 2019
@@ -1000,13 +1000,13 @@ often disable many diagnostics such as `
 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.
+recommend using it. `-Wall` `-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.




More information about the cfe-commits mailing list