Differences

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

Link to this comparison view

Next revision		Previous revision
users:writing_useful_bug_reports [2015/09/07 16:45] – created cmotcusers:writing_useful_bug_reports [2015/11/17 10:57] (current) – subliun
Line 1: Line 1:
 ===== Writing Useful Bug Reports ===== ===== Writing Useful Bug Reports =====
-Adapted from this page at the qTox wiki[[https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports| article]], in turn adapted from the Textmate wiki [[https://github.com/textmate/textmate/wiki/Writing-Bug-Reports| article]].+Adapted from this page at the qTox wiki[[https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports| article]], in turn adapted from the Textmate wiki [[https://github.com/textmate/textmate/wiki/Writing-Bug-Reports| article]]. Primarily adapted for generalization to other clients.
  
 ==== What To Include ==== ==== What To Include ====
Line 26: Line 26:
  
 To acquire a backtrace, you will need to use the debugger appropriate for your platform. For Unix-Like systems that will probably be [[https://www.gnu.org/software/gdb/|gdb]]. You will also need to use the latest debug build of your Tox client. Debug binaries are available for most clients and the core library, but you don't have to use them if you know how to compile Tox with debugging symbols included. To acquire a backtrace, you will need to use the debugger appropriate for your platform. For Unix-Like systems that will probably be [[https://www.gnu.org/software/gdb/|gdb]]. You will also need to use the latest debug build of your Tox client. Debug binaries are available for most clients and the core library, but you don't have to use them if you know how to compile Tox with debugging symbols included.
 +
 +=== Acquiring Debug Builds of Toxcore and your Tox Client ===
 +
 +**From your distribution's package manager:**
 +
 +**Compiling from source:**
  
 === Acquiring a Backtrace === === Acquiring a Backtrace ===
  
 +1: Execute the binary in a debugger
 +
 +<code>
 +#load the debug binary
 +gdb /path/to/debug-bin
 +</code>
 +
 +2: Reproduce the circumstances causing the issue(i.e. deliberately cause it to crash), making sure the steps correspond to what you will report per the [[#bug_report_template| template]].
 +
 +<code>
 +#start the program in the debugger
 +(gdb) run
 +#now reproduce the crash
 +</code>
 +
 +3: Prompt your debugger to trace the error
 +<code>
 +(gdb) backtrace
 +</code>
 +
 +3b: If you need to collect information from all the running threads
 +<code>
 +(gdb) thread apply all backtrace full
 +</code>
 +
 +4: Paste the backtrace somewhere (e.g. [[https://gist.github.com/discover| Gist]] or [[https://pastebin.com/| Pastebin]]), and provide a link to it in your bug report.
 ==== Bug Report Template ==== ==== Bug Report Template ====
  
Line 74: Line 106:
 Some tips for troubleshooting Tox Clients include: Some tips for troubleshooting Tox Clients include:
  
-  - Use Echobot for testing audio. If you start a voice/video call with Echobot, it will echo back all audio you send it with a 1-2 second delay. Echobot's ID can be found at [[https://toxme.se/u/echobot|Toxme]]+  - Use Echobot for testing audio. If you start a voice/video call with Echobot, it will echo back all audio you send it with a 1-2 second delay. Echobot's ID can be found at [[https://toxme.io/u/echobot|Toxme]]
  
 ===== Reading Material ===== ===== Reading Material =====
Line 80: Line 112:
 If you'd like to read other articles describing methods for writing bug reports, the following list contains a few very good picks: If you'd like to read other articles describing methods for writing bug reports, the following list contains a few very good picks:
  
-  * http:%%//%%www.chiark.greenend.org.uk/~sgtatham/bugs.html +  * [[http://www.chiark.greenend.org.uk/~sgtatham/bugs.html]] 
-  * https:%%//%%github.com/textmate/textmate/wiki/Writing-Bug-Reports+  * [[https://github.com/textmate/textmate/wiki/Writing-Bug-Reports]]
  
  

Trace:

Print/export