Debian Codegraph @

docs/bugs.md

raw
1 ---
2 layout: page
3 ---
4
5 # Reporting Bugs in libsndfile
6
7 Before even attempting to report a bug in libsndfile please make sure you have
8 read the [Frequently Asked Questions](FAQ.md). If you are having a problem
9 writing code using libsndfile make sure you read the
10 [Application Programming Interface](api.md) documentation.
11
12 That said, I am interested in finding and fixing all genuine bugs in libsndfile.
13 Bugs I want to fix include any of the following problems (and probably others):
14
15 - Compilation problems on new platforms.
16 - Errors being detected during the `make check` process.
17 - Segmentation faults occurring inside libsndfile.
18 - libsndfile hanging when opening a file.
19 - Supported sound file types being incorrectly read or written.
20 - Omissions, errors or spelling mistakes in the documentation.
21
22 When submitting a bug report you must include:
23
24 - Your system (CPU and memory size should be enough).
25 - The operating system you are using.
26 - Whether you are using a package provided by your distribution or you compiled
27 it yourself.
28 - If you compiled it yourself, the compiler you are using. (Also make sure to
29 run `make check`.)
30 - A description of the problem.
31 - Information generated by the sndfile-info program (see next paragraph).
32 - If you are having problems with sndfile-play and ALSA on Linux, I will need
33 information about your kernel, ALSA version, compiler version, whether you
34 compiled the kernel/ALSA your self or installed from a package etc.
35
36 If libsndfile compiles and installs correctly but has difficulty reading a
37 particular file or type of file you should run the **sndfile-info** program
38 (from the examples directory of the libsndfile distribution) on the file. See
39 [here](sndfile_info.md) for an example of the use of the **sndfile-info**
40 program.
41
42 Please do not send me a sound file which fails to open under libsndfile unless
43 I specifically ask you to. The above information should usually suffice for most
44 problems.
45
46 Once you have the above information you should submit a ticket on the libsndfile
47 [GitHub issue tracker](https://github.com/libsndfile/libsndfile/issues).