PATCH for: Lots of suggestions for the gcc manual

[Gerald Pfeifer <gerald at pfeifer dot com>]

On Sat, 13 Sep 2003, Stephan Thomas Lavavej wrote:
> http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#Warning%20Options

What do you think about the following patch to address several specific
observations you made?

(Concerning your general remarks on how to restructure the list of
options, I'd slightly prefer the variant someone else suggested in
a followup.  For that, however, I'm afraid we'd need to a volunteer
to summarize the suggested changes to the gcc list and, once consensus
has been reached, provide a patch.  I'd really appreciate that.)

Gerald

2003-10-03  Gerald Pfeifer  <gerald@pfeifer.com>

	* doc/invoke.texi (Warning Options): Simplify and clarify the
	descriptions of -Wnonnull and -Winit-self.

Index: doc/invoke.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/invoke.texi,v
retrieving revision 1.339
diff -u -3 -p -r1.339 invoke.texi
--- doc/invoke.texi	25 Sep 2003 01:25:52 -0000	1.339
+++ doc/invoke.texi	3 Oct 2003 18:50:38 -0000
@@ -2172,7 +2172,7 @@ Enable @option{-Wformat} plus format che

 @item -Wnonnull
 @opindex Wnonnull
-Enable warning about passing a null pointer for arguments marked as
+Warn about passing a null pointer for arguments marked as
 requiring a non-null value by the @code{nonnull} function attribute.

 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
@@ -2180,12 +2180,12 @@ can be disabled with the @option{-Wno-no

 @item -Winit-self @r{(C, C++, and Objective-C only)}
 @opindex Winit-self
-Enable warning about uninitialized variables which are initalized with themselves.
-Note this option can only be used with the @option{-Wuninitialized} option and
-that only works with @option{-O}.
+Warn about uninitialized variables which are initialized with themselves.
+Note this option can only be used with the @option{-Wuninitialized} option,
+which in turn only works with @option{-O1} and above.

-For an example, the following code will not warn about i being uninitialized
-without this option:
+For example, GCC will warn about @code{i} being uninitialized in the
+following snippet only when @option{-Winit-self} has been specified:
 @smallexample
 @group
 int f()