From: Carl Worth <cworth@cworth.org>
Date: Sat, 19 Dec 2009 21:05:06 +0000 (-0800)
Subject: lib: Document that the filename is stored in the 'data' of a mail document
X-Git-Tag: 0.1~199
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9257622da8ed50502e59adec69e5daa043ef242a;p=notmuch.git

lib: Document that the filename is stored in the 'data' of a mail document

Our database schema documentation previously didn't give any
indication of where this most essential piece of information is
stored.
---

diff --git a/lib/database.cc b/lib/database.cc
index 7efd3b4a..f7f9943f 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -75,6 +75,9 @@ typedef struct {
  * user in searching. But the database doesn't really care itself
  * about any of these.
  *
+ * Finally, the data portion of a mail document contains the path name
+ * of the mail message (relative to the database path).
+ *
  * Directory document
  * ------------------
  * A directory document is used by a client of the notmuch library to