[PATCH] lib: document n_o_w_config can return NOTMUCH_STATUS_NO_CONFIG

Subject: [PATCH] lib: document n_o_w_config can return NOTMUCH_STATUS_NO_CONFIG

Date: Thu, 21 Oct 2021 11:42:36 -0300

To: notmuch@notmuchmail.org, reply+AAANX2IQCBF766VNFFVYGC57PVNY3EVBNHHD3BUDCM@reply.github.com

Cc: David Bremner

From: David Bremner

This should be treated as fatal by callers, since we didn't succeed in
opening a Xapian database.
---
 lib/notmuch.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 074fc682..8d4d14af 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
-- 
2.33.0
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: