You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.8 KiB
114 lines
3.8 KiB
4 years ago
|
$Id: README.debugging,v 1.7 2007/02/16 18:26:41 desrod Exp $
|
||
|
|
======================================================================
|
||
|
|
README.debugging
|
||
|
|
Author: JP Rosevear, David A. Desrosiers
|
||
|
|
Updated: Mon Oct 16 16:37:45 EDT 2006
|
||
|
|
======================================================================
|
||
|
|
This README will describe in detail, the process and programs necessary
|
||
|
|
to debug any problems you might have with pilot-link with libusb on
|
||
|
|
Linux and Mac OS X machines.
|
||
|
|
|
||
|
|
Debugging pilot-link
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
To begin debugging problems, the core library "libpisock" contains
|
||
|
|
runtime debugging features. You do not need to recompile pilot-link to
|
||
|
|
include these.
|
||
|
|
|
||
|
|
If you want to disable them (not recommended, but you may if you know
|
||
|
|
what you're doing), simply pass the --disable-debug configure option to
|
||
|
|
disable at build time. Debugging is enabled by default, so there is no
|
||
|
|
--enable-debugging target.
|
||
|
|
|
||
|
|
|
||
|
|
Environment variables for debugging
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
The runtime debugging is controlled by setting four different
|
||
|
|
environment variables. These are:
|
||
|
|
|
||
|
|
PILOT_DEBUG
|
||
|
|
PILOT_DEBUG_LEVEL
|
||
|
|
PILOT_LOG
|
||
|
|
PILOT_LOGFILE
|
||
|
|
|
||
|
|
PILOT_DEBUG controls what type of information is output to STDOUT or
|
||
|
|
your logfile. The levels of information available are:
|
||
|
|
|
||
|
|
DEV Device IO
|
||
|
|
SLP Serial Link Protocol
|
||
|
|
PADP Packet Assembly/Disassembly Protocol
|
||
|
|
CMP Connection Management Protocol
|
||
|
|
NET Network Sync Protocol
|
||
|
|
SOCK Socket Commands
|
||
|
|
API API (datebook, address, todo, memos, etc)
|
||
|
|
USER User data
|
||
|
|
|
||
|
|
You can specify multiple types of information to be output/captured
|
||
|
|
as follows:
|
||
|
|
|
||
|
|
setenv PILOT_DEBUG "DEV SLP PADP" # for csh
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
export PILOT_DEBUG="DEV SLP PADP" # for bash
|
||
|
|
|
||
|
|
PILOT_DEBUG_LEVEL controls the level of information displayed for
|
||
|
|
each type. The availab levels are:
|
||
|
|
|
||
|
|
NONE No information displayed at all
|
||
|
|
ERR Critical errors
|
||
|
|
WARN Non-critical errors
|
||
|
|
INFO General information
|
||
|
|
DEBUG Verbose debugging info, everything!
|
||
|
|
|
||
|
|
If the variable PILOT_LOG is set (nonzero), the information will be
|
||
|
|
written to the file "pilot-link.debug" by default. This logfile name
|
||
|
|
be overridden by setting PILOT_LOGFILE to the desired file name you
|
||
|
|
wish to use.
|
||
|
|
|
||
|
|
If you wish to disable logging for a particular session, just set
|
||
|
|
PILOT_LOG to 0.
|
||
|
|
|
||
|
|
Here's an example of the overall usage (for bash, your shell may
|
||
|
|
vary):
|
||
|
|
|
||
|
|
export PILOT_DEBUG="DEV SLP CMP PADP SOCK NET USER"
|
||
|
|
export PILOT_DEBUG_LEVEL="DEBUG"
|
||
|
|
export PILOT_LOG=1
|
||
|
|
export PILOT_LOGFILE="debug.log"
|
||
|
|
|
||
|
|
These logs will provide a level of detail necessay for the
|
||
|
|
pilot-link developers (or yourself) to try to track down why your
|
||
|
|
Palm device is not communicating properly with pilot-link on your
|
||
|
|
machine or operating system.
|
||
|
|
|
||
|
|
|
||
|
|
Capturing the output
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
FIXME
|
||
|
|
|
||
|
|
|
||
|
|
How do I read this stuff?
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
FIXME
|
||
|
|
|
||
|
|
|
||
|
|
Now what do I do next?
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
FIXME
|
||
|
|
|
||
|
|
|
||
|
|
Donating to pilot-link
|
||
|
|
--------------------------------------------------------------------------
|
||
|
|
Do you like our work? Do you rely on the code we release for
|
||
|
|
your daily work or for your own commercial or OSS project?
|
||
|
|
|
||
|
|
Please consider donating to keep the project going. We're 100%
|
||
|
|
self-funded, and we see a LOT of traffic from users and
|
||
|
|
downloads. Every contribution helps, whether to pay for
|
||
|
|
bandwidth or to buy devices for testing.
|
||
|
|
|
||
|
|
You can help support us by visiting the pilot-link.org site and
|
||
|
|
clicking on the "Donate" button on the left side of the page.
|
||
|
|
|
||
|
|
We thank you for your contributions, whatever you can offer.
|