X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=786b8e9f034d4ec73352687b13699319208a9397;hb=4c1cca888fc89cd5c072a2df609d6d6d47acdfaf;hp=60834fb50bb687da9d097ed5b41c15f394554854;hpb=6da656657621febf2d5b9e1ba69c8856f9882140;p=notmuch

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 60834fb5..786b8e9f 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -178,56 +178,56 @@ notmuch_database_close (notmuch_database_t *database);
 const char *
 notmuch_database_get_path (notmuch_database_t *database);
 
-/* Store a timestamp within the database.
+/* Store an mtime within the database for 'path'.
  *
- * The Notmuch database will not interpret this key nor the timestamp
- * values at all. It will merely store them together and return the
- * timestamp when notmuch_database_get_timestamp is called with the
- * same value for 'key'.
+ * 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 timestamp to allow
- * efficient identification of new messages to be added to the
- * database. The recommended usage is as follows:
+ * 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:
  *
  *   o Read the mtime of a directory from the filesystem
  *
  *   o Call add_message for all mail files in the directory
  *
- *   o Call notmuch_database_set_timestamp with the path of the
- *     directory as 'key' and the originally read mtime as 'value'.
+ *   o Call notmuch_database_set_directory_mtime
  *
  * Then, when wanting to check for updates to the directory in the
- * future, the client can call notmuch_database_get_timestamp and know
- * that it only needs to add files if the mtime of the directory and
- * files are newer than the stored timestamp.
+ * future, the client can call notmuch_database_get_directory_mtime
+ * and know that it only needs to add files if the mtime of the
+ * directory and files are newer than the stored timestamp.
  *
- * Note: The notmuch_database_get_timestamp function does not allow
- * the caller to distinguish a timestamp of 0 from a non-existent
- * timestamp. So don't store a timestamp of 0 unless you are
- * comfortable with that.
+ * Note: The notmuch_database_get_directory_mtime function does not
+ * allow the caller to distinguish a timestamp of 0 from a
+ * non-existent timestamp. So don't store a timestamp of 0 unless you
+ * are comfortable with that.
  *
  * Return value:
  *
- * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
+ * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
  *
  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
- *	occurred. Timestamp not stored.
+ *	occurred, mtime not stored.
  */
 notmuch_status_t
-notmuch_database_set_timestamp (notmuch_database_t *database,
-				const char *key, time_t timestamp);
+notmuch_database_set_directory_mtime (notmuch_database_t *database,
+				      const char *path,
+				      time_t mtime);
 
-/* Retrieve a timestamp from the database.
+/* Retrieve the mtime from the database for 'path'.
  *
- * Returns the timestamp value previously stored by calling
- * notmuch_database_set_timestamp with the same value for 'key'.
+ * Returns the mtime value previously stored by calling
+ * notmuch_database_set_directory_mtime with the same 'path'.
  *
- * Returns 0 if no timestamp is stored for 'key' or if any error
- * occurred querying the database.
+ * Returns 0 if no mtime is stored for 'path' or if any error occurred
+ * querying the database.
  */
 time_t
-notmuch_database_get_timestamp (notmuch_database_t *database,
-				const char *key);
+notmuch_database_get_directory_mtime (notmuch_database_t *database,
+				      const char *path);
 
 /* Add a new message to the given notmuch database.
  *