database: Store directory paths as relative, not absolute.

[obsolete/notmuch-old] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index a98241de8878b7542c5e09a3805c4578ee671314..786b8e9f034d4ec73352687b13699319208a9397 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -179,6 +179,11 @@ const char *
 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