= Debugging Guide =

If you open a ticket, additional information will almost always be necessary. The two most common things are a testlog log file and a formatted trace.  The testlog log file is always required. You can save a lot of time by attaching the testlog log file to your ticket when you open it, rather than waiting for the developer to ask for it. Only attach a formatted trace file if the developer asks for it.

This page contains instructions for creating a testlog log file and a formatted trace file.

== Capturing A testlog log file ==

If you don't already have the current version of testlog.cmd, you can download it here: [http://88watts.net/download/testlog-2.08.zip testlog-2.08.zip]

Open a command window and execute the testlog command for your particular driver. For example:
   {{{
testlog r8169
   }}}

Attach the created log file to your ticket. Do not ZIP the log file.

== Installing the Trace Version of the Driver ==

To install the trace version, run the Warpin installation and select both
packages.

To re-install the normal version, run the Warpin installation and uninstall the
trace package and reinstall the retail package.

To enable tracing, add these two lines to your CONFIG.SYS:
{{{
  TRACEBUF=512 /M=NOWRAP,QUEUED,NODTI /D=ALL
  TRACE=ON 248
}}}
You must reboot to make the new driver active and enable tracing. This
assumes that you have already setup this driver using mpts.exe. You do
not need to setup the driver using mpts.exe more than once, even if you
install new versions of the driver. You just need to reboot to start using the new version.

== Capturing the Trace  ==

To capture the trace dump, open a command window and type:

   TRACEFMT

From the file menu choose Save Formatted... and save the trace to a file of your choice.