diff options
| author | David Bremner <david@tethera.net> | 2021-10-23 10:22:35 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-10-30 13:45:40 -0300 |
| commit | f3fcdd2ddac2384c0c1daeffa495ad3ec01bc1af (patch) | |
| tree | 6887faf0201cf0ac6c59516f914bd24098cdace2 /lib/notmuch.h | |
| parent | 74c4ce6d88bcc643424c5d89cc8d30cd835e46c3 (diff) | |
lib/create: document expectations for db on error, add tests
It seems sensible to harmonize the behaviour with
n_d_open_with_config. In this commit we just assert the desired
behaviour.
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 6a0e4c51..316385b8 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -491,6 +491,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 |