lib: clarify description of notmuch_database_add_message
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Thu, 17 Aug 2017 23:14:24 +0000 (19:14 -0400)
committerDavid Bremner <david@tethera.net>
Sun, 20 Aug 2017 11:33:46 +0000 (08:33 -0300)
Since we're accumulating the index when we add a new file to the
message, the semantics have slightly changed.  This tries to align the
documentation with the actual functionality.

lib/notmuch.h

index f78b34732092e417a15b1b17ba40c3eda245e22c..02586a9126e3033c53bab1ea4d08a5b4752ceeda 100644 (file)
@@ -542,8 +542,10 @@ notmuch_database_get_directory (notmuch_database_t *database,
                                notmuch_directory_t **directory);
 
 /**
- * Add a new message to the given notmuch database or associate an
- * additional filename with an existing message.
+ * Add a message file to a database, indexing it for retrieval by
+ * future searches.  If a message already exists with the same message
+ * ID as the specified file, their indexes will be merged, and this
+ * new filename will also be associated with the existing message.
  *
  * Here, 'filename' should be a path relative to the path of
  * 'database' (see notmuch_database_get_path), or else should be an
@@ -556,8 +558,9 @@ notmuch_database_get_directory (notmuch_database_t *database,
  * entire contents of the file.
  *
  * If another message with the same message ID already exists in the
- * database, rather than creating a new message, this adds 'filename'
- * to the list of the filenames for the existing message.
+ * database, rather than creating a new message, this adds the search
+ * terms from the identified file to the existing message's index, and
+ * adds 'filename' to the list of filenames known for the message.
  *
  * If 'message' is not NULL, then, on successful return
  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'