gallium: Document debug_printf usage.

1 files changed, 14 insertions, 0 deletions

diff --git a/src/gallium/include/pipe/p_debug.h b/src/gallium/include/pipe/p_debug.h
index 2a11627b365..a14a1fc5f6c 100644
--- a/src/gallium/include/pipe/p_debug.h
+++ b/src/gallium/include/pipe/p_debug.h
@@ -58,8 +58,22 @@ extern "C" {
 #endif
 
 
+/**
+ * Print debug messages.
+ *
+ * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
+ *
+ * The actual channel used to output debug message is platform specific. To 
+ * avoid misformating or truncation, follow these rules of thumb:   
+ * - output whole lines
+ * - avoid outputing large strings (512 bytes is the current maximum length 
+ * that is guaranteed to be printed in all platforms)
+ */
 void debug_printf(const char *format, ...);
 
+/**
+ * @sa debug_printf 
+ */
 void debug_vprintf(const char *format, va_list ap);
 
 void debug_assert_fail(const char *expr, const char *file, unsigned line);