From: Timo Sirainen <timo.sirainen@dovecot.fi>
Date: Thu, 25 Jan 2018 10:35:35 +0000 (+0200)
Subject: lib-index: Update comments for mail_cache_decision_*()
X-Git-Tag: 2.2.35~109
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5698200906ae3a19eabe0d1bc5dbd2879658b57b;p=thirdparty%2Fdovecot%2Fcore.git

lib-index: Update comments for mail_cache_decision_*()
---

diff --git a/src/lib-index/mail-cache-private.h b/src/lib-index/mail-cache-private.h
index 8529f72db5..38be5559ab 100644
--- a/src/lib-index/mail-cache-private.h
+++ b/src/lib-index/mail-cache-private.h
@@ -250,9 +250,14 @@ void mail_cache_file_close(struct mail_cache *cache);
 int mail_cache_reopen(struct mail_cache *cache);
 
 /* Notify the decision handling code that field was looked up for seq.
-   This should be called even for fields that aren't currently in cache file */
+   This should be called even for fields that aren't currently in cache file.
+   This is used to update caching decisions for fields that already exist
+   in the cache file. */
 void mail_cache_decision_state_update(struct mail_cache_view *view,
 				      uint32_t seq, unsigned int field);
+/* Notify the decision handling code when field is committed to cache.
+   If this is the first time the field is added to cache, its caching decision
+   is updated to TEMP. */
 void mail_cache_decision_add(struct mail_cache_view *view, uint32_t seq,
 			     unsigned int field);