Difference between revisions of "Reporting Bugs"

From Audacity Wiki
Jump to: navigation, search
m (Text replace - "http://forum.audacityteam.org" to "https://forum.audacityteam.org")
(Steps to Reporting a Bug: update link)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Intro|Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.|}}
+
{{Intro|Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.<p>Bug reports should be made on the [https://forum.audacityteam.org/ Audacity Forum], but '''''please''''' read this page thoroughly before making your report.</p>|}}
 
 
{{Advice|'''We are no longer accepting bug reports for the legacy Audacity 1.2.x or the 1.3.x series as these are now obsolete.''' Please use the latest [https://web.audacityteam.org/download/ 2.1.x version] instead.}}
 
 
 
<!--Spacer-->
 
 
 
----
 
 
 
Here are examples of bad or useless bug reports that are likely to just be ignored:
 
 
 
{| style="margin-left:50px"
 
|-
 
|*<span style="color:red;font-weight:bold">&nbsp; "Audacity crashed! Please fix it."</span>
 
|-
 
|*<span style="color:red;font-weight:bold">&nbsp; "It isn't working properly. I have done everything I can."</span>
 
|-
 
|*<span style="color:red;font-weight:bold">&nbsp; "I can't hear anything"</span>
 
|}
 
 
 
If you want your bug report to be useful to us, read on.
 
----
 
  
 +
==Steps to Reporting a Bug==
 
{| style="line-height:12px"
 
{| style="line-height:12px"
 
|-
 
|-
Line 28: Line 9:
 
|-valign="top"
 
|-valign="top"
 
|1.&nbsp;
 
|1.&nbsp;
|<span style="color:#BA55D3;font-weight:bold"> First, make sure your problem isn't merely an Audacity feature you haven't found yet! </span> You can find immediate answers to many common questions on the [http://manual.audacityteam.org/o/man/faq.html Frequently Asked Questions] in the [http://manual.audacityteam.org/o/ Manual] and on this Wiki. You can use the search box top right of the [https://web.audacityteam.org/ main Audacity website] to search that website or the Wiki and Forum, or you can search this Wiki from the search box at the left hand side of any page.
+
|<span style="font-weight:bold"> First, make sure your problem isn't merely an Audacity feature you haven't found yet! </span> You can find immediate answers to many common questions on the [https://manual.audacityteam.org/o/man/faq.html Frequently Asked Questions] in the [https://manual.audacityteam.org/o/ Manual] and on this Wiki. You can use the search box top right of the [https://web.audacityteam.org/ main Audacity website] to search that website or the Wiki and Forum, or you can search this Wiki from the search box at the left hand side of any page.
 
|}
 
|}
 
{| style="line-height:12px"
 
{| style="line-height:12px"
Line 37: Line 18:
 
|-valign="top"
 
|-valign="top"
 
|2.&nbsp;
 
|2.&nbsp;
|<span style="color:#BA55D3;font-weight:bold">Next, please check your problem isn't already known about.</span> Check the [[Release Notes]] for the current version of Audacity, plus the [[Known Issues]] page for known issues reported since the last release. Some problems are entirely specific to particular operating systems, so please check our pages for known [[Windows Bugs|Windows]], [[Mac OS X|Mac]] and [[Linux Issues|Linux/Unix]] problems. It's also possible issues may come up that haven't yet made it to the Frequently Asked Questions or the Wiki. So please search our [https://forum.audacityteam.org/search.php Forum].  If you don't see your isssue, please consider [https://forum.audacityteam.org/ucp.php?mode=register registering on the Forum] and asking our active user community for help directly. A lot of difficulties that arise turn out not to be bugs at all, and getting help will solve the problem.<br>   
+
|<span style="font-weight:bold">Next, please check your problem isn't already known about.</span> Check the [[Release Notes]] for the current version of Audacity, plus the [[Known Issues]] page for known issues reported since the last release. Some problems are entirely specific to particular operating systems, so please check our pages for known [[Windows Bugs|Windows]], [[Mac OS X|Mac]] and [[Linux Issues|Linux/Unix]] problems. It's also possible issues may come up that haven't yet made it to the Frequently Asked Questions or the Wiki. So please search our [https://forum.audacityteam.org/search.php Forum].  If you don't see your isssue, please consider [https://forum.audacityteam.org/ucp.php?mode=register registering on the Forum] and asking our active user community for help directly. A lot of difficulties that arise turn out not to be bugs at all, and getting help will solve the problem.<br>   
{{Hint|1=Advanced users can also search [http://bugzilla.audacityteam.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=DEVEL%20-%20FIX%20MADE&product=Audacity&query_format=advanced&order=changeddate%20DESC,bug_id Audacity Bugzilla] for the complete current bug list. For information on using Bugzilla, see [[Bug Lists]].}}  
+
{{Hint|1=Advanced users can also search [https://bugzilla.audacityteam.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=DEVEL%20-%20FIX%20MADE&product=Audacity&query_format=advanced&order=changeddate%20DESC,bug_id Audacity Bugzilla] for the complete current bug list. For information on using Bugzilla, see [[Bug Lists]].}}  
 
|}
 
|}
 
{| style="line-height:12px"
 
{| style="line-height:12px"
Line 47: Line 28:
 
|-valign="top"
 
|-valign="top"
 
|3.&nbsp;
 
|3.&nbsp;
|<span style="color:#BA55D3;font-weight:bold">If you've gone through the above steps without success, you may have found a bug we don't know about, so please tell us about it!</span> Very often problems are only found and fixed when they are reported to us by users trying to do a particular task in Audacity. Please give us reports of possible bugs by sending an email to our {{external|1=[mailto:[email protected]audacityteam.org?subject=Audacity_Bug_Report feedback address]}}. Please note that we won't necessarily reply, unless we need more information from you, but all reports will be investigated. <span style="color:#BA55D3;font-weight:bold"> Please include all the following six pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:</span>
+
|<span style=";font-weight:bold">If you've gone through the above steps without success, you may have found a bug we don't know about, so please tell us about it!</span> Very often problems are only found and fixed when they are reported to us by users trying to do a particular task in Audacity. Please post reports of possible bugs to our [https://forum.audacityteam.org/viewforum.php?f=50 forum]. <span style="font-weight:bold"> Please include all the following six pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:</span>
 
|}
 
|}
 
{| style="line-height:2px"
 
{| style="line-height:2px"
Line 55: Line 36:
 
{| style="margin-left:75px"
 
{| style="margin-left:75px"
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> The exact three-digit version of Audacity you are running</span> for example 2.1.3. You can always find this by clicking {{menu|Help > About Audacity}} in the program (or {{menu|Audacity > About Audacity}} if you are on a Mac computer).  
+
|*<span style="font-weight:bold"> The exact three-digit version of Audacity you are running</span> for example 2.1.3. You can always find this by clicking {{menu|Help > About Audacity}} in the program (or {{menu|Audacity > About Audacity}} if you are on a Mac computer).  
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> If not downloaded from  </span> [https://web.audacityteam.org our website]<span style="color:#BA55D3;font-weight:bold">, where you obtained Audacity from </span>- for example was it purchased from some other website, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?  
+
|*<span style="font-weight:bold"> If not downloaded from  </span> [https://web.audacityteam.org our website]<span style="color:#BA55D3;font-weight:bold">, where you obtained Audacity from </span>- for example was it purchased from some other website, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?  
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> What operating system you are running </span> including the exact version (for example Windows 10, Windows 7, Mac OS X 10.11.3, Linux Ubuntu 14.04 (Trusty).  
+
|*<span style="font-weight:bold"> What operating system you are running </span> including the exact version (for example Windows 10, Windows 8.1, macOS 10.15.7, Linux Ubuntu 20.04).  
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> What exactly you are trying to do</span> (for example, import a WAV audio file, use an effect, or record from a microphone attached to a mixer).
+
|*<span style="font-weight:bold"> What exactly you are trying to do</span> (for example, import a WAV audio file, use an effect, or record from a microphone attached to a mixer).
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> What is preventing you doing that, including the exact text of any error messages given. </span>
+
|*<span style="font-weight:bold"> What is preventing you doing that, including the exact text of any error messages given. </span>
 
|-
 
|-
|*<span style="color:#BA55D3;font-weight:bold"> If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer</span> (for example, open an AUP (Audacity Project) file, then use the "Amplify" effect).  On Mac, a [http://guides.macrumors.com/Submitting_a_crash_report crash report] will help us, as will a backtrace on Linux/Unix.   
+
|*<span style="font-weight:bold"> If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer</span> (for example, open an AUP (Audacity Project) file, then use the "Amplify" effect).  On Mac, a [http://guides.macrumors.com/Submitting_a_crash_report crash report] will help us, as will a backtrace on Linux/Unix.   
 
|}
 
|}
  
 +
The above information will give us a good bug report to go on.
  
The above information will give us a <span style="color:green; font-weight:bold">good </span> bug report to go on.
+
==What Not to Do==
 
+
Here are examples of bad or useless bug reports. We have received bug reports which are every bit as bad as these ones, sometimes with demands for a refund (Audacity software is free).
 
+
* "Audacity crashed! Please fix it."
----
+
* "It isn't working properly. I have done everything I can."
 
+
* "I can't hear anything"
==If you can give us more information...==
+
* "I need it fixed immediately. Can you call me?"
 
 
With 1.3.12 and later we have a couple of important bugs which only show very occasionally and which we are particularly keen to track down.  If you see these, and are pretty familiar with Audacity, some additional information could really help us.  Let us know if you think there is  
 
something else that might be relevant to making the bug appear.
 
{{hint|Please don't forget the standard information... we still need to know what operating system and what version of Audacity you were using (Help > About Audacity or Audacity > About Audacity on Mac).}}
 
<hr>
 
(Bug 35) '''Crash on importing audio:''' We've heard of this happening when importing WAV and AIFF files.
 
* What is the size of the file being imported in MB or GB?
 
* What is your project rate bottom left of the Audacity window?
 
* Did you copy in the WAV/AIFF or read it directly from source when Audacity asked (or how is this set in the Import / Export Preferences)? 
 
** If you "read directly", were you interacting with the waveform whilst the audio was loading?
 
<hr>
 
(Bug 137) '''Potential issues when reopening saved projects.''' Not everyone will be affected, but we recommend exporting as WAV or AIFF for full safety before closing the project.  
 
<ul><li>'''Projects reopen with any of "Missing Audio Data Block File(s)",  "Problems Reading Sequence Tags" or "Orphan Block File(s)" errors'''.
 
Silenced audio may result. </ul> 
 
{{advice|1=<ul><li>If you see these errors, we recommend choosing the options to "Treat missing audio as silence" or "Continue without deleting" the orphans.</li>
 
<li>'''Note:''' it is known that projects with more than 2^31 samples (just over 13.5 hours at 44100 Hz) will not re-open correctly. We don't need you to report this.</li></ul>}}   
 
<ul><li> '''Projects reopen with silenced audio without warning'''. Various symptoms may be seen either after reopening the project, or may have already occurred when the project was last open. Please look out for these:
 
<ul><li> Errors saving a project or the autosave file, suggesting the disk may be full or not writable when there is no such problem (if this happens, try exporting the audio as WAV)
 
<li> Unwanted renaming or moving of .au files within the project; multiple or duplicated .aup files or project folders appearing within the same project
 
<li> Unexplained crashes or corrupted audio.</ul></ul>
 
'''Please [https://web.audacityteam.org/contact/#feedback let us know] whenever you see the errors or symptoms listed above.''' Are there any steps you took when the project(s) were previously open that could enable us to reproduce the problem? We believe having multiple projects open at once, having projects open in file manager programs or having a long project with many tracks are among the causes. Also do you have an virus checker enabled, if so, what brand/type?
 
  
<hr>
 
  
 
{{CategoryTroubleshooting}}[[Category:Participation]]
 
{{CategoryTroubleshooting}}[[Category:Participation]]

Latest revision as of 14:22, 14 January 2021

Think you've found a bug in Audacity? Having trouble getting it to work? This page describes how to report this to the development team in a way that will help us find and fix the problem as quickly as possible.

Bug reports should be made on the Audacity Forum, but please read this page thoroughly before making your report.

Steps to Reporting a Bug

 
1.  First, make sure your problem isn't merely an Audacity feature you haven't found yet! You can find immediate answers to many common questions on the Frequently Asked Questions in the Manual and on this Wiki. You can use the search box top right of the main Audacity website to search that website or the Wiki and Forum, or you can search this Wiki from the search box at the left hand side of any page.
 
2.  Next, please check your problem isn't already known about. Check the Release Notes for the current version of Audacity, plus the Known Issues page for known issues reported since the last release. Some problems are entirely specific to particular operating systems, so please check our pages for known Windows, Mac and Linux/Unix problems. It's also possible issues may come up that haven't yet made it to the Frequently Asked Questions or the Wiki. So please search our Forum. If you don't see your isssue, please consider registering on the Forum and asking our active user community for help directly. A lot of difficulties that arise turn out not to be bugs at all, and getting help will solve the problem.
Advanced users can also search Audacity Bugzilla for the complete current bug list. For information on using Bugzilla, see Bug Lists.
 
3.  If you've gone through the above steps without success, you may have found a bug we don't know about, so please tell us about it! Very often problems are only found and fixed when they are reported to us by users trying to do a particular task in Audacity. Please post reports of possible bugs to our forum. Please include all the following six pieces of information in your bug report, so our developers can deal with the problem effectively with the minimum of correspondence:
 
* The exact three-digit version of Audacity you are running for example 2.1.3. You can always find this by clicking Help > About Audacity in the program (or Audacity > About Audacity if you are on a Mac computer).
* If not downloaded from our website, where you obtained Audacity from - for example was it purchased from some other website, bundled on a CD with a hardware product, or obtained from the distributor of your Linux/Unix operating system?
* What operating system you are running including the exact version (for example Windows 10, Windows 8.1, macOS 10.15.7, Linux Ubuntu 20.04).
* What exactly you are trying to do (for example, import a WAV audio file, use an effect, or record from a microphone attached to a mixer).
* What is preventing you doing that, including the exact text of any error messages given.
* If Audacity is crashing or freezing, please give us exact steps which always reproduce the crash on your computer (for example, open an AUP (Audacity Project) file, then use the "Amplify" effect). On Mac, a crash report will help us, as will a backtrace on Linux/Unix.

The above information will give us a good bug report to go on.

What Not to Do

Here are examples of bad or useless bug reports. We have received bug reports which are every bit as bad as these ones, sometimes with demands for a refund (Audacity software is free).

  • "Audacity crashed! Please fix it."
  • "It isn't working properly. I have done everything I can."
  • "I can't hear anything"
  • "I need it fixed immediately. Can you call me?"