From: Austin Clements <amdragon@MIT.EDU>
To: notmuch@notmuchmail.org
Subject: [PATCH] lib: Fix slight misinformation in the database schema doc
Date: Thu, 31 Jul 2014 22:59:13 -0400
Message-Id: <1406861953-17358-1-git-send-email-amdragon@mit.edu>
Precedence: list

The database schema documentation made it sound like each mail
document had exactly one on-disk message file, which hasn't been true
for a long time.
---
 lib/database.cc | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/lib/database.cc b/lib/database.cc
index d90a924..c70ce63 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -55,9 +55,12 @@ 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 which the
- * database uses to construct threads, etc.:
+ * A mail document is associated with a particular email message. It
+ * is stored in one or more files on disk (though only one has its
+ * content indexed) and is uniquely identified  by its "id" field
+ * (which is generally the message ID). It is indexed with the
+ * following prefixed terms which the database uses to construct
+ * threads, etc.:
  *
  *    Single terms of given prefix:
  *
-- 
2.0.0