From: Marco Bettini <marco.bettini@open-xchange.com>
Date: Fri, 29 Sep 2023 09:25:07 +0000 (+0000)
Subject: fts: fts_build_mail() - Update comment in header file
X-Git-Tag: 2.4.0~2543
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6fbca9e2ca6d89a2bc7e5004a65c8f30f3a5fcf0;p=thirdparty%2Fdovecot%2Fcore.git

fts: fts_build_mail() - Update comment in header file
---

diff --git a/src/plugins/fts/fts-build-mail.h b/src/plugins/fts/fts-build-mail.h
index aed4413f47..d2cb0fd6bd 100644
--- a/src/plugins/fts/fts-build-mail.h
+++ b/src/plugins/fts/fts-build-mail.h
@@ -1,8 +1,11 @@
 #ifndef FTS_BUILD_MAIL_H
 #define FTS_BUILD_MAIL_H
 
-/* Build indexes for the given mail. Returns 0 on success, -1 on error.
-   The error is set to mail's storage. */
+/* Build indexes for the given mail.
+   Returns -1 on error, The error is set to mail's storage.
+   Returns  0 on ignored error (retry limit reached and mail not built,
+                                see comments in function implementation)
+   Returns  1 on success */
 int fts_build_mail(struct fts_backend_update_context *update_ctx,
 		   struct mail *mail);