User account creation filtered due to spam.

Bug 951 - Documentation of compiler passes and sources very out of date
Summary: Documentation of compiler passes and sources very out of date
Status: NEW
Alias: None
Product: gcc
Classification: Unclassified
Component: rtl-optimization (show other bugs)
Version: 2.97
: P3 normal
Target Milestone: ---
Assignee: Not yet assigned to anyone
URL:
Keywords: documentation
Depends on: 26241 26238 26239 26240 26242 26243
Blocks: 13756
  Show dependency treegraph
 
Reported: 2000-12-01 06:06 UTC by Joseph S. Myers
Modified: 2005-12-10 04:02 UTC (History)
1 user (show)

See Also:
Host: *-*-*
Target: *-*-*
Build: *-*-*
Known to work:
Known to fail:
Last reconfirmed: 2005-09-10 05:42:50


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Joseph S. Myers 2000-12-01 06:06:00 UTC
gcc.texi includes documentation of the passes of the compiler and of
the source files that implement them.  This documentation is very out
of date.

Release:
2.97 20001201 (experimental)

Environment:
System: Linux decomino 2.2.17 #1 Mon Sep 4 20:22:16 UTC 2000 i686 unknown
Architecture: i686

	
host: i686-pc-linux-gnu
build: i686-pc-linux-gnu
target: i686-pc-linux-gnu
configured with: ../gcc-cvs/configure --prefix=/opt/gcc/snapshot --disable-shared --enable-threads=posix --with-system-zlib

How-To-Repeat:
Read the GCC manual.  Observe the failure to cover whole-function
trees, references to now non-existent source files such as sched.c,
out of date information on -d options, etc..
Comment 1 Joseph S. Myers 2000-12-01 06:06:00 UTC
Fix:
Update this part of the manual with careful reference to toplev.c,
including all passes in the correct order, documenting the source
files used and ensuring that each relevant source file is mentioned
and that no source files that are no longer in GCC are mentioned.
Once it is up to date, insist that patches adding optimization passes
or otherwise changing this area must include the documentation updates
as well.
Comment 2 Joseph S. Myers 2001-05-20 16:44:52 UTC
State-Changed-From-To: open->analyzed
State-Changed-Why: Confirming my PR.  Daniel Berlin has begun working on fixing
    this:
    
    http://gcc.gnu.org/ml/gcc-patches/2001-05/msg01196.html
Comment 3 Joseph S. Myers 2001-05-20 23:44:52 UTC
From: jsm28@gcc.gnu.org
To: gcc-gnats@gcc.gnu.org, jsm28@cam.ac.uk, nobody@gcc.gnu.org
Cc:  
Subject: Re: other/951
Date: 20 May 2001 23:44:52 -0000

 Synopsis: Documentation of compiler passes and sources very out of date
 
 State-Changed-From-To: open->analyzed
 State-Changed-By: jsm28
 State-Changed-When: Sun May 20 16:44:52 2001
 State-Changed-Why:
     Confirming my PR.  Daniel Berlin has begun working on fixing
     this:
     
     http://gcc.gnu.org/ml/gcc-patches/2001-05/msg01196.html
 
 http://gcc.gnu.org/cgi-bin/gnatsweb.pl?cmd=view&pr=951&database=gcc
Comment 4 Andrew Pinski 2003-05-27 23:28:15 UTC
Is there any progress on this one?
Comment 5 Joseph S. Myers 2003-05-28 08:40:24 UTC
Subject: Re:  Documentation of compiler passes and sources
 very out of date

On Wed, 27 May 2003, pinskia@physics.uc.edu wrote:

> Is there any progress on this one?

There was some work done - but passes.texi is still far from up to date
and complete.

Comment 6 Nathanael C. Nerode 2003-07-12 04:34:07 UTC
Gaaah... let's try to get this one for 3.4...
Comment 7 Nathanael C. Nerode 2003-08-03 17:29:08 UTC
Not bloody likely for 3.4.  Tree-ssa is rewriting and replacing even *more*
passes; so let's try to get it there.
Comment 8 Steven Bosscher 2003-11-14 06:38:14 UTC
Not really related to tree-ssa, move to 3.5 
Besides, the tree-ssa passes _are_ properly documented.  At best, we make a 
few other flags redundant :-)