Re: [Ada] [wwwdocs] GNAT bug reporting instructions

[Florian Weimer <fw at deneb dot enyo dot de>]

Gerald Pfeifer <pfeifer@dbai.tuwien.ac.at> writes:

> + <ul>
> + <li>the exact version of GCC, as shown by "<code>gcc -v</code>";
>
> Applies to all front ends.

Reporters surely need a single checklist, otherwise their reports are
likely to miss important information, because they tend to take the
language-specific for the complete one.

Anyway, if you insist on a crippled checklist for language-specific
instructions, I can change the patch below accordingly.

> PS: I preapproved, in private mail, a patch where Florian removes at least
> *some* of the redundancy.

Here's a new patch, which moves the mailing list size limits to the
"where" section, so that we can reference it from the Ada section.

Index: bugs.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/bugs.html,v
retrieving revision 1.50
diff -c -r1.50 bugs.html
*** bugs.html	6 Feb 2002 17:43:35 -0000	1.50
--- bugs.html	27 Apr 2002 18:12:30 -0000
***************
*** 20,25 ****
--- 20,26 ----
   <li><a href="#dontwant">What we DON'T want</a></li>
   <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>
   </ul>
  </li>
  <li><a href="#manage">Managing Bugs (GNATS and the test-suite)</a></li>
***************
*** 80,86 ****
    <li>the compiler output (error messages, warnings, etc.); and</li>
    <li>the <em>preprocessed</em> file (<code>*.i*</code>) that triggers the
    bug, generated by adding <code>-save-temps</code> to the complete
!   compilation command (see below).</li>
  </ul>
  
  <h3><a name="dontwant">What we do <strong>not</strong> want</a></h3>
--- 81,88 ----
    <li>the compiler output (error messages, warnings, etc.); and</li>
    <li>the <em>preprocessed</em> file (<code>*.i*</code>) that triggers the
    bug, generated by adding <code>-save-temps</code> to the complete
!   compilation command, or, in the case of a bug report for the GNAT front end,
!   a complete set of source files (see below).</li>
  </ul>
  
  <h3><a name="dontwant">What we do <strong>not</strong> want</a></h3>
***************
*** 140,148 ****
--- 142,157 ----
  <a href="mailto:bug-gcc@gnu.org";>bug-gcc@gnu.org</a> or
  <a href="mailto:gcc-bugs@gcc.gnu.org";>gcc-bugs@gcc.gnu.org</a>.</p>
  
+ <p>The GCC lists have message size limits (200 kbytes) and bug reports
+ over those limits will currently be bounced.  If your bug is larger
+ than that, please post it using the <a href="gnats.html">GCC GNATS bug
+ database</a>.</p>
  
  <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
  preprocessed file it generates.</p>
***************
*** 187,197 ****
  the body of your bug report as plain text, even if needlessly
  duplicated as part of an archive.</p>
  
- <p>The gcc lists have message size limits (200 kbytes) and bug reports
- over those limits will currently be bounced.  If your bug is larger
- than that, please post it using the <a href="gnats.html">GCC GNATS bug
- database</a>.</p>
- 
  <p>If you fail to supply enough information for a bug report to be
  reproduced, someone will probably ask you to post additional
  information (or just ignore your bug report, if they're in a bad day,
--- 196,201 ----
***************
*** 202,208 ****
--- 206,253 ----
  supplied in the incomplete bug report (including the preprocessor
  output), so that the new bug report is self-contained.</p>
  
+ <h2><a name="gnat">Detailed bug reporting instructions for GNAT</a></h2>
+ 
+ <p>See the <a href="#detailed">previous section</a> for bug reporting
+ instructions for GCC language implementations other than Ada.</p>
+ 
+ <p>Bug reports have to contain at least the following information in
+ order to be useful:</p>
+ 
+ <ul>
+ <li>the exact version of GCC, as shown by "<code>gcc -v</code>";
+ <li>the system type;
+ <li>the options when GCC was configured/built;
+ <li>the exact command line passed to the <code>gcc</code> program
+ triggering the bug
+ (not just the flags passed to <code>gnatmake</code>, but
+ <code>gnatmake</code> prints the parameters it passed to <code>gcc</code>)
+ <li>a collection of source files for reproducing the bug,
+ preferably a minimal set (see below);
+ <li>a description of the expected behavior;
+ <li>a description of actual behavior.
+ </ul>
  
+ <p>If your code depends on additional source files (usually package
+ specifications), submit the source code for these compilation units in
+ a single file that is acceptable input to <code>gnatchop</code>,
+ i.e. contains no non-Ada text.  If the compilation terminated
+ normally, you can usually obtain a list of dependencies using the
+ "<code>gnatls -d <i>main_unit</i></code>" command, where
+ <code><i>main_unit</i></code> is the file name of the main compilation
+ unit (which is also passed to <code>gcc</code>).</p>
+ 
+ <p>If you report a bug which causes the compiler to print a bug box,
+ include that bug box in your report, and do not forget to send all the
+ source files listed after the bug box along with your report.</p>
+ 
+ <p>If you use <code>gnatprep</code>, be sure to send in preprocessed
+ sources (unless you have to report a bug in <code>gnatprep</code>).</p>
+ 
+ <p>When you have checked that your report meets these criteria, please
+ 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>
  
  <h1><a name="manage">Managing Bugs (GNATS and the test-suite)</a></h1>