Author: philip
Date: Wed Mar 26 17:28:56 2014
New Revision: 1581956
URL: http://svn.apache.org/r1581956
Log:
Documentation update for multiple path lock/unlock.
* subversion/include/svn_fs.h
(struct svn_fs_lock_target_t, struct svn_fs_lock_result_t): Add @since.
* subversion/include/svn_repos.h
(svn_repos_fs_unlock2, svn_repos_fs_lock): Adjust documentation.
Modified:
subversion/trunk/subversion/include/svn_fs.h
subversion/trunk/subversion/include/svn_repos.h
Modified: subversion/trunk/subversion/include/svn_fs.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1581956&r1=1581955&r2=1581956&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Wed Mar 26 17:28:56 2014
@@ -2513,7 +2513,10 @@ svn_fs_set_uuid(svn_fs_t *fs,
*/
/** The @a targets hash passed to svn_fs_lock2() has <tt>const char
- *</tt> keys and <tt>svn_fs_lock_target_t *</tt> values. */
+ * *</tt> keys and <tt>svn_fs_lock_target_t *</tt> values.
+ *
+ * @since New in 1.9.
+ */
typedef struct svn_fs_lock_target_t
{
const char *token;
@@ -2522,8 +2525,11 @@ typedef struct svn_fs_lock_target_t
} svn_fs_lock_target_t;
/** The @a results hash returned by svn_fs_lock2() and svn_fs_unlock2()
- has <tt>const char *</tt> keys and <tt>svn_fs_lock_result_t *</tt>
- values. */
+ * has <tt>const char *</tt> keys and <tt>svn_fs_lock_result_t *</tt>
+ * values.
+ *
+ * @since New in 1.9.
+ */
typedef struct svn_fs_lock_result_t
{
svn_lock_t *lock;
Modified: subversion/trunk/subversion/include/svn_repos.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1581956&r1=1581955&r2=1581956&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Wed Mar 26 17:28:56 2014
@@ -2238,13 +2238,20 @@ svn_repos_fs_lock(svn_lock_t **lock,
* post-unlock hooks before and after the unlocking action. Use @a
* pool for any necessary allocations.
*
- * If the pre-unlock hook or svn_fs_unlock() fails, throw the original
- * error to caller. If an error occurs when running the post-unlock
- * hook, return the original error wrapped with
- * SVN_ERR_REPOS_POST_UNLOCK_HOOK_FAILED. If the caller sees this
- * error, it knows that the unlock succeeded anyway.
+ * The pre-unlock hook is run for every path in @a targets. Those
+ * entries in @a targets for which the pre-unlock is successful are
+ * passed to svn_fs_unlock2 and the post-unlock is run for those that
+ * are successfully unlocked.
+ *
+ * @a results contains the result of of running the pre-unlock and
+ * svn_fs_unlock2 if the pre-unlock was successful. If an error occurs
+ * when running the post-unlock hook, return the original error
+ * wrapped with SVN_ERR_REPOS_POST_UNLOCK_HOOK_FAILED. If the caller
+ * sees this error, it knows that some unlocks succeeded. In all
+ * cases the caller must handle all error in @a results to avoid
+ * leaks.
*
- * @since New in 1.2.
+ * @since New in 1.9.
*/
svn_error_t *
svn_repos_fs_unlock2(apr_hash_t **results,
@@ -2254,6 +2261,10 @@ svn_repos_fs_unlock2(apr_hash_t **result
apr_pool_t *result_pool,
apr_pool_t *scratch_pool);
+/* Similar to svn_repos_fs_unlock2 but only unlocks a single path.
+ *
+ * @since New in 1.2.
+ */
svn_error_t *
svn_repos_fs_unlock(svn_repos_t *repos,
const char *path,
