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 074fc68287aa247c18890b2332552197c6a06c1c..6a0e4c51f9362d18261b98e78190635fc6067038 100644 (file)
--- 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