svn commit: r1670347 - in /subversion/trunk/subversion/include: svn_fs.h svn_repos.h

[st...@apache.org]

Author: stefan2
Date: Tue Mar 31 14:14:56 2015
New Revision: 1670347

URL: http://svn.apache.org/r1670347
Log:
Extend the documentation for new 1.9 FS and Repos (un-)lock-many API.

* subversion/include/svn_fs.h
  (svn_fs_lock_many,
   svn_fs_unlock_many): Note that these don't process the list of targets
                        atomically.

* subversion/include/svn_repos.h
  (svn_repos_fs_lock_many,
   svn_repos_fs_unlock_many): Same as in FS API.

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=1670347&r1=1670346&r2=1670347&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Tue Mar 31 14:14:56 2015
@@ -2743,6 +2743,9 @@ typedef svn_error_t *(*svn_fs_lock_callb
  *
  * @note At this time, only files can be locked.
  *
+ * @note This function is not atomic.  If it returns an error, some targets
+ * may remain unlocked while others may have been locked.
+ *
  * @note You probably don't want to use this directly.  Take a look at
  * svn_repos_fs_lock_many() instead.
  *
@@ -2816,6 +2819,9 @@ svn_fs_generate_lock_token(const char **
  * The path passed to lock_callback will be allocated in @a result_pool.
  * Use @a scratch_pool for temporary allocations.
  *
+ * @note This function is not atomic.  If it returns an error, some targets
+ * may remain locked while others may have been unlocked.
+ *
  * @note You probably don't want to use this directly.  Take a look at
  * svn_repos_fs_unlock_many() instead.
  *

Modified: subversion/trunk/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1670347&r1=1670346&r2=1670347&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Tue Mar 31 14:14:56 2015
@@ -2283,6 +2283,9 @@ svn_repos_fs_begin_txn_for_update(svn_fs
  * The lock and path passed to @a lock_callback will be allocated in
  * @a result_pool.  Use @a scratch_pool for temporary allocations.
  *
+ * @note This function is not atomic.  If it returns an error, some targets
+ * may remain unlocked while others may have been locked.
+ *
  * @see svn_fs_lock_many
  *
  * @since New in 1.9.
@@ -2339,6 +2342,9 @@ svn_repos_fs_lock(svn_lock_t **lock,
  * The path passed to @a lock_callback will be allocated in @a result_pool.
  * Use @a scratch_pool for temporary allocations.
  *
+ * @note This function is not atomic.  If it returns an error, some targets
+ * may remain locked while others may have been unlocked.
+ *
  * @see svn_fs_unlock_many
  *
  * @since New in 1.9.