X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=786b8e9f034d4ec73352687b13699319208a9397;hb=154bf7ac677c41168c5c6a982fee3f22350adfef;hp=a98241de8878b7542c5e09a3805c4578ee671314;hpb=9257622da8ed50502e59adec69e5daa043ef242a;p=obsolete%2Fnotmuch-old

diff --git a/lib/notmuch.h b/lib/notmuch.h
index a98241de..786b8e9f 100644
--- 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