src/inc/errCatch.h 1.3

Index: src/inc/errCatch.h
===================================================================
RCS file: /projects/compbio/cvsroot/kent/src/inc/errCatch.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -b -B -U 1000000 -r1.2 -r1.3
--- src/inc/errCatch.h	10 Aug 2006 01:02:47 -0000	1.2
+++ src/inc/errCatch.h	29 Apr 2010 03:15:15 -0000	1.3
@@ -1,56 +1,56 @@
 /* errCatch - help catch errors so that errAborts aren't
  * fatal, and warn's don't necessarily get printed immediately. 
  * Note that error conditions caught this way will tend to
  * leak resources unless there are additional wrappers. 
  *
  * Typical usage is
  * errCatch = errCatchNew();
  * if (errCatchStart(errCatch))
  *     doFlakyStuff();
  * errCatchEnd(errCatch);
  * if (errCatch->gotError)
- *     warn(errCatch->message->string);
+ *     warn("Flaky stuff failed: %s", errCatch->message->string);
  * errCatchFree(&errCatch); 
  * cleanupFlakyStuff();
  */
 #ifndef ERRCATCH_H
 #define ERRCATCH_H
 
 #ifndef DYSTRING_H
     #include "dystring.h"
 #endif
 
 struct errCatch
 /* Something to help catch errors.   */
     {
     struct errCatch *next;	 /* Next in stack. */
     jmp_buf jmpBuf;		 /* Where to jump back to for recovery. */
     struct dyString *message; /* Error message if any */
     boolean gotError;		 /* Some sort of error was caught. */
     };
 
 struct errCatch *errCatchNew();
 /* Return new error catching structure. */
 
 void errCatchFree(struct errCatch **pErrCatch);
 /* Free up resources associated with errCatch */
 
 #define errCatchStart(e) (errCatchPushHandlers(e) && setjmp(e->jmpBuf) == 0)
 /* Little wrapper around setjmp.  This returns TRUE
  * on the main execution thread, FALSE after abort. */
 
 
 boolean errCatchPushHandlers(struct errCatch *errCatch);
 /* Push error handlers.  Not usually called directly. 
  * but rather through errCatchStart() macro.  Always
  * returns TRUE. */
 
 void errCatchEnd(struct errCatch *errCatch);
 /* Restore error handlers and pop self off of catching stack. */
 
 boolean errCatchFinish(struct errCatch **pErrCatch);
 /* Finish up error catching.  Report error if there is a
  * problem and return FALSE.  If no problem return TRUE.
  * This handles errCatchEnd and errCatchFree. */
 #endif /* ERRCATCH_H */