diff mbox

[Docs] Reword the documentation for -fdump-rtl-

Message ID 1446137730-22239-1-git-send-email-james.greenhalgh@arm.com
State New
Headers show

Commit Message

James Greenhalgh Oct. 29, 2015, 4:55 p.m. UTC
Hi Sandra,

Thanks for the review.

On Thu, Oct 29, 2015 at 10:22:01AM -0600, Sandra Loosemore wrote:
> s/will be registered/are registered/


Fixed, alongside other occurrences.

> >+registered by plugins, which are specific to compilation targets, or

> >+which are otherwise registered after all the other passes, will be

>

> This is ambiguous.  Do you mean

>

> "passes registered by plugins (which are specific to compilation

> targets or otherwise registered after all the other passes)"

>

> or

>

> "passes registered by plugins, passes specific to compilation

> targets, or passes that are otherwise registered after all the other

> passes"

>


The latter, fixed.

> -Sandra the nit-picky


:-)

OK for trunk?

Thanks,
James

---
2015-10-29  James Greenhalgh  <james.greenhalgh@arm.com>

	* doc/invoke.texi (fdump-rtl-@var{pass}): Clarify relationship
	between pass numbering and execution order.

Comments

James Greenhalgh Oct. 30, 2015, 3:48 p.m. UTC | #1
On Thu, Oct 29, 2015 at 11:09:32AM -0600, Sandra Loosemore wrote:
> On 10/29/2015 10:55 AM, James Greenhalgh wrote:

> 

> >diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi

> >index 76fdc31..5549f17 100644

> >--- a/gcc/doc/invoke.texi

> >+++ b/gcc/doc/invoke.texi

> >@@ -6665,17 +6665,19 @@ Says to make debugging dumps during compilation at times specified by

> > @var{letters}.  This is used for debugging the RTL-based passes of the

> > compiler.  The file names for most of the dumps are made by appending

> > a pass number and a word to the @var{dumpname}, and the files are

> >-created in the directory of the output file. In case of

> >+created in the directory of the output file.  In case of

> > @option{=@var{filename}} option, the dump is output on the given file

> >-instead of the pass numbered dump files. Note that the pass number is

> >-computed statically as passes get registered into the pass manager.

> >-Thus the numbering is not related to the dynamic order of execution of

> >-passes.  In particular, a pass installed by a plugin could have a

> >-number over 200 even if it executed quite early.  @var{dumpname} is

> >-generated from the name of the output file, if explicitly specified

> >-and it is not an executable, otherwise it is the basename of the

> >-source file. These switches may have different effects when

> >-@option{-E} is used for preprocessing.

> >+instead of the pass numbered dump files.  Note that the pass number is

> >+assigned as passes are registered into the pass manager.  Most passes

> >+are registered in the order that they will execute and for these passes

> >+the number corresponds to the pass execution order.  However, passes

> >+registered by plugins, passes specific to compilation targets, or

> >+passes which are otherwise registered after all the other passes are

> 

> s/which/that/

> 

> >+numbered higher than a pass named "final", even if they are executed

> >+earlier.  @var{dumpname} is generated from the name of the output

> >+file if explicitly specified and not an executable, otherwise it is

> >+the basename of the source file.  These switches may have different

> >+effects when @option{-E} is used for preprocessing.

> >

> > Debug dumps can be enabled with a @option{-fdump-rtl} switch or some

> > @option{-d} option @var{letters}.  Here are the possible

> 

> OK with that change, unless somebody speaks up to say this is

> technically incorrect.


Thanks. I didn't hear anything back regarding the technical accuracy, so
I've committed this with your suggested change as revision 229584.

Thanks,
James
diff mbox

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 76fdc31..5549f17 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -6665,17 +6665,19 @@  Says to make debugging dumps during compilation at times specified by
 @var{letters}.  This is used for debugging the RTL-based passes of the
 compiler.  The file names for most of the dumps are made by appending
 a pass number and a word to the @var{dumpname}, and the files are
-created in the directory of the output file. In case of
+created in the directory of the output file.  In case of
 @option{=@var{filename}} option, the dump is output on the given file
-instead of the pass numbered dump files. Note that the pass number is
-computed statically as passes get registered into the pass manager.
-Thus the numbering is not related to the dynamic order of execution of
-passes.  In particular, a pass installed by a plugin could have a
-number over 200 even if it executed quite early.  @var{dumpname} is
-generated from the name of the output file, if explicitly specified
-and it is not an executable, otherwise it is the basename of the
-source file. These switches may have different effects when
-@option{-E} is used for preprocessing.
+instead of the pass numbered dump files.  Note that the pass number is
+assigned as passes are registered into the pass manager.  Most passes
+are registered in the order that they will execute and for these passes
+the number corresponds to the pass execution order.  However, passes
+registered by plugins, passes specific to compilation targets, or
+passes which are otherwise registered after all the other passes are
+numbered higher than a pass named "final", even if they are executed
+earlier.  @var{dumpname} is generated from the name of the output
+file if explicitly specified and not an executable, otherwise it is
+the basename of the source file.  These switches may have different
+effects when @option{-E} is used for preprocessing.
 
 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
 @option{-d} option @var{letters}.  Here are the possible