bugs.html 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <HTML>
  3. <HEAD>
  4. <TITLE>
  5. Bug Reporting
  6. </TITLE>
  7. <META NAME="Author" CONTENT="Erik de Castro Lopo (erikd AT mega-nerd DOT com)">
  8. <LINK REL="stylesheet" HREF="libsndfile.css" TYPE="text/css" MEDIA="all">
  9. <LINK REL="stylesheet" HREF="print.css" TYPE="text/css" MEDIA="print">
  10. </HEAD>
  11. <BODY>
  12. <CENTER>
  13. <H1><B>Reporting Bugs in libsndfile</B></H1>
  14. </CENTER>
  15. <P>
  16. Before even attempting to report a bug in libsndfile please make sure you have
  17. read the
  18. <A HREF="FAQ.html">Frequently Asked Questions</A>.
  19. If you are having a problem writing code using libsndfile make sure you read
  20. the
  21. <A HREF="api.html">Application Programming Interface</A>
  22. documentation.
  23. </P>
  24. <P>
  25. That said, I am interested in finding and fixing all genuine bugs in libsndfile.
  26. Bugs I want to fix include any of the following problems (and probably others) :
  27. </P>
  28. <UL>
  29. <LI> Compilation problems on new platforms.
  30. <LI> Errors being detected during the `make check' process.
  31. <LI> Segmentation faults occuring inside libsndfile.
  32. <LI> libsndfile hanging when opening a file.
  33. <LI> Supported sound file types being incorrectly read or written.
  34. <LI> Omissions, errors or spelling mistakes in the documentation.
  35. </UL>
  36. <P>
  37. When submitting a bug report you must include :
  38. </P>
  39. <UL>
  40. <LI> Your system (CPU and memory size should be enough).
  41. <LI> The operating system you are using.
  42. <LI> Whether you are using a package provided by your distribution or you
  43. compiled it youself.
  44. <LI> If you compiled it yourself, the compiler you are using. (Also make
  45. sure to run 'make check'.)
  46. <LI> A description of the problem.
  47. <LI> Information generated by the sndfile-info program (see next paragraph).
  48. <LI> If you are having problems with sndfile-play and ALSA on Linux, I will
  49. need information about your kernel, ALSA version, compiler version,
  50. whether you compiled the kernel/ALSA your self or installed from a
  51. package etc.
  52. </UL>
  53. <P>
  54. If libsndfile compiles and installs correctly but has difficulty reading a particular
  55. file or type of file you should run the <B>sndfile-info</B> program (from the examples
  56. directory of the libsndfile distribution) on the file. See
  57. <A HREF="sndfile_info.html">here</A>
  58. for an example of the use of the <B>sndfile-info</B> program.
  59. </P>
  60. <P>
  61. Please do not send me a sound file which fails to open under libsndfile unless I
  62. specifically ask you to. The above information should usually suffice for most
  63. problems.
  64. </P>
  65. <P>
  66. Once you have the above information you should submit a ticket on the libsnfile
  67. <A HREF="https://github.com/erikd/libsndfile/issues">github issue tracker</A>.
  68. </P>
  69. </BODY>
  70. </HTML>