Author: danielsh
Date: Sat Feb 19 20:05:27 2011
New Revision: 1072431

URL: http://svn.apache.org/viewvc?rev=1072431&view=rev
Log:
* subversion/include/private/svn_debug.h
  (SVN_DBG):  Add a docstring.

Modified:
    subversion/trunk/subversion/include/private/svn_debug.h

Modified: subversion/trunk/subversion/include/private/svn_debug.h
URL: 
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_debug.h?rev=1072431&r1=1072430&r2=1072431&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_debug.h (original)
+++ subversion/trunk/subversion/include/private/svn_debug.h Sat Feb 19 20:05:27 
2011
@@ -74,6 +74,19 @@ svn_dbg__printf(const char *fmt, ...)
 
 #else
 
+/** Debug aid macro that prints the file:line of the call and printf-like
+ * arguments to the #SVN_DBG_OUTPUT stdio stream.  Typical usage:
+ *
+ * <pre>
+ *   SVN_DBG(("path='%s' rev=%ld\n", dirent, revnum));
+ * </pre>
+ *
+ * outputs:
+ *
+ * <pre>
+ *   kitchensink.c:42:path='/tmp/svn/wc1/iota' rev=3141592
+ * </pre>
+ */
 #define SVN_DBG(ARGS) (svn_dbg__preamble(__FILE__, __LINE__, SVN_DBG_OUTPUT), \
                        svn_dbg__printf ARGS)
 


Reply via email to