aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2004-09-19 16:38:29 +0000
committerUlf Lamping <ulf.lamping@web.de>2004-09-19 16:38:29 +0000
commit26300c1fb2adbeadd7e30d49f64b8a2dcc4b9201 (patch)
tree35e7f48f262764496441a2253cab0332c15ea3f9 /docbook
parentaf0075ed565ebb34394146647e69c38ba9f9dcbf (diff)
add some info how to report problems
svn path=/trunk/; revision=12050
Diffstat (limited to 'docbook')
-rw-r--r--docbook/dg-src/EDG_chapter_env_intro.xml29
1 files changed, 23 insertions, 6 deletions
diff --git a/docbook/dg-src/EDG_chapter_env_intro.xml b/docbook/dg-src/EDG_chapter_env_intro.xml
index 1e825a1e48..a57792c374 100644
--- a/docbook/dg-src/EDG_chapter_env_intro.xml
+++ b/docbook/dg-src/EDG_chapter_env_intro.xml
@@ -373,7 +373,7 @@
</para>
</section>
- <section><title>Reporting Problems</title>
+ <section id="ChIntroReportProblems"><title>Reporting Problems</title>
<note><title>Note!</title>
<para>
Before reporting any problems, please make sure you have installed the
@@ -381,6 +381,13 @@
</para>
</note>
<para>
+ If you report problems, provide as much
+ information as possible. In general, just think about what
+ you would need to find that problem, if someone else sends you such a
+ problem report. Also keep in mind, that people uses a lot of different
+ platforms to compile/run Ethereal on.
+ </para>
+ <para>
When reporting problems with Ethereal, it is helpful if you supply the
following information:
<orderedlist>
@@ -401,6 +408,15 @@
A detailed description of your problem.
</para>
</listitem>
+ <listitem>
+ <para>
+ If you get an error/warning message, copy the text of that message (and
+ also a few lines before and after it, if there are some), so others may
+ find the build step where things go wrong.
+ Please don't give something like: "I get a warning when comiling x"
+ as this won't give any direction to look at.
+ </para>
+ </listitem>
</orderedlist>
</para>
<note><title>Don't send large files!</title>
@@ -420,11 +436,11 @@
</note>
</section>
- <section><title>Reporting Crashes on UNIX/Linux platforms</title>
+ <section><title>Reporting Crashes on UNIX/Linux platforms</title>
<para>
When reporting crashes with Ethereal, it is helpful if you supply the
- traceback information (besides the information mentioned in "Reporting
- Problems").
+ traceback information (besides the information mentioned in
+ <xref linkend="ChIntroReportProblems"/>).
</para>
<para>
You can obtain this traceback information with the following commands:
@@ -468,12 +484,13 @@ $
</para>
</section>
- <section><title>Reporting Crashes on Windows platforms</title>
+ <section><title>Reporting Crashes on Windows platforms</title>
<para>
The Windows distributions don't contain the symbol files (.pdb), because
they are very large. For this reason it's not possible to create
a meaningful backtrace file from it. You should report your crash just
- like other problems, using the mechanism described above.
+ like other problems, using the mechanism from
+ <xref linkend="ChIntroReportProblems"/>.
</para>
</section>
</section>