BugReport

Version 4 (Richy, 31/05/2014 11:08)

1 1 admin
h1. Reporting Bugs
2 1 admin
3 4 Richy
If you've found a bug in libavg, please report it on the bug tracking system. It can be reached in the toolbar above ('Issues' and 'New Issue'). It will lead you to "github":https://www.github.com", and you'll need to sign up there.
4 1 admin
5 3 coder
Please report a bug if you hit a segmentation fault or an assertion, if make check fails on your machine, or if libavg is doing something else that it shouldn't be. If you think you might have found a bug but aren't sure, please ask in the forums. Also, please check the installation guides if you can't get libavg running at all - most causes of installation failures are described in the wiki.
6 1 admin
7 1 admin
h1. What to Include
8 1 admin
9 1 admin
To find out what is happening, we need to reproduce the bug. In the majority of cases, bug reports don't contain enough information for us to do this.
10 1 admin
11 1 admin
We always need to know:
12 1 admin
13 4 Richy
* The libavg version: Installer, tarball, git checkout? If git checkout: which commit and branch?
14 1 admin
* The exact program output.
15 1 admin
* If make check terminates without errors. If there are errors in make check, please sent the output of make check. 
16 1 admin
17 2 coder
If it's a configuration-related bug (many are), we need to know:
18 1 admin
19 1 admin
* What type of system you are running libavg on (OS and exact version, processor, graphics card, driver version).
20 1 admin
* Under Mac OS X, open the System Profiler (About This Mac -> More Info), then choose File -> Save As and RTF file format, or just tell us the version of Mac OS X as well as the model and graphics card of the computer.
21 1 admin
* Under linux, we need to know the distribution (incl. version) and the output of:
22 1 admin
23 1 admin
<pre><code class="shell">
24 1 admin
$ uname -a
25 1 admin
$ glxinfo
26 1 admin
</code></pre>
27 1 admin
28 1 admin
h1. Segmentation Faults
29 1 admin
30 3 coder
If you're running into a segmentation fault, a stack trace helps:
31 1 admin
32 1 admin
<pre><code class="shell">
33 1 admin
 $ gdb python
34 1 admin
 (gdb) r Test.py
35 1 admin
 [...]
36 1 admin
 ./bin/bash: line 4:  4324 Segmentation fault      ${dir}$tst
37 1 admin
 (gdb) bt
38 1 admin
</code></pre>
39 1 admin
40 1 admin
Replace 'Test.py' with whatever libavg program is causing the segfault. If the segfault doesn't happen directly after the 'r Test.py' line, insert a 'c' command (for 'continue'). The 'b' command should then generate your stack trace.