lib-storage: Clarify what MAIL_LOOKUP_ABORT_READ_MAIL means.

It should maybe even be renamed to something clearer.

diff --git a/src/lib-storage/mail-storage.h b/src/lib-storage/mail-storage.h
index 6c8890238ff9f1915dae167c0deb0dc835361eed..d7dca071f41aa8ea151bdc715fa526937babb306 100644 (file)
--- a/src/lib-storage/mail-storage.h
+++ b/src/lib-storage/mail-storage.h
@@ -364,7 +364,10 @@ ARRAY_DEFINE_TYPE(mailbox_expunge_rec, struct mailbox_expunge_rec);
 enum mail_lookup_abort {
        /* Perform everything no matter what it takes */
        MAIL_LOOKUP_ABORT_NEVER = 0,
-       /* Abort if the operation would require reading message header/body */
+       /* Abort if the operation would require reading message header/body or
+          otherwise opening the mail file (e.g. with dbox metadata is read by
+          opening and reading the file). This still allows somewhat fast
+          operations to be performed, such as stat()ing a file. */
        MAIL_LOOKUP_ABORT_READ_MAIL,
        /* Abort if the operation can't be done fully using cache file */
        MAIL_LOOKUP_ABORT_NOT_IN_CACHE