debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 04:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: correct deprecated db open functions' docs

Browse source 
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.
This commit is contained in:
Austin Ray 2021-08-14 18:39:17 -04:00 committed by David Bremner
parent af56f3bcdc
commit 414ba75c81
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/notmuch.h
View file

@ -316,7 +316,7 @@ typedef enum {
/** /**
* Deprecated alias for notmuch_database_open_with_config with * 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) * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
*/ */
/* NOTMUCH_DEPRECATED(5, 4) */ /* NOTMUCH_DEPRECATED(5, 4) */
@ -326,7 +326,7 @@ notmuch_database_open (const char *path,
notmuch_database_t **database); notmuch_database_t **database);
/** /**
* Deprecated alias for notmuch_database_open_with_config with * Deprecated alias for notmuch_database_open_with_config with
* config_path=NULL * config_path=""
* *
* @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32) * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
* *