]> git.notmuchmail.org Git - notmuch/commitdiff
lib: Fix slight misinformation in the database schema doc
authorAustin Clements <amdragon@MIT.EDU>
Fri, 1 Aug 2014 02:59:13 +0000 (22:59 -0400)
committerDavid Bremner <david@tethera.net>
Mon, 4 Aug 2014 21:58:11 +0000 (18:58 -0300)
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

index 45c42607802d79db683f7cb77683d68aaa831a4a..c76029067f4c28b32933e26e432713f39becd4b0 100644 (file)
@@ -54,9 +54,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:
  *