svn commit: r1589376 - /subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c

[st...@apache.org]

Author: stefan2
Date: Wed Apr 23 11:47:08 2014
New Revision: 1589376

URL: http://svn.apache.org/r1589376
Log:
* subversion/libsvn_fs_fs/fs_fs.c
  (chain_lock_baton,
   svn_fs_fs__with_all_locks): Document how the lock chain construction
                               order maps onto the lock acquisition order.
                               No functional change.

Modified:
    subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c

Modified: subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c?rev=1589376&r1=1589375&r2=1589376&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c (original)
+++ subversion/trunk/subversion/libsvn_fs_fs/fs_fs.c Wed Apr 23 11:47:08 2014
@@ -329,6 +329,9 @@ create_lock_baton(svn_fs_t *fs,
 }
 
 /* Return a baton that wraps NESTED and requests LOCK_ID as additional lock.
+ *
+ * That means, when you create a lock chain, start with the last / innermost
+ * lock to take out and add the first / outermost lock last.
  */
 static with_lock_baton_t *
 chain_lock_baton(lock_id_t lock_id,
@@ -407,7 +410,8 @@ svn_fs_fs__with_all_locks(svn_fs_t *fs,
   fs_fs_data_t *ffd = fs->fsap_data;
 
   /* Be sure to use the correct lock ordering as documented in
-     fs_fs_shared_data_t. */
+     fs_fs_shared_data_t.  The lock chain is being created in 
+     innermost (last to acquire) -> outermost (first to acquire) order. */
   with_lock_baton_t *lock_baton
     = create_lock_baton(fs, write_lock, body, baton, pool);