Update bug reporting guidelines

This commit is contained in:
Nick Clifton
2002-06-20 14:44:10 +00:00
parent 2755afbaec
commit b553b18375
2 changed files with 25 additions and 14 deletions

View File

@ -1,3 +1,10 @@
2002-06-20 Nick Clifton <nickc@cambridge.redhat.com>
* ld.texinfo (Bug Reporting): Update text to suggest a limit on
the size of attached object files, to allow make the object files
available via FTP or HTTP and to mention that the mail will be
sent to a mailing list.
2002-06-20 Nathanael Nerode <neroden@twcny.rr.com> 2002-06-20 Nathanael Nerode <neroden@twcny.rr.com>
* ld/configure.host (romp): Drop support. * ld/configure.host (romp): Drop support.

View File

@ -4682,17 +4682,18 @@ fact or leave it out, state it!
Often people omit facts because they think they know what causes the Often people omit facts because they think they know what causes the
problem and assume that some details do not matter. Thus, you might problem and assume that some details do not matter. Thus, you might
assume that the name of a symbol you use in an example does not matter. assume that the name of a symbol you use in an example does not
Well, probably it does not, but one cannot be sure. Perhaps the bug is matter. Well, probably it does not, but one cannot be sure. Perhaps
a stray memory reference which happens to fetch from the location where the bug is a stray memory reference which happens to fetch from the
that name is stored in memory; perhaps, if the name were different, the location where that name is stored in memory; perhaps, if the name
contents of that location would fool the linker into doing the right were different, the contents of that location would fool the linker
thing despite the bug. Play it safe and give a specific, complete into doing the right thing despite the bug. Play it safe and give a
example. That is the easiest thing for you to do, and the most helpful. specific, complete example. That is the easiest thing for you to do,
and the most helpful.
Keep in mind that the purpose of a bug report is to enable us to fix the bug if Keep in mind that the purpose of a bug report is to enable us to fix
it is new to us. Therefore, always write your bug reports on the assumption the bug if it is new to us. Therefore, always write your bug reports
that the bug has not been reported previously. on the assumption that the bug has not been reported previously.
Sometimes people give a few sketchy facts and ask, ``Does this ring a Sometimes people give a few sketchy facts and ask, ``Does this ring a
bell?'' Those bug reports are useless, and we urge everyone to bell?'' Those bug reports are useless, and we urge everyone to
@ -4732,10 +4733,13 @@ and then we might not encounter the bug.
@item @item
A complete input file, or set of input files, that will reproduce the A complete input file, or set of input files, that will reproduce the
bug. It is generally most helpful to send the actual object files, bug. It is generally most helpful to send the actual object files
uuencoded if necessary to get them through the mail system. Making them provided that they are reasonably small. Say no more than 10K. For
available for anonymous FTP is not as good, but may be the only bigger files you can either make them available by FTP or HTTP or else
reasonable choice for large object files. state that you are willing to send the object file(s) to whomever
requests them. (Note - your email will be going to a mailing list, so
we do not want to clog it up with large attachments). But small
attachments are best.
If the source files were assembled using @code{gas} or compiled using If the source files were assembled using @code{gas} or compiled using
@code{gcc}, then it may be OK to send the source files rather than the @code{gcc}, then it may be OK to send the source files rather than the