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

diff --git a/5b/695bdb28bdb133df2c745b04ea72e40155a6d1 b/5b/695bdb28bdb133df2c745b04ea72e40155a6d1
new file mode 100644 (file)
index 0000000..46c2668
--- /dev/null
+++ b/5b/695bdb28bdb133df2c745b04ea72e40155a6d1
@@ -0,0 +1,203 @@
+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 33CEA431FBC\r
+       for <notmuch@notmuchmail.org>; Fri,  1 Nov 2013 16:20:07 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.699\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.699 tagged_above=-999 required=5\r
+       tests=[HTML_MESSAGE=0.001, 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 l8r6uJ6xJl7P for <notmuch@notmuchmail.org>;\r
+       Fri,  1 Nov 2013 16:20:01 -0700 (PDT)\r
+Received: from mail-vb0-f47.google.com (mail-vb0-f47.google.com\r
+       [209.85.212.47]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 44AF0431FAF\r
+       for <notmuch@notmuchmail.org>; Fri,  1 Nov 2013 16:20:01 -0700 (PDT)\r
+Received: by mail-vb0-f47.google.com with SMTP id m10so105785vbh.34\r
+       for <notmuch@notmuchmail.org>; Fri, 01 Nov 2013 16:20:00 -0700 (PDT)\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:mime-version:in-reply-to:references:date\r
+       :message-id:subject:from:to:cc:content-type;\r
+       bh=raP2CEcFwp3CkjnM/qO1ihboDBd6YREHtlSzbvF5NpI=;\r
+       b=PjyXd3lZDl6hVElO/dm7FPm4Tyz3eZlMV3mw6CEOEAfhDRVU0ckUVE+jgBDC3LuSBa\r
+       ncTBJRTPzLQ4NxWprtHpXoagV0RsMDWqQj0CouAeUhs8QeOIgROAmkIk0UeF7CitjLa+\r
+       FvZLg/irE41vffnKxYwdT1ZBN+CllAHcN9cGNgDq/pJruXO2rV7OCHhGzEMyy8Shq32S\r
+       oXDdD91Fwvx2LMd0OBriHIJyOb5/lEEYk4JtxyY8obUHNUoqWhQRj28CtvWldDuZfjx3\r
+       Pxsm8KXh4SdD73YFyQj4OicydxlUYopue5wEDCn36pcHXd1IyPeRFtzHUE5kmkNsF6Ig\r
+       zMCA==\r
+X-Gm-Message-State:\r
+ ALoCoQkVOR3JI9L7A7udbBuWf8nC6hskSfBjfoZ5doAF3wO6/wOYJzNgCuCnLSnP+HqnCBkMg86Q\r
+MIME-Version: 1.0\r
+X-Received: by 10.52.103.100 with SMTP id fv4mr704912vdb.55.1383347998643;\r
+       Fri, 01 Nov 2013 16:19:58 -0700 (PDT)\r
+Received: by 10.58.96.20 with HTTP; Fri, 1 Nov 2013 16:19:58 -0700 (PDT)\r
+Received: by 10.58.96.20 with HTTP; Fri, 1 Nov 2013 16:19:58 -0700 (PDT)\r
+In-Reply-To: <1383347716-5375-1-git-send-email-david@tethera.net>\r
+References:\r
+ <2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org>\r
+       <1383347716-5375-1-git-send-email-david@tethera.net>\r
+Date: Sat, 2 Nov 2013 01:19:58 +0200\r
+Message-ID:\r
+ <CAB+hUn8+PB+Y3C1bZediJCL4DvPx+shyCyCndaFEnxOSHHi9sA@mail.gmail.com>\r
+Subject: Re: [PATCH] lib: update documentation of callback functions for\r
+       database_compact and database_upgrade.\r
+From: Jani Nikula <jani@nikula.org>\r
+To: David Bremner <david@tethera.net>\r
+Content-Type: multipart/alternative; boundary=047d7bacba9a0f6fd804ea25ce96\r
+Cc: Notmuch Mail <notmuch@notmuchmail.org>, 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:20:07 -0000\r
+\r
+--047d7bacba9a0f6fd804ea25ce96\r
+Content-Type: text/plain; charset=UTF-8\r
+\r
+The point was, we can do this *now* without soname bumps, because we\r
+haven't released this yet.\r
+ On Nov 2, 2013 1:16 AM, <david@tethera.net> wrote:\r
+\r
+> From: David Bremner <bremner@debian.org>\r
+>\r
+> Compact was missing callback documentation entirely, and upgrade did not\r
+> discuss the\r
+> closure parameter.\r
+> ---\r
+> This patch depends on\r
+>\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\r
+> *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\r
+> *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
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r
+>\r
+\r
+--047d7bacba9a0f6fd804ea25ce96\r
+Content-Type: text/html; charset=UTF-8\r
+Content-Transfer-Encoding: quoted-printable\r
+\r
+<p dir=3D"ltr">The point was, we can do this *now* without soname bumps, be=\r
+cause we haven&#39;t released this yet.<br>\r
+</p>\r
+<div class=3D"gmail_quote">On Nov 2, 2013 1:16 AM,  &lt;<a href=3D"mailto:d=\r
+avid@tethera.net">david@tethera.net</a>&gt; wrote:<br type=3D"attribution">=\r
+<blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1p=\r
+x #ccc solid;padding-left:1ex">\r
+From: David Bremner &lt;<a href=3D"mailto:bremner@debian.org">bremner@debia=\r
+n.org</a>&gt;<br>\r
+<br>\r
+Compact was missing callback documentation entirely, and upgrade did not di=\r
+scuss the<br>\r
+closure parameter.<br>\r
+---<br>\r
+This patch depends on<br>\r
+<br>\r
+=C2=A0 =C2=A0 =C2=A0<a href=3D"mailto:id%3A2a58adbdc1257f16579692544b4bcbad=\r
+ca3d3045.1383315568.git.jani@nikula.org">id:2a58adbdc1257f16579692544b4bcba=\r
+dca3d3045.1383315568.git.jani@nikula.org</a><br>\r
+<br>\r
+BTW, I didn&#39;t completely understand the remark about SONAME bumps;<br>\r
+since we&#39;re providing new symbols, it doesn&#39;t really matter what th=\r
+e<br>\r
+signature is?<br>\r
+<br>\r
+=C2=A0lib/notmuch.h | 6 +++++-<br>\r
+=C2=A01 file changed, 5 insertions(+), 1 deletion(-)<br>\r
+<br>\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h<br>\r
+index cd301a4..82fd599 100644<br>\r
+--- a/lib/notmuch.h<br>\r
++++ b/lib/notmuch.h<br>\r
+@@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char =\r
+*message, void *closure);<br>\r
+=C2=A0 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE<=\r
+br>\r
+=C2=A0 * during the compaction process to ensure no writes are made.<br>\r
+=C2=A0 *<br>\r
++ * If the optional callback function &#39;status_cb&#39; is non-NULL, it w=\r
+ill<br>\r
++ * be called with diagnostic and informational messages. The argument<br>\r
++ * &#39;closure&#39; is passed verbatim to any callback invoked.<br>\r
+=C2=A0 */<br>\r
+=C2=A0notmuch_status_t<br>\r
+=C2=A0notmuch_database_compact (const char* path,<br>\r
+@@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t *dat=\r
+abase);<br>\r
+=C2=A0 * provide progress indication to the user. If non-NULL it will be<br=\r
+>\r
+=C2=A0 * called periodically with &#39;progress&#39; as a floating-point va=\r
+lue in<br>\r
+=C2=A0 * the range of [0.0 .. 1.0] indicating the progress made so far in<b=\r
+r>\r
+- * the upgrade process.<br>\r
++ * the upgrade process. =C2=A0The argument &#39;closure&#39; is passed ver=\r
+batim to<br>\r
++ * any callback invoked.<br>\r
+=C2=A0 */<br>\r
+=C2=A0notmuch_status_t<br>\r
+=C2=A0notmuch_database_upgrade (notmuch_database_t *database,<br>\r
+--<br>\r
+1.8.4.rc3<br>\r
+<br>\r
+_______________________________________________<br>\r
+notmuch mailing list<br>\r
+<a href=3D"mailto:notmuch@notmuchmail.org">notmuch@notmuchmail.org</a><br>\r
+<a href=3D"http://notmuchmail.org/mailman/listinfo/notmuch" target=3D"_blan=\r
+k">http://notmuchmail.org/mailman/listinfo/notmuch</a><br>\r
+</blockquote></div>\r
+\r
+--047d7bacba9a0f6fd804ea25ce96--\r