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

[bl...@apache.org]

Author: blair
Date: Wed Dec 22 00:22:52 2010
New Revision: 1051713

URL: http://svn.apache.org/viewvc?rev=1051713&view=rev
Log:
Another documentation improvement.

Suggested by: danielsh

* subversion/include/svn_error.h
  (svn_error_find_cause):
    Document that the input error should not be cleared because the
    output one shares memory with it.

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=1051713&r1=1051712&r2=1051713&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_error.h (original)
+++ subversion/trunk/subversion/include/svn_error.h Wed Dec 22 00:22:52 2010
@@ -194,7 +194,9 @@ svn_error_t *
 svn_error_root_cause(svn_error_t *err);
 
 /** Return the first error in @a err's chain that has an error code @a
- * apr_err or #SVN_NO_ERROR if there is no error with that code.
+ * apr_err or #SVN_NO_ERROR if there is no error with that code.  @a
+ * err should *not* be cleared as the returned error shares memory
+ * with @a err.
  *
  * If @a err is #SVN_NO_ERROR, return #SVN_NO_ERROR.
  *