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.
This commit is contained in:
David Bremner 2021-10-21 11:42:36 -03:00
parent d6e4ca6a7a
commit fb02817943

View file

@ -433,6 +433,8 @@ notmuch_database_open_verbose (const char *path,
* @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
* argument is NULL. * 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_OUT_OF_MEMORY: Out of memory.
* *
* @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the