[xiph-commits] r13262 - websites/icecast.org
moritz at svn.xiph.org
moritz at svn.xiph.org
Sun Jul 15 08:23:05 PDT 2007
Author: moritz
Date: 2007-07-15 08:23:04 -0700 (Sun, 15 Jul 2007)
New Revision: 13262
Modified:
websites/icecast.org/ezstream.php
Log:
Add a "Support" section.
Modified: websites/icecast.org/ezstream.php
===================================================================
--- websites/icecast.org/ezstream.php 2007-07-14 23:43:14 UTC (rev 13261)
+++ websites/icecast.org/ezstream.php 2007-07-15 15:23:04 UTC (rev 13262)
@@ -57,7 +57,8 @@
<a href="#ez_about">About</a> |
<a href="#ez_download">Download</a> |
<a href="#ez_more">More ...</a> |
- <a href="#ez_relnotes">Release Notes</a>
+ <a href="#ez_relnotes">Release Notes</a> |
+ <a href="#ez_support">Support</a>
</p>
</div>
@@ -116,7 +117,8 @@
<a href="#ez_about">About</a> |
<a href="#ez_download">Download</a> |
<a href="#ez_more">More ...</a> |
- <a href="#ez_relnotes">Release Notes</a>
+ <a href="#ez_relnotes">Release Notes</a> |
+ <a href="#ez_support">Support</a>
</p>
</div>
@@ -169,6 +171,12 @@
<em>INSTALL</em> files inside the distribution package.
</p>
+<p>
+ It might be a good idea to check whether the operating system vendor provides
+ a binary package of a recent ezstream release and install that one instead of
+ building from source.
+</p>
+
<h4>Windows</h4>
<p>
@@ -191,8 +199,7 @@
<p>
Those, who are interested in how ezstream development progresses, can stay
informed by occasionally looking at the
- <a href="http://svn.xiph.org/trunk/ezstream/NEWS">NEWS</a>
- file.
+ <a href="http://svn.xiph.org/trunk/ezstream/NEWS">NEWS file</a>.
It is kept up-to-date with important changes in ezstream as they happen.
</p>
@@ -200,7 +207,8 @@
<a href="#ez_about">About</a> |
<a href="#ez_download">Download</a> |
<a href="#ez_more">More ...</a> |
- <a href="#ez_relnotes">Release Notes</a>
+ <a href="#ez_relnotes">Release Notes</a> |
+ <a href="#ez_support">Support</a>
</p>
</div>
@@ -215,7 +223,7 @@
<div class="roundtop">
<img src="/images/corner_topleft.jpg" class="corner" style="display: none" />
</div>
-<div class="newscontent" id="ez_relnotes" name="ez_relnotes">
+<div class="newscontent" id="ez_relnotes" name="ez_relnotes">
<h3>Release Notes</h3>
@@ -323,7 +331,8 @@
<a href="#ez_about">About</a> |
<a href="#ez_download">Download</a> |
<a href="#ez_more">More ...</a> |
- <a href="#ez_relnotes">Release Notes</a>
+ <a href="#ez_relnotes">Release Notes</a> |
+ <a href="#ez_support">Support</a>
</p>
</div>
@@ -334,4 +343,179 @@
<br/>
+<div class="roundcont">
+<div class="roundtop">
+<img src="/images/corner_topleft.jpg" class="corner" style="display: none" />
+</div>
+<div class="newscontent" id="ez_support" name="ez_support">
+
+<h3>Support</h3>
+
+<h4>Reporting Problems</h4>
+
+<p>
+ In case of problems with ezstream, please make sure to re-read the
+ documentation first and double-check your configuration.
+ A lot of effort has been put into the <code>ezstream(1)</code> manual, and it
+ should -- at least in theory -- answer all questions.
+</p>
+
+<p>
+ Of course, ezstream isn't immune to bugs.
+ After
+ <a href="https://trac.xiph.org/report/21">checking whether your bug is already known</a>,
+ or a newer ezstream release fixes your problem, it is much appreciated that you
+ <a href="https://trac.xiph.org/newticket?component=ezstream">file your <b>complete</b> bug report</a>
+ (see below) with the Xiph.org bug tracker.
+</p>
+
+<p>
+ If you encounter one of the following issues, you most definitely found a
+ genuine bug:
+</p>
+
+<ul style="font-size: smaller; margin: 1em 3em">
+ <li>
+ Ezstream crashes with a segmentation fault (SIGSEGV).
+ </li>
+ <li>
+ Ezstream aborts with an "Internal error".
+ </li>
+ <li>
+ A long-lived ezstream process keeps requiring more and more resources until
+ they run out.
+ </li>
+ <li>
+ A newer version of ezstream behaves surprisingly different, compared to an
+ earlier release, even though the configuration hasn't changed.
+ Such a behavioral change would have to be clearly intended and noted in the
+ <a href="http://svn.xiph.org/trunk/ezstream/NEWS">NEWS file</a>,
+ or it is considered a bug.
+ </li>
+ <li>
+ A part of the documentation is missing, unclear, or plain wrong.
+ </li>
+</ul>
+
+<p>
+ Of course, sensible feature requests are also welcome.
+ Please select <em>enhancement</em> in the "Type:" drop-down menu for
+ those reports.
+</p>
+
+<h4>The Good Bug Report</h4>
+
+<p>
+ Since it's hard to read someone else's mind, especially over the Internet,
+ a bug report needs to be "good".
+ A good bug report is never too short, and contains all the necessary
+ information to allow the developer to research, reproduce, understand and fix
+ the problem.
+</p>
+
+<p>
+ Unless you are able to provide a fix (unified diff with explanation) to your
+ problem, please follow this guide as closely as possible:
+</p>
+
+<ul style="font-size: smaller; margin: 1em 3em">
+ <li>
+ <em>Be precise.</em><br/>
+ Vague phrases like "It doesn't work", "It crashes" or
+ "There is a strange problem" are not helpful without a verbose
+ explanation.
+ Do not be afraid of bug reports that seem too lengthy; it's a fact of life.
+ </li>
+ <li>
+ <em>What are you using?</em><br/>
+ Include information about the ezstream version, your operating system name,
+ version and architecture.
+ </li>
+ <li>
+ <em>What did you do?</em><br/>
+ Include the exact sequence of steps and events necessary to reproduce the
+ problem.
+ This includes, at the very least:
+ <ul>
+ <li>
+ Any command line options passed to ezstream.
+ </li>
+ <li>
+ The ezstream configuration file, in full. (Please censor passwords and
+ host names, but keep it intact otherwise.)
+ </li>
+ </ul>
+ </li>
+ <li>
+ <em>What happened?</em><br/>
+ Describe the problem that you're having, including all error and log
+ messages that you might be seeing.
+ In case of a crash or an "Internal error", if you're up to it,
+ include a gdb backtrace:
+ <ul>
+ <li>
+ Rebuild ezstream with debugging symbols.
+ This can be achieved by building with "<code>DEBUG=-g</code>"
+ in the environment.
+ </li>
+ <li>
+ Reproduce the issue and get a fresh core dump.
+ On some systems, core dumps need to be enabled with
+ "<code>ulimit -c unlimited</code>".
+ </li>
+ <li>
+ Run <code>gdb(1)</code> with the core dump.
+ The name of the file containing the dump is either
+ <code>ezstream.core</code> or just <code>core</code> (adjust the following
+ command, if necessary):
+ "<code>gdb ezstream ezstream.core</code>"
+ </li>
+ <li>
+ Get the backtrace, by typing "<code>bt full</code>" at the
+ <em>(gdb)</em> prompt.
+ </li>
+ <li>
+ Include the complete backtrace in your problem report.
+ Note that coredump files are only meaningful on the system where ezstream
+ crashed, and are useless elsewhere - do not include the core dump itself
+ in your report.
+ </li>
+ </ul>
+ </li>
+ <li>
+ <em>Do not diagnose the problem.</em><br/>
+ Or, well, do not do so without including the other information as well.
+ A diagnosis won't lead to a fix unless it can be verified by analyzing all
+ of the symptoms.
+ The only acceptable shortcut is a working patch in the report! :-)
+ </li>
+</ul>
+
+<p>
+ Good problem reports help make ezstream better, and your efforts are very
+ much appreciated!
+</p>
+
+<h4>Contact</h4>
+
+<p>
+ The current maintainer of ezstream is Moritz Grimm (mdgrimm at gmx dot net).
+</p>
+
+<p class="ez_nav">
+ <a href="#ez_about">About</a> |
+ <a href="#ez_download">Download</a> |
+ <a href="#ez_more">More ...</a> |
+ <a href="#ez_relnotes">Release Notes</a> |
+ <a href="#ez_support">Support</a>
+</p>
+
+</div>
+<div class="roundbottom">
+<img src="/images/corner_bottomleft.jpg" class="corner" style="display: none" />
+</div>
+</div>
+
+<br/>
+
<? include "common/footer.php"; ?>
More information about the commits
mailing list