Sync common code between configure.ac files
[xapian.git] / xapian-bindings / NEWS
blobb4d07853a5828ad8ed190b4432242ac843ca3214
1 Xapian-bindings 1.4.19 (2021-12-31):
3 Documentation:
5 * configure: Add missing AC_ARG_VAR for all programs so that they are
6   documented in --help output, and so that autoconf knows they are "precious"
7   and preserves them if configure is rerun even when they're specified via an
8   environment variable.
10 General:
12 * Replace uses of obsolete autoconf macros, fixing warnings if configure is
13   regenerated with a recent release of autoconf.
15 Perl:
17 * Add missing wrappers for some QueryParser FLAG_* constants.
18     
19 * Fix incorrect formatting in the processed POD documentation due to missing
20   escaping of `>` in code snippets.
22 PHP:
24 * Make configure PHP5 version check more robust.  Previously it would have
25   incorrectly accepted any (future) PHP version >= 10.0.0.
27 PHP7:
29 * configure: We now reject PHP8 since it isn't currently supported
30   by a released version of SWIG.  SWIG 4.1.0 will supports PHP8.
32 * configure: Check for php-config7.4 as well as earlier 7.x versions
33   and php-config.
35 Python3:
37 * Fix deprecation warnings with Python >= 3.9.
39 * Remove more files/dirs on "make clean".  Reported by Gaurav Arora.
41 Ruby:
43 * Fix build with Ruby 3.0 and clang. Reported by Eduard Panov on macos, where
44   clang is the default compiler.
46 * Improve markup in Ruby bindings docs.
48 Xapian-bindings 1.4.18 (2021-01-14):
50 Portability:
52 * Support macOS 11.0 - AC_CANONICAL_HOST identifies this as darwin20, which
53   wasn't caught by our glob pattern.  Patch from FX Coudert in
54   https://github.com/xapian/xapian/pull/319
56 CSharp:
58 * Wrap const std::string* parameters to accept a string or null in C#.  See #204.
60 Java:
62 * Wrap const std::string* parameters to accept a String or null in Java.
64 Perl:
66 * Fix minor documentation typo.
68 Xapian-bindings 1.4.17 (2020-08-21):
70 * No user-visible change except for bumping the version to indicate
71   compatibility with Xapian-core 1.4.17.
73 Xapian-bindings 1.4.16 (2020-06-08):
75 General:
77 * Remove code to support SVN snapshots since we stopped using SVN more than 5
78   years ago.
80 * Ignore overloads for logical ops, *, /.  These were already ignored for
81   several languages, and aren't actually usefully wrapped for any of the other
82   languages.
84 CSharp:
86 * Work around mono terminfo parsing bug in more cases.  With this, "make",
87   "make check", "make install" and "make uninstall" all work on Ubuntu 18.10.
88   Patch from Dipanshu Garg, fixes https://github.com/xapian/xapian/pull/287 and
89   #801.
91 Lua:
93 * Allow passing a Lua function as a MatchSpy.  This was supposed to be
94   supported already, but the typemaps weren't set up.
96 * On platforms where sizeof(long) is 4, SWIG was wrapping Xapian::BAD_VALUENO
97   as a negative constant in Lua, which was then rejected by a check which
98   disallows passing negative values for unsigned C++ types.  We now direct SWIG
99   to handle Xapian::valueno as double (which is what numbers in Lua usually
100   actually are) which gives us an unsigned constant, and also eliminates the
101   negative value check.
103 * Correct documentation - get_description() is wrapped as tostring() in Lua,
104   not str() as we previously claimed.
106 * Add test coverage for passing Lua function for a Stopper.
108 Perl:
110 * Resolve the remaining issues and remove the "experimental" marker:
112   + Add search_xapian_compat() function which sets up aliases in the
113     Search::Xapian namespace to aid writing code which uses either
114     Search::Xapian or this module.
116   + Allow passing Perl sub for simpler Xapian functor classes.  This fills in a
117     missing feature compared to Search::Xapian.  See #523.
119   + Remove useless PerlStopper class which was an incomplete copy of the
120     apparently non-functional Search::Xapian::PerlStopper.  We now support
121     passing a Perl sub for a Stopper object.
123   + Adjust some method names to match Search::Xapian.  Iterators now support
124     inc() (and dec() where the C++ class supports operator--) like
125     Search::Xapian, rather than increment() and prev().  Reported by Eric Wong
126     in #523.
128   + Drop undocumented and unexpected extra equals() method.
130   + Provide compatibility with ENQ_ASCENDING, etc constants.  SWIG wraps these
131     as $Xapian::Enquire::ASCENDING, which better matches the C++ API, but
132     Search::Xapian wraps this as Search::Xapian::ENQ_ASCENDING, etc so provide
133     those too for compatibility.  Reported by Eric Wong in #523.
135   + Drop stringification and int conversion overloads.  These seem more
136     confusing than helpful, and overloading stringification works badly
137     with SWIG-generated bindings.
139   + Document remaining known differences from Search::Xapian.
141 * Update recently tested versions in README.
143 * Improve documentation.
145 * Fix t/02pod.t to look for files in right directory.
147 Ruby:
149 * Don't print iterator sizes to stdout.  This was some debugging accidentally
150   left in as part of a change in 1.4.12.  Patch from Dan Callaghan.
152 Xapian-bindings 1.4.15 (2020-02-24):
154 Perl:
156 * Improve comment about App::Prove.
158 Ruby:
160 * Support Ruby 2.7.
162 Xapian-bindings 1.4.14 (2019-11-23):
164 Python:
166 * Remove broken replicationtest.py.  It's never worked reliably, and because
167   of that was disabled shortly after being added over a decade ago.
168   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
169   in fixing it, so it's time to just get rid of it.  Closes #320.
171 Python3:
173 * Remove broken replicationtest.py.  It's never worked reliably, and because
174   of that was disabled shortly after being added over a decade ago.
175   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
176   in fixing it, so it's time to just get rid of it.  Closes #320.
178 Xapian-bindings 1.4.13 (2019-10-14):
180 General:
182 * Omit SWIG exception handling for destructors.  Since C++11, destructors can't
183   throw by default and we don't override that default, so there's no point
184   adding exception handling code for them.
186 * Ensure doccomments.i is distributed.  If you unpacked a distribution tarball,
187   configured it and then ran "make dist" python/doccomments.i and
188   python3/doccomments.i would be missing unless you configured the tree with
189   --enable-maintainer-mode.
191 PHP:
193 * Check for php-config5.6 and php-config5.5 in configure as these versioned
194   names are used in some packages (such as those from the ondrej/php PPA).
196 PHP7:
198 * Work around build failure on Illuminos.  Fixes
199   https://trac.xapian.org/ticket/793, reported by Amitai Schleier.
201 Ruby:
203 * smoketest.rb: Use #push not #append on Array to restore compatibility with
204   Ruby < 2.5 (broken by changes in 1.4.12).
206 * Expand tabs in Ruby code since using spaces for indentation seems to be
207   preferred Ruby style.
209 * Remove trailing `;` from Ruby code.
211 Xapian-bindings 1.4.12 (2019-07-23):
213 Documentation:
215 * Update bindings HACKING document.  Reported as out of date by Niwesh Gupta.
217 CSharp:
219 * Work around mono terminfo parsing bug - older cli-sn fails with e.g.
220   TERM=xterm-256color due to: https://github.com/mono/mono/issues/6752
221   Encountered on Kubuntu 18.10 and debugged by Tejasvi Tomar.  Seems to be
222   fixed in the mono version in Debian buster.
224 Perl:
226 * Suppress warnings from older Perl headers due to use of constructs which look
227   like C++11 user-defined literals.  They're fixed in newer versions so they're
228   just noise in our build.  We were working around these in the CI build, so
229   drop that workaround as we want to make the build warning-clean for users
230   too.  Reported by daniel93 on #xapian.
232 Python3:
234 * Fix build for changes in Sphinx 2.0 (which drops support for sphinx.main()).
235   Fixes #778, reported by karolyi.  Also reported by Gaurav Arora.
237 * We now throw UnicodeEncodeError for bad Unicode string input.  Previously
238   cases such as a lone surrogate would be handled by quietly skipping the bad
239   codepoints when converting to UTF-8 to pass to Xapian.
241 * We no longer use the deprecated old-style Py_UNICODE API, which currently
242   gives deprecation warnings and is slated to be removed in Python 4.0.
244 Ruby:
246 * Add support for block iteration.  All the iterator methods in the Ruby API
247   now accept an optional block.  If no block is given an array is returned so
248   existing code will still work.  Partly based on a patch in
249   https://github.com/xapian/xapian/pull/232 from Cong Ding.
251 * Add missing wrappers for all the C++ methods returning iterators which
252   weren't wrapped for Ruby.  Fixes #777, reported by do.
254 * Suppress warnings from Ruby 2.3 headers due to use of register and
255   constructs which look like C++11 user-defined literals.  They're fixed in
256   newer versions so they're just noise in our build.  We were working around
257   these in the CI build, so drop that workaround as we want to make the build
258   warning-clean for users too.  Reported by daniel93 on #xapian.
260 * smoketest.rb: Don't leave temporary databases behind in /tmp.
262 Xapian-bindings 1.4.11 (2019-03-02):
264 CSharp:
266 * Make MatchAll and MatchNothing readonly.
268 Java:
270 * Simplify load-time setup of Query.OP_OR, etc which are provided for
271   compatibility with the original hand-written JNI bindings.
273 PHP:
275 * We now load the module for "make check" using -d extension=xapian which
276   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
277   the module is usually loaded in production use.
279 PHP7:
281 * Fix access to already released memory during PHP module shutdown, which often
282   didn't cause visible problems, but could result in segmentation faults, bus
283   errors, etc.
285 * Fix generated code to compile when using a ZTS-enabled build of PHP.
287 * We now load the module for "make check" using -d extension=xapian which
288   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
289   the module is usually loaded in production use.
291 Xapian-bindings 1.4.10 (2019-02-12):
293 Documentation:
295 * Use https for URLs where supported.
297 General:
299 * Wrap new DatabaseClosedError and DatabaseNotFoundError exceptions.
300   See #772 and #773.  Patches from Vaibhav Kansagara.
302 * Update expected query descriptions in tests for the xapian-core
303   change to produce flatter Query trees.
305 * Workaround Perl 5.28 -i quirk when postprocessing SWIG-generated code.
306   The commands in question are only run when maintainer-mode is enabled.
308 CSharp:
310 * C++ constant Xapian::BAD_VALUENO is now wrapped without using a getter.
311   This shouldn't affect existing user code.
313 Java:
315 * C++ constant Xapian::BAD_VALUENO is now wrapped as Java constant
316   Xapian.BAD_VALUENO.  The previous Java wrapping as function
317   Xapian.getBAD_VALUENO() is still supported for compatibility with
318   existing code.
320 * Remove redundant std::string initialisation.
322 Lua:
324 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
325   an immutable attribute.  This shouldn't affect existing user code.
327 Perl:
329 * C++ constant Xapian::BAD_VALUENO is now wrapped as Perl constant
330   Xapian::BAD_VALUENO.  The previous Perl wrapping as variable
331   $Xapian::BAD_VALUENO is still supported for compatibility with existing
332   code.
334 * Note in the POD documentation that the Error base classes which are abstract
335   in C++ don't have a new method in Perl.
337 PHP:
339 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
340   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
341   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
342   code.
344 * Remove code to work around a SWIG bug which was fixed in 2006.
346 PHP7:
348 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
349   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
350   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
351   code.
353 * configure: Check for php-config7.3 and php-config7.2 as well as
354   php-config7.1, php-config7.0 and php-config.
356 * Correct references to PHP5 in PHP7 script comments.
358 * Remove some C code which is no longer needed with PHP7.
360 Ruby:
362 * C++ constant Xapian::BAD_VALUENO is now wrapped as Ruby constant
363   Xapian::BAD_VALUENO.  The previous Ruby wrapping as function
364   Xapian::BAD_VALUENO() is still supported for compatibility with existing
365   code.
367 * We now recommend using String#encode instead of the Iconv class, since the
368   latter is no longer included with Ruby.
370 Tcl:
372 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
373   variable which can't be written to.  This shouldn't affect existing user
374   code.
376 Xapian-bindings 1.4.9 (2018-11-02):
378 PHP7:
380 * Fix to build with upcoming PHP 7.3 release, which changes array_init()
381   to not return a value instead of always returning the constant SUCCESS.
382   We were checking this return value but no longer do.
384 Xapian-bindings 1.4.8 (2018-10-25):
386 Perl:
388 * Wrap new STEM_SOME_FULL_POS constant.
390 * Add STEM_ALL_Z to qpstem export tag and POD docs.
392 * Fix Perl bindings documentation typos.
394 Python:
396 * Fix RST formatting warning during build.
398 Python3:
400 * Fix RST formatting warning during build.
402 Xapian-bindings 1.4.7 (2018-07-19):
404 Ruby:
406 * Fix -Wconversion-null warnings with newer GCC.
408 Xapian-bindings 1.4.6 (2018-07-02):
410 Documentation:
412 * Stop using "probabilistic" to mean "weighted" - we've supported other
413   families of weighting schemes since 1.3.2.
415 Packaging:
417 * Use https for tarball URLs in .spec files.  This provides protection against
418   MITM attacks on people building packages using these spec files, and is also
419   slightly more efficient as the http: URLs redirect to the https: versions
420   anyway.
422 CSharp:
424 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
425   with older SWIG, but it does with current versions, and using it means that
426   we skip any return value translation logic when an exception has been thrown.
428 Java:
430 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
431   with older SWIG, but it does with current versions, and using it means that
432   we skip any return value translation logic when an exception has been thrown.
434 * Fix leaks in binary std::string typemaps.  These are used for document values
435   and serialised data.
437 * Improve VPATH build.  Previously we looked for class files and java sources
438   in srcdir first, then in builddir.  That's backwards from how autotools
439   VPATH builds search for targets and prerequisites so reverse this order to
440   make handling of Java files more consistent.
442 Perl:
444 * Invoke prove via the App::Prove module.  This avoids potentially using
445   prove from a different Perl installation to perl (previously the user
446   needed to manually specify the corresponding PROVE= if they specify PERL= to
447   configure).  In particular this is useful on macOS when using Perl from
448   homebrew.
450 * Improve Perl Enquire::set_docid_order documentation by syncing improvements
451   from the C++ API docs.
453 Python:
455 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
456   James Aylett.
458 * Suppress clang -Wdeprecated-register warnings about uses register in C code
459   in Python.h.  We can't do anything about these other than suppress them.
461 Python3:
463 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
464   James Aylett.
466 * Suppress clang -Wdeprecated-register warnings about uses register in C code
467   in Python.h.  We can't do anything about these other than suppress them
468   (and they appear to have been removed in Python 3.4 and later).
470 * Remove unused MSet::__cmp__ extend method.  This was used in Python 2, but
471   Python 3 does things differently.  There doesn't seem a good reason to
472   provide comparison operations for MSet objects, and we don't for other
473   classes, so let's just drop this feature - it seems nobody has noticed it has
474   gone.
476 * Simplify generated wrapper post-processing.
478 Xapian-bindings 1.4.5 (2017-10-16):
480 Documentation:
482 * HACKING: Add details of Debian PHP7 packages to install for development.
484 General:
486 * Use a pattern match to ignore methods meant for internal use only rather
487   than having to list them all - they're consistently named to end with an
488   underscore.
490 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
491   Deprecation warnings are suppressed when building the bindings (because the
492   bindings usually still need to wrap deprecated C++ features) so this probably
493   has no user-visible consequences.
495 Java:
497 * Fix JNI code to be compatible with Java 6 and earlier, where the final
498   parameter of SetByteArrayRegion() was not const.  This also seems to affect
499   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
500   1.4.4.
502 Lua:
504 * Support subclassing of RangeProcessor in Lua.
506 Perl:
508 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
509   if the Perl threads module is in use.
511 * Keep references for set RangeProcessor objects, like how we do for
512   ValueRangeProcessor and various other functor objects.
514 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
515   ValueRangeProcessor is now deprecated.
517 PHP:
519 * Keep references for set RangeProcessor objects, like how we do for
520   ValueRangeProcessor and various other functor objects.
522 * Add type hints to QueryParser::add_rangeprocessor().
524 PHP7:
526 * Keep references for set RangeProcessor objects, like how we do for
527   ValueRangeProcessor and various other functor objects.
529 * Add type hints to QueryParser::add_rangeprocessor().
531 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
532   one, which in general is going to be the same but we won't have probed for
533   that unless we're also building the PHP5 bindings, which means "make check"
534   failed for PHP7 unless you also had the PHP5 bindings enabled.
536 Python3:
538 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
539   3.2 doesn't support the u'foo' syntax.
541 * Copy over Python2 check which aims to catch any internal functions, methods,
542   constants, etc which have accidentally been wrapped.
544 Ruby:
546 * Fix dependency generation for Ruby SWIG command (only relevant at all if
547   you configure with --enable-maintainer-mode).
549 Xapian-bindings 1.4.4 (2017-04-19):
551 General:
553 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
554   descriptions in certain cases.
556 Packaging:
558 * Ship java.i in tarball.
560 Java:
562 * Handle object serialisations and document values as Java byte[].  These will
563   usually contain binary data, so Java String doesn't work well and byte[] is a
564   much better fit.
566 * Correct various errors in java examples and documentation on how to run them.
568 * Fix java examples not to abuse doc values as fields - use the document data
569   instead.
571 * "make clean" now removes additional class files.
573 PHP7:
575 * Update version of SWIG required to >= 3.0.12 so that the code generated
576   for PHP7 no longer results in a segmentation fault on module unload with
577   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
579 Python:
581 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
582   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
583   https://bugs.debian.org/849722
585 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
586   Patricio Paez.  Fixes #749.
588 Python3:
590 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
591   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
592   https://bugs.debian.org/849722
594 Xapian-bindings 1.4.3 (2017-01-25):
596 Python:
598 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
600 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
601   function, which should be a little more efficient and makes the Python 2
602   code more closely match the Python 3 code.
604 Ruby:
606 * "make clean" should only remove docs/xapian.rb if configure option
607   --enable-documentation was used to enable all rules to rebuild documentation.
608   Reported by Samuel Williams on xapian-discuss.
610 * Fix make rule for running rdoc for the cases where srcdir != builddir.
612 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
613   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
614   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
615   cause "make install" and "make uninstall" to fail for the Ruby bindings.
617 Xapian-bindings 1.4.2 (2016-12-26):
619 General:
621 * configure: Fail with clear error with xapian-core < 1.4.0.
623 * Work around OS X "System Integrity Protection".  We can't address the problem
624   of being unable to run tests against an uninstalled tree when the interpreter
625   is in a system directory (you have to "make install" in xapian-core for that
626   case), but we can at least make this work for interpreters which aren't in
627   system directories.
629 Java:
631 * Disable parallel make for java subdirectory as it causes random build
632   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
634 * Disable automatic use of -Xcheck:jni for now as it seems to report false
635   positives with OpenJDK 8 and 9.
637 PHP:
639 * Generates smaller PHP wrappers by only emitting each unique arginfo
640   combination once (~6% saving in stripped extension module size for
641   PHP7 on x86_64 Linux).
643 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
644   default on Microsoft Windows).
646 * Add support for PHP7.
648 * Drop workaround for PHP4 from test code.
650 Python:
652 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
653   from a command line Python code snippet.  Reported by Alex Dunn in
654   https://github.com/xapian/xapian/pull/126 and solved with help from James
655   Aylett.
657 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
658   need to keep such a reference (as we already do for ValueRangeProcessor and
659   several other classes).
661 Python3:
663 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
664   from a command line Python code snippet.  Reported by Alex Dunn in
665   https://github.com/xapian/xapian/pull/126 and solved with help from James
666   Aylett.
668 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
669   need to keep such a reference (as we already do for ValueRangeProcessor and
670   several other classes).
672 Ruby:
674 * Use more conventional Ruby variable names in the examples (Ruby convention
675   uses underscores not camelcase) and fix comma/space transposition in a couple
676   of places.
678 Xapian-bindings 1.4.1 (2016-10-21):
680 Documentation:
682 * Fix --disable-documentation - in maintainer-mode, we still tried to make
683   docs/index.html for most of the bindings, which failed because the rule to do
684   so was disabled.
686 General:
688 * Update for additions to C++ API.
690 * When a backend is disabled in the xapian-core we're building against, we
691   have a stub version of any factory functions so the bindings still have
692   something to wrap.  Update these for 1.4:
693   + Disable stub for InMemory::open() when
694     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
695   + Add new optional flags parameter to both overloaded forms of
696     Remote::open_writable().
698 Portability:
700 * Drop compiler options that are no longer useful:
701   + -fshow-column is the default in all GCC versions we now support
702     (checked as GCC 4.6).
703   + -Wno-long-long is no longer necessary now that we require C++11 where
704     "long long" is a standard type.
706 Java:
708 * Use a cleaner technique to insert the Java code to load JNI library into the
709   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
710   Perl to post-process the generated wrapper.  Suggested by James Aylett.
712 * Run Java tests with -Xcheck:jni if supported, which should help catch any
713   any bugs in the JNI code.
715 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
716   to automatically determine the machine-dependent JNI include path, so add
717   another case to use "win32" on Cygwin.  Reported by John Bankert on
718   xapian-discuss.
720 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
721   There doesn't seem to be an explicit list of these directories anywhere, but
722   grepping the OpenJDK 8 source code finds additional values "darwin" and
723   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
724   Bankert on xapian-discuss).
726 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
727   involved is really just an implementation detail.
729 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
731 Perl:
733 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
734   improvement is a number of methods previously lacking docs now have them.
736 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
737   Reported by knowledgejunkie in #730.
739 Python:
741 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
743 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
744   generates for importing the compiled module in a recent version, and
745   the newer code no longer works with the wrapper renamed to
746   xapian/__init__.py.  There's currently no way to configure SWIG to produce
747   what we need so for now we run a "fixup" script over the generated wrapper
748   which replaces the complex import code with a single statement which does
749   what we want.  It also strips out various unneeded code, mostly to do with
750   handling Python 3.x (which we don't need since we have an entirely
751   separate set of bindings for that).  Reported by James Aylett in #731.
752   The way we were importing the bindings to generate the .pyc and .pyo
753   files was masking this problem, so rework that as suggested by James.
755 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
756   parallel builds (make -j) may attempt to schedule the sphinx doc build before
757   the relevant wrapper has been compiled and moved into position.  This won't
758   result in a build failure, but will silently omit API docs that sphinx
759   would otherwise include.  Patch from James Aylett.
761 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
762   doxygen comments is handled.  Patch from Vivek Pal.
764 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
765   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
766   default source encoding is UTF-8, so we don't need the equivalent change
767   there.
769 Python3:
771 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
773 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
774   generates for importing the compiled module in a recent version, and
775   the newer code no longer works with the wrapper renamed to
776   xapian/__init__.py.  There's currently no way to configure SWIG to produce
777   what we need so for now we run a "fixup" script over the generated wrapper
778   which replaces the complex import code with a single statement which does
779   what we want.  It also strips out various unneeded code, mostly to do with
780   handling Python 2.x (which we don't need since we have an entirely
781   separate set of bindings for that).  Reported by James Aylett in #731.
782   The way we were importing the bindings to generate the .pyc and .pyo
783   files was masking this problem, so rework that as suggested by James.
785 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
786   parallel builds (make -j) may attempt to schedule the sphinx doc build before
787   the relevant wrapper has been compiled and moved into position.  This won't
788   result in a build failure, but will silently omit API docs that sphinx
789   would otherwise include.  Patch from James Aylett.
791 * Fix memory leak converting string from Python to C++.
792   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
793   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
795 Xapian-bindings 1.4.0 (2016-06-24):
797 Documentation:
799 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
800   had a chance to sort out any remaining changes we want to make.
802 Xapian-bindings 1.3.7 (2016-06-01):
804 Documentation:
806 * Remove long out-dated reference to tinderbox.
808 General:
810 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
811   us in the changes since the git snapshot we were using - mostly this means
812   we're using a released version, which seems preferable.
814 Tcl:
816 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
817   wasn't being found, so libtclstub wasn't being linked to, which is required
818   with Tcl >= 8.6.
820 Xapian-bindings 1.3.6 (2016-05-09):
822 General:
824 * Update for changes to the C++ API.
826 * Use WritableDatabase::commit() instead of flush() in testcases, as the
827   latter is now formally deprecated.
829 Java:
831 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
832   change.  Noted on #xapian-discuss by Aakash Muttineni.
834 * Update Java TODO list.
836 * SmokeTest.java: Port over version checks from SmokeTest.cs.
838 * Update list of recently tested JDK versions.
840 Lua:
842 * Note Lua bindings work with Lua 5.3.
844 Perl:
846 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
847   HTML docs.
849 * Convert POD to HTML when building from a source tarball - the conversion
850   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
851   output, as reported by Anthony Basile.
853 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
854   from the Perl interpreter found by configure, rather than assuming pod2html
855   is on PATH, and the right one (this matters more now that it's not just
856   people building from git who build these docs).
858 * Improve Perl bindings POD documentation.
860 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
861   a different workaround to the generated C++ wrapper file, and we require SWIG
862   3.0.8 for a Python fix, so we no longer need our workaround.
864 Python:
866 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
867   system, so I'm guessing this is now required due to a change in the code SWIG
868   generates.
870 Python3:
872 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
873   system, so I'm guessing this is now required due to a change in the code SWIG
874   generates.
876 * Fix install location for python3 docs.  They were being install to the same
877   path as the python docs - now the path includes "python3" instead of
878   "python".
880 Ruby:
882 * Increase minimum Ruby version to 2.1, as older versions are no longer
883   supported by the Ruby developers.
885 Xapian-bindings 1.3.5 (2016-04-01):
887 This release includes all changes from 1.2.23 which are relevant.
889 Documentation:
891 * Fix to install docs when not in maintainer-mode.
893 * Note open_stub() is deprecated (most of the bindings already noted this, but
894   now ruby and tcl do too).
896 General:
898 * Update for changes to the C++ API.
900 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
901   Joost Cassee.
903 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
905 * Add installcheck-local make targets for most languages - these run the
906   testsuites using the installed bindings.
908 CSharp:
910 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
911   dmcs were all deprecated in Mono 2.11.
913 * configure: Strip out handling of DotGNU - it's been inactive for years, and
914   was officially "decommissioned" in December 2012.
916 * README: Update list of mono versions recently tested with.
918 Lua:
920 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
921   now appends ".0" for whole numbers.
923 Perl:
925 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
926   need this to correctly handle references to other Xapian classes.  Reported
927   on #xapian-discuss by HowManny and abhishek_rand0wn.
929 Python:
931 * Run sphinx at build time.  It's an extra tool for people building from source
932   to have to install, but its output is rather large (this change reduces our
933   tar.xz size by ~20%), and its output includes a source-less minified copy of
934   jquery.
936 Python3:
938 * Run sphinx at build time.  It's an extra tool for people building from source
939   to have to install, but its output is rather large (this change reduces our
940   tar.xz size by ~20%), and its output includes a source-less minified copy of
941   jquery.
943 * Fix handling of integer values larger than a C int by bootstraping with a
944   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
946 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
947   function, and the Python3 bindings haven't yet had a stable release.
949 Ruby:
951 * Run rdoc at build time - it is included as part of the Ruby core
952   distribution, so we can assume it is available if ruby is, and avoid shipping
953   its rather large generated output in our source tarball.
955 Xapian-bindings 1.3.4 (2016-01-01):
957 This release includes all changes from 1.2.22 which are relevant.
959 General:
961 * Wrap new and changed features in C++ API.
963 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
964   reported by Richard Boulton.
966 * configure script now defaults to looking for xapian-config-1.3.  This is now
967   automatically done for development series (odd middle component of the
968   version number), but not for stable series (even middle component).  Fixes
969   #695, reported by Jorge C. Leitão
971 PHP:
973 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
974   EOL.
976 * In the examples, when iterating an MSet with foreach, don't throw the docid
977   away as $dummy, put it in $docid and use it - the code looks cleaner, and
978   this avoids an extra call to C++ to get the docid on each iteration.
980 Python:
982 * Drop support for Python 2.5.
984 Python3:
986 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
987   Leitão.
989 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
991 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
992   patch from UsusDei.
994 * Fix Python 3 version check to accept 3.10.
996 Xapian-bindings 1.3.3 (2015-06-01):
998 This release includes all changes from 1.2.20-1.2.21 which are relevant.
1000 Documentation:
1002 * INSTALL: IRIX is past EOL so drop information about IRIX make.
1004 General:
1006 * Add DB_RETRY_LOCK as a constant to wrap.
1008 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
1010 * Fix "make install" from a git tree configured with --disable-documentation.
1011   (Fixes #658, reported by Germán M. Bravo)
1013 * Fix "make install" when building from git with --disable-documentation.
1015 * Fix to handle a VPATH build from a tarball when the generated docs will be in
1016   $(srcdir).
1018 * Update testcases for lazy wildcard expansion change in xapian-core.
1020 * Update for addition of XAPIAN_NOEXCEPT.
1022 * Don't wrap internal methods of Xapian::Weight.
1024 Portability:
1026 * Require a compiler with good C++11 support, like xapian-core now does.
1028 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
1029   doxygen.
1031 * configure: Update check for -fvisibility to match xapian-core's.
1033 CSharp:
1035 * Fix configure test for whether $CLI can run CSharp programs - previously it
1036   would always fail, which would mean that the CSharp tests wouldn't be run on
1037   platforms where CSharp programs can't be run directly.
1039 Java:
1041 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
1043 Lua:
1045 * The Lua bindings are no longer considered to be "experimental" (in reality
1046   they haven't been for some time).
1048 Perl:
1050 * Add a "LICENSE" section to the main POD.
1052 * Add 'use strict' to all testcases, and add missing instances of 'my' that
1053   this change uncovered.
1055 * Wrap new WILDCARD_LIMIT_* constants as constants.
1057 Python:
1059 * Don't release the GIL when constructing a Query object from a sequence of
1060   Query objects and/or strings.
1062 * python/smoketest.py: Add new testcase to catch any internal functions,
1063   methods, constants, etc which have accidentally been wrapped.
1065 Python3:
1067 * The Python3 bindings are no longer considered to be "experimental".
1069 * Don't release the GIL when constructing a Query object from a sequence of
1070   Query objects and/or strings.  (fixes #346)
1072 * python3/pythontest.py: Expand comment about disabling test_import_star under
1073   threads.
1075 Tcl:
1077 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
1078   version added ::tcl::pkgconfig, which makes the configure tests simpler and
1079   more reliable.
1081 * Adjust precedence of the typecheck typemap for wrapping constructing a query
1082   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
1083   constructor correctly.
1085 Xapian-bindings 1.3.2 (2014-11-24):
1087 This release includes all changes from 1.2.16-1.2.19 which are relevant.
1089 Documentation:
1091 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
1093 * Update for deprecation of Xapian::Chert::open().
1095 * Update for renaming of "brass" backend to "glass".
1097 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
1098   updated" information isn't all that informative anyway - there can still be
1099   stale information even if the file was updated very recently.
1101 General:
1103 * Releases and snapshots are now bootstrapped using a more recent version of
1104   SWIG (a git snapshot from after the 3.0.3 release).
1106 * configure: Fix SWIG version check to accept 3.x, and update the minimum
1107   accepted version to be what we actually currently want.
1109 * Wrap new C++ API features, and in particular all the new weighting schemes,
1110   the changes to opening databases, and Xapian::Snipper.
1112 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
1113   argument which the C++ API takes.  If opts != 0, then output is sent to
1114   stdout, otherwise no output is produced.
1116 * Object descriptions are now always valid UTF-8. (see #620)
1118 * Provide a SimpleStopper constructor which provides the ability to initialise
1119   from a stopword list in a file.  Based on patch from Assem Chelli.
1121 CSharp:
1123 * README: Note that C# bindings now need .NET 2 or later (because that's what
1124   SWIG-generated code now requires).
1126 Java:
1128 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
1129   Anish Kanchan.  (see #616, reported by "Naveen")
1131 Lua:
1133 * Document that constants can now be accessed using CLASS.CONSTANT as well as
1134   CLASS_CONSTANT.
1136 Perl:
1138 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
1139   overlap with the hand-coded XS 'Search::Xapian' module.
1141 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1142   during parallel builds.
1144 * Use croak_sv() or ERRSV if defined.
1146 PHP:
1148 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
1149   reached EOL.
1151 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
1152   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
1153   `foreach ($it as $c)` works and allows iterating through the equivalent of
1154   C++ operator* on the iterator.  (fixes#652)
1156 * Fix handling of an exception thrown from a PHP implementation of
1157   FieldProcessor::apply().
1159 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
1160   weight threshold.
1162 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1163   available it will now only look in the configured extension directory.  The
1164   upshot is that there no longer seems to be a sane way to install the PHP
1165   bindings without being root.  Fixes #661, reported by Felix Ostmann.
1167 Python2:
1169 * The python testsuite already tested if any constants weren't marked with
1170   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
1171   clearly point to the actual problem.  Now we report the names of any
1172   such constants.
1174 * In the testsuite, use the xapian.WritableDatabase constructor rather than
1175   chert_open() - that code dates back to when chert was the only disk-based
1176   backend to support valuestreams, but flint was the default backend.
1178 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1179   Germán M. Bravo in github PR59.
1181 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1183 Python3:
1185 * Python 3 support has been split off into its own subdirectory, and should now
1186   be usable.  3.2 is the minimum supported version currently.  Existing code
1187   will need updating for Python 3, and the wrapped API is necessarily different
1188   in how Unicode is handled, so we've dropped deprecated features (such as
1189   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
1191 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1192   Germán M. Bravo in github PR59.
1194 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1196 Ruby:
1198 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
1199   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
1200   picking ruby 1.6.
1202 Xapian-bindings 1.3.1 (2013-05-03):
1204 This release includes all changes from 1.2.10-1.2.15 which are relevant.
1206 Documentation:
1208 * HACKING: Document Debian packages needed for each language.
1210 General:
1212 * Wrap new C++ API features.
1214 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
1215   unnecessary exception handling code where we call such functions and
1216   methods.
1218 * Tweak wrapping of Query from list constructor so the needed number of
1219   elements get preallocated.
1221 * Ignore Query(Query::Internal&) constructor, which is for internal use
1222   only.
1224 * For all languages except C# and Java, wrap the functions declared in
1225   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
1226   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
1227   languages.
1229 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
1230   dependencies, and adjusts the generated dependencies to work in our build
1231   system.
1233 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
1234   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
1235   V=1' and 'make V=0' which are broadly equivalent and more standard.
1237 * Fix the tests to work with the new automake parallel test driver.
1239 Portability:
1241 * Improve workaround which allows building against an uninstalled xapian-core
1242   on OS X - this should now work with any uninstalled xapian-core (not only in
1243   a tree with the same layout as an SVN or git checkout) and it also won't try
1244   to build against "../xapian-core/.libs" just because it happens to exist.
1245   (Fixes #322)
1247 CSharp:
1249 * configure: The variable to specify the interpreter is now CLI (was MONO, but
1250   didn't actually work properly).
1252 Java:
1254 * Document that we aim to support JDK 1.6 (Java 6) and later.
1256 * Avoid generating a temporary C++ vector of Query objects when constructing
1257   a Query from a Java array of Query objects or a Java array of strings.
1259 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
1260   ValueIterator, and TermIterator.
1262 * Add Enquire.getMatchingTerms().
1264 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
1265   building, e.g. "make JAVACFLAGS=-g".
1267 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
1268   with (the rather elderly) ECJ 3.3.1.
1270 Perl:
1272 * Fix PostingIterator wrapper to work.
1274 * Update list of unwrapped things in POD documentation.
1276 * Improve test coverage.
1278 * perl/t/10query.t: Adjust regexp which checks expected error message to work
1279   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
1281 * Probe for the test running tool 'prove' in configure.
1283 PHP:
1285 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
1286   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
1287   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
1288   compiled PHP module by 6%.
1290 * php/smoketest.php: Add more tests of geospatial API.
1292 Python:
1294 * Drop support for Python 2.4.
1296 * python/smoketest2.py: Add more testcases.
1298 * python/smoketest2.py: Improve reporting of test failures for certain
1299   testcases.
1301 * Update Python 3 tests from Python 2 versions using 2to3.
1303 Xapian-bindings 1.3.0 (2012-03-14):
1305 Documentation:
1307 * In maintainer builds, run doxygen to generate XML for the bindings in the
1308   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
1310 General:
1312 * Wrap new geospatial API.
1314 * Wrap new database checking API.
1316 * Deprecated features scheduled for removal in 1.3.0 have been removed.
1318 * Wrap ExpandDecider even if we don't have director support - there's a
1319   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
1320   needs some typemap work to actually get it usefully wrapped.
1322 * configure:
1324   + Add --disable-visibility option to match xapian-core.
1326   + Add -fshow-column for GCC.
1328   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
1329     variable, so that it's easy to override it if you're getting a new warning
1330     from SWIG but want to just ignore it for the time being.
1332 * Exception handling now uses Error::get_description() rather than get_type +
1333   ": " + get_msg().  In many cases this is the same, but if context or errno
1334   are available, get_description() includes them.  Catch and report
1335   std::exception rather than handling it as an unknown error (so in particular
1336   std::bad_alloc will now be reported more helpfully).
1338 CSharp:
1340 * Avoid generating unwanted wrapper sources
1341   SWIGTYPE_p_std__vectorT_std__string_t.cs and
1342   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
1344 Java:
1346 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
1347   bindings promoted in their place.  This means almost the entire C++ API is
1348   now wrapped for Java, but the downside is there are some changes required
1349   to existing code.  Overall we feel the short-term pain is worth the long
1350   term benefits of having Java bindings which stay up to date.
1352 * java/SmokeTest.java: Add test that string passing is zero byte safe.
1354 Lua:
1356 * Improve error messages.
1358 Perl:
1360 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
1361   Perl 5.14.
1363 * Fix Search::Xapian::Query->new() to work.
1365 * Enable warnings for all test cases and make them fatal.
1367 * Add "use Carp;" where we use functions from that module.
1369 * Improve POD docs for Document and TermGenerator methods - "weight" is
1370   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
1372 * The Query constructor which takes an array of subqueries is now wrapped more
1373   efficiently - previous a temporary C++ std::vector was built but now we avoid
1374   doing this.
1376 PHP:
1378 * PHP >= 5.3 is now required.
1380 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
1382 * The XapianQuery constructor which takes an array of subqueries is now
1383   wrapped more efficiently - previous a temporary C++ std::vector was built
1384   but now we avoid doing this.
1386 Python:
1388 * Python >= 2.4 is now required.
1390 * Remove deprecated Stem_get_available_languages().
1392 * Hide away the deprecated non-pythonic iterators - we still need them to
1393   implement the pythonic iterators, so we can't entirely remove them.
1395 * Replace SWIG's thread locking with code which does nothing unless threads
1396   are already initialised, to avoid the overhead of thread locking in the
1397   common case of single-threaded Python code.  This seems to be about 5-10%
1398   faster for pythontest2.py modified to repeat the tests 100 times.
1400 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
1401   #364.
1403 * The Query constructor which takes an array of subqueries is now wrapped more
1404   efficiently - previous a temporary C++ std::vector was built but now we avoid
1405   doing this.
1407 Ruby:
1409 * The XapianQuery constructor which takes an array of subqueries is now
1410   wrapped more efficiently - previous a temporary C++ std::vector was built
1411   but now we avoid doing this.
1413 Tcl:
1415 * The XapianQuery constructor which takes an array of subqueries is now
1416   wrapped more efficiently - previous a temporary C++ std::vector was built
1417   but now we avoid doing this.
1419 Xapian-bindings 1.2.23 (2016-03-28):
1421 Documentation:
1423 * Update links to Xapian website and trac to use https, which is now supported,
1424   thanks to James Aylett.
1426 PHP:
1428 * Check that the PHP interpreter we find is actually PHP5, and if not look
1429   harder.  On current Debian unstable, php-config5 --php-binary reports
1430   /usr/bin/php which can be PHP7.
1432 * Document that PHP7 isn't currently supported, and explicitly check for and
1433   reject it in configure.
1435 Ruby:
1437 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
1438   fall-back case when rdoc wasn't found in the same directory as the ruby
1439   interpreter).
1441 Xapian-bindings 1.2.22 (2015-12-29):
1443 Documentation:
1445 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
1446   'git cherry-pick' from working as it should.  The git repo history should be
1447   sufficient for complying with GPLv2 2(a).
1449 General:
1451 * Stop wrapping internal methods of Xapian::Weight.
1453 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
1454   many cases this is the same, but if context or errno are available,
1455   get_description() includes them.
1457 * Catch and report std::exception rather than handling it as an unknown error
1458   (so in particular std::bad_alloc will now be reported more helpfully).
1460 CSharp:
1462 * Fix configure test for whether $MONO can run CSharp programs - previously it
1463   would always fail, which would mean that the CSharp tests would only be run
1464   on systems where CSharp programs can be run directly.
1466 Lua:
1468 * Send stderr from lua version check to config.log instead of letting it appear
1469   on the terminal.
1471 PHP:
1473 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1475 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1476   constructors now work.
1478 Python:
1480 * Add new testcase to catch any internal functions, methods, constants, etc
1481   which have accidentally been wrapped.
1483 Xapian-bindings 1.2.21 (2015-05-20):
1485 Lua:
1487 * README: Remove note about the Lua bindings being experimental - it's not
1488   really been true for some time now.
1490 Perl:
1492 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1494 * Add workaround for Perl defining a seed() macro which breaks compilation with
1495   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1496   classes with a method called seed).
1498 * Update list of unwrapped things in POD documentation.
1500 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1501   during parallel builds.
1503 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1505 * Add test that we can create all the stemmers returned by
1506   Stem::get_available_languages().
1508 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1509   likely due to external reasons, like incompatible compiler flags being taken
1510   from Perl's Config module, due to Perl having been built with a different
1511   compiler to Xapian.
1513 * Use croak_sv() or ERRSV if defined.
1515 PHP:
1517 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1518   was fixed in 1.2.19.
1520 Python:
1522 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1523   stable release 1.4.0.
1525 Ruby:
1527 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1529 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1530   https://bugs.debian.org/782270
1532 Xapian-bindings 1.2.20 (2015-03-04):
1534 Portability:
1536 * configure: Avoid using \? in sed command in Lua detection - it isn't
1537   supported by all sed implementations.
1539 Lua:
1541 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1542   being specified without a leading '.'.
1544 * configure: Add an example of specifying LUA_SO to --help output.
1546 PHP:
1548 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1549   1.2.19.
1551 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1552   available it will now only look in the configured extension directory.  The
1553   upshot is that there no longer seems to be a sane way to install the PHP
1554   bindings without being root, so update the documentation to reflect this.
1555   Fixes #661, reported by Felix Ostmann.
1557 Xapian-bindings 1.2.19 (2014-10-21):
1559 PHP:
1561 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1562   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1563   Gottfried)
1565 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1566   which were getting incorrectly wrapped such that they didn't actually do
1567   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1568   reference tracking fix in 1.2.14.
1570 Ruby:
1572 * README: Note that Ruby 2.1 works too.
1574 Xapian-bindings 1.2.18 (2014-06-22):
1576 Documentation:
1578 * README: Add links to Erlang and Node.js bindings.
1580 Lua:
1582 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1583   expected), which most of the calls already used, and fix up the few calls
1584   which passed (expected, got).
1586 PHP:
1588 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1589   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1590   wasn't masking a test failure.
1592 Python:
1594 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1595   - chert is the default backend now, and both chert and brass support the
1596   required functionality for the tests which do this, so this just needlessly
1597   causes the tests to fail if chert is disabled in xapian-core.
1599 * configure: If the Python version is too new or too old, only report it once
1600   not twice.
1602 Ruby:
1604 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1605   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1607 Xapian-bindings 1.2.17 (2014-01-29):
1609 Portability:
1611 * Improve workaround which allows building against an uninstalled xapian-core
1612   on OS X - this should now work with any uninstalled xapian-core (not only in
1613   a tree with the same layout as an SVN or git checkout) and it also won't try
1614   to build against "../xapian-core/.libs" just because it happens to exist.
1615   (Backported from 1.3.1; fixes #322)
1617 Python:
1619 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1620   for a Python 2 interpreter now checks for 'python2' first, and checks that
1621   the version of found interpreter is 2.x.
1623 Ruby:
1625 * Tweak configure to work with Ruby 2.0.
1627 Tcl:
1629 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1630   in https://bugs.debian.org/724830).
1632 * Use a better check for TCL_INC for Tcl 8.5 and later.
1634 Xapian-bindings 1.2.16 (2013-12-04):
1636 Documentation:
1638 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1640 General:
1642 * Compress source tarballs with xz instead of gzip.
1644 * configure: Handle git snapshot naming.
1646 Portability:
1648 * configure: Update list of platforms where we tell libtool not to link in
1649   deplibs to match the list used for xapian-core.
1651 Perl:
1653 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1654   GCC 4.7 warning).
1656 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1657   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1659 PHP:
1661 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1662   with a message explaining this.
1664 Python:
1666 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1668 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1670 * pythontest.py: Fix testcase checking we get an exception from using
1671   non-random-access iterators after then have advanced - previously these
1672   didn't actually test as fully as intended.
1674 Ruby:
1676 * Omit internal classes and methods from the rdocs.
1678 Xapian-bindings 1.2.15 (2013-04-16):
1680 General:
1682 * Fix configure --enable-quiet option to actually work for the bindings.
1684 Perl:
1686 * Fix doc typo: "as as" -> "as a"
1688 Ruby:
1690 * Fix deprecation warning in configure from Ruby 1.9.3.
1692 Xapian-bindings 1.2.14 (2013-03-14):
1694 Python:
1696 * Fix typo in doccomment.
1698 PHP:
1700 * Keep references to the PHP wrapper object when an object is set on another
1701   object.  (fixes #614)
1703 Tcl:
1705 * Allow TCL_INC to be passed to configure.  (fixes #612)
1707 Xapian-bindings 1.2.13 (2012-11-09):
1709 CSharp:
1711 * configure: Overhaul checks for C# tools to use modern names in preference.
1713 Lua:
1715 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1717 * Document that get_description() is mapped to str(), and end() to _end().
1719 * Fix functor wrappers which return strings to be zero-byte clean.
1721 Perl:
1723 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1724   1.2's XS Search::Xapian.  (ticket#607)
1726 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1727   is deprecated.
1729 PHP:
1731 * Document that subclassing Xapian classes in PHP currently doesn't work with
1732   PHP 5.4.
1734 Xapian-bindings 1.2.12 (2012-06-27):
1736 No changes since 1.2.11 except to bump the version - this release was made to
1737 fix an incorrect library version information update in xapian-core 1.2.11.
1739 Xapian-bindings 1.2.11 (2012-06-26):
1741 General:
1743 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1745 Perl:
1747 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1748   av_fetch() (spotted due to GCC 4.7 warning).
1750 PHP:
1752 * Fix "make check" to work for PHP when building from a release tarball with
1753   srcdir != builddir.
1755 * Work around "undefined symbol: zend_error_noreturn" error.
1757 Xapian-bindings 1.2.10 (2012-05-09):
1759 CSharp:
1761 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1762   us to do this instead of setting them in AssemblyInfo.cs.
1764 * Use diff's -c option when comparing the files SWIG generated against those we
1765   were expecting to get as the output should be easier to understand.
1767 * Sort both the lists of expected and of found SWIG-generated sources with
1768   Perl, to avoid problems with locale-specific sort orders.
1770 Java-SWIG:
1772 * Remove now superfluous old check that SWIG generated at least the sources we
1773   want - we now check it generated *exactly* the sources we want.
1775 * Use diff's -c option when comparing the files SWIG generated against those we
1776   were expecting to get as the output should be easier to understand.
1778 * Sort both the lists of expected and of found SWIG-generated sources with
1779   Perl, to avoid problems with locale-specific sort orders.
1781 Lua:
1783 * Now works with Lua 5.2.
1785 * "require 'xapian'" now returns the module table.  (ticket #593)
1787 * lua/smoketest.lua: Improve reporting of test failures.
1789 Perl:
1791 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
1793 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
1794   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
1796 Python:
1798 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
1799   iteration features which have been removed on trunk.  This also fixes a
1800   segfault if there are no matches and no documents are explicitly marked as
1801   relevant.
1803 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
1804   way to rerun tests with verbose output.
1806 Ruby:
1808 * configure: Make sure the ruby subdirectory exists before trying to create
1809   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
1811 Xapian-bindings 1.2.9 (2012-03-08):
1813 Java:
1815 * configure: Fix test for jni.h to try looking for jni.h relative to the real
1816   location of javac, which should work for more JDKs.
1818 Lua:
1820 * Handle an exception from C++ by raising a xapian.Error object as an error in
1821   Lua.
1823 * Rename get_description() methods to __tostring(), so that you can use write
1824   tostring(obj) in Lua.
1826 * configure: Honour LUA_LIB if already set.  Fixes #581.
1828 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
1829   support platforms where the compiled Lua module isn't called .so.
1831 Perl:
1833 * Add tests of Document::get_docid().
1835 PHP:
1837 * Add a test that Query constructor taking OP_NEAR with a window size works.
1839 Python:
1841 * python/testsuite2.py: Don't run off the traceback looking for a test function
1842   if the exception wasn't from a test function.
1844 Xapian-bindings 1.2.8 (2011-12-13):
1846 Lua:
1848 * Wrap user-subclassable functor objects by allowing the user to pass a
1849   Lua function where the functor object would be passed in the C++ API.
1851 PHP:
1853 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
1855 * The PHP bindings will now work again with a version of PHP built with ZTS
1856   enabled (which is the default on Microsoft Windows).  This was broken by
1857   the changes to support subclassing in PHP in the version of SWIG used since
1858   1.2.6.
1860 Python:
1862 * Add a module docstring.  (Fixes bug #573)
1864 * The python testsuite now checks for object leaks during each testcase.
1866 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
1867   only check for leaks the second time to avoid falsely reporting a leak when
1868   some cached value gets initialised under Python 2.5.
1870 Ruby:
1872 * Wrap optional prefix parameter to Database::allterms.
1874 Xapian-bindings 1.2.7 (2011-08-10):
1876 Documentation:
1878 * INSTALL: Pull in a few updates from the latest version of the automake
1879   document which this file was originally based on.  Add in the missing
1880   copyright and licensing information.
1882 * INSTALL: Add --with-lua to list of options.
1884 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
1885   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
1886   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
1887   supported platforms in the README.
1889 * HACKING: Update and start section on deprecation warnings for the bindings.
1891 General:
1893 * Add missing wrappers for Database::has_positions() and
1894   TermIterator::positionlist_count(), and correct the return type of
1895   Database::get_doclength() from double to Xapian::termcount.
1897 CSharp:
1899 * README: Note a recent version of Mono which we've tested the C# bindings
1900   with.
1902 * Check that exactly the sources we expect are generated, and add some sources
1903   which were missing from the list.
1905 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
1906   gets removed.
1908 * Fix iterator ++ and -- so that the reference to the object isn't released
1909   prematurely, which was causing an occasional crash if the garbage collection
1910   happened at just the wrong moment,
1912 * Add test coverage for QueryParser.ParseQuery() with flags argument.
1914 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1916 Java:
1918 * SmokeTest.java: Fix == comparisons with strings to use equals().
1920 * Add test that string passing is zero byte safe.
1922 * Fix MyExpandDecider.accept() to really check the passed parameter.
1924 Java-SWIG:
1926 * Put the SWIG-generated Java bindings in package org.xapian.
1928 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1930 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
1932 * Add test that string passing is zero byte safe.
1934 * Fix MyExpandDecider.accept() to really check the passed parameter.
1936 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
1938 * Create an HTML documentation page based on java/README.
1940 * Copy java examples from the hand-coded JNI ones.
1942 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
1944 * Check that exactly the sources we expect are generated, and add some sources
1945   which were missing from the list.
1947 Lua:
1949 * Merge latest Lua changes from Xiaona Han.
1951 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
1953 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
1954   matches.
1956 Perl:
1958 * Sync updates to examples from XS Search::Xapian:
1960   + Require Perl >= 5.6 so we can "use warnings;".
1962   + Loop over file using while() (which reads a line per iteration) not
1963     foreach() (which reads the whole file up front).
1965 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1966   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1968 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1970 * perl/Makefile.am: Fix "make check".
1972 * perl/t/symbol-test.t: Fix to work when built against an installed
1973   xapian-core.  (ticket#558)
1975 PHP:
1977 * php/smoketest.php: Install an error handler so the test fails if there are
1978   any errors, warnings, notices, etc.
1980 * Change PHP examples and test program to use 'include "xapian.php"' like user
1981   code should (rather than 'include "php5/xapian.php"' as they did previously).
1983 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
1984   XapianQuery::MatchNothing(). (ticket#158)
1986 Ruby:
1988 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
1990 Xapian-bindings 1.2.6 (2011-06-12):
1992 General:
1994 * SWIG-based bindings are now generated with a newer version of SWIG
1995   (ticket#538).
1997 Portability:
1999 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
2000   .jnilib extension as we do for older versions.
2002 CSharp:
2004 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
2006 Java:
2008 * Fix memory leaks when functions taking string parameters throw exceptions.
2010 * Previously a hash table was used to map Java objects to C++ ones, but we
2011   now just cast the address of the C++ object to a jlong (which is 64 bits
2012   so will hold a pointer on current platforms).  This is more efficient and
2013   avoids the need for thread locks around accesses to the hash table.
2015 * Remove explicit checks for NULL around calls to delete.
2017 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
2018   during parallel builds.
2020 Lua:
2022 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
2023   year.  The current support should be regarded as experimental - it passes
2024   its automated tests, but the details of the Lua API are likely to evolve as
2025   the project progresses.
2027 Perl:
2029 * README: say that Perl bindings probably need Perl 5.8 or later.
2031 PHP:
2033 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
2035 Python:
2037 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
2038   all the garbage, so repeat until no further objects are freed.
2039   (https://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
2041 Ruby:
2043 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
2044   the compaction tests for these versions.
2046 Xapian-bindings 1.2.5 (2011-04-04):
2048 Documentation:
2050 * README: Update info on SWIG-based Perl bindings.
2052 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
2053   section with better equivalent from xapian-core/INSTALL.
2055 General:
2057 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
2059 * configure: If xapian-core is a different release series, promote the
2060   mismatched versions warning to an error.
2062 Portability:
2064 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
2065   10.4 on x86, as the default if unset on these versions is the current OS
2066   version.  (ticket#541)
2068 * python/pythontest2.py: In test_compactor(), close any open databases before
2069   removing the directory as you can't delete an open database on Microsoft
2070   Windows.  (ticket#526)
2072 CSharp:
2074 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
2076 * Clarify the licence is GPL "version 2 or later" in the meta information
2077   we put in the module.
2079 Python:
2081 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
2082   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
2083   accidentally left an older version of get_matching_terms() exposed.
2085 * Remove broken implementation of MSet.__contains__.  This appears never to
2086   have worked, and to have been broken for at least the past 3.5 years without
2087   anyone mentioning it, and is probably of little use anyway, so no need to
2088   deprecate.
2090 * python/docs/index.html: Document that MSet.items and ESet.items are
2091   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
2092   the tuple returned by MSet.items.  (ticket#531)
2094 * Add test coverage for mset.items.
2096 Ruby:
2098 * Add test coverage for Xapian::Compactor.
2100 * Handle an empty response to $RUBY --version specially.  This gives a less
2101   opaque error in cases where the user specified RUBY but the value given
2102   wasn't an executable file.
2104 Xapian-bindings 1.2.4 (2010-12-19):
2106 General:
2108 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
2109   virtual method is wrapped for subclassing for Python and Ruby currently.
2111 * Eliminate separate Makefile.am in the docs subdirectory of each language
2112   subdirectory and just inline any rules into the main sub-Makefile.am, which
2113   allows more of the build to run in parallel.
2115 * Don't ship some files which are generated at build time.
2117 * configure: Need python in maintainer mode to run doxy2swig.py.
2119 Packaging:
2121 * RPM: Package the Perl bindings.
2123 * RPM: Don't package _XapianSharp.la.
2125 Portability:
2127 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
2128   uninstalled Xapian library.  See ticket #322.
2130 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2132 CSharp:
2134 * Don't install _XapianSharp.la.
2136 Perl:
2138 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
2139   GSoC 2009.  These are close to being a compatible replacement for the
2140   hand-coded XS bindings in Search::Xapian but also offer a more complete
2141   wrapping of the C++ API.  We're planning to replace the XS bindings with the
2142   SWIG ones for easier maintenance.  We encourage you to try them and let us
2143   know how you get on - particularly if you find cases where code which works
2144   with the XS bindings doesn't work with the SWIG ones.
2146 PHP:
2148 * Document that iterators shouldn't be dereferenced or advanced when at their
2149   end points (ticket#520).
2151 Python:
2153 * Fix memory leaks in typemaps which return Python lists.
2155 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
2156   supported.
2158 * configure: Use sys.version_info tuple, rather than string splicing which
2159   assumes the Python "major.minor" is 3 characters (which would fail if Python
2160   2.10 were ever released, for example).
2162 Xapian-bindings 1.2.3 (2010-08-24):
2164 Packaging:
2166 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
2168 Xapian-bindings 1.2.2 (2010-06-27):
2170 * No user-visible change except for bumping the version to indicate
2171   compatibility with Xapian-core 1.2.2.
2173 Xapian-bindings 1.2.1 (2010-06-22):
2175 This release includes all changes from 1.0.21 which are relevant.
2177 General:
2179 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
2180   Python.  (ticket#448)
2182 Guile:
2184 * Remove non-functional disabled guile bindings left over from Open Muscat
2185   days - if someone wanted to add guile bindings, it would be easier to start
2186   from scratch.
2188 Java-SWIG:
2190 * Update list of generated java sources in the SWIG-based Java bindings.
2192 PHP:
2194 * zend_throw_exception() returns, so return control to PHP directly after
2195   calling it to avoid needless extra work and possible issues.
2197 Python:
2199 * Fix "from xapian import *".  (ticket#477)
2201 * Fix testcase weight_normalise - a change in xapian-core means that
2202   get_max_possible() can now return zero for a non-existent term, so don't
2203   blindly calculate the reciprocal of it.
2205 * python/replicationtest2.py: Extend to check that changesets get applied
2206   correctly.
2208 * python/smoketest2.py: Check len(mset) works (improving test coverage of
2209   Python-specific wrapping).
2211 Xapian-bindings 1.2.0 (2010-04-28):
2213 This release includes all changes from 1.0.20 which are relevant.
2215 Portability:
2217 * configure: Tell libtool not to link in deplibs on platforms where we know
2218   they aren't needed.
2220 * configure: On Linux, extract the library search path from ldconfig which
2221   gives us the default entries reliably.
2223 Xapian-bindings 1.1.5 (2010-04-15):
2225 This release includes all changes from 1.0.19 which are relevant.
2227 Tcl:
2229 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
2230   sidestep the whole destructor issue.  (ticket#62)
2232 Xapian-bindings 1.1.4 (2010-02-15):
2234 This release includes all changes from 1.0.18 which are relevant.
2236 General:
2238 * Update for the new Brass backend and other C++ API changes.
2240 * Wrap Database::get_doclength_lower_bound(),
2241   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
2242   Database::valuestream_begin() and Database::valuestream_end() for all
2243   languages. (ticket#431)
2245 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
2247 Python:
2249 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
2250   object which dereferences to a ValueStreamItem object,
2252 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
2254 Ruby:
2256 * Add safe wrapper for the valuestream iterator.
2258 Xapian-bindings 1.1.3 (2009-11-18):
2260 This release includes all changes from 1.0.15-1.0.17 which are relevant.
2262 General:
2264 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
2265   specified.
2267 * Wrap the new MatchSpy class, and associated features.
2269 * Don't wrap PostingSource::serialise(), Weight::serialise() and
2270   Weight::unserialise() as they aren't useful from the bindings.
2272 * Update for the Sorter to KeyMaker changes.
2274 PHP:
2276 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
2277   as it standardly is on Microsoft Windows.  Fixes #411.
2279 * Merged the PHP "smoketest" back together now we don't need to support
2280   PHP4 now.
2282 Python:
2284 * Fix a memory leak on error (in theory - we've not got a way to generate this
2285   error, so haven't been able to reproduce the leak or test the fix).
2287 Xapian-bindings 1.1.2 (2009-07-23):
2289 This release includes all changes from 1.0.14 which are relevant to trunk.
2291 Python:
2293 * Several changes towards fully supporting Python 3, but more work is required.
2294   (ticket#246)
2296 Xapian-bindings 1.1.1 (2009-06-09):
2298 This release includes all changes from 1.0.13 which are relevant to trunk.
2300 General:
2302 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
2304 CSharp:
2306 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2307   C# yet, and to use Query("") and Query() instead.
2309 * configure: If we don't find a C# compiler, don't test an empty command name
2310   further which saves a fork and avoids an odd looking message.
2312 PHP:
2314 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2315   PHP yet, and to use Query("") and Query() instead.
2317 Python:
2319 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
2320   are wrapped (ticket#158).
2322 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
2323   expect SYNONYM in generated query.
2325 Ruby:
2327 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2328   Ruby yet, and to use Query("") and Query() instead.
2330 Tcl:
2332 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
2333   are wrapped (ticket#158).
2335 Xapian-bindings 1.1.0 (2009-04-22):
2337 Documentation:
2339 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
2340   the instructions to suggest users use this standard location for installing
2341   without root access.
2343 General:
2345 * All deprecated features slated for removal in 1.1.0 have been removed.
2347 * All new C++ API features have been wrapped.  Also, since we now supply some
2348   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
2349   these can be passed in even for languages for which SWIG doesn't support
2350   subclassing.
2352 Packaging:
2354 * xapian-bindings.spec: Updated to reflect the new Python packaging.
2356 Portability:
2358 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
2359   to put the compiler into ISO C++ mode).
2361 PHP:
2363 * PHP4 support has been removed, since PHP4 is no longer supported upstream
2364   as of 2008-08-08.
2366 Python:
2368 * Python 2.3 or later is now required.  2.2 is essentially unsupported
2369   upstream.
2371 * The import method used has been changed (by using a newer SWIG version)
2372   and no longer gives a warning with Python 2.6.
2374 * Initial support for Python 3.0 has been added.  This currently doesn't
2375   work correctly and should be treated as experimental. (ticket#346)
2377 * The newer SWIG version handles exceptions in director methods correctly
2378   so we no longer need our workaround for ticket #289.
2380 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
2381   wrapped for Python as Database.metadata_keys().
2383 * The Python bindings are now installed as a python package, with the
2384   files in a xapian subdirectory, hiding the internal _xapian module
2385   better.
2387 * Python now flags deprecation warnings for the single argument form and old
2388   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
2389   friends.
2391 Xapian-bindings 1.0.23 (2011-01-14):
2393 Portability:
2395 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2397 PHP:
2399 * Document that iterators shouldn't be dereferenced or advanced when at their
2400   end points (ticket#520).
2402 Python:
2404 * Fix memory leaks in typemaps which return Python lists.
2406 Xapian-bindings 1.0.22 (2010-10-03):
2408 Packaging:
2410 * RPM: Don't package _XapianSharp.la.
2412 CSharp:
2414 * Don't install _XapianSharp.la.
2416 Python:
2418 * configure: Use sys.version_info tuple, rather than string splicing which
2419   assumes the Python "major.minor" is 3 characters (which would fail if Python
2420   2.10 were ever released, for example).
2422 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
2423   testcase in pythontest.py.
2425 Xapian-bindings 1.0.21 (2010-06-18):
2427 Python:
2429 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
2430   can't be written to. (ticket#297)
2432 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
2434 * Add test to check that "from xapian import *" works.
2436 Xapian-bindings 1.0.20 (2010-04-27):
2438 Python:
2440 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
2441   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
2442   trap to delete them after running tests for older versions of Python.
2443   (ticket#315)
2445 Ruby:
2447 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
2449 Xapian-bindings 1.0.19 (2010-04-15):
2451 Tcl:
2453 * tcl8/docs/index.html: Improve wording in a few places.
2455 Xapian-bindings 1.0.18 (2010-02-14):
2457 General:
2459 * Wrap new C++ API method Document::add_boolean_term().
2461 Ruby:
2463 * Generate entries in the Ruby rdocs for all classes which aren't documented
2464   because of Ruby-specific methods.  Fixes ticket#417.
2466 * Avoid absolute paths in the generated rdocs.
2468 Xapian-bindings 1.0.17 (2009-11-18):
2470 Packaging:
2472 * Improve RPM package summaries - the files are needed to *use* scripts as well
2473   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
2474   conventional.
2476 Portability:
2478 * python/Makefile.am: Restore the "./" path to the sourced file
2479   libtoolconfig.tmp as ksh requires it.
2481 Java:
2483 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2485 Xapian-bindings 1.0.16 (2009-09-10):
2487 Python:
2489 * Improved docstrings for QueryParser::set_default_op() and
2490   QueryParser::get_default_op() (automatically generated from changes in
2491   xapian-core).
2493 Xapian-bindings 1.0.15 (2009-08-26):
2495 Python:
2497 * Don't break long words when wrapping text in the generated API documentation
2498   comments as this was causing identifiers to be broken in two.
2500 Xapian-bindings 1.0.14 (2009-07-21):
2502 General:
2504 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2505   and the only side-effect was an odd looking message.
2507 Python:
2509 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2510   the latter approach adds a small time overhead when the module is being
2511   loaded.
2513 Ruby:
2515 * Fix to accept an integer value > MAXINT for a double parameter.
2517 Xapian-bindings 1.0.13 (2009-05-23):
2519 Packaging:
2521 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2522   _XapianSharp.so in 1.0.11.
2524 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2525   bindings since 1.0.6.
2527 PHP:
2529 * Backport fix from SWIG SVN for misuse of formatted error function in
2530   SWIG-generated code.
2532 Python:
2534 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2535   Python's Global Interpreter Lock (GIL) in situations where we know that it
2536   will already be locked.  This avoids some dead-locks with mod_python (due to
2537   mod_python bugs which are apparently unlikely to ever be fixed), and results
2538   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2539   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2540   faster). (ticket#185)
2542 * README,python/docs/index.html: Update documentation of the above mod_python
2543   issue and also document the related mod_wsgi issue.  The status is now that
2544   everything seems to work if you stick to the main interpreter (ticket#364).
2546 * Backport fix from SWIG SVN for misuse of formatted error function in
2547   SWIG-generated code.
2549 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2550   second parameter, not the third.
2552 * python/docs/examples/simplematchdecider.py,
2553   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2554   clearer code.
2556 Ruby:
2558 * README: Note that the testsuite fails due to a bug in the test/unit module in
2559   Ruby 1.9.0, but applications using the bindings should work, and that the
2560   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2561   appears to be completely dead both upstream and in the wild.
2563 Xapian-bindings 1.0.12 (2009-04-19):
2565 Documentation:
2567 * INSTALL: Add a note about being able to pass variables to configure to pick
2568   which of several parallel installations of a language to build for.
2570 Python:
2572 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2573   test to avoid failing due to rounding differences.
2575 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2576   stop the whole testsuite, not just the currently running testcase.
2578 Xapian-bindings 1.0.11 (2009-03-15):
2580 Documentation:
2582 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2583   Python 3, and possible current issues with Ruby 1.9.
2585 Portability:
2587 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2588   Cygwin.
2590 Python:
2592 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2593   latter is deprecated, and support was removed in 1.0.0).
2595 * Add support for using the new name ("reverse") for the second argument of
2596   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2597   The old name ("ascending") is still supported, but will be deprecated in
2598   1.1.0.
2600 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2601   which get set on other objects to avoid segmentation faults if they go out
2602   of scope before the object they are set on does.  (ticket#341)
2604 Ruby:
2606 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2607   fails so "make check" doesn't pass, but code using the bindings should work.
2609 Xapian-bindings 1.0.10 (2008-12-23):
2611 Python:
2613 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2614   as things stand (upstream fix for Debian bug 506090).
2616 Xapian-bindings 1.0.9 (2008-10-31):
2618 General:
2620 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2622 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2623   methods.
2625 Xapian-bindings 1.0.8 (2008-09-04):
2627 General:
2629 * configure: Report bug report URL in --help output.
2631 Python:
2633 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2634   (bug#289)
2636 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2638 Xapian-bindings 1.0.7 (2008-07-14):
2640 Documentation:
2642 * Document how all the database factory functions and library version functions
2643   are wrapped for all languages.
2645 General:
2647 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2649 * The "program" version of Remote::open() has been wrapped for some time, so
2650   update the documentation which said it wasn't.
2652 Packaging:
2654 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2656 Portability:
2658 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2659   different module extension rather than our own ugly bodge.
2661 Java:
2663 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2664   simple to make C++ to Java work though.
2666 PHP:
2668 * Add test that OP_VALUE_GE works for PHP.
2670 Python:
2672 * Several corrections to the Python documentation.
2674 * configure: Fix problem with building under mingw.
2676 Ruby:
2678 * Include simplematchdecider.rb example.
2680 * smoketest.rb: Test the version reporting functions.
2682 Tcl:
2684 * Include simpleexpand.tcl example.
2686 * Fix where the Tcl module gets installed.
2688 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2690 Xapian-bindings 1.0.6 (2008-03-17):
2692 General:
2694 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2695   used with.
2697 * configure: Correct the required SWIG version given in an error message.
2699 PHP:
2701 * php/smoketest.php: Add note that this script should be run using 'make check'
2702   in the build tree (rather than trying to copy it to a webserver as someone
2703   recently tried to).
2705 * php/smoketest.php: Fix to work under PHP4.
2707 Python:
2709 * The Python module now always has the extension which Python expects, which
2710   fixes a failure on Mac OS X.
2712 Ruby:
2714 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2715   with the ruby bindings.
2717 Tcl:
2719 * configure: Sort out the default value of TCL_LIB, which could end up being
2720   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2722 Xapian-bindings 1.0.5 (2007-12-21):
2724 General:
2726 * Wrap Xapian::Sorter and subclasses.
2728 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2729   and Enquire::set_sort_by_relevance_then_key().
2731 * Factor out the code to protect multitarget rules against parallel make, and
2732   fix it to handle the source being changed while the rule is executing, and to
2733   correctly return an error code if we fail while trying to recover from the
2734   removal of a target of a multi-target rule.
2736 * configure: Improve the clarity of the error given when none of the tools
2737   needed for any supported language are found.
2739 * configure: SWIG 1.3.32 has now been released, so require at least this
2740   released version for maintainer builds.
2742 Java:
2744 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2745   GCC 4.3.
2747 * configure: Log the output of trying to compile conftest.java in config.log;
2748   if the test fails, report whether the failure was compiling or running the
2749   test program.
2751 * Check for directory existence rather than calling mkdir unconditionally as
2752   despite the "(ignored)", the error message seems to confuse some people.
2754 PHP:
2756 * Add feature test for XapianMultiValueSorter.
2758 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2759   interface.  Fix the error reported when the PHP5 exception test fails.
2761 * php/smoketest.php: Add feature test to confirm that optional arguments to
2762   XapianQuery's "term" constructor are wrapped.
2764 Python:
2766 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2767   these properties build a python list, so dropping the GIL isn't safe and
2768   may cause undefined behaviour in multithreaded environments.
2770 * configure: Update error message to reflect requirement for at least python
2771   2.2.
2773 * configure: Change "print foo" to "print(foo)" in python version checks, for
2774   compatibility with python 3.0.
2776 Ruby:
2778 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
2779   previously incorrect).
2781 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
2782   ruby/docs/index.html previously had a dead link to.
2784 Tcl:
2786 * configure: Overhaul code to find tcl.h since the old version no longer worked
2787   with Debian unstable.
2789 * tcl8/docs/index.html: Update documentation to cover flint and mention that
2790   quartz is now deprecated.
2792 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
2793   throws QueryParserError instead.
2795 Xapian-bindings 1.0.4 (2007-10-30):
2797 General:
2799 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
2800   Add feature tests for all languages.
2802 * The "bindings.html" file documenting each of the bindings has been renamed to
2803   "index.html".
2805 Packaging:
2807 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
2808   older distros.
2810 Portability:
2812 * Fix warnings when compiling with GCC 4.2.
2814 PHP:
2816 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
2817   and methods/functions which return a wrapped class.
2819 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
2820   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
2822 * Document how non-class functions are wrapped.
2824 * Fix wrapping of NumberValueRangeProcessor for PHP4.
2826 * smoketest.php: Split the regression test for bug#193 into separate
2827   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
2829 Python:
2831 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
2832   non-pythonic iterators.  Make it clearer that the "sequence API" is
2833   deprecated.
2835 * Add test of a custom ValueRangeProcessor (ie, one written in python).
2837 * Update the examples to use the new-style attributes to access MSet item
2838   values rather than the old-style MSET_* constants.
2840 * Document MSET_DOCUMENT.
2842 Ruby:
2844 * smoketest.rb: Rename test of metadata access methods which had been named the
2845   same as the matchdecider test due to a copy-and-paste error.
2847 Xapian-bindings 1.0.3 (2007-09-28):
2849 General:
2851 * Wrap new methods Database::get_metadata() and
2852   WritableDatabase::set_metadata().
2854 * "make uninstall" now removes the loadable module we install for each of
2855   the bindings.
2857 * "make distcheck" now works.
2859 * Distribution tarballs are now in the POSIX "ustar" format since it saves
2860   about 40KB and we need to use it for xapian-core anyway.
2862 Packaging:
2864 * RPMs: Package xapian.php.
2866 CSharp:
2868 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
2869   usefully used currently.
2871 Java:
2873 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
2874   C++ library.
2876 * "make clean" now removes the class files generated for inner classes.
2878 PHP:
2880 * Add feature test for DateValueRangeProcessor when used with QueryParser.
2882 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
2883   isn't actually very useful, since you can't subclass it in PHP currently.
2885 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
2886   if the third parameter was specified and a floating point number (e.g. 0.0).
2888 * php/docs/bindings.html: Fix errors in example code.
2890 Python:
2892 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
2893   Python which takes two strings and returns a 3-tuple (value_number,
2894   modified_begin, modified_end).  Previously this always failed with a
2895   type error, so this doesn't break existing code.
2897 * python/pythontest.py: Interpret any commandline arguments as a list of
2898   tests to be run (the default is to run all tests).
2900 * README,python/docs/bindings.html: Add a note about the problems with
2901   mod-python (as described in bug #185).
2903 * python/pythontest.py: Delete the database handles before deleting a database
2904   to fix problems running the Python tests on MS Windows (bug#179).
2906 * "make clean" now removes testsuite.pyc.
2908 Ruby:
2910 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
2911   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
2912   now the site-specific directories, which is more correct when building
2913   from source.  Debian packages, etc can override this by setting RUBY_LIB and
2914   RUBY_LIB_ARCH.
2916 Tcl:
2918 * Check for TCL_LIB in the environment or on the configure command-line to
2919   allow installing without root access more cleanly.
2921 Xapian-bindings 1.0.2 (2007-07-05):
2923 Documentation:
2925 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
2926   phpextdir.
2928 * Remove documentation of removed "--with-swig" configure option.
2930 General:
2932 * Add methods of NumberValueRangeProcessor for serialising and
2933   unserialising doubles.
2935 * Add methods and constants supporting spelling correction and synonyms.
2937 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
2938   to ensure that it works with uninstalled copies of Xapian.
2940 * Value of PYTHON_LIB supplied to configure is now respected - previously
2941   it was documented, but ignored.
2943 * Add support for supplying PHP_EXTENSION_DIR to configure.
2945 * Change to using "%include", rather than reproducing contents of header
2946   files, for "queryparser.h", "document.h" and "postingiterator.h".
2948 * Add new form of get_mset() which allows a matchspy matchdecider to be
2949   set.
2951 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
2952   explode.  Add in a missing "mv" in the command for installing tcl8
2953   documentation.
2955 CSharp:
2957 * Fix rule handling parallel make to include xapian_wrap.h
2959 PHP:
2961 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2962   doesn't seem to be a standard location, but this works for Debian at
2963   least, and it seems better to at least try to install it.
2965 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2966   prefix for PHP4.
2968 Python:
2970 * Fix a threading problem: the GIL was not being acquired in the exception
2971   handling code before setting the Python exception state, leading to
2972   various memory corruption symptoms in threaded programs.
2974 * Add special iterators to Database for synonyms, synonym_keys and
2975   spellings.
2977 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
2978   synonym iterators and spelling iterators.
2980 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
2981   the expected description to make the tests more readable.
2983 Xapian-bindings 1.0.1 (2007-06-11):
2985 Documentation:
2987 * NEWS: Fix the recent headings which said "Xapian-core" to say
2988   "Xapian-bindings".
2990 General:
2992 * Wrap Xapian::Query constructor for creating ValueRange queries.
2994 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
2995   which take a prefix.
2997 Packaging:
2999 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
3000   %{buildroot} prefix on most files which we then have to work around.
3002 CSharp:
3004 * SimpleIndex now uses Xapian.TermGenerator.
3006 * SimpleSearch now uses Xapian.QueryParser.
3008 * New SimpleExpand example.
3010 * Document explicitly how STEM_SOME constants are currently wrapped.
3012 * Update GetTermName() reference in documentation to GetTerm().
3014 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
3015   their CVS repo, and the fix should be in their 0.8.2 release.
3017 Java:
3019 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
3020   looked at, but in fact its value was read but ignored.  We now use it as the
3021   first place to look for jni.h.
3023 * configure will now automatically add an extra "-I" for the
3024   linux/solaris/win32 subdirectory which Sun's JDK requires.
3026 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
3027   "precious" so their values are preserved for when configure is automatically
3028   rerun.
3030 PHP:
3032 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
3034 * The PHP examples have been rewritten to be clearer and to make use of the
3035   new XapianTermGenerator class.
3037 Python:
3039 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
3041 * Add support for prefix-restricted pythonic allterms iterators.
3043 * Update documentation in a couple of places to refer to updated replacements
3044   for MSetIterator.
3046 * Change testsuite output to be more vim-friendly (vim should be able to jump
3047   to the right lines now).
3049 * __str__ on Xapian::Error now includes extra information in some cases (the
3050   error_string and context, if they are set).
3052 * python/smoketest.py: Eliminate uses of the legacy sequence API.
3054 * python/pythontest.py: The legacy sequence API is only supported for Python
3055   2.3 and later, so don't run tests for it when running under Python 2.2.
3057 * We now generate and install xapian.pyo as well as xapian.pyc.
3059 Ruby:
3061 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
3062   classes.
3064 * Add missing rename for the C++ TermGenerator::set_document() method so it can
3065   be used as "tg.document = doc" in Ruby.
3067 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
3069 Tcl:
3071 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
3072   feedback, based on C++ simpleexpand.cc.
3074 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
3075   TermGenerator class.
3077 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
3078   QueryParser class.
3080 * tcl8/docs/bindings.html: Document how constants are wrapped.
3082 * Update smoketest and examples to require version 1.0.0 - previously this
3083   required 0.9.6, which failed since TCL doesn't accept differing major
3084   version numbers.
3086 * pkgIndex.tcl is now generated by configure.
3088 Packaging:
3090 * The required automake version has been lowered to 1.8.3, so RPMs can now be
3091   built on RHEL 4 and SLES 9.
3093 Xapian-bindings 1.0.0 (2007-05-17):
3095 Documentation:
3097 * Document Unicode support for each language.
3099 * Assorted minor improvements and typo fixes.
3101 General:
3103 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
3104   it, for languages where SWIG supports directors.
3106 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
3107   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
3108   allows the "default_prefix" argument to be supplied, QueryParser flags
3109   FLAG_PURE_NOT and FLAG_PARTIAL.
3111 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3113 * Remove wrappers for deprecated features removed from the C++ API (see
3114   docs/deprecation.html in xapian-core for full details and upgrade
3115   information).
3117 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
3119 * QueryParserError is now a real error, so remove special handling for "const
3120   char *" exceptions.
3122 * Use a stamp file in "make" rules with multiple targets so that parallel
3123   make works.
3125 * configure: Now quotes $PYTHON, etc so that you can specify a program with
3126   arguments.
3128 * configure: If the user specifies a program which doesn't exist (e.g.
3129   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
3131 * configure: Disable probes for f77, gcj, and rc completely by preventing
3132   the probe code from even appearing in configure - this reduces the size of
3133   configure by 28% and should speed it up significantly.
3135 * configure: If the version check against the xapian-core version detects a
3136   mismatch, we now issue a warning rather than a hard error since if you're
3137   careful this can work.  The warning is issued late on in configure, so it's
3138   harder for the user to miss.
3140 * configure: The --with-swig option has been removed.  It no longer has a
3141   purpose as we now ship the files which are generated by SWIG.
3143 Portability:
3145 * The PHP bindings can now be built with MSVC for Microsoft Windows.
3147 CSharp:
3149 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
3150   than mcs to avoid segmentation faults at runtime due to unimplemented
3151   features in mcs.  Document this, and update configure to prefer gmcs.
3153 * The return type of MatchDecider::operator() is now `bool' rather than `int'
3154   (in line with the same change in the C++ API).
3156 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
3158 Java:
3160 * The Java bindings have been updated to use C++ replacements for deprecated
3161   methods, so they still build.  The Java wrappers still provide the old
3162   deprecated names for now though.  The longer term plan is to replace the
3163   hand-written JNI with SWIG generated wrappers (work has now begun on this)
3164   which is likely to require some API changes, and it seems more sensible to
3165   make any changes to align with C++ API changes at the same time.
3167 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
3168   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
3170 PHP:
3172 * Fix undefined behaviour in get_matching_terms().
3174 * Document the (existing) renaming of methods which are PHP reserved words
3175   (empty() to is_empty() and clone() to clone_object()).
3177 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3179 Python:
3181 * The Python bindings now throw exceptions as classes with a hierarchy which
3182   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
3183   base class inherits from the standard Python Exception class.
3185 * All Python methods which accept strings can now be passed either a unicode
3186   object or a simple string.  Strings are returned as simple strings: unicode
3187   input will be returned as utf-8 encoded output.  The documentation now
3188   contains a "Unicode" section.
3190 * The Python bindings should now be usable more efficiently from threaded
3191   Python applications since we now use SWIG's -threads option when generating
3192   them, so that the GIL is released during long-running Xapian operations
3193   (bug#137).
3195 * Most classes, methods, functions, etc now have docstrings which are either
3196   automatically extracted from the C++ documentation comments, or overridden by
3197   more appropriate versions.
3199 * Most of the Pythonic iterators now return an object instead of a sequence,
3200   which means they now lazily fetch the information which previously had to be
3201   fetched to put it in the sequence.  The old sequence API is supported for
3202   compatibility, but is scheduled for removal in Xapian 1.1.0.
3204 * Those Python iterators which have skip_to() methods now return the item
3205   skipped to, and next() will return the following item.  Previously, they
3206   returned None, and next() returned the item skipped to.  Several bugs in the
3207   skip_to() wrappers were fixed.
3209 * Because of the lazy access, some objects returned by iterators will raise
3210   an error if the lazy evaluation happens after the iterator has moved on
3211   (since the underlying Xapian API doesn't allow efficient access to the
3212   information in this situation).  The exact semantics are defined in the
3213   docstrings for each iterator.
3215 * Those Pythonic iterators which return only a list of terms now return
3216   simple strings, instead of a sequence or an object containing the term.  This
3217   is an incompatible change with earlier releases.  The affected iterators are
3218   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
3219   QueryParser.unstemlist.
3221 * The contents of an MSet can now be iterated in the standard Python way.
3222   The iteration will return MSetItem objects.  The __contains__ and __getitem__
3223   methods are also implemented, allowing the "in" and [] operators to work.
3224   MSet.__getitem__ is a synonym for MSet.get_hit.
3226 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
3227   so that lazy access to its attributes is supported.  MSetItem has some
3228   deprecated methods which mimic the MSetIterator interface to allow old code
3229   to work without modification until release 1.1.0.
3231 * MSetItem provides access to the collapse_key and collapse_count, which
3232   weren't accessible from the sequence returned by the iterators before this
3233   release.
3235 * Out-of-range access to MSets will now raise an IndexError - it used to
3236   cause undefined behaviour (usually a crash).
3238 * The Python testsuite is now much more extensive, and supports colour output
3239   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
3240   features are separated out, so that they can easily be removed when the
3241   features are removed.  The Python tests currently focus mainly on Python
3242   specific iterators and related functionality - general Xapian behaviour is
3243   tested by the C++ testsuite.
3245 * The pure Python code in the bindings now uses new-style classes, since we
3246   have required Python >= 2.2 since Xapian release 0.9.9.
3248 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
3249   instead.
3251 * The get_description() method which many classes support has been deprecated
3252   in favour of new more pythonic __str__ methods, so that the str() builtin can
3253   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
3255 Ruby:
3257 * We no longer regard the Ruby bindings as "beta quality", so remove the
3258   warning from their documentation.
3260 * Document that that C++ operator() becomes the method "call" in Ruby.
3262 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
3263   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
3265 Tcl:
3267 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3269 Xapian-bindings 0.9.10.1 (2007-04-04):
3271 PHP:
3273 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
3274   default parameters.  The most notable case was a missing Query constructor
3275   which meant that QueryParser was unusable.
3277 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
3278   (which mostly seems to mean the MS Windows version).
3280 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
3281   seems to mean the MS Windows version).
3283 * Add note to the documentation that PHP examples are written for CLI version
3284   of PHP, but that the bindings work with any version.
3286 * Add check to all PHP examples that they are being run under a CLI version of
3287   PHP.
3289 Python:
3291 * simpleexpand.py: Print each term's expand weight as a floating point value,
3292   not an integer.
3294 Ruby:
3296 * INSTALL: document how to install Xapian's Ruby bindings in your home
3297   directory.
3299 Xapian-bindings 0.9.10 (2007-03-04):
3301 Java:
3303 * Under Mac OS X, automatically look in the standard location for jni.h,
3304   and automatically rename the JNI library we build to ".jnilib", as is
3305   required by the OS X JVM.
3307 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
3308   to add the linux header directory to the include path when using this JDK.
3310 * Add missing default constructor for RSet class - it's not much use without
3311   this!
3313 * Fix Enquire.getESet() to actually work.
3315 * Fix bug in ESetIterator.hasNext().
3317 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
3319 * Fix memory leak with some JVMs in the "Query from array" constructor.
3321 * Fix memory leak in Enquire.setQuery().
3323 * SmokeTest.java: Add regression tests for RSet default constructor,
3324   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
3325   Add feature tests for Enquire.getQuery(), and to make sure we get passed
3326   the right document in a java subclass of MatchDecider.
3328 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
3329   respective variables are set.
3331 PHP:
3333 * Update the documentation to fix out-of-date information and document the
3334   differences between the PHP4 and PHP5 wrappers.
3336 * Update the examples to use the new Object Oriented API, and provide versions
3337   for both PHP4 and PHP5.
3339 * Add a "simpleexpand" example.
3341 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
3342   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
3343   new name, but keep the old name for now for backward compatibility.
3345 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
3346   interpreter - this works with PHP5.
3348 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
3349   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
3350   directory may not exist and "make install" will create it.
3352 * configure: If zend.h isn't found and configure was run with "--with-php",
3353   exit with an error rather than automatically disabling PHP support.
3355 Python:
3357 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
3359 Packaging:
3361 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
3362   various "--without" options in a comment at the start of the .spec file.
3364 * RPMs: Remove "." from the end of the Summary.
3366 Xapian-bindings 0.9.9 (2006-11-09):
3368 Documentation:
3370 * Ship our custom INSTALL file rather than the generic one from autoconf which
3371   we've accidentally been shipping instead since 0.9.5.
3373 General:
3375 * Wrap Flint::open() and Flint::open_writable().
3377 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
3378   suitable).
3380 Python:
3382 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
3383   bit platforms with Python 2.5.
3385 Packaging:
3387 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
3389 * RPMs: The Python bindings now require Python >= 2.2.
3391 Portability:
3393 * configure: Remove unnecessary backticks from tclsh version test.
3395 Xapian-bindings 0.9.8 (2006-11-02):
3397 General:
3399 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
3400   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
3402 * The C++ method QueryParser::parse_query() current throws "std:string"
3403   exceptions if there's a parse error.  Previously the bindings didn't catch
3404   these.  Now we catch them and handle them as if they were exceptions of
3405   type Xapian::QueryParserError (in anticipation of this changing in
3406   xapian-core).  Added testcases for this for PHP, Python, and C#.
3408 * configure: Note that SWIG is only useful for Xapian developers in --help
3409   output.
3411 * configure: If we failed to find any languages to build for, give a more
3412   helpful message.
3414 CSharp:
3416 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
3418 Java:
3420 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
3421   work rather than using the cached failure of the first jni.h check.
3423 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
3425 * SmokeTest.java: Avoid gcj "set but not used" warning.
3427 PHP:
3429 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
3431 * smoketest4.php,smoketest5.php: Check the exception message given by the
3432   DocNotFoundError testcase.
3434 Python:
3436 * Drop support for Python 2.1.
3438 Xapian-bindings 0.9.7 (2006-10-10):
3440 Documentation:
3442 * NEWS: Fix the recent headings which said "Xapian-core" to say
3443   "Xapian-bindings".
3445 General:
3447 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
3448   configure.ac.
3450 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
3451   compiling SWIG generated code which makes the compiled modules a few percent
3452   smaller and perhaps a little faster.
3454 * Wrap the newly implemented transaction API.
3456 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
3457   (this option was supposed to be used to compile the Python bindings from
3458   0.9.3 onwards, but this wasn't actually working correctly).
3460 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
3462 * In maintainer-mode, "make clean" now removes the SWIG generated files
3463   which would otherwise only be removed on "make maintainer-clean".
3465 CSharp:
3467 * Xapian::MatchDecider can now be subclassed in C#.
3469 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
3470   to use it.  This has been fixed and a regression test added.
3472 * SmokeTest.cs: Added exception handling test.
3474 Java:
3476 * Correct two misuses of delete to delete[].  Fixes bug#78.
3478 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3479   Debian and Ubuntu boxes at least.
3481 PHP:
3483 * We now generate class wrappers for PHP5.
3485 * We now generate proxy classes for PHP4, which is an incompatible change
3486   from previous versions of xapian-bindings.  A perl script to upgrade
3487   your scripts is included.
3489 * smoketest.php:
3491   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3492     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3494   + Rely on xapian.php to load the extension module for us.
3496   + Fix error messages to show PHP code, not Python code.
3498 * When running smoketest.php, pass the "-q" option to php, which suppresses
3499   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3500   recent versions of PHP.
3502 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3503   the PHP interpreter not to be found in some cases when it was actually
3504   available, but it's only used to run the smoketest not for building the
3505   bindings.
3507 Python:
3509 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3510   and also report the check and its result to the user.
3512 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3513   built, so add an explicit dependency so that this works reliably in parallel
3514   builds.  Fixes bug#77.
3516 * In examples and documentation, don't call the MatchDecider class/object
3517   "matcher", since we use the term "matcher" to mean something else in
3518   the library documentation.
3520 * smoketest.py:
3522   + Add test of exception handling.
3524   + Add test that MatchDecider can be subclassed successfully.
3526 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3527   pythonic iterator class.
3529 Ruby:
3531 * Xapian::MatchDecider can now be subclassed in Ruby.
3533 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3534   (with no "ruby" alias) on Ubuntu dapper at least.
3536 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3537   since we may have less than 10 matches, so say "1-<N>" instead.
3539 * simplematchdecider.rb: Implemented.
3541 Tcl:
3543 * Implement saner exception handling for Tcl and document it.
3545 * smoketest.tcl:
3547   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3549   + Rework how the smoketest gets run to eliminate special code for using
3550     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3551     to be run using installed bindings, and also makes it a better example
3552     program.
3554   + Add test for exception handling.
3556   + Send error messages to stderr.
3558   + Add comment about Tcl storing zero bytes as \xc0\x80.
3560 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3562 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3563   used for the Tcl bindings.
3565 Xapian-bindings 0.9.6 (2006-05-15):
3567 Documentation:
3569 * INSTALL: Add section describing how to install without root access.
3571 General:
3573 * Updated to reflect the renaming of Xapian::xapian_version_string and
3574   companions to Xapian::version_string.
3576 * Wrap optional length parameter to Enquire::set_query().
3578 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3579   consistency.  Keep get_document_id as an alias for now for backward
3580   compatibility.
3582 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3583   probably a largely harmless error).
3585 * Stop SWIG from adding exception handling wrappers to the calls which return
3586   version strings, since they can't throw exceptions.
3588 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3589   a typedef for an unsigned integer type.
3591 * configure: Add some missing "checking ..." messages so the user has more idea
3592   what is going on.
3594 * Language specific util.i files can now define
3595   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3596   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3597   are provided for each language.  This avoids needing to keep this
3598   information in two different places.
3600 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3601   parameter names (for the benefit of bindings which use the parameter names,
3602   like the OO PHP5 patch for SWIG I'm working on...)
3604 Portability:
3606 * configure: Fix warning flags passed for Intel C++ compiler.
3608 CSharp:
3610 * We now support building with Portable.NET.
3612 * Note that the passing of strings from C# into Xapian and back isn't currently
3613   zero byte safe.  If you try to handle string containing zero bytes, you'll
3614   find they get truncated at the zero byte.
3616 * C# bindings now build and pass tests when srcdir != builddir.
3618 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3619   always say "CSharp" instead.
3621 * Not all machines are set up to run compiled C# programs when invoked
3622   directly, so get configure to check if we can, and otherwise see if using
3623   mono or ilrun works.  If not, just skip the C# tests.
3625 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3626   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3627   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3629 * Move the C# specific %rename list to csharp/util.i.
3631 * Store the strong name key in the key container so we reuse it for later
3632   builds.
3634 * Wrap the version functions as more sensible names and document them (and
3635   continue to provide the older undocumented names for now just in case anyone
3636   was using them.)
3638 * Set the version of XapianSharp.dll correctly when building a snapshot from
3639   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3641 * SmokeTest.cs: Add test of version functions.
3643 Guile:
3645 * The Guile bindings don't work and aren't being actively worked on, so we're
3646   no longer including them in the distributed tarball to avoid disappointing
3647   users who notice a "guile" subdirectory.  It also makes the download smaller.
3649 Java:
3651 * Simplify (and improve portability of) run-java-test by using "libtool
3652   --mode=execute"'s -dlopen option.
3654 * Need to make sure "built" subdirectory exists or building from clean fails.
3656 * Fix "make check" to work when srcdir != builddir.
3658 PHP:
3660 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3661   4.3.10), so use "php -n" and then set the options we specifically want using
3662   "-d".
3664 * Fix the smoketest invocation to work better when srcdir != builddir.
3666 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3668 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3670 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3672 * smoketest.php:
3674   + Add test for version reporting functions
3676   + If a test fails, say which one to aid debugging.
3678   + Added simple test that zero-bytes are handled correctly when passing
3679     strings to and from Xapian.
3681 Python:
3683 * README: Note that Python bindings have been built with MSVC.
3685 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3686   to make them executable (they don't have a #! line).
3688 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3689   "mymatchdecider".  Add description of what this example does.
3691 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3693 * smoketest.py: Added simple test that zero-bytes are handled when passing
3694   strings to and from Xapian.
3696 Ruby:
3698 * Added new Ruby bindings from Paul Legato.
3700 Tcl:
3702 * smoketest.tcl:
3704   + Add test for version reporting functions
3706   + If a test fails, say which one to aid debugging.
3708   + Added simple test that zero-bytes are handled correctly when passing
3709     strings to and from Xapian.
3711 Xapian-bindings 0.9.5 (2006-04-08):
3713 Documentation:
3715 * HACKING,README: Split off HACKING to contain information which is only
3716   relevant to those wishing to modify the bindings.
3718 General:
3720 * SWIG-based bindings are now built with SWIG 1.3.29.
3722 * configure: Report which languages we're building bindings for just before
3723   configure finishes.
3725 * xapian.i: Make the stub definitions for disabled backends static.
3727 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3728   message.
3730 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3732 Packaging:
3734 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3735   Python bindings to support 64 bit systems.
3737 * RPMs: Package the C# bindings.
3739 Portability:
3741 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3742   different name.
3744 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3745   avoid noise from compiling generated code.
3747 CSharp:
3749 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3751 Guile:
3753 * configure: Disable --with-guile since Guile support doesn't currently work.
3755 Java:
3757 * Override deprecation warnings for Xapian methods/functions/etc.
3759 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3760   have some idea what went wrong!
3762 * Rework how we include headers to get hash_map to avoid compiler warnings
3763   since it's usually not in the std namespace nowadays.
3765 * Previously the "all" target also ran the "install" target, but this has
3766   proved very problematic, so change "make check" to use the uninstalled JNI
3767   glue library, and update the instructions to say that "make install" is now
3768   required.
3770 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3771   .class files.
3773 * README: Note that some platforms need "-pthread" or similar flags.
3775 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3776   Query objects.
3778 * Compiling a .java file to a .class file now deletes the .jar file to ensure
3779   it gets updated.
3781 PHP:
3783 * php -n avoids reading any php.ini, but the compiled in default may be to
3784   enable the dubiously named "safe_mode" which prevents dl() being used so
3785   "make check" fails.  So instead provide a very simple php.ini which turns off
3786   safe_mode and makes sure enable_dl is on.
3788 * Fix handling of bool parameters when resolving overloaded methods and/or
3789   default arguments.  This fixes Enquire_sort_by_value() to work when the
3790   second argument is specified.  Added regression test for this case.
3792 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
3794 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
3795   passed by reference.  Fixes bug#74.
3797 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
3798   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
3800 Python:
3802 * Use the fairly new "swig -O" option for the "modern" python bindings as
3803   it generates a smaller glue library and runs faster.  Some of the features
3804   enabled also work on python 2.1, so enable these for the "olde" bindings.
3806 * configure: Catch the case where the user has python installed but not the
3807   module "distutils.sysconfig" and explain that they probably need to install a
3808   python-dev or python-devel package.
3810 * "make check" now works in VPATH builds.
3812 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
3813   know which check it was!
3815 * smoketest.py: catch Exception objects and print them.
3817 * smoketest.py: Add feature tests for the various pythonic iterator
3818   wrappers
3820 * python/docs/bindings.html: Document the Pythonic iterators.
3822 * Fix TermIter not to try to read termfreqs or positions if they aren't
3823   meaningful for the current TermIter.
3825 Xapian-bindings 0.9.4 (2006-02-21):
3827 Documentation:
3829 * COPYING: Updated FSF address.
3831 General:
3833 * Wrap Stopper::get_description().
3835 * Wrap xapian_version_string() and related functions.
3837 Portability:
3839 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
3840   run from "make" too.
3842 PHP:
3844 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
3845   default on Windows).
3847 Python:
3849 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
3851 Xapian-bindings 0.9.3 (2006-02-16):
3853 Documentation:
3855 * README: Updated and expanded (now covers supported platforms, and lists
3856   criteria which bindings for an additional language need to fulfil before
3857   we're likely to accept them).
3859 * INSTALL: Updated and improved.
3861 * TODO: Move C#-specific TODO to top level so we can track to-do items for
3862   all languages.
3864 General:
3866 * configure: Change how the user selects which bindings to build.  If no
3867   --with* arguments are passed, then we default to building bindings we detect
3868   the required tools for (as before).  But instead of requiring the user to
3869   deselect all bindings they don't actually want, we now let them select the
3870   bindings they do want.  So "./configure --with-python" will only build the
3871   python bindings (and will fail if the required tools aren't installed).
3873 * Every wrapped method contains exception handling code.  The bulk of this
3874   is now factored out into a single helper function, which cuts the compile
3875   time by around a factor of 3 and halves the size of the stripped library
3876   (figures are for Tcl on x86_64).
3878 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
3879   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
3881 * configure: Bump required SWIG version to 1.3.28 and drop the special
3882   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
3883   SWIG to install the bindings - SWIG is run by the Xapian developers
3884   so these updated requirements are only relevant if you want to modify
3885   the bindings.
3887 * Eliminate separate Makefile in each examples subdirectory, which makes the
3888   build system simpler, smaller, and a little faster.
3890 * xapian.i: Include default constructors for all classes so that SWIG knows it
3891   doesn't have to use SwigValueWrapper for them, which makes the bindings code
3892   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
3893   std::pair<...>.
3895 * configure: Document special environmental variables which configure
3896   recognises.  Enhance handling of environmental variables so you can
3897   e.g. './configure PYTHON=python23' (previously you had to give a full
3898   path in such environmental variables or they would be ignored.
3900 Packaging:
3902 * RPM spec file:
3904   + Automatically detect the python version.
3906   + Rename "php4" references to "php".
3908   + Automatically detect the PHP extension directory.
3910   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
3912   + Add support for "--without php" and --without tcl8" options to rpmbuild.
3914 Portability:
3916 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
3917   10.3.  This is required to link the bindings, and it doesn't seem to be
3918   possible to link them on 10.1 or 10.2 anyway.
3920 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
3921   to be explicitly specified and libtool correctly handles platforms where it
3922   would have been implicitly linked with anyway.
3924 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
3926 * configure: Add missing ";;" on the last alternative in some case statements.
3928 * Only pass -no-undefined on platforms where it is required in order to link a
3929   shared library at all (it causes problems on Mac OS X in some cases).
3931 CSharp:
3933 * This release includes a lot of improvements for the C# bindings.  They're
3934   now pretty much on a par with the other language bindings.
3936 * Added documentation and examples.
3938 * Method and function names are now renamed to match C# conventions
3939   (e.g. from get_description() to GetDescription()).  This is obviously an
3940   incompatible change, but the C# bindings haven't been suitable for real world
3941   use prior to this release.
3943 * Optional parameters are now wrapped so no longer need be specified
3944   explicitly.
3946 * Overload ++ and -- for iterators.
3948 * Overload == and != for iterators.  Now comparisons with the end iterator
3949   work as expected, and SmokeTest passes.
3951 * SmokeTest now reports exceptions verbosely.
3953 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
3954   similarly for other database factory functions.
3956 * Heed compatibility warnings from mcs and use different forms for
3957   command-line switches to the C# compiler (presumably for compatibility with
3958   Microsoft's compiler, though the warnings don't actually say that
3959   explicitly).
3961 Guile:
3963 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3964   zero-byte safe.  The guile bindings are still a long way from actually
3965   working though.
3967 Java:
3969 * Wrap optional second parameter (query length) to Enquire::set_query().
3971 * configure now probes for the Java path separator, which we then use to
3972   separate entries in the java -classpath command line option so we can
3973   build on platforms where it isn't ":".
3975 * SmokeTest.java: Expand to test more features.
3977 * java/README:
3979   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
3981   + Add note about how wrapped methods are named.
3983 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
3984   validity check.
3986 * Query.java: Comment out unused code.
3988 * Fixed memory leak in Query-from-array-of-strings constructor.
3990 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
3991   Xapian::Error subclasses can tell you their typename directly (using
3992   get_type()).
3994 PHP:
3996 * Some problems with overloaded methods in PHP have been fixed by a major
3997   overhaul of SWIG's PHP support.  So we no longer rename such methods
3998   for PHP.  This is an incompatible change, but it's easy to update your
3999   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
4001 * Previously the documentation and simpleindex.php suggested that you
4002   should call delete_CLASS().  This was incorrect and resulted in a
4003   double-free() in some cases, so we've fixed the documentation and
4004   examples and eliminated the delete_CLASS() wrappers.  This is another
4005   incompatible change, but again easy to update for.
4007 * We now support PHP5 as well as PHP4, so the configure test now looks
4008   for either and all references to "PHP4" or "php4" have been adjusted.
4010 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
4011   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
4012   warning and making the method return "Null".  This isn't ideal, but it's
4013   the best we can easily do without proper exceptions.
4015 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
4016   empty php.ini in srcdir (which we were failing to distribute anyway), use
4017   "$(PHP) -n" which tells PHP not to use any php.ini file.
4019 * Update PHP documentation to include new features.
4021 * Redo Xapian section in phpinfo() to look more like most other modules.
4023 * You can now construct a Query object from an array of strings or Query
4024   objects (or even a mixture).
4026 * PHP examples now give a more useful error message if a database can't be
4027   opened.
4029 * smoketest.php: Expanded the tests performed, including feature tests for
4030   the new Query-from-list constuctor.
4032 * simplesearch.php: Use newly wrapped Query-from-list constructor.
4034 * Use std::string::data() instead of c_str() as it may be more efficient for
4035   some STL implementations.
4037 * Enquire::get_matching_terms() now generates the PHP list directly from the
4038   TermIterator rather than constructing a temporary C++ std::list, which is
4039   faster and requires less temporary memory.
4041 Python:
4043 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
4044   once again (it has been broken since 0.9.0).  Added a regression test to
4045   help keep this working.
4047 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
4048   instead of a list).  Also the sequence can contain xapian.Query objects or
4049   strings or a mixture.  Documented these enhancements.
4051 * smoketest.py: Expanded the tests performed.
4053 * Convert C++ strings to python ones in a zero-byte clean way.
4055 * Added more error checking of the results of calls into the python
4056   interpreter.
4058 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
4059   itself is compiled with this option to avoid problems and it appears we ought
4060   to use it too to avoid the risk of hitting the same problems, although I'm
4061   not aware of anyone actually encountering such problems).
4063 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
4064   avoid creating a broken xapian.pyc is the shared library can't be loaded for
4065   some reason.
4067 * Enquire::get_matching_terms() now generates the Python list directly from the
4068   TermIterator rather than constructing a temporary C++ std::list, which is
4069   faster and requires less temporary memory.
4071 Tcl:
4073 * Terms with a leading underscore now work (thanks to changes in SWIG).
4075 * Implement custom typemaps for Tcl, so that you can now construct a Query from
4076   a list of Query objects and/or strings, and Enquire::get_matching_terms is
4077   now wrapped.
4079 * simplesearch.tcl: Use the new Query from list constructor.
4081 * simplesearch.tcl: Fix to lowercase and stem query terms.
4083 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
4085 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
4087 Xapian-bindings 0.9.2 (2005-07-15):
4089 General:
4091 * Added wrappers for new optional flags argument to QueryParser::parse_query().
4093 CSharp:
4095 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
4096   another tool with the same name.
4098 Java:
4100 * Include SmokeTest.java in the distribution so "make check" works.
4102 * Added success report for Sun java 1.4.1_01a.
4104 Python:
4106 * When converting a python list to vector<string> we know the number of elements
4107   so reserve that number in the vector.
4109 Xapian-bindings 0.9.1 (2005-06-06):
4111 General:
4113 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
4115 Tcl:
4117 * Updated documentation to include information from Michael Schlenker about how
4118   to delete a database object such that the destructor gets called.
4120 Xapian-bindings 0.9.0 (2005-05-13):
4122 General:
4124 * Updated SWIG-based bindings to latest Xapian API
4126 * Improve support for building the bindings on MS Windows:
4128   + Provide stub versions of any backend functions which are disabled in the
4129     library we're wrapping to avoid a link failure on MS Windows (where the
4130     remote backend is automatically disabled).  These stubs just throw
4131     Xapian::FeatureUnavailableError.
4133   + Add -no-undefined to *_la_LDFLAGS.
4135   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
4136     appropriate.
4138   + For python, paths for finding headers and installing libraries are now
4139     handled so they work on MS Windows; an extra static library needs to be
4140     linked in too.
4142 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
4143   for disabled backends).
4145 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
4146   being useful functionality.
4148 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
4149   introduced in future get fixed.
4151 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
4152   have.
4154 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
4155   1.3.22 for as more recent versions don't work with methods with optional
4156   arguments - the arguments become non-optional!)
4158 Guile:
4160 * configure: Disable guile by default, as it needs more work.
4162 Java:
4164 * Updated to compile against 0.9.0 API.
4166 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
4168 * Wrap optional parameters to Query(term) constructor.
4170 PHP4:
4172 * For PHP4, rename default Database constructor to Database_empty
4173   instead of suppressing the much more useful Database(const string &path)
4174   constructor.
4176 * Use a blank config file when running PHP4 tests to avoid problems
4177   when the bindings are already installed as an extension which is
4178   loaded automatically in the default config.
4180 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
4181   it probably just means it's not in PATH.  We only need it for running tests,
4182   so substitute a trivial shell script which just exits with code 77 so PHP
4183   tests are skipped (previously we substituted "missing" which caused the tests
4184   to fail).
4186 Python:
4188 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
4189   and ValueIter.
4191 * configure: If python is found, also check that Python.h exists (it may not be
4192   if the python-dev package (or similar) isn't installed).
4194 Xapian-bindings 0.8.5.1 (2005-02-23):
4196 General:
4198 * configure: Run compiler feature tests using the C++ compiler, not the C
4199   compiler.
4201 * Allow bindings version to have an extra "patchlevel", yet still match with
4202   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
4204 Java:
4206 * Added a missing .java source file and removed several unused ones.
4208 * Fixed several glitches in the java bindings automake build system.
4210 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
4211   warnings in generated code (we were carefully passing "-Wunused"
4212   which is the opposite of what is needed!)
4214 * Fixed a couple of warnings from GCJ.
4216 * Wrapped a few missing methods added since Eric created the bindings.  There
4217   are still some missing methods - there's now a (probably incomplete) list in
4218   java/README.
4220 * Added various useful bits of information to java/README.
4222 * Tweaked SimpleSearch.java to be more like the C++ version.
4224 PHP4:
4226 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
4227   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
4228   a more recent version.
4230 * configure: Check for "php" as a program name as well as "php4", and
4231   fall-back to missing so the error message from "make check" is better.
4233 Xapian-bindings 0.8.5 (2004-12-23):
4235 General:
4237 * INSTALL: Added non-generic installation instructions.
4239 Python:
4241 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
4242   the same directory as xapian.py, but Makefile.am was looking in current
4243   directory when installing it.  Additionally, VPATH builds were broken.
4244   These problems were introduced by changes in 0.8.4.
4246 Xapian-bindings 0.8.4 (2004-12-08):
4248 General:
4250 * README: Now clearly says which languages we currently support, which people
4251   are working on, etc.
4253 * Instead of requiring the user to have a really recent SWIG installed, ship
4254   the files SWIG generates.  Disable all the SWIG rules unless configure is run
4255   with --enable-maintainer-mode to make sure they aren't triggered accidentally
4256   (e.g. by make with dodgy VPATH).
4258 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
4259   needed if you just want to install the bindings).
4261 * Wrap the new Database and WritableDatabase constructors which replace
4262   Auto::open().
4264 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
4265   (for example, simpleexpand.py needs it).
4267 * In the Query constructor which takes a vector of terms, only call set_window
4268   if window is non-zero.  Otherwise things go wrong if we're passed an empty
4269   vector.
4271 * Second argument to Document::add_posting() isn't optional, but xapian.i
4272   indicated that it was.
4274 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
4275   Deriving your own weight class in the scripting language isn't currently
4276   supported.
4278 * xapian.i: %name is deprecated, so use %rename instead.  This also works
4279   around a bug in SWIG 1.3.23.
4281 * configure: Removed pointless probe for a C compiler - everything we compile
4282   is C++.
4284 * configure: Reinstated the check that the bindings version matches the version
4285   of the xapian library.  It was added in 0.8.2, but accidentally removed in
4286   0.8.3.
4288 * Use newly added option `xapian-config --swigflags` which (a) avoids always
4289   passing -I/usr/include which could cause problems if we're using a Xapian
4290   install not in /usr and there's another one in /usr and (b) avoids problems
4291   if `xapian-config --cxxflags` contains flags other than -I<something>.
4293 CSharp:
4295 * Richard Boulton has put together bindings for C#.  These build successfully
4296   with the Mono tools, but the smoketest currently fails.  Unclear if the
4297   problem is the bindings or the smoketest code.
4299 Guile:
4301 * The guile bindings now build successfully, so we've enabled the guile
4302   detection machinery in configure.  They're untested though (we don't
4303   know guile!) so success or failure reports are encouraged!
4305 PHP4:
4307 * Mention the example scripts near the start of the documentation, not right at
4308   the end.
4310 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4311   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4312   mention!
4314 Python:
4316 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
4317   work in Python.
4319 * Changed examples to use the newly wrapped Query from list of terms ctor.
4321 * Mention the example scripts near the start of the documentation, not right at
4322   the end.
4324 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
4325   SWIG.
4327 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4328   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4329   mention!
4331 * Mention simpleexpand example in documentation.
4333 * Examples now report messages for Xapian exceptions.
4335 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
4337 * Make the example MatchDecider exclude documents matching a value, rather than
4338   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
4339   don't want examples to mislead like that.
4341 * python/docs/bindings.html: Note that you can construct a query
4342   from a list of terms, even if you can't from a list of queries.
4343   Add HTML links to the examples.
4345 * simpleindex.py: Trim spaces from the start as well as from the end of each
4346   line.  Simplify the loop slightly.
4348 Tcl:
4350 * Wrap in a tcl8 namespace "Xapian".
4352 * Added a smoketest.
4354 * Translated simpleindex and simplesearch into Tcl.
4356 * Set the Tcl package version.
4358 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
4360 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
4362 * Added documentation for tcl8 bindings.
4364 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
4365   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
4366   version (was 8.0).
4368 * configure.ac: Noted that the bindings can easily be compiled for use with
4369   Tcl 8.0, in case anybody needs that for some reason.
4371 * Don't wrap the factory functions which return a quartz WritableDatabase as
4372   the destructor never gets called so changes aren't flushed and the lock file
4373   isn't removed.
4375 Xapian-bindings 0.8.3 (2004-09-20):
4377 General:
4379 * Fixed mismatching versions of libtool used to produce configure and
4380   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
4381   names.
4383 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
4384   PHP4, and Tcl bindings.
4386 Java:
4388 * Pass -classpath to javac to fix build problems.
4390 * Make sure errors subdirectory is built before we try to build the jar file.
4392 * Fixed "make install" to not give libtool error.
4394 PHP4:
4396 * Include PHP4 documentation and exmples in the tarball.
4398 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
4399   change from 0.8.2 - it turns out we only need to pass these flags if we use
4400   swig's -noruntime option (which we don't do).
4402 Python:
4404 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
4405   faster Python wrapper code.
4407 Tcl:
4409 * Don't install xapian.la.
4411 * Improved configure check for tcl.h to work with Fedora Core 2.
4413 Xapian-bindings 0.8.2 (2004-09-13):
4415 General:
4417 * Added wrappers for recently added methods: ESet::back() and
4418   Database::get_lastdocid(), and wrap the new optional third parameter
4419   to Enquire::set_sorting().
4421 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
4423 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
4425 * Wrap Quartz, InMemory, and Remote database factory functions as
4426   quartz_open(), inmemory_open(), and remote_open().
4428 * Added missing wrappers for static Stem::get_available_languages() and
4429   Stem::get_description().
4431 * Wrap renamed method Query::empty() (was Query::is_empty()).
4433 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
4434   as an alias for now).
4436 * Require autoconf 2.59 and automake 1.8.5.
4438 * configure: Added check that the bindings version matches the version of
4439   the xapian library.
4441 * configure: Check if we're using GCC and only pass GCC specific warning
4442   control options if we are.
4444 * configure: When running with GCC, also pass -Wno-uninitialized so the
4445   SWIG glue builds without warnings.
4447 * README: Updated list of languages which SWIG supports.
4449 PHP4:
4451 * Document that the 2 argument form of Xapian::Auto::open() for opening a
4452   writable database is wrapped as open_writable() (bug #32).
4454 * Include Xapian version in output from phpinfo().
4456 * Build the SWIG glue library like we build the others rather than using
4457   SWIG's -phpfull option.  This avoids problems with newer automake versions
4458   and means we can build against an uninstalled xapian library.
4460 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
4461   Fixed documentation of how Xapian::Query::OP_* are wrapped.
4463 * Use special SWIG PHP ldflags when linking the PHP glue library.
4465 * simplesearch.py now works with multi-term queries.
4467 * Added documentation on how to install the PHP4 bindings.
4469 * Added a simple testcase to at least ensure the PHP4 bindings can be
4470   initialised and some simple operations work.
4472 Python:
4474 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4476 * Don't install _xapian.la and _xapian.a.
4478 * Byte compile xapian.py to xapian.pyc and install it.
4480 * Suppress SWIG warning about MatchDecider::operator() director discarding
4481   const.
4483 * "make clean" no longer leaves "xapian_wrap.h" behind.
4485 * Added a simple testcase to at least ensure the python bindings can be
4486   initialised and some simple operations work.
4488 Tcl8:
4490 * configure: Disable building tcl8 bindings if the headers are missing
4491   (probably because the tcl8.X-dev package isn't installed).
4493 Xapian-bindings 0.8.1 (2004-06-30):
4495 General:
4497 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4499 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4500   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4501   doesn't emit -I/usr/include in this situation (because it causes problems
4502   with some GCC versions).
4504 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4505   not just a subset.
4507 Java:
4509 * Removed wrappers for unused error classes which have been pruned from C++.
4511 * Make finalize() methods of Database and WritableDatabase public so they can
4512   be called from by the user.
4514 * Document Document.add_term_nopos() as deprecated.
4516 PHP4:
4518 * Make sure that PHP bindings build a module which exports get_module() so PHP
4519   is able to load it.
4521 * Configure now checks that phpize can actually be run, rather than just that
4522   it's executable (test -x isn't portable anyhow).
4524 * Added basic documentation and examples to PHP4 bindings.
4526 * Rename overloaded methods and constructors.
4528 * Add simple access to the prefixes map in QueryParser.
4530 * Correct simpleindex ports to never generate empty termnames.
4532 Python:
4534 * configure: Use $PYTHON instead of python when running python to determine
4535   library and include paths and version number.
4537 * Actually ship python examples and documentation.
4539 Xapian-bindings 0.8.0 (2004-04-20):
4541 * README: Started collecting information on supporting Xapian from even
4542   more languages.
4544 * Added configure tests to enable bindings only where the necessary tools
4545   are installed and have a supported version.  ./configure --without-LANGUAGE
4546   allows particular languages to be forcibly disabled.
4548 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4550 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4552 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4553   have been well tested, but integration with the xapian-bindings configure
4554   system hasn't been tested at all - please alert us to any problems.
4556 * Xapian can now be used from TCL.
4558 * Python: MSet now provides a Python iterator.
4560 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4562 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4564 * Python: Added basic documentation, and some examples.