annotate src/libsndfile-1.0.27/doc/bugs.html @ 83:ae30d91d2ffe

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