From: David Bremner <david@tethera.net>
Date: Thu, 21 Oct 2021 14:42:36 +0000 (-0300)
Subject: lib: document n_o_w_config can return NOTMUCH_STATUS_NO_CONFIG
X-Git-Tag: archive/debian/0.34.1-1~11
X-Git-Url: https://git.cworth.org/git?a=commitdiff_plain;h=fb02817943e8cd646641d7f1fe914ce8adb3ecb2;p=notmuch-old

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.
---

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