summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2021-10-21 11:42:36 -0300
committerDavid Bremner <david@tethera.net>2021-10-30 13:41:57 -0300
commitfb02817943e8cd646641d7f1fe914ce8adb3ecb2 (patch)
tree3e81830aede1b98a680cb0e27c91dd7f8667437c /lib
parentd6e4ca6a7a3a1a18eee7be3aa5fb8d0987e0894d (diff)
lib: document n_o_w_config can return NOTMUCH_STATUS_NO_CONFIG
This should be treated as fatal by callers, since we didn't succeed in opening a Xapian database.
Diffstat (limited to 'lib')
-rw-r--r--lib/notmuch.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 074fc682..6a0e4c51 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