diff options
| author | David Bremner <david@tethera.net> | 2021-10-30 15:01:01 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-10-30 15:01:01 -0300 |
| commit | e7bb7919a2484e12cd5a672eaa21b695b7464acf (patch) | |
| tree | 3ef0170ae2eff800d499fb291d2c939e65db23d2 /lib/notmuch.h | |
| parent | e7528f9b77cb90a01502e1ad7491be71c59ba32a (diff) | |
| parent | fe51c275fcd7107d92b40de511086300ba4060ed (diff) | |
Merge branch 'release'
Diffstat (limited to 'lib/notmuch.h')
| -rw-r--r-- | lib/notmuch.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index 19391614..1b2bdf3f 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -433,6 +433,8 @@ notmuch_database_open_verbose (const char *path, * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database * argument is NULL. * + * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was found. Fatal. + * * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory. * * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the @@ -458,6 +460,9 @@ notmuch_database_open_with_config (const char *database_path, * * For description of arguments, @see notmuch_database_open_with_config * + * For errors other then NO_DATABASE and NO_CONFIG, *database is set to + * NULL. + * * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration. * * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal. @@ -489,6 +494,9 @@ notmuch_database_load_config (const char *database_path, * * For description of arguments, @see notmuch_database_open_with_config * + * In case of any failure, this function returns an error status and + * sets *database to NULL. + * * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database. * * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created |