[WWW] Reporting instructions for PCH bugs

[Geoffrey Keating]

The attached patch tries to describe how to report a PCH bug.

Does anyone have any objections?

-- 
- Geoffrey Keating <geoffk@apple.com>

===File ~/patches/www-pchbugs.patch=========================
*** bugs.html.~1.62.~	Fri Dec  6 11:58:47 2002
--- bugs.html	Fri Dec 13 18:36:25 2002
***************
*** 21,26 ****
--- 21,27 ----
   <li><a href="#where">Where to post it</a></li>
   <li><a href="#detailed">Detailed bug reporting instructions</a></li>
   <li><a href="#gnat">Detailed bug reporting instructions for GNAT</a></li>
+  <li><a href="#pch">Detailed bug reporting instructions when using a precompiled header</a></li>
   </ul>
  </li>
  <li><a href="#manage">Managing Bugs (GNATS and the test-suite)</a></li>
***************
*** 116,122 ****
    possible as a follow-up to the original bug report</li>
  
    <li>Assembly files (<code>*.s</code>) produced by the compiler, or any
!   binary files, such as object files, executables or core files</li>
  
    <li>Duplicate bug reports, or reports of bugs already fixed in the
    development tree, especially those that have already been reported
--- 117,124 ----
    possible as a follow-up to the original bug report</li>
  
    <li>Assembly files (<code>*.s</code>) produced by the compiler, or any
!   binary files, such as object files, executables, core files, or
!   precompiled header files</li>
  
    <li>Duplicate bug reports, or reports of bugs already fixed in the
    development tree, especially those that have already been reported
***************
*** 150,156 ****
  <h2><a name="detailed">Detailed bug reporting instructions</a></h2>
  
  <p>Please refer to the <a href="#gnat">next section</a> when reporting
! bugs in GNAT, the Ada compiler.</p>
  
  <p>In general, all the information we need can be obtained by
  collecting the command line below, as well as its output and the
--- 152,159 ----
  <h2><a name="detailed">Detailed bug reporting instructions</a></h2>
  
  <p>Please refer to the <a href="#gnat">next section</a> when reporting
! bugs in GNAT, the Ada compiler, or to the <a href="#pch">one after
! that</a> when reporting bugs that appear when using a precompiled header.</p>
  
  <p>In general, all the information we need can be obtained by
  collecting the command line below, as well as its output and the
***************
*** 170,180 ****
  much easier.</p>
  
  <p>The <b>only</b> excuses to not send us the preprocessed sources are
! (i) if you've found a bug in the preprocessor, or (ii) if you've
! reduced the testcase to a small file that doesn't include any
! other file.  If you can't post the preprocessed sources because
! they're proprietary code, then try to create a small file that
! triggers the same problem.</p>
  
  <p>Since we're supposed to be able to re-create the assembly output
  (extension <code>.s</code>), you usually should not include
--- 173,183 ----
  much easier.</p>
  
  <p>The <b>only</b> excuses to not send us the preprocessed sources are
! (i) if you've found a bug in the preprocessor, (ii) if you've reduced
! the testcase to a small file that doesn't include any other file or
! (iii) if the bug appears only when using precompiled headers.  If you
! can't post the preprocessed sources because they're proprietary code,
! then try to create a small file that triggers the same problem.</p>
  
  <p>Since we're supposed to be able to re-create the assembly output
  (extension <code>.s</code>), you usually should not include
***************
*** 248,253 ****
--- 251,280 ----
  submit it accoding to our <a href="#where">generic instructions</a>.
  (If you use a mailing list for reporting, please include an
  "<code>[Ada]</code>" tag in the subject.)</p>
+ 
+ <h2><a name="pch">Detailed bug reporting instructions when using a
+ precompiled header</a></h2>
+ 
+ <p>If you're encountering a bug when using a precompiled header, the
+ first thing to do is to delete the precompiled header, and try running
+ the same GCC command again.  If the bug happens again, the bug doesn't
+ really involve precompiled headers, please report it without using
+ them by following the instructions <a href="#detailed">above</a>.</p>
+ 
+ <p>If you've found a bug while <i>building</i> a precompiled header
+ (for instance, the compiler crashes), follow the usual instructions
+ <a href="#detailed">above</a>.</p>
+ 
+ <p>If you've found a real precompiled header bug, what we'll need to
+ reproduce it is the sources to build the precompiled header (as a
+ single <code>.i</code> file), the source file that uses the
+ precompiled header, any other headers that source file includes, and
+ the command lines that you used to build the precompiled header and to
+ use it.</p>
+ 
+ <p>Please <strong>don't</strong> send us the actual precompiled
+ header.  It is likely to be very large and we can't use it to
+ reproduce the problem.</p>
  
  <h1><a name="manage">Managing Bugs (GNATS and the test-suite)</a></h1>
  
============================================================