dovecot-2.2: lib-index: Comment update

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/7bbc5c50c309
changeset: 15609:7bbc5c50c309
user:      Timo Sirainen <tss at iki.fi>
date:      Wed Jan 09 05:29:13 2013 +0200
description:
lib-index: Comment update

diffstat:

 src/lib-index/mail-index.h |  9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

diffs (19 lines):

diff -r f06419a40a06 -r 7bbc5c50c309 src/lib-index/mail-index.h
--- a/src/lib-index/mail-index.h	Wed Jan 09 05:38:13 2013 +0200
+++ b/src/lib-index/mail-index.h	Wed Jan 09 05:29:13 2013 +0200
@@ -441,10 +441,11 @@
 /* Append a new record to index. */
 void mail_index_append(struct mail_index_transaction *t, uint32_t uid,
 		       uint32_t *seq_r);
-/* Assign UIDs for mails with uid=0 or uid<first_uid. Assumes that mailbox is
-   locked in a way that UIDs can be safely assigned. Returns UIDs for all
-   asigned messages, in their sequence order (so UIDs are not necessary
-   ascending). */
+/* Assign UIDs for mails with uid=0 or uid<first_uid. All the assigned UIDs
+   are higher than the highest unassigned UID (i.e. it doesn't try to fill UID
+   gaps). Assumes that mailbox is locked in a way that UIDs can be safely
+   assigned. Returns UIDs for all asigned messages, in their sequence order
+   (so UIDs are not necessary ascending). */
 void mail_index_append_finish_uids(struct mail_index_transaction *t,
 				   uint32_t first_uid,
 				   ARRAY_TYPE(seq_range) *uids_r);