summaryrefslogtreecommitdiff
path: root/docs/htmldocs/bugreport.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/htmldocs/bugreport.html')
-rw-r--r--docs/htmldocs/bugreport.html118
1 files changed, 60 insertions, 58 deletions
diff --git a/docs/htmldocs/bugreport.html b/docs/htmldocs/bugreport.html
index 49eb2117ca..0e963269d5 100644
--- a/docs/htmldocs/bugreport.html
+++ b/docs/htmldocs/bugreport.html
@@ -1,115 +1,117 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 35. Reporting Bugs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="samba-doc.html" title="SAMBA Project Documentation"><link rel="up" href="troubleshooting.html" title="Part V. Troubleshooting"><link rel="previous" href="problems.html" title="Chapter 34. Analysing and solving samba problems"><link rel="next" href="Appendixes.html" title="Part VI. Appendixes"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 35. Reporting Bugs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><th width="60%" align="center">Part V. Troubleshooting</th><td width="20%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="bugreport"></a>Chapter 35. Reporting Bugs</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jelmer</span> <span class="othername">R.</span> <span class="surname">Vernooij</span></h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Andrew</span> <span class="surname">Tridgell</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:tridge@samba.org">tridge@samba.org</a>&gt;</tt></p></div></div></div></div><div><p class="pubdate"> 27 June 1997 </p></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="bugreport.html#id2960613">Introduction</a></dt><dt><a href="bugreport.html#id2960681">General info</a></dt><dt><a href="bugreport.html#id2960718">Debug levels</a></dt><dt><a href="bugreport.html#id2960926">Internal errors</a></dt><dt><a href="bugreport.html#id2961060">Attaching to a running process</a></dt><dt><a href="bugreport.html#id2961107">Patches</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960613"></a>Introduction</h2></div></div><div></div></div><p>Please report bugs using
- <a href="https://bugzilla.samba.org/" target="_top">bugzilla</a>.</p><p>
-Please take the time to read this file before you submit a bug
-report. Also, please see if it has changed between releases, as we
-may be changing the bug reporting mechanism at some time.
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 35. Reporting Bugs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="troubleshooting.html" title="Part V. Troubleshooting"><link rel="previous" href="problems.html" title="Chapter 34. Analyzing and Solving Samba Problems"><link rel="next" href="Appendixes.html" title="Part VI. Appendixes"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 35. Reporting Bugs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><th width="60%" align="center">Part V. Troubleshooting</th><td width="20%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="bugreport"></a>Chapter 35. Reporting Bugs</h2></div><div><div class="author"><h3 class="author"><span class="firstname">John</span> <span class="othername">H.</span> <span class="surname">Terpstra</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jht@samba.org">jht@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Jelmer</span> <span class="othername">R.</span> <span class="surname">Vernooij</span></h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Andrew</span> <span class="surname">Tridgell</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:tridge@samba.org">tridge@samba.org</a>&gt;</tt></p></div></div></div></div><div><p class="pubdate"> 27 June 1997 </p></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="bugreport.html#id2972309">Introduction</a></dt><dt><a href="bugreport.html#id2972372">General Information</a></dt><dt><a href="bugreport.html#id2972408">Debug Levels</a></dt><dt><a href="bugreport.html#id2972617">Internal Errors</a></dt><dt><a href="bugreport.html#id2972752">Attaching to a Running Process</a></dt><dt><a href="bugreport.html#id2972799">Patches</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972309"></a>Introduction</h2></div></div><div></div></div><p>Please report bugs using Samba's
+<ulink url="https://bugzilla.samba.org/">Bugzilla</ulink> facilities and
+take the time to read this file before you submit a bug
+report. Also, check to see if it has changed between releases, as we
+may be changing the bug reporting mechanism at some point.
</p><p>
-Please also do as much as you can yourself to help track down the
+Please do as much as you can yourself to help track down the
bug. Samba is maintained by a dedicated group of people who volunteer
-their time, skills and efforts. We receive far more mail about it than
-we can possibly answer, so you have a much higher chance of an answer
-and a fix if you send us a &quot;developer friendly&quot; bug report that lets
+their time, skills and efforts. We receive far more mail than
+we can possibly answer, so you have a much higher chance of a response
+and a fix if you send us a &#8220;<span class="quote">developer friendly</span>&#8221; bug report that lets
us fix it fast.
</p><p>
Do not assume that if you post the bug to the comp.protocols.smb
newsgroup or the mailing list that we will read it. If you suspect that your
-problem is not a bug but a configuration problem then it is better to send
-it to the Samba mailing list, as there are (at last count) 5000 other users on
-that list that may be able to help you.
+problem is not a bug but a configuration problem, it is better to send
+it to the Samba mailing list, as there are thousands of other users on
+that list who may be able to help you.
</p><p>
You may also like to look though the recent mailing list archives,
-which are conveniently accessible on the Samba web pages
-at <a href="http://samba.org/samba/" target="_top">http://samba.org/samba/</a>.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960681"></a>General info</h2></div></div><div></div></div><p>
-Before submitting a bug report check your config for silly
-errors. Look in your log files for obvious messages that tell you that
-you've misconfigured something and run testparm to test your config
+which are conveniently accessible on the Samba Web pages
+at <ulink url="http://samba.org/samba/">http://samba.org/samba/</ulink>.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972372"></a>General Information</h2></div></div><div></div></div><p>
+Before submitting a bug report, check your config for silly
+errors. Look in your log files for obvious messages that tell
+you've misconfigured something. Run testparm to check your config
file for correct syntax.
</p><p>
-Have you run through the <a href="diagnosis.html" title="Chapter 33. The Samba checklist">diagnosis</a>?
-This is very important.
+ Have you looked through <link linkend="diagnosis">? This is extremely important.
</p><p>
-If you include part of a log file with your bug report then be sure to
+If you include part of a log file with your bug report, then be sure to
annotate it with exactly what you were doing on the client at the
-time, and exactly what the results were.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960718"></a>Debug levels</h2></div></div><div></div></div><p>
+time and exactly what the results were.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972408"></a>Debug Levels</h2></div></div><div></div></div><p>
If the bug has anything to do with Samba behaving incorrectly as a
-server (like refusing to open a file) then the log files will probably
-be very useful. Depending on the problem a log level of between 3 and
+server (like refusing to open a file), then the log files will probably
+be quite useful. Depending on the problem, a log level of between 3 and
10 showing the problem may be appropriate. A higher level gives more
detail, but may use too much disk space.
</p><p>
-To set the debug level use the <a class="indexterm" name="id2960739"></a><i class="parameter"><tt>log level</tt></i> in your
+To set the debug level, use the <a class="indexterm" name="id2972430"></a><i class="parameter"><tt>log level</tt></i> in your
<tt class="filename">smb.conf</tt>. You may also find it useful to set the log
level higher for just one machine and keep separate logs for each machine.
-To do this add the following lines to your main <tt class="filename">smb.conf</tt> file:
+To do this, add the following lines to your main <tt class="filename">smb.conf</tt> file:
</p><table class="simplelist" border="0" summary="Simple list"><tr><td><i class="parameter"><tt>log level = 10</tt></i></td></tr><tr><td><i class="parameter"><tt>log file = /usr/local/samba/lib/log.%m</tt></i></td></tr><tr><td><i class="parameter"><tt>include = /usr/local/samba/lib/smb.conf.%m</tt></i></td></tr></table><p>
-then create a file
-<tt class="filename">/usr/local/samba/lib/smb.conf.<i class="replaceable"><tt>machine</tt></i></tt> where
+and create a file <tt class="filename">/usr/local/samba/lib/smb.conf.<i class="replaceable"><tt>machine</tt></i></tt> where
<i class="replaceable"><tt>machine</tt></i> is the name of the client you wish to debug. In that file
put any <tt class="filename">smb.conf</tt> commands you want, for example
-<a class="indexterm" name="id2960830"></a><i class="parameter"><tt>log level</tt></i> may be useful. This also allows you to
-experiment with different security systems, protocol levels etc on just
+<a class="indexterm" name="id2972521"></a><i class="parameter"><tt>log level</tt></i> may be useful. This also allows you to
+experiment with different security systems, protocol levels and so on, on just
one machine.
</p><p>
-The <tt class="filename">smb.conf</tt> entry <a class="indexterm" name="id2960857"></a><i class="parameter"><tt>log level</tt></i>
-is synonymous with the parameter <a class="indexterm" name="id2960872"></a><i class="parameter"><tt>debuglevel</tt></i> that has
-been used in older versions of Samba and is being retained for backwards
+The <tt class="filename">smb.conf</tt> entry <a class="indexterm" name="id2972548"></a><i class="parameter"><tt>log level</tt></i>
+is synonymous with the parameter <a class="indexterm" name="id2972562"></a><i class="parameter"><tt>debuglevel</tt></i> that has
+been used in older versions of Samba and is being retained for backward
compatibility of <tt class="filename">smb.conf</tt> files.
</p><p>
-As the <a class="indexterm" name="id2960897"></a><i class="parameter"><tt>log level</tt></i> value is increased you will record
-a significantly increasing level of debugging information. For most
-debugging operations you may not need a setting higher than
+As the <a class="indexterm" name="id2972588"></a><i class="parameter"><tt>log level</tt></i> value is increased, you will record
+a significantly greater level of debugging information. For most
+debugging operations, you may not need a setting higher than
<tt class="constant">3</tt>. Nearly
all bugs can be tracked at a setting of <tt class="constant">10</tt>, but be
-prepared for a VERY large volume of log data.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960926"></a>Internal errors</h2></div></div><div></div></div><p>
-If you get a <span class="errorname">INTERNAL ERROR</span> message in your log files
+prepared for a large volume of log data.
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972617"></a>Internal Errors</h2></div></div><div></div></div><p>
+If you get the message &#8220;<span class="quote"><span class="errorname">INTERNAL ERROR</span></span>&#8221; in your log files,
it means that Samba got an unexpected signal while running. It is probably a
segmentation fault and almost certainly means a bug in Samba (unless
you have faulty hardware or system software).
</p><p>
-If the message came from smbd then it will probably be accompanied by
-a message which details the last SMB message received by smbd. This
-info is often very useful in tracking down the problem so please
+If the message came from smbd, it will probably be accompanied by
+a message that details the last SMB message received by smbd. This
+information is often useful in tracking down the problem so please
include it in your bug report.
</p><p>
You should also detail how to reproduce the problem, if
possible. Please make this reasonably detailed.
-</p><a class="indexterm" name="id2960962"></a><p>
+</p><p>
+<a class="indexterm" name="id2972657"></a>
You may also find that a core file appeared in a <tt class="filename">corefiles</tt>
-subdirectory of the directory where you keep your samba log
+subdirectory of the directory where you keep your Samba log
files. This file is the most useful tool for tracking down the bug. To
-use it you do this:
-</p><a class="indexterm" name="id2960984"></a><a class="indexterm" name="id2960993"></a><pre class="screen">
+use it, you do this:
+<a class="indexterm" name="id2972676"></a>
+<a class="indexterm" name="id2972684"></a>
+</p><pre class="screen">
<tt class="prompt">$ </tt><b class="userinput"><tt>gdb smbd core</tt></b>
</pre><p>
adding appropriate paths to smbd and core so gdb can find them. If you
-don't have gdb then try <b class="userinput"><tt>dbx</tt></b>. Then within the debugger
+do not have gdb, try <b class="userinput"><tt>dbx</tt></b>. Then within the debugger,
use the command <b class="command">where</b> to give a stack trace of where the
problem occurred. Include this in your report.
</p><p>
-If you know any assembly language then do a
-<b class="command">disass</b> of the routine
-where the problem occurred (if its in a library routine then
+If you know any assembly language, do a <b class="command">disass</b> of the routine
+where the problem occurred (if its in a library routine, then
disassemble the routine that called it) and try to work out exactly
where the problem is by looking at the surrounding code. Even if you
-don't know assembly, including this info in the bug report can be
+do not know assembly, including this information in the bug report can be
useful.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2961060"></a>Attaching to a running process</h2></div></div><div></div></div><p>
-Unfortunately some unixes (in particular some recent linux kernels)
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972752"></a>Attaching to a Running Process</h2></div></div><div></div></div><p>
+Unfortunately, some UNIXes (in particular some recent Linux kernels)
refuse to dump a core file if the task has changed uid (which smbd
-does often). To debug with this sort of system you could try to attach
+does often). To debug with this sort of system, you could try to attach
to the running process using
<b class="userinput"><tt>gdb smbd <i class="replaceable"><tt>PID</tt></i></tt></b> where you get
<i class="replaceable"><tt>PID</tt></i> from <span class="application">smbstatus</span>.
Then use <b class="command">c</b> to continue and try to cause the core dump
using the client. The debugger should catch the fault and tell you
where it occurred.
-</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2961107"></a>Patches</h2></div></div><div></div></div><a class="indexterm" name="id2961114"></a><a class="indexterm" name="id2961123"></a><p>
+</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2972799"></a>Patches</h2></div></div><div></div></div><p>
+<a class="indexterm" name="id2972810"></a>
+<a class="indexterm" name="id2972818"></a>
The best sort of bug report is one that includes a fix! If you send us
-patches please use <b class="userinput"><tt>diff -u</tt></b> format if your version of
+patches, please use <b class="userinput"><tt>diff -u</tt></b> format if your version of
diff supports it, otherwise use <b class="userinput"><tt>diff -c4</tt></b>. Make sure
you do the diff against a clean version of the source and let me know
exactly what version you used.
-</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="troubleshooting.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 34. Analysing and solving samba problems </td><td width="20%" align="center"><a accesskey="h" href="samba-doc.html">Home</a></td><td width="40%" align="right" valign="top"> Part VI. Appendixes</td></tr></table></div></body></html>
+</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="troubleshooting.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 34. Analyzing and Solving Samba Problems </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Part VI. Appendixes</td></tr></table></div></body></html>