summaryrefslogtreecommitdiff
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2009-12-19 13:11:00 -0800
committerCarl Worth <cworth@cworth.org>2010-01-06 10:32:05 -0800
commit154bf7ac677c41168c5c6a982fee3f22350adfef (patch)
tree43123ac6b204ac8c7727d80fc688926b0f2773a4 /lib/notmuch.h
parent9257622da8ed50502e59adec69e5daa043ef242a (diff)
database: Store directory paths as relative, not absolute.
We were already storing relative mail filenames, so this is consistent with that. Additionally, it means that directory documents remain valid even if the database is relocated within its containing filesystem.
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index a98241d..786b8e9 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -180,6 +180,11 @@ notmuch_database_get_path (notmuch_database_t *database);
/* Store an mtime within the database for 'path'.
*
+ * Here,'path' should be the path of a directory relative to the path
+ * of 'database' (see notmuch_database_get_path), or else should be an
+ * absolute path with initial components that match the path of
+ * 'database'.
+ *
* The intention is for the caller to use the mtime to allow efficient
* identification of new messages to be added to the database. The
* recommended usage is as follows: