Add ENVIRONMENT VARIABLES section to the man page

[notmuch] / lib / notmuch.h

diff --git a/lib/notmuch.h b/lib/notmuch.h
index d8508dfd682821bdeaed809e622a71db1635086f..d3e50a79536c37283e3cd42fc74b5e7c79ad1d88 100644 (file)
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -204,15 +204,14 @@ notmuch_database_needs_upgrade (notmuch_database_t *database);
  *
  * The optional progress_notify callback can be used by the caller to
  * provide progress indication to the user. If non-NULL it will be
- * called periodically with 'count' as the number of messages upgraded
- * so far and 'total' the overall number of messages that will be
- * converted.
+ * called periodically with 'progress' as a floating-point value in
+ * the range of [0.0 .. 1.0] indicating the progress made so far in
+ * the upgrade process.
  */
 notmuch_status_t
 notmuch_database_upgrade (notmuch_database_t *database,
                          void (*progress_notify) (void *closure,
-                                                  unsigned int count,
-                                                  unsigned int total),
+                                                  double progress),
                          void *closure);
 
 /* Retrieve a directory object from the database for 'path'.
@@ -865,7 +864,7 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);
  * notmuch_message_remove_all_tags), will not be committed to the
  * database until the message is thawed with notmuch_message_thaw.
  *
- * Multiple calls to freeze/thaw are valid and these calls with
+ * Multiple calls to freeze/thaw are valid and these calls will
  * "stack". That is there must be as many calls to thaw as to freeze
  * before a message is actually thawed.
  *
@@ -883,7 +882,7 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);
  *    notmuch_message_thaw (message);
  *
  * With freeze/thaw used like this, the message in the database is
- * guaranteed to have either the full set of original tag value, or
+ * guaranteed to have either the full set of original tag values, or
  * the full set of new tag values, but nothing in between.
  *
  * Imagine the example above without freeze/thaw and the operation