dovecot-2.2: lib: file_lock_try_update() comment updated.

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/c792d026d3fa
changeset: 18745:c792d026d3fa
user:      Timo Sirainen <tss at iki.fi>
date:      Sun May 24 13:40:46 2015 -0400
description:
lib: file_lock_try_update() comment updated.
It should possibly be removed entirely from the API.

diffstat:

 src/lib/file-lock.h |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diffs (13 lines):

diff -r 57f8c2a6209b -r c792d026d3fa src/lib/file-lock.h
--- a/src/lib/file-lock.h	Sun May 24 13:24:19 2015 -0400
+++ b/src/lib/file-lock.h	Sun May 24 13:40:46 2015 -0400
@@ -42,7 +42,8 @@
 			 enum file_lock_method lock_method,
 			 unsigned int timeout_secs,
 			 struct file_lock **lock_r, const char **error_r);
-/* Change the lock type. */
+/* Change the lock type. WARNING: This isn't an atomic operation!
+   The result is the same as file_unlock() + file_try_lock(). */
 int file_lock_try_update(struct file_lock *lock, int lock_type);
 
 /* Unlock and free the lock. */