Blame doc/bugs.html

Packit 4aff17
Packit 4aff17
<HTML>
Packit 4aff17
Packit 4aff17
<HEAD>
Packit 4aff17
	<TITLE>
Packit 4aff17
	Bug Reporting
Packit 4aff17
	</TITLE>
Packit 4aff17
	<META NAME="Author"      CONTENT="Erik de Castro Lopo (erikd AT mega-nerd DOT com)">
Packit 4aff17
	<LINK REL="stylesheet" HREF="libsndfile.css" TYPE="text/css" MEDIA="all">
Packit 4aff17
	<LINK REL="stylesheet" HREF="print.css" TYPE="text/css" MEDIA="print">
Packit 4aff17
</HEAD>
Packit 4aff17
Packit 4aff17
<BODY>
Packit 4aff17
Packit 4aff17
<CENTER>
Packit 4aff17
		

Reporting Bugs in libsndfile

Packit 4aff17
</CENTER>
Packit 4aff17

Packit 4aff17
	Before even attempting to report a bug in libsndfile please make sure you have
Packit 4aff17
	read the
Packit 4aff17
		Frequently Asked Questions.
Packit 4aff17
	If you are having a problem writing code using libsndfile make sure you read
Packit 4aff17
	the
Packit 4aff17
		Application Programming Interface
Packit 4aff17
	documentation.
Packit 4aff17

Packit 4aff17

Packit 4aff17
	That said, I am interested in finding and fixing all genuine bugs in libsndfile.
Packit 4aff17
	Bugs I want to fix include any of the following problems (and probably others) :
Packit 4aff17

Packit 4aff17
	
    Packit 4aff17
    	
  • Compilation problems on new platforms.
  • Packit 4aff17
    	
  • Errors being detected during the `make check' process.
  • Packit 4aff17
    	
  • Segmentation faults occuring inside libsndfile.
  • Packit 4aff17
    	
  • libsndfile hanging when opening a file.
  • Packit 4aff17
    	
  • Supported sound file types being incorrectly read or written.
  • Packit 4aff17
    	
  • Omissions, errors or spelling mistakes in the documentation.
  • Packit 4aff17
    	
    Packit 4aff17
    Packit 4aff17

    Packit 4aff17
    	When submitting a bug report you must include :
    Packit 4aff17

    Packit 4aff17
    	
      Packit 4aff17
      	
    • Your system (CPU and memory size should be enough).
    • Packit 4aff17
      	
    • The operating system you are using.
    • Packit 4aff17
      	
    • Whether you are using a package provided by your distribution or you
    • Packit 4aff17
      			compiled it youself.
      Packit 4aff17
      	
    • If you compiled it yourself, the compiler you are using. (Also make
    • Packit 4aff17
      			sure to run 'make check'.)
      Packit 4aff17
      	
    • A description of the problem.
    • Packit 4aff17
      	
    • Information generated by the sndfile-info program (see next paragraph).
    • Packit 4aff17
      	
    • If you are having problems with sndfile-play and ALSA on Linux, I will
    • Packit 4aff17
      			need information about your kernel, ALSA version, compiler version,
      Packit 4aff17
      			whether you compiled the kernel/ALSA your self or installed from a
      Packit 4aff17
      			package etc.
      Packit 4aff17
      	
      Packit 4aff17
      Packit 4aff17

      Packit 4aff17
      	If libsndfile compiles and installs correctly but has difficulty reading a particular
      Packit 4aff17
      	file or type of file you should run the sndfile-info program (from the examples
      Packit 4aff17
      	directory of the libsndfile distribution) on the file. See
      Packit 4aff17
      		here
      Packit 4aff17
      	for an example of the use of the sndfile-info program.
      Packit 4aff17

      Packit 4aff17

      Packit 4aff17
      	Please do not send me a sound file which fails to open under libsndfile unless I
      Packit 4aff17
      	specifically ask you to. The above information should usually suffice for most
      Packit 4aff17
      	problems.
      Packit 4aff17

      Packit 4aff17

      Packit 4aff17
      	Once you have the above information you should submit a ticket on the libsnfile
      Packit 4aff17
      		github issue tracker.
      Packit 4aff17
      Packit 4aff17

      Packit 4aff17
      </BODY>
      Packit 4aff17
      </HTML>