interpretor/libsndfile-1.0.25/doc/bugs.html

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