svn commit: r1439214 - /subversion/trunk/subversion/include/svn_fs.h

[st...@apache.org]

Author: stefan2
Date: Mon Jan 28 00:30:06 2013
New Revision: 1439214

URL: http://svn.apache.org/viewvc?rev=1439214&view=rev
Log:
* subversion/include/svn_fs.h
  (svn_fs_verify,
   svn_fs_verify_rev): make their relationship clear in the docstrings

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

Modified: subversion/trunk/subversion/include/svn_fs.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1439214&r1=1439213&r2=1439214&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Mon Jan 28 00:30:06 2013
@@ -300,6 +300,13 @@ typedef void (*svn_fs_progress_notify_fu
  * svn_repos_verify_fs2() instead, which does non-backend-specific
  * verifications as well.
  *
+ * @note To ensure a full verification using all tests and covering all
+ * revisions, you must call this function *and* #svn_fs_verify_rev.
+ * 
+ * @note Implementors, please do tests that can be done efficiently for
+ * a single revision to #svn_fs_verify_rev.  This function is meant for
+ * global checks or tests that require an expensive context setup.
+ *
  * @since New in 1.8.
  */
 svn_error_t *
@@ -321,6 +328,13 @@ svn_fs_verify(const char *path,
  * svn_repos_verify_fs2() instead, which does non-backend-specific
  * verifications as well.
  *
+* @note To ensure a full verification using all tests and covering all
+ * revisions, you must call this function *and* #svn_fs_verify.
+ *
+ * @note Implementors, please do tests that cannot be done efficiently for
+ * a single revision to #svn_fs_verify.  This function is meant for local
+ * checks that don't require an expensive context setup.
+ *
  * @since New in 1.8.
  */
 svn_error_t *