JezK
Edit File: askingforhelp.html
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>What to include when asking for help</title><link rel="stylesheet" type="text/css" href="userguide.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="home" href="index.html" title="FreeTDS User Guide" /><link rel="up" href="help.html" title="Chapter 9. Getting Help" /><link rel="prev" href="mailinglist.html" title="The Mailing List" /><link rel="next" href="contrib.html" title="Chapter 10. Helping" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">What to include when asking for help</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="mailinglist.html">Prev</a> </td><th width="60%" align="center">Chapter 9. Getting Help</th><td width="20%" align="right"> <a accesskey="n" href="contrib.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="askingforhelp"></a>What to include when asking for help</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Waddyagot"></a>Waddya got?</h3></div></div></div><p>It's important to convey your setup and configuration. </p><table border="0" summary="Simple list" class="simplelist"><tr><td><span class="productname">SQL Server</span> version</td></tr><tr><td><span class="productname">FreeTDS</span> version (or snapshot date, if not a release)</td></tr><tr><td>any options used with <span class="command"><strong>configure</strong></span></td></tr><tr><td>which client library you are using</td></tr><tr><td>what language or Perl module, as appropriate, you're using</td></tr><tr><td>your client OS and hardware architecture</td></tr></table></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="help.log"></a>Attach a logfile</h3></div></div></div><p>If you're puzzled by some interaction with the server (often the case), it's a very good idea to set <code class="envar">TDSDUMP</code> and attach the log to your message. Messages are currently limited to 75 KB attachments, and the logs are quite detailed, so make your query as short as possible. If necessary, trim the log; <span class="command"><strong>gzip</strong></span> is also your friend here. It's always a good idea to post it on a website where people can fetch it if they're so inclined.</p><p>Log files are especially important if you're not programming at the C level. Sometimes there are problems — an impedance mismatch, to coin a phrase — between <span class="productname">FreeTDS</span> and the calling framework/language. But if you write to the list and say <span class="quote">“<span class="quote">Why does my <code class="literal">PHP foo()</code> returns an empty string?</span>”</span>, please keep in mind that your question might as well be in Urdu to someone familiar with the C library. Without knowing which C function was called, and with what data, it's impossible to even begin to try to answer the question. </p><p>Think about it this way: If you attach a log no one reads, you wasted some bandwidth. If you don't attach one and someone asks you for it, you wasted a day. Like that.</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="ShowYourWork"></a>Show your work</h3></div></div></div><p>Great questions make the problem crystal clear to a tired developer after supper. </p><p>Show what you did, and show what happened. Throughout this User Guide, you've seen examples of screenshots; in each case the first line was the command entered, followed by the machine's response. By showing <span class="emphasis"><em>verbatim</em></span> what you did and saw, you give someone who knows what to do a chance to look over your shoulder. <span class="emphasis"><em>Across the Internet!</em></span> How cool is that? </p><p>Whether you're having a problem with your own application or with something at a higher level, you're well advised to try to reproduce it using one of the <span class="productname">FreeTDS</span> utilities, preferably one that used the same client library you're using. If, say, <span class="command"><strong>bsqldb</strong></span> works and your program doesn't, that's a clue. By the same token, if <span class="command"><strong>bsqldb</strong></span> exhibits problems, too, chances are you found a bug. Or — how to say it? — a <span class="emphasis"><em>missing feature</em></span>. It's always good to know about those. </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="mailinglist.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="help.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="contrib.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The Mailing List </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 10. Helping</td></tr></table></div></body></html>