From: Austin Ray <austin@austinray.io>
Date: Sat, 14 Aug 2021 22:39:17 +0000 (-0400)
Subject: lib: correct deprecated db open functions' docs
X-Git-Tag: 0.32.3~8
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=414ba75c81133fb9b6390d79bd40e3d8fb83a269

lib: correct deprecated db open functions' docs

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.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 4b053932..c0fa1768 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -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)
  *