[PATCH] D65706: [docs] Better documentation for -Weverything

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sat Aug 3 16:18:07 PDT 2019


aaron.ballman added a comment.

Thank you for working on this!



================
Comment at: clang/docs/UsersManual.rst:998
+:option:`-Werror`, and also includes the warnings from :option:`-pedantic`. Some
+diagnostics contradict each other, users of :option:`-Weverything` therefore
+often disable many diagnostics such as :option:`-Wno-c++98-compat`
----------------
users of -Weverything therefore -> therefore, users of -Weverything


================
Comment at: clang/docs/UsersManual.rst:999-1000
+diagnostics contradict each other, users of :option:`-Weverything` therefore
+often disable many diagnostics such as :option:`-Wno-c++98-compat`
+:option:`-Wno-c++-compat`.
+
----------------
Would you care to propose a more exhaustive list of conflicting diagnostics? (Perhaps in a follow-up patch.)


================
Comment at: clang/docs/UsersManual.rst:1006
+more difficult because you're exposed to experimental diagnostics which might be
+of lower quality than the default once. If you do use :option:`-Weverything`
+then we advise that you address all new compiler diagnostics as they get added
----------------
once -> ones
Add a comma after -Weverything


================
Comment at: clang/docs/UsersManual.rst:1008
+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.
----------------
clang -> Clang


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D65706/new/

https://reviews.llvm.org/D65706





More information about the cfe-commits mailing list