diff options
| author | David Bremner <david@tethera.net> | 2021-10-23 10:22:37 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-10-30 13:49:37 -0300 |
| commit | 8f0b84789d4fda0182e073b68b73160c9b94a4b7 (patch) | |
| tree | 30d3a2f9f0ecf651a516064493c1349855949f75 /lib/notmuch.h | |
| parent | 2ba50b52302dce08068843e0029f9ee935a0d7f3 (diff) | |
lib/load_config: document expectations for db on error, add tests
This is a bit different than n_d_{open,create}_with_config, since
there are several non-zero status codes where we do want to return a
non-NULL database structure.
Diffstat (limited to 'lib/notmuch.h')
| -rw-r--r-- | lib/notmuch.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index 316385b8..5c5a024e 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -460,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. |