wiki:HowToReportABug

Version 1 (modified by zooko, at 2010-03-08T07:55:44Z) (diff)

how to report a bug

Please report bugs! If something isn't right, we want to hear about it. Even if you aren't sure whether you are using Tahoe-LAFS correctly, go ahead and report the issue, because if you weren't using it correctly then this is how we learn that our docs or user interface is confusing or inadequate. Reporting a bug is quick and easy and we will be grateful.

Here's how:

Either subscribe to tahoe-dev and send a message to that list describing your problem, or register on this issue tracker and open a ticket describing your problem. Always include the following information (which is quick and easy for you to include):

  • the symptoms of the problem; Resist the urge to guess about what the underlying cause of the problem is -- like they used to say Dragnet: "All we want are the facts."
  • the version of Tahoe-LAFS that you are using; If unsure, run tahoe --version or look at the welcome page on the web user interface. All of the version numbers listed are potentially useful, so just cut and paste them all into your report, or if that is inconvenient for some reason then just tell us the allmydata-tahoe version number.
  • if the problem happens every time or if it is sporadic; Exactly when the problem does and doesn't manifest itself is usually the best clue for us to start with.

If you don't mind taking an extra few minutes of your time to include the log files, then please include them with your bug report. You can find them in the logs subdirectory of the Tahoe-LAFS base directory. The log file named twistd.log might be useful, and any log files which are located in the logs/incidents subdirectory and which have timestamps around the time of the problem might be useful.