Merge changes from CUPS 1.4svn-r8540.

[thirdparty/cups.git] / cups / debug.h

diff --git a/cups/debug.h b/cups/debug.h
index 0d81b46cb12a89f1155f2ee39a0b0b52b9718993..e13335bfce523267748582bfa276511356ce9ee7 100644 (file)
--- a/cups/debug.h
+++ b/cups/debug.h
@@ -3,7 +3,7 @@
  *
  *   Debugging macros for the Common UNIX Printing System (CUPS).
  *
- *   Copyright 2007-2008 by Apple Inc.
+ *   Copyright 2007-2009 by Apple Inc.
  *   Copyright 1997-2005 by Easy Software Products.
  *
  *   These coded instructions, statements, and computer programs are the
@@ -36,6 +36,24 @@ extern "C" {
  *   DEBUG_printf(("format string", arg, arg, ...));
  *
  * Note the extra parenthesis around the DEBUG_printf macro...
+ *
+ * Newlines are not required on the end of messages, as both add one when
+ * writing the output.
+ *
+ * If the first character is a digit, then it represents the "log level" of the
+ * message from 0 to 9.  The default level is 1.  The following defines the
+ * current levels we use:
+ *
+ * 0 = public APIs, other than value accessor functions
+ * 1 = return values for public APIs
+ * 2 = public value accessor APIs, progress for public APIs
+ * 3 = return values for value accessor APIs
+ * 4 = private APIs, progress for value accessor APIs
+ * 5 = return values for private APIs
+ * 6 = progress for private APIs
+ * 7 = static functions
+ * 8 = return values for static functions
+ * 9 = progress for static functions
  */
 
 #  ifdef DEBUG