You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@subversion.apache.org by ju...@apache.org on 2011/06/23 16:35:08 UTC

svn commit: r1138902 - /subversion/trunk/subversion/include/svn_error.h

Author: julianfoad
Date: Thu Jun 23 14:35:08 2011
New Revision: 1138902

URL: http://svn.apache.org/viewvc?rev=1138902&view=rev
Log:
* subversion/include/svn_error.h
  (svn_error_return): Tweak doc string for accuracy.

Modified:
    subversion/trunk/subversion/include/svn_error.h

Modified: subversion/trunk/subversion/include/svn_error.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_error.h?rev=1138902&r1=1138901&r2=1138902&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_error.h (original)
+++ subversion/trunk/subversion/include/svn_error.h Thu Jun 23 14:35:08 2011
@@ -306,9 +306,10 @@ svn_handle_warning(FILE *stream,
   } while (0)
 
 /**
- * A statement macro for returning error values.
+ * A macro for wrapping an error in a source-location trace message.
  *
- * This macro can be used when directly returning an error to ensure
+ * This macro can be used when directly returning an already created
+ * error (when not using SVN_ERR, svn_error_create(), etc.) to ensure
  * that the call stack is recorded correctly.
  *
  * @since New in 1.7.