Chapter 8. Debug Logging

Written by Dimitrie O. Paun , 28 Mar 1998

(Extracted from wine/documentation/debug-msgs)

Note

The new debugging interface can be considered to be stable, with the exception of the in-memory message construction functions. However, there is still a lot of work to be done to polish things up. To make my life easier, please follow the guidelines described in this document.

Important

Read this document before writing new code. DO NOT USE fprintf (or printf) to output things. Also, instead of writing FIXMEs in the source, output a FIXME message if you can.

At the end of the document, there is a "Style Guide" for debugging messages. Please read it.

8.1. Debugging classes

There are 4 types (or classes) of debugging messages:

The user has the capability to turn on or off messages of a particular type. You can expect the following patterns of usage (but note that any combination is possible):

Of course, the user will have the runtime ability to override these defaults. However, this ability may be turned off and certain classes of messages may be completely disabled at compile time to reduce the size of Wine.