annotate src/libsndfile-1.0.25/doc/bugs.html @ 0:c7265573341e

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