]> Savannah Git Hosting - gnulib.git/commitdiff
warnings, manywarnings: Doc fixes.
authorSimon Josefsson <simon@josefsson.org>
Fri, 23 Sep 2022 07:06:22 +0000 (09:06 +0200)
committerSimon Josefsson <simon@josefsson.org>
Fri, 23 Sep 2022 07:06:22 +0000 (09:06 +0200)
* doc/manywarnings.texi (manywarnings): Improve usage instruction.
Start list of comments on particular warning flags, based on
comment from Paul Eggert <eggert@cs.ucla.edu>.
* doc/warnings.texi (warnings): Mention that it is often used with manywarnings.

ChangeLog
doc/manywarnings.texi
doc/warnings.texi

index a6399f10484bd351c48b24f52d0433dd496f7ebc..5b5804df682bfb167c7c2a31cecc0a24142f720f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2022-09-23  Simon Josefsson  <simon@josefsson.org>
+
+       warnings, manywarnings: Doc fixes.
+       * doc/manywarnings.texi (manywarnings): Improve usage instruction.
+       Start list of comments on particular warning flags, based on
+       comment from Paul Eggert <eggert@cs.ucla.edu>.
+       * doc/warnings.texi (warnings): Mention that it is often used with manywarnings.
+
 2022-09-21  Paul Eggert  <eggert@cs.ucla.edu>
 
        assert-h: suppress clang false alarms
index 1b3e5907bec64b8cb62a2bf6870dff2ab7389b7f..7ab3f09cee64988356cac9043d275a38014ccbe5 100644 (file)
@@ -32,7 +32,7 @@ go through the list of warnings. You will likely deactivate warnings that
 occur often and don't point to mistakes in the code, by adding them to the
 @samp{nw} variable, then reconfiguring and recompiling. When warnings point
 to real mistakes and bugs in the code, you will of course not disable
-them.
+them but fix your code to silence the warning instead.
 
 There are also many GCC warning options which usually don't point to mistakes
 in the code; these warnings enforce a certain programming style. It is a
@@ -44,3 +44,15 @@ When a new version of GCC is released, you can add the new warning options
 that it introduces into the @code{gl_MANYWARN_ALL_GCC} macro (and submit your
 modification to the Gnulib maintainers :-)), and enjoy the benefits of the
 new warnings, while adding the undesired ones to the @samp{nw} variable.
+
+Comments on particular warning flags:
+
+@table @samp
+
+@item -Wsign-compare
+Clang generates too many false alarms with -Wsign-compare, and we don't
+recommend that warning.  Programs using Gnulib generally don't enable
+that warning when compiling Gnulib code.  If you happen to find a real
+bug with that warning we'd like to know it.
+
+@end table
index 1836c04325416c3122d4ad7fbe91a7ccb759f6f3..47ce6332506fd72b07f7ac558c5835a32e3acc8f 100644 (file)
@@ -2,7 +2,9 @@
 @section warnings
 
 The @code{warnings} module allows to regularly build a package with more
-GCC warnings than the default warnings emitted by GCC.
+GCC warnings than the default warnings emitted by GCC.  It is often used
+indirectly through the @code{manywarnings} module
+(@pxref{manywarnings}).
 
 It provides the following functionality: