40/2f0a457de93fc4feaeab3d03cb08b36311a28b

   1 Return-Path: <amdragon@mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 36F8F431FDC\r
   6         for <notmuch@notmuchmail.org>; Mon, 25 Aug 2014 10:26:36 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -2.3\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id 5xrPyhn+kJo1 for <notmuch@notmuchmail.org>;\r
  16         Mon, 25 Aug 2014 10:26:31 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-7.mit.edu (dmz-mailsec-scanner-7.mit.edu\r
  18         [18.7.68.36])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 64BEA431FBF\r
  22         for <notmuch@notmuchmail.org>; Mon, 25 Aug 2014 10:26:21 -0700 (PDT)\r
  23 X-AuditID: 12074424-f79346d000004923-4f-53fb71bc9962\r
  24 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  25         (using TLS with cipher AES256-SHA (256/256 bits))\r
  26         (Client did not present a certificate)\r
  27         by dmz-mailsec-scanner-7.mit.edu (Symantec Messaging Gateway) with SMTP\r
  28         id 97.99.18723.DB17BF35; Mon, 25 Aug 2014 13:26:21 -0400 (EDT)\r
  29 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  30         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id s7PHQJFa007819; \r
  31         Mon, 25 Aug 2014 13:26:19 -0400\r
  32 Received: from drake.dyndns.org (31-35-14.wireless.csail.mit.edu\r
  33         [128.31.35.14]) (authenticated bits=0)\r
  34         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  35         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s7PHQC7Y029625\r
  36         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  37         Mon, 25 Aug 2014 13:26:18 -0400\r
  38 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  39         (envelope-from <amdragon@mit.edu>)\r
  40         id 1XLy20-0003jo-2T; Mon, 25 Aug 2014 13:26:12 -0400\r
  41 From: Austin Clements <amdragon@mit.edu>\r
  42 To: notmuch@notmuchmail.org\r
  43 Subject: [PATCH v4 11/11] lib: Update doc of notmuch_database_{needs_upgrade,\r
  44         upgrade}\r
  45 Date: Mon, 25 Aug 2014 13:26:09 -0400\r
  46 Message-Id: <1408987569-14146-12-git-send-email-amdragon@mit.edu>\r
  47 X-Mailer: git-send-email 2.0.0\r
  48 In-Reply-To: <1408987569-14146-1-git-send-email-amdragon@mit.edu>\r
  49 References: <1408987569-14146-1-git-send-email-amdragon@mit.edu>\r
  50 X-Brightmail-Tracker:\r
  51  H4sIAAAAAAAAA+NgFjrGIsWRmVeSWpSXmKPExsUixCmqrLu38HewwdT/LBY3WrsZLZqmO1tc\r
  52         vzmT2YHZ49b91+wez1bdYvbYcug9cwBzFJdNSmpOZllqkb5dAlfG4pZG5oLNghXHni5la2Cc\r
  53         zdfFyMkhIWAiceDnTHYIW0ziwr31bF2MXBxCArOZJJadecYC4WxklDi7+CITSJWQwDEmiYe3\r
  54         kyAScxkl/n15wwiSYBPQkPh9azFYkYiAtMTOu7NZQWxmAS+JZRf6wWxhgVCJ+Qf/g9WwCKhK\r
  55         HFx6jg3E5hVwlGhc8IgF4gw5iYYbn8DinEDx6QtnQy12kPh++TzzBEb+BYwMqxhlU3KrdHMT\r
  56         M3OKU5N1i5MT8/JSi3TN9XIzS/RSU0o3MYKCi91FZQdj8yGlQ4wCHIxKPLw34n8HC7EmlhVX\r
  57         5h5ilORgUhLlnZYPFOJLyk+pzEgszogvKs1JLT7EKMHBrCTC2wyS401JrKxKLcqHSUlzsCiJ\r
  58         8761tgoWEkhPLEnNTk0tSC2CycpwcChJ8N4vAGoULEpNT61Iy8wpQUgzcXCCDOcBGh4PUsNb\r
  59         XJCYW5yZDpE/xagoJc77HyQhAJLIKM2D64VF/ytGcaBXhHmPglTxABMHXPcroMFMQINNe36C\r
  60         DC5JREhJNTA2SnRPKyjaLVukeuLJs2K7Sbe2F8tfM074UnWRa3q576rdwhfSq24qSkyNNP2V\r
  61         8Pm7c6XMqk+F4frF//fpJK+PudlmXeC2xdr4zrtK/RP/dH494dRJ7Zg/deuR75o8s4PK1v37\r
  62         lma5Uu6DWXPAuhlOJXrva+yPhiycrBzge7rljeWMhRmFBuZKLMUZiYZazEXFiQCzHfSk2QIA        AA==\r
  63 X-BeenThere: notmuch@notmuchmail.org\r
  64 X-Mailman-Version: 2.1.13\r
  65 Precedence: list\r
  66 List-Id: "Use and development of the notmuch mail system."\r
  67         <notmuch.notmuchmail.org>\r
  68 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  69         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  70 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  71 List-Post: <mailto:notmuch@notmuchmail.org>\r
  72 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  73 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  74         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  75 X-List-Received-Date: Mon, 25 Aug 2014 17:26:36 -0000\r
  76 \r
  77 Clients are no longer required to call these functions after opening a\r
  78 database in read/write mode (which is good, because almost none of\r
  79 them do!).\r
  80 ---\r
  81  lib/notmuch.h | 23 ++++++++++++++---------\r
  82  1 file changed, 14 insertions(+), 9 deletions(-)\r
  83 \r
  84 diff --git a/lib/notmuch.h b/lib/notmuch.h\r
  85 index cbf2ba5..21a5225 100644\r
  86 --- a/lib/notmuch.h\r
  87 +++ b/lib/notmuch.h\r
  88 @@ -352,22 +352,27 @@ unsigned int\r
  89  notmuch_database_get_version (notmuch_database_t *database);\r
  90  \r
  91  /**\r
  92 - * Does this database need to be upgraded before writing to it?\r
  93 + * Can the database be upgraded to a newer database version?\r
  94   *\r
  95 - * If this function returns TRUE then no functions that modify the\r
  96 - * database (notmuch_database_add_message, notmuch_message_add_tag,\r
  97 - * notmuch_directory_set_mtime, etc.) will work unless the function\r
  98 - * notmuch_database_upgrade is called successfully first.\r
  99 + * If this function returns TRUE, then the caller may call\r
 100 + * notmuch_database_upgrade to upgrade the database.  If the caller\r
 101 + * does not upgrade an out-of-date database, then some functions may\r
 102 + * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED.  This always returns\r
 103 + * FALSE for a read-only database because there's no way to upgrade a\r
 104 + * read-only database.\r
 105   */\r
 106  notmuch_bool_t\r
 107  notmuch_database_needs_upgrade (notmuch_database_t *database);\r
 108  \r
 109  /**\r
 110 - * Upgrade the current database.\r
 111 + * Upgrade the current database to the latest supported version.\r
 112   *\r
 113 - * After opening a database in read-write mode, the client should\r
 114 - * check if an upgrade is needed (notmuch_database_needs_upgrade) and\r
 115 - * if so, upgrade with this function before making any modifications.\r
 116 + * This ensures that all current notmuch functionality will be\r
 117 + * available on the database.  After opening a database in read-write\r
 118 + * mode, it is recommended that clients check if an upgrade is needed\r
 119 + * (notmuch_database_needs_upgrade) and if so, upgrade with this\r
 120 + * function before making any modifications.  If\r
 121 + * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.\r
 122   *\r
 123   * The optional progress_notify callback can be used by the caller to\r
 124   * provide progress indication to the user. If non-NULL it will be\r
 125 -- \r
 126 2.0.0\r
 127 \r