bf/07cafc549f169346b99e7da939672196d88e9a

   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 7706B431FD5\r
   6         for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:11:01 -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 taErLlEpHcjI for <notmuch@notmuchmail.org>;\r
  16         Thu, 31 Jul 2014 19:10:57 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu\r
  18         [18.7.68.34])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 6EC8D431FD7\r
  20         for <notmuch@notmuchmail.org>; Thu, 31 Jul 2014 19:10:20 -0700 (PDT)\r
  21 X-AuditID: 12074422-f79be6d000007518-94-53daf70b24de\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         (using TLS with cipher AES256-SHA (256/256 bits))\r
  24         (Client did not present a certificate)\r
  25         by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
  26         id 8B.05.29976.C07FAD35; Thu, 31 Jul 2014 22:10:20 -0400 (EDT)\r
  27 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  28         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id s712A8fe014706; \r
  29         Thu, 31 Jul 2014 22:10:09 -0400\r
  30 Received: from drake.dyndns.org\r
  31         (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  32         [216.15.114.40]) (authenticated bits=0)\r
  33         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  34         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s712A7Ze029995\r
  35         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  36         Thu, 31 Jul 2014 22:10:08 -0400\r
  37 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  38         (envelope-from <amdragon@mit.edu>)\r
  39         id 1XD2II-000341-9v; Thu, 31 Jul 2014 22:10:06 -0400\r
  40 From: Austin Clements <amdragon@MIT.EDU>\r
  41 To: notmuch@notmuchmail.org\r
  42 Subject: [PATCH v3 13/13] lib: Update doc of notmuch_database_{needs_upgrade,\r
  43         upgrade}\r
  44 Date: Thu, 31 Jul 2014 22:10:03 -0400\r
  45 Message-Id: <1406859003-11561-14-git-send-email-amdragon@mit.edu>\r
  46 X-Mailer: git-send-email 2.0.0\r
  47 In-Reply-To: <1406859003-11561-1-git-send-email-amdragon@mit.edu>\r
  48 References: <1406859003-11561-1-git-send-email-amdragon@mit.edu>\r
  49 X-Brightmail-Tracker:\r
  50  H4sIAAAAAAAAA+NgFtrLIsWRmVeSWpSXmKPExsUixCmqrMvz/VawwfIJzBar5/JYXL85k9mB\r
  51         yWPnrLvsHs9W3WIOYIrisklJzcksSy3St0vgyrj6/xdbwX6BisvNt1kaGA/wdjFyckgImEhc\r
  52         +7GZEcIWk7hwbz1bFyMXh5DAbCaJ2bd7GSGcjYwSu84uhHLuMEmsnvOTCcKZyyjReGciM0g/\r
  53         m4CGxLb9y8FmiQhIS+y8O5sVxGYWcJT4vH8RG4gtLBAqsX/WNCYQm0VAVeLqlNVgNi9QzdtV\r
  54         nSwQd8hJNNz4BFbPCRT//28B2BwhAQeJ1tNbmScw8i9gZFjFKJuSW6Wbm5iZU5yarFucnJiX\r
  55         l1qka6qXm1mil5pSuokRFErsLko7GH8eVDrEKMDBqMTD6xB6K1iINbGsuDL3EKMkB5OSKK/N\r
  56         R6AQX1J+SmVGYnFGfFFpTmrxIUYJDmYlEd6XH4ByvCmJlVWpRfkwKWkOFiVx3rfWVsFCAumJ\r
  57         JanZqakFqUUwWRkODiUJ3jNfgRoFi1LTUyvSMnNKENJMHJwgw3mAhl8DqeEtLkjMLc5Mh8if\r
  58         YlSUEufdA5IQAElklObB9cJi/RWjONArwrwPQap4gGkCrvsV0GAmoMHPb10HGVySiJCSamBk\r
  59         YjdvWmTGzyLlNPXhzOplVzfVCfftvfDSfMYpkYgTM9am9KRdV/g2W6jV+eHOtW6Jn+KS1rY1\r
  60         iXKUrp+71jmmV7fcWzS70k17tXfIuSNMMoFvQ83PXfitGLz888NzYdXt7dn3eX5kaBceu1fP\r
  61         b/VhimPcJQO/J11B99YtLJx2+P09Tgnt0ENKLMUZiYZazEXFiQAa6VQJ0AIAAA==\r
  62 X-BeenThere: notmuch@notmuchmail.org\r
  63 X-Mailman-Version: 2.1.13\r
  64 Precedence: list\r
  65 List-Id: "Use and development of the notmuch mail system."\r
  66         <notmuch.notmuchmail.org>\r
  67 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  68         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  69 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  70 List-Post: <mailto:notmuch@notmuchmail.org>\r
  71 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  72 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  73         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  74 X-List-Received-Date: Fri, 01 Aug 2014 02:11:02 -0000\r
  75 \r
  76 Clients are no longer required to call these functions after opening a\r
  77 database in read/write mode (which is good, because almost none of\r
  78 them do!).\r
  79 ---\r
  80  lib/notmuch.h | 21 ++++++++++++---------\r
  81  1 file changed, 12 insertions(+), 9 deletions(-)\r
  82 \r
  83 diff --git a/lib/notmuch.h b/lib/notmuch.h\r
  84 index cbf2ba5..d771eb2 100644\r
  85 --- a/lib/notmuch.h\r
  86 +++ b/lib/notmuch.h\r
  87 @@ -352,22 +352,25 @@ unsigned int\r
  88  notmuch_database_get_version (notmuch_database_t *database);\r
  89  \r
  90  /**\r
  91 - * Does this database need to be upgraded before writing to it?\r
  92 + * Is the database behind the latest supported database version?\r
  93   *\r
  94 - * If this function returns TRUE then no functions that modify the\r
  95 - * database (notmuch_database_add_message, notmuch_message_add_tag,\r
  96 - * notmuch_directory_set_mtime, etc.) will work unless the function\r
  97 - * notmuch_database_upgrade is called successfully first.\r
  98 + * If this function returns TRUE, then the caller may call\r
  99 + * notmuch_database_upgrade to upgrade the database.  If the caller\r
 100 + * does not upgrade an out-of-date database, then some functions may\r
 101 + * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED.\r
 102   */\r
 103  notmuch_bool_t\r
 104  notmuch_database_needs_upgrade (notmuch_database_t *database);\r
 105  \r
 106  /**\r
 107 - * Upgrade the current database.\r
 108 + * Upgrade the current database to the latest supported version.\r
 109   *\r
 110 - * After opening a database in read-write mode, the client should\r
 111 - * check if an upgrade is needed (notmuch_database_needs_upgrade) and\r
 112 - * if so, upgrade with this function before making any modifications.\r
 113 + * This ensures that all current notmuch functionality will be\r
 114 + * available on the database.  After opening a database in read-write\r
 115 + * mode, it is recommended that clients check if an upgrade is needed\r
 116 + * (notmuch_database_needs_upgrade) and if so, upgrade with this\r
 117 + * function before making any modifications.  If\r
 118 + * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.\r
 119   *\r
 120   * The optional progress_notify callback can be used by the caller to\r
 121   * provide progress indication to the user. If non-NULL it will be\r
 122 -- \r
 123 2.0.0\r
 124 \r