From 82de6336d88be43de759b94634e87b9e4a8391b1 Mon Sep 17 00:00:00 2001
From: Benjamin Otte <otte@redhat.com>
Date: Tue, 6 Jul 2010 00:48:36 +0200
Subject: test: Add note about how to fix failures to api-special-cases

---
 test/api-special-cases.c | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'test/api-special-cases.c')

diff --git a/test/api-special-cases.c b/test/api-special-cases.c
index b4b4c0a9c..3a1d7e9aa 100644
--- a/test/api-special-cases.c
+++ b/test/api-special-cases.c
@@ -48,6 +48,12 @@
  *    - TRUE if the function modifies the surface, FALSE otherwise
  *    - the surface type for which the function is valid or -1 if it is valid
  *      for all surface types.
+ *
+ * FIXING FAILURES
+ *
+ * The test will dump failures notices into the api-special-cases.log file (when 
+ * it doesn't crash). These should be pretty self-explanatory. Usually it is 
+ * enough to just add a new check to the function it complained about.
  */
 
 #ifdef HAVE_CONFIG_H
-- 
cgit v1.2.1