From: Carl Worth <cworth@cworth.org>
Date: Mon, 12 Apr 2010 21:19:15 +0000 (-0700)
Subject: lib: Fix internal documentation of _resolve_message_id_to_thread_id
X-Git-Tag: 0.2~73
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=e9bb90ba2c18ac6c36168ccb20099ef395d7dfb6

lib: Fix internal documentation of _resolve_message_id_to_thread_id

We no longer return NULL, but instead generate a new thread ID for
messages that we haven't seen yet.
---

diff --git a/lib/database.cc b/lib/database.cc
index 92234ff4..9cd46d4f 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -1138,10 +1138,13 @@ _get_metadata_thread_id_key (void *ctx, const char *message_id)
 
 /* Find the thread ID to which the message with 'message_id' belongs.
  *
- * Returns NULL if no message with message ID 'message_id' is in the
- * database.
+ * Always returns a newly talloced string belonging to 'ctx'.
  *
- * Otherwise, returns a newly talloced string belonging to 'ctx'.
+ * Note: If there is no message in the database with the given
+ * 'message_id' then a new thread_id will be allocated for this
+ * message and stored in the database metadata, (where this same
+ * thread ID can be looked up if the message is added to the database
+ * later).
  */
 static const char *
 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,