Skip to content

Reporting Bugs

ronso0 edited this page Aug 26, 2022 · 4 revisions

Reporting Bugs

If you think you've found a bug in the software, first make sure you're using the latest version from www.mixxx.org, then check the Troubleshooting page and the forums to see if there is a known solution or workaround or if other people are having the same problem.

If you don't find anything there, take a look at our bug tracking system Github Issues. First try a few searches on various keywords related to the problem to see if it's already been reported and what the current status is.

If no existing bugs cover your issue, please gather the following information to report a new issue.

  • Steps to reproduce the problem. Please be as detailed as you can be. For example, rather than saying "Foo doesn't work", say "When I clicked on the Bar button, Foo did not put the Bazes in the right place. I expected the Bazes to be put in Folder 1, but instead Mixxx put them in Folder 2." If you cannot write well in English, please use a translator, e.g. https://translate.google.com/ or https://www.linguee.com/
  • Operating system (Windows, Linux, OSX, etc.) and version
  • CPU architecture (Athlon, Core 2 Duo, Celeron, Pentium II, etc.) and speed (in MHz or GHz)
  • Your video and sound hardware if relevant (Brands, models, options, etc.)
  • Information logs
  • Screenshots of the bug, if applicable

Much of the system information can be gathered from System Information in Windows (found under Control Panel->Administrative Tools->Computer Management->System Information,) and with the commands uname -a and lspci -v on Linux.

Gathering logs

Obtain the following information and add it as an attachment to your bug report:

Ubuntu

On Ubuntu, if Mixxx crashes and Ubuntu asks if you would like to report the problem, please click report. We receive these crash reports, and they are quite useful.

If you are filing a bug, see if you have a crash report, stored in /var/crash, and if you find one for Mixxx, please attach it to your bug report. If you don't find an error report, please use the ubuntu-bug tool to create an error report. From a terminal, or by pressing Alt + F2 to invoke the run dialog, enter:

ubuntu-bug mixxx --save mixxx.crash

This will create a mixxx.crash file in your home directory which you can attach to the bug report you file in Mixxx Github Issues. However, since this isn't a crash from an actual run of Mixxx, it will not contain details on your specific bug -- just background information about your system that will be useful to us. If you are reporting a crash bug, it would be useful if you could include a crash report from /var/crash from a time when Mixxx actually crashed. Additionally, see below about generating backtraces. Crash reports sometimes include backtraces, but if you collect one yourself it may be more informative.

Linux & Mac OSX

  • Most recent console output at the time of the error (About 50 lines or so.)
  • Back-traces from gdb are also extremely helpful. To capture one you need to install the gdb package (GNU Debugger), then from a console window run: gdb --eval-command=run mixxxReproduce the crash mixxx and then type thread apply all bt at the (gdb) prompt and copy the lines from your terminal and paste them into the bug report.

Windows

Mixxx.log

Find and attach this file to the bug. (Don't just paste it into the text area because it's long!) See the Finding the mixxx.log file.

Debugging Logs

If Mixxx crashes on you and you know how to reproduce the crash, please do the following:

Ensure Windows Error Reporting is enabled
  1. Go to Start
  2. Select Control Panel
  3. Select Action Center
  4. Select Change Action Center settings
  5. Select Problem reporting settings
  6. Select Change report settings for all users
  7. Select Automatically check for solutions (Recommended)
  8. Select the Ok button to apply the settings

Now collect information from the following three sources:

Debug diagnostic tool
  1. Download & install the Microsoft debug diagnostic tool
  2. Start Mixxx from inside the tool (or attach it to a running Mixxx process)
  3. Make Mixxx crash
  4. Save the output from the debugging tool to a text file and attach it to your bug report
Event logs
  1. Go to Control Panel -> Administrative Tools -> Event Viewer
  2. Click Application Log and System Log. Make note of what the most recent event is in both.
  3. Start Mixxx, make it give the error
  4. Refresh the display of both logs (F5 key) and look at any new events logged (double click them.)
  5. Click the Copy button (looks like two pieces of paper)
  6. Paste the text into your bug report (do this for each new event logged since you started the program.)
Windows Error Reporting

WER will automatically appear if an application crashes.

  1. Click Send
  2. Click View Details
  3. Save the files to a folder of your choice
  4. Attach the files WERxxxx.tmp.appcompat.txt and WERxxxx.tmp.version.txt to your bug report. (xxxx is some number.) Do not include the .dmp file! (You can just delete that since it's very large.)
Clone this wiki locally