[PATCH 1/6] lib: Correct out-of-date doc comment
Austin Clements
amdragon at MIT.EDU
Mon Aug 12 11:40:34 PDT 2013
notmuch_message_get_header started returning some headers straight
from the database in 567bcbc, but this comment explicitly claimed all
headers were read from the message file.
---
lib/notmuch.h | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 73c85a4..9fc34ef 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -1015,8 +1015,11 @@ notmuch_message_get_date (notmuch_message_t *message);
/* Get the value of the specified header from 'message'.
*
- * The value will be read from the actual message file, not from the
- * notmuch database. The header name is case insensitive.
+ * Common headers are stored in the database when the message is
+ * indexed and will be returned from the database. Other headers will
+ * be read from the actual message file.
+ *
+ * The header name is case insensitive.
*
* The returned string belongs to the message so should not be
* modified or freed by the caller (nor should it be referenced after
--
1.7.10.4
More information about the notmuch
mailing list