dovecot-2.2: lib-storage: Comment update for mail_prefetch()

[dovecot at dovecot.org]

details:   http://hg.dovecot.org/dovecot-2.2/rev/f64a91637f9b
changeset: 15411:f64a91637f9b
user:      Timo Sirainen <tss at iki.fi>
date:      Mon Nov 26 23:19:04 2012 +0200
description:
lib-storage: Comment update for mail_prefetch()

diffstat:

 src/lib-storage/mail-storage-private.h |  4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diffs (14 lines):

diff -r b0bda8a2d178 -r f64a91637f9b src/lib-storage/mail-storage-private.h
--- a/src/lib-storage/mail-storage-private.h	Mon Nov 26 23:18:30 2012 +0200
+++ b/src/lib-storage/mail-storage-private.h	Mon Nov 26 23:19:04 2012 +0200
@@ -575,7 +575,9 @@
 void mail_storage_copy_error(struct mail_storage *dest,
 			     struct mail_storage *src);
 
-/* Returns TRUE if everything should already be in memory after this call. */
+/* Returns TRUE if everything should already be in memory after this call
+   or if prefetching is not supported, i.e. the caller shouldn't do more
+   prefetching before this message is handled. */
 bool mail_prefetch(struct mail *mail);
 void mail_set_aborted(struct mail *mail);
 void mail_set_expunged(struct mail *mail);