From: David Bremner <david@tethera.net>
Date: Sat, 30 Oct 2021 18:01:01 +0000 (-0300)
Subject: Merge branch 'release'
X-Git-Tag: 0.35_rc0~94
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=e7bb7919a2484e12cd5a672eaa21b695b7464acf;hp=-c

Merge branch 'release'
---

e7bb7919a2484e12cd5a672eaa21b695b7464acf
diff --combined lib/notmuch.h
index 19391614,5c5a024e..1b2bdf3f
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@@ -112,7 -112,7 +112,7 @@@ typedef int notmuch_bool_t
   * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
   * completed without error. Any other value indicates an error.
   */
 -typedef enum _notmuch_status {
 +typedef enum {
      /**
       * No error occurred.
       */
@@@ -323,7 -323,7 +323,7 @@@ typedef enum 
   * config_path="" and error_message=NULL
   * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
   */
 -/* NOTMUCH_DEPRECATED(5, 4) */
 +NOTMUCH_DEPRECATED(5, 4)
  notmuch_status_t
  notmuch_database_open (const char *path,
  		       notmuch_database_mode_t mode,
@@@ -335,7 -335,7 +335,7 @@@
   * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
   *
   */
 -/* NOTMUCH_DEPRECATED(5, 4) */
 +NOTMUCH_DEPRECATED(5, 4)
  notmuch_status_t
  notmuch_database_open_verbose (const char *path,
  			       notmuch_database_mode_t mode,
@@@ -433,6 -433,8 +433,8 @@@
   * @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
@@@ -458,6 -460,9 +460,9 @@@ notmuch_database_open_with_config (cons
   *
   * For description of arguments, @see notmuch_database_open_with_config
   *
+  * For errors other then NO_DATABASE and NO_CONFIG, *database is set to
+  * NULL.
+  *
   * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
   *
   * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
@@@ -489,6 -494,9 +494,9 @@@ notmuch_database_load_config (const cha
   *
   * For description of arguments, @see notmuch_database_open_with_config
   *
+  * In case of any failure, this function returns an error status and
+  * sets *database to NULL.
+  *
   * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
   *
   * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
@@@ -1678,7 -1686,7 +1686,7 @@@ notmuch_message_reindex (notmuch_messag
  /**
   * Message flags.
   */
 -typedef enum _notmuch_message_flag {
 +typedef enum {
      NOTMUCH_MESSAGE_FLAG_MATCH,
      NOTMUCH_MESSAGE_FLAG_EXCLUDED,
  
@@@ -2524,7 -2532,7 +2532,7 @@@ notmuch_config_list_destroy (notmuch_co
  /**
   * Configuration keys known to libnotmuch
   */
 -typedef enum _notmuch_config_key {
 +typedef enum {
      NOTMUCH_CONFIG_FIRST,
      NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
      NOTMUCH_CONFIG_MAIL_ROOT,