Author: kotkov
Date: Fri Jun 26 14:17:53 2015
New Revision: 1687776
URL: http://svn.apache.org/r1687776
Log:
Following up on r1687769, extend the documentation about the lifetime of
the error passed to the new verify callback, and about who is responsible
for clearing it.
No functional changes.
* subversion/include/svn_repos.h
(svn_repos_verify_callback_t): Document the lifetime of 'verify_err'.
(svn_repos_verify_fs3): Include a @see link to svn_repos_verify_callback_t
for the convenience of a person crawling through the documentation.
Modified:
subversion/trunk/subversion/include/svn_repos.h
Modified: subversion/trunk/subversion/include/svn_repos.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1687776&r1=1687775&r2=1687776&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Fri Jun 26 14:17:53 2015
@@ -2824,6 +2824,12 @@ enum svn_repos_load_uuid
* provided for the convenience of the implementor, who should not
* expect it to live longer than a single callback call.
*
+ * @a verify_err will be cleared and becomes invalid after the callback
+ * returns, use svn_error_dup() to preserve the error. If a callback uses
+ * @a verify_err as the return value or as a part of the return value, it
+ * should also call svn_error_dup() for @a verify_err. Implementors of this
+ * callback are forbidden to call svn_error_clear() for @a verify_err.
+ *
* @see svn_repos_verify_fs3
*
* @since New in 1.9.
@@ -2899,6 +2905,8 @@ typedef svn_error_t *(*svn_repos_verify_
*
* Use @a scratch_pool for temporary allocation.
*
+ * @see svn_repos_verify_callback_t
+ *
* @since New in 1.9.
*/
svn_error_t *
