From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>
Subject: Re: [PATCH 1/3] cli: add insert --must-index option
In-Reply-To: <87bo2xtdp2.fsf@unb.ca>
References: <1374365254-13227-1-git-send-email-novalazy@gmail.com>
	<87ip048gbj.fsf@qmul.ac.uk>
	<20130727151510.GA13750@hili.localdomain>
	<87hadtxfrr.fsf@qmul.ac.uk>
	<20130912001349.GA18821@hili.localdomain>
	<87zjqhv264.fsf@zancas.localnet>
	<m238o9fguj.fsf@guru.guru-group.fi> <87bo2xtdp2.fsf@unb.ca>
User-Agent: Notmuch/0.16+115~g11c2ff5 (http://notmuchmail.org) Emacs/24.3.1
	(x86_64-unknown-linux-gnu)
Date: Wed, 23 Oct 2013 22:05:26 +0300
Message-ID: <m2eh7bu7t5.fsf@guru.guru-group.fi>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Cc: notmuch@notmuchmail.org
Precedence: list

On Thu, Oct 10 2013, David Bremner <david@tethera.net> wrote:

> Tomi Ollila <tomi.ollila@iki.fi> writes:
>>> I'm not opposed to doing an SONAME bump for 0.17. Are there other ABI
>>> breaking changes that we have been holding back on? Can these maybe go
>>> through at the same time?
>>
>> Maybe something along these lines...
>>
>> (Quick draft for the API part; to start discussion before working too mu=
ch
>> for something that is going to be dropped...)
>>
>>  notmuch_status_t
>> -notmuch_database_create (const char *path, notmuch_database_t **databas=
e);
>> +notmuch_database_create (const char *path,
>> +			 notmuch_loghook_t *loghook,
>> +			 notmuch_database_t **database);
>
> Another idea floated (by Austin?) was to pass in an options struct, to
> allow future options to be added without changing the function
> signature. I guess with some care this could be done in an upwardly
> compatible way.

Maybe something like

#define NOTMUCH_API_OPTIONS_VERSION 1
typedef struct {
        int options_version;
        void (*log)(void *, int level, int status, const char * format, ...=
);
        void * logdata;
} notmuch_options_t;=20=20=20=20=20=20=20=20

...

notmuch_status_t
notmuch_database_create (const char *path,
			 notmuch_options_t *options,
			 notmuch_database_t **database);
...

notmuch_status_t
notmuch_database_open (const char *path,
                       notmuch_database_mode_t mode,
                       notmuch_options_t *options,
                       notmuch_database_t **database);

then in use:

notmuch_options_t options =3D {
       .options_version =3D NOTMUCH_API_OPTIONS_VERSION,

.. =C3=A4sh, this has problem that the macro changes in header file
but the structure initialization is not following automatically
(in other fields than that). Therefore perhaps "fixing"
the version macros:

#define NOTMUCH_API_OPTIONS_VERSION_1 1
/* #define NOTMUCH_API_OPTIONS_VERSION_2 2 // added in the future */

notmuch_options_t options =3D {
       .options_version =3D NOTMUCH_API_OPTIONS_VERSION_1,
       .log =3D log_to_stderr,
       .logdata =3D NULL
};

Well, this is one idea (does not sound as good as I initially
thought...) how does other software tackle this kind of issues...

If something like this is finally chosen we could provide easy
transition path to allow NULL as options -- making notmuch CLI
behave as it used to be (log to stderr...).


> d

Tomi