[PATCH v2 06/11] lib: update documentation of callback functions for database_compact...

diff --git a/29/d096eaa9cf958eb5407fd832bf10e270c4ec28 b/29/d096eaa9cf958eb5407fd832bf10e270c4ec28
new file mode 100644 (file)
index 0000000..b47fbe4
--- /dev/null
+++ b/29/d096eaa9cf958eb5407fd832bf10e270c4ec28
@@ -0,0 +1,106 @@
+Return-Path: <jani@nikula.org>\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 32637431FDE\r
+       for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:25:32 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 8N7SuIqN+a1Y for <notmuch@notmuchmail.org>;\r
+       Sun,  3 Nov 2013 04:25:26 -0800 (PST)\r
+Received: from mail-ea0-f172.google.com (mail-ea0-f172.google.com\r
+       [209.85.215.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 057E6431E82\r
+       for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:25:10 -0800 (PST)\r
+Received: by mail-ea0-f172.google.com with SMTP id r16so2880341ead.17\r
+       for <notmuch@notmuchmail.org>; Sun, 03 Nov 2013 04:25:09 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
+       :references:in-reply-to:references;\r
+       bh=LOx8jpN1NtyKVEa/IAyIQS8usHuCQPFZ8+nVGR2R/HA=;\r
+       b=ZctB1PG0Dtv24cBo2fiQbZxtu5uQEC5qJX/5dLA0gyhaDmOXrTu3T+QBX61psnBk9Y\r
+       gf1bG6n6kNKBCu44TYaDiOkJrlAj4Pv4vsEbGRx3ZEeW+qlMhOaWYqP6drpCUlSmDNl0\r
+       v7zRN8PEzHQd8TIM3WyOUUbneS4YfI+8T03IWz6mNOTC1WnjajALwSM75qFtJAm+5wE3\r
+       yppgZxNH70BwR1ADchrJsqlX11mWbeJc01jYqXrx9NexgKveA3EwODg+Tu0okHX7+gKl\r
+       k6LHUgUOYV7RPxQVv/HUrEPBhWe3SW6T1j5y7l7n9sgxfEDPGA7WLBO4zbBKVKE8GT66\r
+       POZQ==\r
+X-Gm-Message-State:\r
+ ALoCoQklQS1dmdfQ4Rmb1Qk5UuS4BRi2T7odE0PHxJu+51f3/x1C5pZdd8z0GGng+3LSkUhBo3ho\r
+X-Received: by 10.15.100.198 with SMTP id bn46mr12403978eeb.11.1383481509839; \r
+       Sun, 03 Nov 2013 04:25:09 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91])\r
+       by mx.google.com with ESMTPSA id i47sm9567313eem.5.2013.11.03.04.25.08\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sun, 03 Nov 2013 04:25:09 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 06/11] lib: update documentation of callback functions for\r
+       database_compact and database_upgrade.\r
+Date: Sun,  3 Nov 2013 14:24:46 +0200\r
+Message-Id:\r
+ <3ccb768e0da07e53e37d9fd593855719ba900c1c.1383481295.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
+References: <cover.1383481295.git.jani@nikula.org>\r
+In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
+References: <cover.1383481295.git.jani@nikula.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: Sun, 03 Nov 2013 12:25:32 -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
+ 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