Previous: Bug Criteria,Up: Reporting Bugs



18.2 How to Report Bugs

A number of companies and individuals offer support for gnuproducts. If you obtained the binary utilities from a supportorganization, we recommend you contact that organization first.

You can find contact information for many support companies andindividuals in the file etc/SERVICE in the gnu Emacsdistribution.

In any event, we also recommend that you send bug reports for the binaryutilities to http://www.sourceware.org/bugzilla/.

The fundamental principle of reporting bugs usefully is this:report all the facts. If you are not sure whether to state afact or leave it out, state it!

Often people omit facts because they think they know what causes theproblem and assume that some details do not matter. Thus, you mightassume that the name of a file you use in an example does not matter. Well, probably it does not, but one cannot be sure. Perhaps the bug isa stray memory reference which happens to fetch from the location wherethat pathname is stored in memory; perhaps, if the pathname weredifferent, the contents of that location would fool the utility intodoing the right thing despite the bug. Play it safe and give aspecific, 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 ifit is new to us. Therefore, always write your bug reports on the assumptionthat the bug has not been reported previously.

Sometimes people give a few sketchy facts and ask, “Does this ring abell?” This cannot help us fix a bug, so it is basically useless. Werespond by asking for enough details to enable us to investigate. You might as well expedite matters by sending them to begin with.

To enable us to fix the bug, you should include all these things:

Here are some things that are not necessary:

Reference Home

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.