]> git.notmuchmail.org Git - notmuch/commitdiff
lib: correct deprecated db open functions' docs
authorAustin Ray <austin@austinray.io>
Sat, 14 Aug 2021 22:39:17 +0000 (18:39 -0400)
committerDavid Bremner <david@tethera.net>
Tue, 17 Aug 2021 23:30:05 +0000 (16:30 -0700)
Both notmuch_database_open() and notmuch_database_open_verbose()'s
documentation state they call notmuch_database_open_with_config() with
config_path=NULL; however, their implementations pass an empty string.
The empty string is the correct value to maintain their original
behavior of not loading the user's configuration so their documentation
is incorrect.

lib/notmuch.h

index 4b0539323da826d99aea2875cd0fd1583b60fb33..c0fa176833cd138ff6ffaf33771997247f99da24 100644 (file)
@@ -316,7 +316,7 @@ typedef enum {
 
 /**
  * Deprecated alias for notmuch_database_open_with_config with
- * config_path=error_message=NULL
+ * config_path="" and error_message=NULL
  * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
  */
 /* NOTMUCH_DEPRECATED(5, 4) */
@@ -326,7 +326,7 @@ notmuch_database_open (const char *path,
                       notmuch_database_t **database);
 /**
  * Deprecated alias for notmuch_database_open_with_config with
- * config_path=NULL
+ * config_path=""
  *
  * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
  *