Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
contribute:bugs:start [2014/03/14 10:43] – [Bug Reporting] nickcontribute:bugs:start [2024/12/19 08:46] (current) – [Backtraces] simondedman
Line 1: Line 1:
-====== Bug Reporting ======+~~NOTOC~~ 
 +{{ :xfce-64x64.png?nolink|}} 
 +====== Bug Reporting and Fixing======
  
-One of the most useful tasks that we rely on the community for is testing and reporting of bugs. Since Xfce runs on various platform and in a lot of different setups, testing all changes in every possible situation is an impossible task. As such we kindly ask users to assist in testing, and reporting all bugs they may find, using our [[https://bugzilla.xfce.org|bug tracker]].+One of the most useful tasks that we rely on the community for is the testing and reporting of bugs. Since Xfce runs on various platforms and in a variety of different setups, testing all changes, in every possible situation, is an impossible task. As such, we kindly ask our users to assist us in testing, and reporting all bugs that they may find, using our [[https://gitlab.xfce.org|issue tracker]].
  
-Once a bug has been found, the cause of the bug needs to be tracked down, and then (obviously) fixed. If you want to get involved in the actual development process of Xfce a great way to start is by solving bugs and then submitting a patch file.+----
  
-=== Detailed Sections ===+===== Crashes =====
  
-[[backtrace|Backtraces]]\\ +We always try to make the Xfce Desktop Environment as stable as possible; but, there is always a possibility that a crash, exception, or a segmentation fault(segfault) may occur. The problem with crashes is that they are not always reproducible by the developers. This often makes it quite hard to track-down the problem and patch the issue. We rely on users, like yourself, to help us in identifying issues, submitting bug reports, and alerting us to issues.
-Gather information about crashes/segfaults in applications.+
  
-[[:xfce:building]]\\ +There are a couple of things you can do to help us resolve these issues and help making the experience of using Xfce better for everyone. We appreciate your help.
-How to compile Xfce from source to provide better debug information. +
-===== Feature Requests =====+
  
-Although the philosophy of Xfce is to find the correct balance between features and lightweight, it is still possible there are features you'd like to see in future releases.+----
  
-This right approach for larger changes is to discuss them on the mailing list first. You might think your idea is brilliant, but there is a high possibility other users.+==== Search First ==== 
 +Search the open issues of the project to see if the issue is already known. Also, look through resolved issues because the issue might be fixed already, but has not been released or applied downstream.
  
-Afterwards a bug can be opened in the bug tracker and make sure the //Importance// is set to //normal// and //enhancement//.+----
  
-Obviously its also nice if you can write a patch that implements the feature, but its not a necessity.+==== Report ====
  
-===== Crashes ===== 
  
-We always try to make the software as stable as possible, but there is always a possibility a crash or segfault can occur. To problem with crashes is that they are not always reproducible by the developers, this makes it quite often hard to track-down the problem and patch the issue.+When writing your bug report, try to be as descriptive as possible, but avoid verbosity; Mozilla has a nice guide on [[https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines|how to write a bug report]].
  
-Nonetheless there are a couple of things you can do to help resolving them:+If you have not found anything or missed it, report it in the bug tracker. Reports that only say 'application X crashed' will be closed as invalid quickly, so try to provide a way to describe and reproduce the problem: //Application X crashed when doing Y//.
  
-==== Search First ==== +In the description provide a short way to reproduce the crash. Also run the application in a terminal and look if there are console warnings, put those in the bug as well.
-Search the [[https://bugzilla.xfce.org|bug tracker]] and look if the issue is already known. Also look through the resolved bugs because the issue might be fixed already, but has not been released or applied downstream. Peeking the [[http://git.xfce.org/xfce|GIT repository]] might help for the latter.+
  
-==== Report ====+If the developer cannot reproduce it, he might ask for a //backtrace//, read more about creating backtraces in the next section.
  
-If you have not found anything or missed it, report it in the bug tracker. Reports that only say 'application X crashed' will be closed as invalid quickly, so try to provide a way to describe and reproduce the problem: //Application X crashed when doing Y//.+[[|Back To Top]] 
 +---- 
 + 
 +==== Backtraces ==== 
 + 
 +If you do get an Xfce application to crash, it's best to detail exactly what you were doing that led to the crash. In addition, we need the //backtrace// of the crash. However most distributions by default make backtrace output useless because their binaries are optimized and do not contain human-readable information to make a relation between the compiled code and the source code (like file, function, and variable-names). 
 + 
 +The sites below provide guidance from the respective distributions how to remedy this situation so you can provide all the info we need to fix your issue. 
 + 
 +In case of panel plugins there is some additional information on [[:xfce:xfce4-panel:debugging|how to start a panel plugin inside a debugger]]. 
 + 
 +  * [[https://wiki.archlinux.org/index.php/Debug_-_Getting_Traces]] 
 +  * [[https://wiki.debian.org/HowToGetABacktrace]] 
 +  * [[https://wiki.ubuntu.com/DebuggingProgramCrash]] 
 +  * [[http://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces]] 
 +  * [[http://fedoraproject.org/wiki/StackTraces]] 
 +  * [[https://wiki.mageia.org/en/Debugging_software_crashes]] 
 +  * [[http://wiki.mandriva.com/en/Development/Howto/Software_Crash]] 
 +  * [[http://en.opensuse.org/openSUSE:Bugreport_application_crashed]] 
 +  * [[https://wiki.sabayon.org/?title=Debugging_Symbols_-_splitdebug]] 
 + 
 +[[|Back To Top]] 
 +---- 
 + 
 +===== Fixing Bugs ===== 
 + 
 +Once a bug has been found, the cause of the bug needs to be tracked down, and then (obviously) fixed. If you want to get involved in the actual development process of Xfce a great way to start is by solving bugs and attaching a patch file to the reported bug. ( "git format-patch" is the preferred way to create a patch file )  
 + 
 +Not familiar with git? [[contribute/dev/git/start|This manual]] will help you to get started.  
 + 
 +To get started, best read our [[contribute/dev/coding/example|beginners example on how to fix a simple xfce bug]].
  
-In the description provide a short way to reproduce the crash. Also run the application in a terminal and look if there are console warnings, put those in the bug as well. 
  
-If the developer cannot reproduce it, he might ask for a //backtrace//, read more about creating backtraces [[.:bugs:backtrace|here]].+[[|Back To Top]] 
 +---- 
 +[[ :start:|Return to Main Xfce documentation page]]