summaryrefslogtreecommitdiff
path: root/lib/database.cc
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2009-12-19 13:05:06 -0800
committerCarl Worth <cworth@cworth.org>2010-01-06 10:32:05 -0800
commit9257622da8ed50502e59adec69e5daa043ef242a (patch)
tree7888a168d36305a87cb7d86ada4f09fec1b979e4 /lib/database.cc
parent50ae83a17feb1fc2f48fb8e51ef73da08ae4e2f2 (diff)
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.
Diffstat (limited to 'lib/database.cc')
-rw-r--r--lib/database.cc3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/database.cc b/lib/database.cc
index 7efd3b4..f7f9943 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