diff mbox

Fix -fopt-info documentation in invoke.texi

Message ID 1493919950.9224.6.camel@cavium.com
State New
Headers show

Commit Message

Steve Ellcey May 4, 2017, 5:45 p.m. UTC 
On Thu, 2017-05-04 at 12:24 +0200, Richard Biener wrote:
> > 
> > OK to checkin?
> Ok for trunk and branches.
> 
> Richard.

I just realized there is a problem/inconsistency with my patch.  The
ChangeLog says I am changing invoke.texi but the change is actually to
optinfo.texi.

It looks like invoke.texi and optinfo.texi have the same examples in
them but changes in one did not necessarily get duplicated in the other.
That is why I got confused.  invoke.texi already has the right default
(optimized-optall) for -fopt-info but optinfo.texi has the wrong one.

Here is an updated patch, the changes to optinfo.texi are the same but
I am also tweaking invoke.texi to include the explicit ordering statement
I put in optinfo.texi and I fixed the ChangeLog entry to match the actual
patch.

Since the actual textual changes are the same as before (just not where I
said they were) I will go ahead and check this in tomorrow unless there are
objections.

Steve Ellcey
sellcey@cavium.com


2017-05-05  Steve Ellcey  <sellcey@cavium.com>

	* doc/invoke.texi (-fopt-info): Explicitly say order of options
	included in -fopt-info does not matter.
	* doc/optinfo.texi (-fopt-info): Fix description of default
	behavour. Explicitly say order of options included in -fopt-info
	does not matter.
diff mbox

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 68a558e..57c9678 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -13219,7 +13219,8 @@  gcc -O2 -ftree-vectorize -fopt-info-vec-missed
 prints information about missed optimization opportunities from
 vectorization passes on @file{stderr}.  
 Note that @option{-fopt-info-vec-missed} is equivalent to 
-@option{-fopt-info-missed-vec}.
+@option{-fopt-info-missed-vec}.  The order of the optimization group
+names and message types listed after @option{-fopt-info} does not matter.
 
 As another example,
 @smallexample
diff --git a/gcc/doc/optinfo.texi b/gcc/doc/optinfo.texi
index e17cb37..7e32efe 100644
--- a/gcc/doc/optinfo.texi
+++ b/gcc/doc/optinfo.texi
@@ -208,16 +208,18 @@  optimized locations from all the inlining passes into
 If the @var{filename} is provided, then the dumps from all the
 applicable optimizations are concatenated into the @file{filename}.
 Otherwise the dump is output onto @file{stderr}. If @var{options} is
-omitted, it defaults to @option{all-all}, which means dump all
-available optimization info from all the passes. In the following
-example, all optimization info is output on to @file{stderr}.
+omitted, it defaults to @option{optimized-optall}, which means dump
+all information about successful optimizations from all the passes.
+In the following example, the optimization information is output on
+to @file{stderr}.
 
 @smallexample
 gcc -O3 -fopt-info
 @end smallexample
 
 Note that @option{-fopt-info-vec-missed} behaves the same as
-@option{-fopt-info-missed-vec}.
+@option{-fopt-info-missed-vec}.  The order of the optimization group
+names and message types listed after @option{-fopt-info} does not matter.
 
 As another example, consider