lib: Document that the filename is stored in the 'data' of a mail document
authorCarl Worth <cworth@cworth.org>
Sat, 19 Dec 2009 21:05:06 +0000 (13:05 -0800)
committerCarl Worth <cworth@cworth.org>
Wed, 6 Jan 2010 18:32:05 +0000 (10:32 -0800)
Our database schema documentation previously didn't give any
indication of where this most essential piece of information is
stored.

lib/database.cc

index 7efd3b4ae3c1dea17833de6e1dba9f8cc9cbf536..f7f9943f8a5ac6e03e90c40640b9198d95a2b8cf 100644 (file)
@@ -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