From: Carl Worth <cworth@cworth.org>
Date: Wed, 18 Nov 2009 02:48:38 +0000 (-0800)
Subject: database: Add "replyto" to the database schema documentation.
X-Git-Tag: 0.1~462
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=c50891f449269b7c6f235c510a472be832b95cc1

database: Add "replyto" to the database schema documentation.

Maybe ths lack of this documentation is why I forgot we were actually
storing this and wrote the ugly code to fetch In-Reply-To from message
files rather than from the database.
---

diff --git a/lib/database.cc b/lib/database.cc
index eaf52667..5b677d42 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -42,7 +42,8 @@ typedef struct {
  * Mail document
  * -------------
  * A mail document is associated with a particular email message file
- * on disk. It is indexed with the following prefixed terms:
+ * on disk. It is indexed with the following prefixed terms which the
+ * database uses to construct threads, etc.:
  *
  *    Single terms of given prefix:
  *
@@ -53,6 +54,8 @@ typedef struct {
  *
  *	thread:	The ID of the thread to which the mail belongs
  *
+ *	replyto: The ID from the In-Reply-To header of the mail (if any).
+ *
  *    Multiple terms of given prefix:
  *
  *	reference: All message IDs from In-Reply-To and Re ferences
@@ -67,6 +70,11 @@ typedef struct {
  *
  *	MESSAGE_ID:	The unique ID of the mail mess (see "id" above)
  *
+ * In addition, terms from the content of the message are added with
+ * "from", "to", "attachment", and "subject" prefixes for use by the
+ * user in searching. But the database doesn't really care itself
+ * about any of these.
+ *
  * Timestamp document
  * ------------------
  * A timestamp document is used by a client of the notmuch library to