Re: CodeSourcery's online test compilation

[Alexandre Oliva <aoliva at redhat dot com>]

On Oct 12, 2000, Gerald Pfeifer <pfeifer@dbai.tuwien.ac.at> wrote:

> Please also have a look at HP's remarks, but apart from that and the
> following minor nits, the changes are fine -- and most welcome!

Thanks.  I'm checking in the patch below.

> +   <li>An attachment containing all (or some :-) of the above</li>

> Isn't this essentially redundant?

Nope.  It's emphasizing the fact that we'd rather have everything as
plain text in the body of a message, instead of in a zip or tar file.
I've rephrased so as to make the intention clearer.

Index: bugs.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/bugs.html,v
retrieving revision 1.19
diff -u -p -c -r1.19 bugs.html
*** bugs.html	2000/10/08 16:55:21	1.19
--- bugs.html	2000/10/13 18:06:28
*************** The manual can also be read using `<i>M-
*** 19,65 ****
  the GNU <tt>info</tt> program is installed on your system by `<tt>info --node
  "(gcc)Bugs"</tt>'.
  
! <p>Before you report a bug for the <em>C++ compiler</em>, please check
! the <a href="#known">list of well-known bugs</a>. If you want to
! report a bug with <em>egcs 1.0.x</em> or <em>egcs 1.1.x</em>, we
! strongly recommend upgrading to the current release first.</p>
! 
! <p>In short, if GCC says <tt>Internal compiler error</tt> (or any
! other error that you'd like us to be able to reproduce, for that
! matter), please mail a bug report to <a
! href="mailto:gcc-bugs@gcc.gnu.org">gcc-bugs@gcc.gnu.org</a> or
! <a href="mailto:bug-gcc@gnu.org">bug-gcc@gnu.org</a> including:</p>
  
  <ul>
!   <li>The GCC version</li>
!   <li>The system type</li>
!   <li>All options you passed to the compiler</li>
!   <li>Preprocessed output of the source file that caused the compiler
!       error, even if the source code can be downloaded from elsewhere</li>
  </ul>
  
! <p>Instead of sending a bug report by mail, you can also enter it
! directly into <a href="gnats.html">GNATS</a>.</p>
  
! <p>All this can normally be accomplished by mailing the command line, the
! output of the command, and the resulting `<tt><i>your-file</i>.i</tt>' for C,
! or `<tt><i>your-file</i>.ii</tt>' for C++, corresponding to:</p>
  
! <p><tt>gcc -v --save-temps <i>all-your-options</i> <i>your-file</i>.c</tt></p>
  
! <p>Typically the CPP output (extension <code>.i</code> for C or
  <code>.ii</code> for C++) will be large, so please compress the
  resulting file with one of the popular compression programs such as
  <tt>bzip2</tt>, <tt>gzip</tt>, <tt>zip</tt> or <tt>compress</tt> (in
  decreasing order of preference).  Use maximum compression
! (<code>-9</code>) if available.  Please include the compressed CPP
! output in your bug report, even if the source code is freely available
! elsewhere; it makes the job of our volunteer testers much easier.</p>
  
  <p>Since we're supposed to be able to re-create the assembly output
! (extension <code>.s</code>), you usually don't have to include it in
! the bug report, although you may want to post parts of it to point out
! assembly code you consider to be wrong.</p>
  
  <p>Whether to use MIME attachments or <code>uuencode</code> is up to
  you.  In any case, make sure the compiler command line, version and
--- 19,141 ----
  the GNU <tt>info</tt> program is installed on your system by `<tt>info --node
  "(gcc)Bugs"</tt>'.
  
! <p>Before you report a bug, please check the <a href="#known">list of
! well-known bugs</a> and, if possible, try a newer development snapshot
! or <a href="http://www.codesourcery.com/gcc-compile.shtml">
! CodeSourcery's Online Test Compilation</a>.  If you want to report a
! bug with <em>egcs 1.0.x</em> or <em>egcs 1.1.x</em>, we strongly
! recommend upgrading to the current release first.</p>
! 
! <h2>Summarized bug reporting instructions</h2>
! 
! <p>After this summary, you'll find detailed bug reporting
! instructions, that explain how to obtain some of the information
! requested in this summary.</p>
! 
! <h3>What we need</h3>
! 
! Please include in your bug report <b>all</b> of the following items:
! 
! <ul>
!   <li>The GCC version (not just 2.xx; run <tt>gcc -v</tt>)</li>
!   <li>The system type (the dir name after <tt>gcc-lib</tt> in the
!   output of <tt>gcc -v</tt></li>
!   <li>The complete command line that triggers the bug</li>
!   <li>The compiler output (error messages, warnings, etc)</li>
!   <li>The <b>preprocessed</b> file (<t>*.i*</t>) that triggers the
!   bug, generated by adding <tt>-save-temps</tt> to the complete
!   compilation command (see below)</li>
!   <li>The options given when GCC was configured/built</li>
! </ul>
  
+ <h3>What we DON'T want</h3>
+ 
  <ul>
!   <li>A source file that <tt>#include</tt>s header files that are left
!   out of the bug report (see above)</li>
! 
!   <li>That source file <b>and</b> a collection of header files (don't
!   waste your time; the preprocessor will collect them for you! :-)
! 
!   <li>An attached archive (tar, zip, shar, whatever) containing all
!   (or some :-) of the above, so that we can tell what the bug report
!   is about without having to unarchive it</li>
! 
!   <li>A code snippet that won't cause the compiler to produce the
!   exact output mentioned in the bug report (e.g., a snippet with just
!   a few lines around the one that <b>apparently</b> triggers the bug,
!   with some pieces replaced with ellipses or comments for extra
!   obfuscation :-)</li>
! 
!   <li>The location (URL) of the package that failed to build (we won't
!   download it, anyway, since you've already given us what we need to
!   duplicate the bug, haven't you? :-)</li>
! 
!   <li>An error that occurs only some of the times a certain file is
!   compiled, such that retrying a sufficient number of times results in
!   a successful compilation; this is a symptom of a hardware problem,
!   not of a compiler bug (sorry)</li>
! 
!   <li>E-mail messages that complement previous, incomplete bug
!   reports; post a new, self-contained, full bug report instead, if
!   possible as a follow-up (or reply) to the original bug report</li>
! 
!   <li>Assembly files (<t>*.s</t>) 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
!   as fixed last week :-)</li>
! 
!   <li>Bugs in the assembler, the linker or the C library.  These are
!   separate projects, with separate mailing lists and different bug
!   reporting procedures</li>
! 
!   <li>Bugs in releases or snapshots of GCC not issued by the Free
!   Software Foundation.  Report them to whoever provided you with the
!   release</li>
! 
!   <li>Questions about the correctness or the expected behavior of
!   certain constructs that are not GCC extensions.  Ask them in forums
!   dedicated to the discussion of the programming language</li>
  </ul>
+ 
+ <h3>Where to post it</h3>
+ 
+ <p>Please mail your bug report to <a
+ href="mailto:gcc-bugs@gcc.gnu.org">gcc-bugs@gcc.gnu.org</a> or
+ <a href="mailto:bug-gcc@gnu.org">bug-gcc@gnu.org</a>, or enter it
+ directly into our <a href="gnats.html">GNATS</a> bug database.
  
! <h2>Detailed bug reporting instructions</h2>
  
! <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>
  
! <p><tt>gcc -v -save-temps <i>all-your-options source-file</i></tt></p>
  
! <p>Typically the preprocessed file (extension <code>.i</code> for C or
  <code>.ii</code> for C++) will be large, so please compress the
  resulting file with one of the popular compression programs such as
  <tt>bzip2</tt>, <tt>gzip</tt>, <tt>zip</tt> or <tt>compress</tt> (in
  decreasing order of preference).  Use maximum compression
! (<code>-9</code>) if available.  <b>Please</b> include the compressed
! preprocessor output in your bug report, even if the source code is
! freely available elsewhere; it makes the job of our volunteer testers
! 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 <b>any</b>
! 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 <b>not</b> include
! it in the bug report, although you may want to post parts of it to
! point out assembly code you consider to be wrong.</p>
  
  <p>Whether to use MIME attachments or <code>uuencode</code> is up to
  you.  In any case, make sure the compiler command line, version and
*************** make sure the compiler version, error me
*** 76,92 ****
  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 (100 kbytes) and bug reports
! over those limits will currently be bounced.  We're trying to find a
! way to allow larger bug reports to be posted, but this is currently
! impossible (unless you use MIME partials, which most people are unable
! to handle anyway, so you'd better avoid them for now).  So, although
! we prefer to have complete bug reports archived, if you cannot reduce
! the bug report below the limit, please make it available for ftp or
! http and post the URL.  Another alternative is to break the
! preprocessed output in multiple files (using <code>split</code>, for
! example) and post them in separate messages, but we prefer to have
! self-contained bug reports in single messages.</p>
  
  <p>If you fail to supply enough information for a bug report to be
  reproduced, someone will probably ask you to post additional
--- 152,160 ----
  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 directly in GNATS.</p>
  
  <p>If you fail to supply enough information for a bug report to be
  reproduced, someone will probably ask you to post additional


-- 
Alexandre Oliva   Enjoy Guarana', see http://www.ic.unicamp.br/~oliva/
Red Hat GCC Developer                  aoliva@{cygnus.com, redhat.com}
CS PhD student at IC-Unicamp        oliva@{lsd.ic.unicamp.br, gnu.org}
Free Software Evangelist    *Please* write to mailing lists, not to me