[PATCH] lib: update documentation of callback functions for database_compact and...

diff --git a/04/bfb739d7536c534ddaf10481d9d3afc0cf2b5a b/04/bfb739d7536c534ddaf10481d9d3afc0cf2b5a
new file mode 100644 (file)
index 0000000..c30cdcc
--- /dev/null
+++ b/04/bfb739d7536c534ddaf10481d9d3afc0cf2b5a
@@ -0,0 +1,95 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 79A52431FAF\r
+       for <notmuch@notmuchmail.org>; Fri,  1 Nov 2013 16:15:50 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id bZPffedN-E3g for <notmuch@notmuchmail.org>;\r
+       Fri,  1 Nov 2013 16:15:46 -0700 (PDT)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 6D17A431FAE\r
+       for <notmuch@notmuchmail.org>; Fri,  1 Nov 2013 16:15:46 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1VcNwK-0002BP-Ty; Fri, 01 Nov 2013 20:15:40 -0300\r
+Received: (nullmailer pid 5441 invoked by uid 1000); Fri, 01 Nov 2013\r
+       23:15:35 -0000\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] lib: update documentation of callback functions for\r
+       database_compact and database_upgrade.\r
+Date: Fri,  1 Nov 2013 20:15:16 -0300\r
+Message-Id: <1383347716-5375-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To:\r
+ <2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org>\r
+References:\r
+ <2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org>\r
+Cc: David Bremner <bremner@debian.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 01 Nov 2013 23:15:50 -0000\r
+\r
+From: David Bremner <bremner@debian.org>\r
+\r
+Compact was missing callback documentation entirely, and upgrade did not discuss the\r
+closure parameter.\r
+---\r
+This patch depends on \r
+     \r
+     id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org\r
+\r
+BTW, I didn't completely understand the remark about SONAME bumps;\r
+since we're providing new symbols, it doesn't really matter what the\r
+signature is?\r
+\r
+ lib/notmuch.h | 6 +++++-\r
+ 1 file changed, 5 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index cd301a4..82fd599 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);\r
+  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE\r
+  * during the compaction process to ensure no writes are made.\r
+  *\r
++ * If the optional callback function 'status_cb' is non-NULL, it will\r
++ * be called with diagnostic and informational messages. The argument\r
++ * 'closure' is passed verbatim to any callback invoked.\r
+  */\r
+ notmuch_status_t\r
+ notmuch_database_compact (const char* path,\r
+@@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t *database);\r
+  * provide progress indication to the user. If non-NULL it will be\r
+  * called periodically with 'progress' as a floating-point value in\r
+  * the range of [0.0 .. 1.0] indicating the progress made so far in\r
+- * the upgrade process.\r
++ * the upgrade process.  The argument 'closure' is passed verbatim to\r
++ * any callback invoked.\r
+  */\r
+ notmuch_status_t\r
+ notmuch_database_upgrade (notmuch_database_t *database,\r
+-- \r
+1.8.4.rc3\r
+\r