From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 33CEA431FBC for ; Fri, 1 Nov 2013 16:20:07 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.699 X-Spam-Level: X-Spam-Status: No, score=-0.699 tagged_above=-999 required=5 tests=[HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id l8r6uJ6xJl7P for ; Fri, 1 Nov 2013 16:20:01 -0700 (PDT) Received: from mail-vb0-f47.google.com (mail-vb0-f47.google.com [209.85.212.47]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 44AF0431FAF for ; Fri, 1 Nov 2013 16:20:01 -0700 (PDT) Received: by mail-vb0-f47.google.com with SMTP id m10so105785vbh.34 for ; Fri, 01 Nov 2013 16:20:00 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=raP2CEcFwp3CkjnM/qO1ihboDBd6YREHtlSzbvF5NpI=; b=PjyXd3lZDl6hVElO/dm7FPm4Tyz3eZlMV3mw6CEOEAfhDRVU0ckUVE+jgBDC3LuSBa ncTBJRTPzLQ4NxWprtHpXoagV0RsMDWqQj0CouAeUhs8QeOIgROAmkIk0UeF7CitjLa+ FvZLg/irE41vffnKxYwdT1ZBN+CllAHcN9cGNgDq/pJruXO2rV7OCHhGzEMyy8Shq32S oXDdD91Fwvx2LMd0OBriHIJyOb5/lEEYk4JtxyY8obUHNUoqWhQRj28CtvWldDuZfjx3 Pxsm8KXh4SdD73YFyQj4OicydxlUYopue5wEDCn36pcHXd1IyPeRFtzHUE5kmkNsF6Ig zMCA== X-Gm-Message-State: ALoCoQkVOR3JI9L7A7udbBuWf8nC6hskSfBjfoZ5doAF3wO6/wOYJzNgCuCnLSnP+HqnCBkMg86Q MIME-Version: 1.0 X-Received: by 10.52.103.100 with SMTP id fv4mr704912vdb.55.1383347998643; Fri, 01 Nov 2013 16:19:58 -0700 (PDT) Received: by 10.58.96.20 with HTTP; Fri, 1 Nov 2013 16:19:58 -0700 (PDT) Received: by 10.58.96.20 with HTTP; Fri, 1 Nov 2013 16:19:58 -0700 (PDT) In-Reply-To: <1383347716-5375-1-git-send-email-david@tethera.net> References: <2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org> <1383347716-5375-1-git-send-email-david@tethera.net> Date: Sat, 2 Nov 2013 01:19:58 +0200 Message-ID: Subject: Re: [PATCH] lib: update documentation of callback functions for database_compact and database_upgrade. From: Jani Nikula To: David Bremner Content-Type: multipart/alternative; boundary=047d7bacba9a0f6fd804ea25ce96 Cc: Notmuch Mail , David Bremner X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 01 Nov 2013 23:20:07 -0000 --047d7bacba9a0f6fd804ea25ce96 Content-Type: text/plain; charset=UTF-8 The point was, we can do this *now* without soname bumps, because we haven't released this yet. On Nov 2, 2013 1:16 AM, wrote: > From: David Bremner > > Compact was missing callback documentation entirely, and upgrade did not > discuss the > closure parameter. > --- > This patch depends on > > > id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani@nikula.org > > BTW, I didn't completely understand the remark about SONAME bumps; > since we're providing new symbols, it doesn't really matter what the > signature is? > > lib/notmuch.h | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/lib/notmuch.h b/lib/notmuch.h > index cd301a4..82fd599 100644 > --- a/lib/notmuch.h > +++ b/lib/notmuch.h > @@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char > *message, void *closure); > * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE > * during the compaction process to ensure no writes are made. > * > + * If the optional callback function 'status_cb' is non-NULL, it will > + * be called with diagnostic and informational messages. The argument > + * 'closure' is passed verbatim to any callback invoked. > */ > notmuch_status_t > notmuch_database_compact (const char* path, > @@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t > *database); > * provide progress indication to the user. If non-NULL it will be > * called periodically with 'progress' as a floating-point value in > * the range of [0.0 .. 1.0] indicating the progress made so far in > - * the upgrade process. > + * the upgrade process. The argument 'closure' is passed verbatim to > + * any callback invoked. > */ > notmuch_status_t > notmuch_database_upgrade (notmuch_database_t *database, > -- > 1.8.4.rc3 > > _______________________________________________ > notmuch mailing list > notmuch@notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch > --047d7bacba9a0f6fd804ea25ce96 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable

The point was, we can do this *now* without soname bumps, be= cause we haven't released this yet.

On Nov 2, 2013 1:16 AM, <david@tethera.net> wrote:
=
From: David Bremner <bremner@debia= n.org>

Compact was missing callback documentation entirely, and upgrade did not di= scuss the
closure parameter.
---
This patch depends on

=C2=A0 =C2=A0 =C2=A0id:2a58adbdc1257f16579692544b4bcba= dca3d3045.1383315568.git.jani@nikula.org

BTW, I didn't completely understand the remark about SONAME bumps;
since we're providing new symbols, it doesn't really matter what th= e
signature is?

=C2=A0lib/notmuch.h | 6 +++++-
=C2=A01 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index cd301a4..82fd599 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char = *message, void *closure);
=C2=A0 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE<= br> =C2=A0 * during the compaction process to ensure no writes are made.
=C2=A0 *
+ * If the optional callback function 'status_cb' is non-NULL, it w= ill
+ * be called with diagnostic and informational messages. The argument
+ * 'closure' is passed verbatim to any callback invoked.
=C2=A0 */
=C2=A0notmuch_status_t
=C2=A0notmuch_database_compact (const char* path,
@@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t *dat= abase);
=C2=A0 * provide progress indication to the user. If non-NULL it will be =C2=A0 * called periodically with 'progress' as a floating-point va= lue in
=C2=A0 * the range of [0.0 .. 1.0] indicating the progress made so far in - * the upgrade process.
+ * the upgrade process. =C2=A0The argument 'closure' is passed ver= batim to
+ * any callback invoked.
=C2=A0 */
=C2=A0notmuch_status_t
=C2=A0notmuch_database_upgrade (notmuch_database_t *database,
--
1.8.4.rc3

_______________________________________________
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch
--047d7bacba9a0f6fd804ea25ce96--