Fix typo in 1.2.22 NEWS entry
[xapian.git] / xapian-core / NEWS
bloba0773be94e4dbf890e135b08814f4a25ce02f883
1 Xapian-core 1.2.22 (2015-12-29):
3 API:
5 * Add FLAG_CJK_NGRAM for QueryParser and TermGenerator.  Has the same effect as
6   setting the environment variable XAPIAN_CJK_NGRAM.  Fixes #180, reported by
7   Richard Boulton, with contributions from Pavel Strashkin, Mikkel Kamstrup
8   Erlandsen and Brandon Schaefer.
10 * Fix bug parsing multiple non-exclusive filter terms - previously this could
11   result in such filters effectively being ignored.
13 * Fix Database::get_doclength_lower_bound() over multiple databases when some
14   are empty or consist only of zero-length documents.  Previously this would
15   report a lower bound of zero, now it reports the same lowest bound as a
16   single database containing all the same documents.
18 * Make Database::get_wdf_upper_bound("") return 0.
20 * Mark constructors taking a single argument as "explicit" to avoid unwanted
21   implicit conversions.
23 testsuite:
25 * If command line option --verbose/-v isn't specified, set the verbosity level
26   from environmental variable VERBOSE.
28 * Skip timed tests if $AUTOMATED_TESTING is set.  Fixes #553, reported by
29   Dagobert Michelsen.
31 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
33 * apitest: Revert disabling of part of adddoc5 for clang - the test failure was
34   in fact due to a bug in 1.3.x, and 1.2.x was never affected.
36 * apitest: Tweak bounds checks in dbstats1 testcase - multi backends should
37   give tight bounds.
39 brass backend:
41 * Format limit on docid now correctly imposed when sizeof(int) > 4.
43 * Avoid potential DB corruption with full-compaction when using 64K blocks.
45 chert backend:
47 * Format limit on docid now correctly imposed when sizeof(int) > 4.
49 * Avoid potential DB corruption with full-compaction when using 64K blocks.
51 flint backend:
53 * Format limit on docid now correctly imposed when sizeof(int) > 4.
55 * Avoid potential DB corruption with full-compaction when using 64K blocks.
57 remote backend:
59 * Fix to handle total document length exceeding 34,359,738,368.  (Fixes #678,
60   reported by matf).
62 * Avoid dividing by zero when getting the average length for an empty database.
64 * Stop apparent error from remote server when read-only client disconnects.  A
65   read-only client just closes the connection when done, but the server
66   previously reported "Got exception NetworkError: Received EOF", which sounds
67   like there was a problem.  Now we just say "Connection closed" here, and
68   "Connection closed unexpectedly" if the client connects in the middle of an
69   exchange.  Possibly fixes #654, reported by German M. Bravo.
71 * Give a clearer error message when the client and server remote protocol
72   versions aren't compatible.
74 * Check length of key in MSG_SETMETADATA.
76 build system:
78 * pkg-config: Fix library name in .pc file to say "xapian" not "xapian-core".
79   Reported by Eric Lindblad to the xapian-devel list.
81 * Private symbol decode_length() is no longer visible outside the library.
83 documentation:
85 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
86   'git cherry-pick' from working as it should.  The git repo history should be
87   sufficient for complying with GPLv2 2(a).
89 * Strip out "quickstart" examples which are out of date and rather redundant
90   with the "simple" examples.
92 * Correct documentation of Enquire::get_query().  If no query has been set,
93   the documentation said Xapian::InvalidArgumentError was thrown, but in
94   fact we just return a default initialised Query object (i.e. Query()).  This
95   seems reasonable behaviour and has been the case since Xapian 0.9.0.
97 * Document xapian-compact --blocksize takes an argument.
99 * Update snowball website link to snowballstem.org.
101 tools:
103 * xapian-replicate: Fix replication for files > 4GB on 32-bit platforms.
104   Previously replication would fail to copy a file whose size didn't fit in
105   size_t.  Fixes #685, reported by Josh Elsasser.
107 * xapian-tcpsrv: Better error if -p/--port not specified
109 * quest: Support `-f cjk_ngram`.
111 examples:
113 * xapian-metadata: Extend "list" subcommand to take optional key prefix.
115 portability:
117 * Fix new warnings from recent versions of GCC and clang.
119 * Add spaces between literal strings and macros which expand to literal strings
120   for C++11 compatibility in __WIN32__-specific code.
122 * Need <unistd.h> for unlink() on FreeBSD, reported by Germán M. Bravo via
123   github PR 72.
125 * Fix testsuite to build when S_ISSOCK() isn't defined.
127 * Don't provide our own implementation of sleep() under __WIN32__ if there
128   already is one - mingw provides one, and in some situations it seems to clash
129   with ours.  Reported to xapian-discuss by John Alveris.
131 * Add missing '#include <arpa/inet.h>' to htons().  Seems to be implicitly
132   included on most platforms, but Interix needs it.  Reported by Eric Lindblad
133   on xapian-discuss.
135 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
136   compiler, as it fires for functions ending in a "throw" statement.  Genuine
137   instances will be caught by compilers with superior warning machinery.
139 * Prefer scalbn() to ldexp() where possible, since the former doesn't ever set
140   errno.
142 * '#include <config.h>' in the "simple" examples, as when compiling with xlC on
143   AIX, _LARGE_FILES gets defined by AC_SYS_LARGEFILE to enable large file
144   support, and defining this changes the ABI of std::string, so it also needs
145   to be defined when compiling code using Xapian.
147 * On cygwin, include <arpa/inet.h> instead of winsock headers for htons() and
148   htonl().
150 * Include <cygwin/version.h> for CYGWIN_VERSION_API_MAJOR.
152 * Avoid referencing static members via an object in that object's own
153   definition, as this doesn't work with all compilers (noted with GCC 3.3), and
154   is a bit of an odd construct anyway.  Reported by Eric Lindblad on
155   xapian-discuss.
157 * GCC < 3.4.2 lacks operator<< overloads for unsigned long long on some
158   platforms, so simply work around this by using str(), as this isn't
159   performance sensitive code.  Reported by Eric Lindblad on xapian-discuss.
161 * Fix delete which should be delete[] in brass backend cursor code.
163 Xapian-core 1.2.21 (2015-05-20):
165 API:
167 * QueryParser: Extend the set of characters allowed in the start of a range to
168   be anything except for '(' and characters <= ' '.  This better matches what's
169   accepted for a range end (anything except for ')' and characters <= ' ').
170   Reported by Jani Nikula.
172 matcher:
174 * Reimplement OP_PHRASE for non-exact phrases.  The previous implementation was
175   buggy, giving both false positives and false negatives in rare cases when
176   three or more terms were involved.  Fixes #653, reported by Jean-Francois
177   Dockes.
179 * Reimplement OP_NEAR - the new implementation consistently requires the terms
180   to occur at different positions, and fixes some previously missed matches.
182 * Fix a reversed check for picking the shorter position list for an exact
183   phrase of two terms.  The difference this makes isn't dramatic, but can be
184   measured (at least with cachegrind).  Thanks to kbwt for spotting this.
186 * When matching an exact phrase, if a term doesn't occur where we want, use
187   its actual position to advance the anchor term, rather than just checking
188   the next position of the anchor term.
190 brass backend:
192 * Fix cursor versioning to consider cancel() and reopen() as events where
193   the cursor version may need incrementing, and flag the current cursor version
194   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
196 * Avoid using file descriptions < 3 for writable database tables, as it risks
197   corruption if some code in the same process tries to write to stdout or
198   stderr without realising it is closed.  (Partly addresses #651)
200 chert backend:
202 * Fix cursor versioning to consider cancel() and reopen() as events where
203   the cursor version may need incrementing, and flag the current cursor version
204   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
206 * Avoid using file descriptions < 3 for writable database tables, as it risks
207   corruption if some code in the same process tries to write to stdout or
208   stderr without realising it is closed.  (Partly addresses #651)
210 flint backend:
212 * Fix cursor versioning to consider cancel() and reopen() as events where
213   the cursor version may need incrementing, and flag the current cursor version
214   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
216 remote backend:
218 * Fix sort by value when multiple databases are in use and one or more are
219   remote.  This change necessitated a minor version bump in the remote
220   protocol.  Fixes #674, reported by Dylan Griffith.  If you are upgrading a
221   live system which uses the remote backend, upgrade the servers before the
222   clients.
224 build system:
226 * The compiler ABI check in the public API headers now issues a warning
227   (instead of an error) for an ABI mismatch for ABI versions 2 and later
228   (which means GCC >= 3.4).  The changes in these ABI versions are bug fixes
229   for corner cases, so there's a good chance of things working - e.g. building
230   xapian-bindings with GCC 5.1 (which defaults to ABI version 8) against
231   xapian-core built with GCC 4.9 (which defaults to ABI version 2) seems to
232   work OK.  A warning is still useful as a clue to what is going on if linking
233   fails due to a missing symbol.
235 * xapian-config,xapian-core.pc: When compiling with xlC on AIX, the reported
236   --cxxflags/--cflags now include -D_LARGE_FILES=1 as this is defined for the
237   library, and defining it changes the ABI of std::string with this compiler,
238   so it must also be defined when building code using the Xapian API.
240 * xapian-core.pc: Include --enable-runtime-pseudo-reloc in --libs output for
241   mingw and cygwin, like xapian-config does.
243 * xapian-core.pc: Fix include directory reported by `pkg-config --cflags`.
244   This bug was harmless if xapian-core was installed to a directory which was
245   on the default header search path (such as /usr/include).
247 * xapian-config: Fix typo so cached result of test in is_uninstalled() is
248   actually used on subsequent calls.  Fixes #676, reported (with patch) by Ryan
249   Schmidt.
251 * configure: Changes in 1.2.19 broke the custom macro we use to probe for
252   supported compiler flags such that the flags never got used.  This release
253   fixes this problem.
255 * configure: Set default value for AUTOM4TE before AC_OUTPUT so the default
256   will actually get used.  Only relevant when building in maintainer mode
257   (e.g. from git).
259 * soaktest: Link with libtool's '-no-install' or '-no-fast-install', like we
260   already do for other test programs, which means that libtool doesn't need to
261   generate shell script wrappers for them on most platforms.
263 documentation:
265 * API documentation: Minor wording tweaks and formatting improvements.
267 * docs/deprecation.rst: Add deprecation of omindex --preserve-nonduplicates
268   which happened in 1.2.4.
270 * HACKING: Update URL.
272 * HACKING: libtool 2.4.6 is now used for bootstrapping snapshots and releases.
274 tools:
276 * xapian-compact: Make sure we open all the tables of input databases at the
277   same revision.  (Fixes #649)
279 * xapian-metadata: Add 'list' subcommand to list all the metadata keys.
281 * xapian-replicate: Fix connection timeout to be 10 seconds rather than 10000
282   seconds (the incorrect timeout has been the case since 1.2.3).
284 * xapian-replicate: Set SO_KEEPALIVE for xapian-replicate's connection to the
285   master, and add command line option to allow setting socket-level timeouts
286   (SO_RCVTIMEO and SO_SNDTIMEO) on platforms that support them.  Fixes #546,
287   reported by nkvoll.
289 * xapian-replicate-server: Avoid potentially reading uninitialised data if a
290   changeset file is truncated.
292 portability:
294 * Add spaces between literal strings and macros which expand to literal strings
295   for C++11 compatibility.
297 * ValueCountMatchSpy::top_values_begin(): Fix the comparison function not to
298   return true for two equal elements, which manifests as incorrect sorting in
299   some cases when using clang's libc++ (which recent OS X versions do).
301 * apitest: The adddoc5 testcase fails under clang due to an exception handling
302   bug, so just #ifdef out the problematic part of the testcase when building
303   with clang for now.
305 * Fix clang warnings on OS X.  Reported by Germán M. Bravo.
307 * Fix examples to build with IBM's xlC compiler on AIX - they were failing due
308   to _LARGE_FILES being defined for the library build but not for the examples,
309   and defining this changes the ABI of std::string with this compiler.
311 * configure: Improve the probe for whether the test harness can use RTTI to
312   work for IBM's xlC compiler (which defaults to not generating RTTI).
314 * Fix to build with Sun's C++ compiler.
316 * Use F_DUPFD where available to dup to a file descriptor which is >= 2, rather
317   than calling dup() until we get one.
319 * When unserialising a double, avoid reading one byte past the end of the
320   serialised value.  In practice this was harmless on most platforms, as
321   dbl_max_mantissa is 255 for IEEE-754 format doubles, and at least GCC's
322   std::string keeps the buffer nul-terminated.  Reported by Germán M. Bravo in
323   github PR#67.
325 * When unserialising a double, add missing cast to unsigned char when we check
326   if the value will fit in the double type.  On machines with IEEE-754 doubles
327   (which is most current platforms) this happened to work OK before.  It would
328   also have been fine on machines where char is unsigned by default.
330 * Fix incorrect use of "delete" which should be "delete []".  This is
331   undefined behaviour in C++, though the type is POD, so in practice this
332   probably worked OK on many platforms.
334 debug code:
336 * Fix some overly strict assertions in flint, which caused apitest's
337   cursordelbug1 to fail with assertions on.
339 Xapian-core 1.2.20 (2015-03-04):
341 chert backend:
343 * After splitting a block, we always insert the new block in the parent right
344   after the block it was split from - there's no need to binary chop.
346 build system:
348 * Generate and install a file for pkg-config.  (Fixes#540)
350 * configure: Update link to cygwin FAQ in error message.
352 documentation:
354 * include/xapian/weight.h: Document the enum stat_flags values.
356 * docs/postingsource.rst: Use a modern class in postingsource example.  (Noted
357   by James Aylett)
359 * docs/deprecation.rst,docs/replication.rst: Fix typos.
361 * Update doxygen configuration files to avoid warnings about obsolete tags from
362   newer doxygen versions.
364 * HACKING: Update details of building Xapian packages.
366 tools:
368 * xapian-check: For chert and brass, cross-check the position and postlist
369   tables to detect positional data for non-existent documents.
371 portability:
373 * When locking a database for writing, use F_OFD_SETLK where available, which
374   avoids having to fork() a child process to hold the lock.  This currently
375   requires Linux kernel >= 3.15, but it has been submitted to POSIX so
376   hopefully will be widely supported eventually.  Thanks to Austin Clements for
377   pointing out this now exists.
379 * Fix detection of fdatasync(), which appears to have been broken practically
380   forever - this means we've probably been using fsync() instead, which
381   probably isn't a big additional overhead.  Thanks to Vlad Shablinsky for
382   helping with Mac OS X portability of this fix.
384 * configure: Define MINGW_HAS_SECURE_API under mingw to get _putenv_s()
385   declared in stdlib.h.
387 * Use POSIX O_NONBLOCK in preference to O_NDELAY - the semantics of the latter
388   differ between BSD and System V.
390 * According to POSIX, strerror() may not be thread safe, so use alternative
391   thread-safe ways to translate errno values where possible.
393 * On Microsoft Windows, avoid defining EADDRINUSE, etc if they're already
394   defined, and use WSAE* constants un-negated - they start from a high value
395   so won't collide with E* constants.
397 debug code:
399 * Add more assertions to the chert backend code.
401 Xapian-core 1.2.19 (2014-10-21):
403 API:
405 * Xapian::BM25Weight:
407   + Improve BM25 upper bound in the case when our wdf upper bound > our
408     document length lower bound.  Thanks to Craig Macdonald for pointing out
409     this trick.
411   + Pre-multiply termweight by (param_k1 + 1) rather than doing it for
412     every weighted term in every document considered.
414 testsuite:
416 * Don't report apparent leaks of fds opened on /dev/urandom - at least on
417   Linux, something in the C library seems to lazily open it, and the report of
418   a possible leak followed by assurance that it's OK really is just noise we
419   can do without.
421 matcher:
423 * Fix false matches reported for non-exact phrases in some cases.  Fixes the
424   reduced testcase in #657, reported by Jean-Francois Dockes.
426 brass backend:
428 * Only full sync after writing the final base file (only affects Max OS X).
430 chert backend:
432 * Only full sync after writing the final base file (only affects Max OS X).
434 flint backend:
436 * Only full sync after writing the final base file (only affects Max OS X).
438 build system:
440 * For Sun's C++ compiler, pass -library=Crun separately since libtool looks for
441   " -library=stlport4 " (with the spaces).  (fixes#650)
443 * Remove .replicatmp (created by the test suite) upon "make clean".
445 documentation:
447 * include/xapian/compactor.h: Fix formatting of doxygen comment.
449 * HACKING: freecode no longer accepts updates, so drop that item from the
450   release checklist.
452 * docs/overview.rst: Add missing database path to example of using
453   xapian-progsrv in a stub database file.
455 portability:
457 * Suppress unused typedef warnings from debugging logging macros, which occur
458   in functions which always exit via throwing an exception when compiling with
459   recent versions of GCC or clang.
461 * Fix debug logging code to compile with clang.  (fixes #657, reported by
462   Germán M. Bravo)
464 debug code:
466 * Add missing RETURN() markup for debug logging in a few places, highlighted by
467   warnings from recent GCC.
469 * Fix incorrect return types in debug logging annotations so that code compiles
470   when configured with --enable-log.
472 Xapian-core 1.2.18 (2014-06-22):
474 API:
476 * Document: Fix get_docid() to return the docid for the sub-database (as it
477   is explicitly documented to) for Document objects passed to functors like
478   KeyMaker during the match.  (fixes#636, reported by Jeff Rand).
480 * Document: Don't store the termname in OmDocumentTerm - we were only using it
481   in get_description() output and an exception message.  Speeds up indexing
482   etext.txt using simpleindex by 0.4%, and should reduce memory usage a bit
483   too.  (Change inspired by comments from Vishesh Handa on xapian-devel).
485 * Database: Iterating the values in a particular slot is now a bit more
486   efficient for inmemory and remote backends (but still slow compared to
487   flint, chert and brass).
489 testsuite:
491 * apitest: Expand crashrecovery1 to check that the expected base files exist
492   and ones which shouldn't exist don't.
494 * queryparsertest: Fix testcase for empty wildcard followed by negation to
495   enable FLAG_LOVEHATE so the negation is actually parsed.  Fortunately the
496   fixed testcase passes.
498 matcher:
500 * OP_SYNONYM: avoid fetching the doclength if the weighting scheme doesn't
501   need it and the calculated wdf for the synonym is <= doclength_lower_bound
502   for the current subdatabase.  (fixes #360)
504 build system:
506 * Releases are now bootstrapped with libtool 2.4.2 instead of 2.4, and with
507   config.guess and config.sub updated to the latest versions.
509 documentation:
511 * Add an example of initializing SimpleStopper using a file listing stopwords.
512   (Patch from Assem Chelli)
514 * Improve the descriptions of the stem_strategy values in the API docs.
515   (Reported by "oilap" on #xapian)
517 * docs/sorting.rst: Fix incorrect parameter types in Xapian::Weight
518   subclass example.
520 * docs/glossary.rst: Add definition of "collection frequency".
522 * HACKING:
524   + makeindex is now in Debian package texlive-binaries.
526   + Replace a link to the outdated autotools "goat book" with a link to the
527     "Portable Shell" chapter of the autoconf manual.
529 * include/xapian/base.h: Remove very out of date comments talking about atomic
530   assignment and locking - since 0.5.0 we've adopted a "user locks" policy.
531   (Reported by Jean-Francois Dockes)
533 examples:
535 * delve:
537   + Add -A <prefix> option to list all terms with a particular prefix.
539   + Send errors to stderr not stdout.
541   + If -v is specified more than once, show even more info in some cases.
542     (NEWS file claimed this was backported in 1.2.15, but it actually wasn't).
544 * quest:
546   + Add --default-op option.
548   + Add --weight option to allow the weighting scheme to be specified.
550 portability:
552 * Explicitly '#include <algorithm>' for std::max(), fixing build with VS2013.
553   (Fixes#641, reported by "boomboo").
555 * Fix testcase blocksize1 not to try to delete an open database, which isn't
556   possible under Windows.  (Fixes #643, reported by Chris Olds)
558 * docs/quickstart.rst: Split --cxxflags and --libs for portability (noted by
559   "Hurricane Tong" on xapian-devel).
561 * Fix warnings with clang 5.0.
563 debug code:
565 * Add assertions that weighting scheme upper bounds aren't exceeded.
567 Xapian-core 1.2.17 (2014-01-29):
569 API:
571 * Enquire::set_sort_by_relevance_then_value() and
572   Enquire::set_sort_by_relevance_then_key(): Fix sense of reverse parameter.
573   Reported by "boomboo" on IRC.
575 * BM25Weight: Fix case where (k1 == 0 || b == 0) but k2 != 0.  Reported by
576   "boomboo" on IRC.
578 * Unicode::tolower(): Fix to give correct results for U+01C5, U+01C8, U+01CB,
579   and U+01F2 (previously these were left unchanged).
581 testsuite:
583 * Automatically probe for and hook in eatmydata to the testsuite using the
584   wrapper script it now includes.
586 * Fix apitest to build when brass, chert or flint are disabled.
588 brass backend:
590 * Fix handling of invalid block sizes passed to Xapian::Brass::open() - the
591   size gets fixed as documented, but the uncorrected size was passed to the
592   base file (and abort() was called if 0 was passed).
594 * Validate "dir_end" when reading a block.  (fixes #592)
596 chert backend:
598 * Fix handling of invalid block sizes passed to Xapian::Chert::open() - the
599   size gets fixed as documented, but the uncorrected size was passed to the
600   base file (and abort() was called if 0 was passed).
602 * Validate "dir_end" when reading a block.  (fixes #592)
604 flint backend:
606 * Fix handling of invalid block sizes passed to Xapian::Flint::open() - the
607   size gets fixed as documented, but the uncorrected size was passed to the
608   base file (and abort() was called if 0 was passed).
610 * Validate "dir_end" when reading a block.  (fixes #592)
612 build system:
614 * configure: Improve reporting of GCC version.
616 * Use -no-fast-install on platforms where -no-install causes libtool to emit a
617   warning.
619 * docs/Makefile.am: Fix handling of MAINTAINER_NO_DOCS.
621 * Include UnicodeData.txt and the script to generate the unicode tables from
622   it.
624 documentation:
626 * postingsource.rst: Clarify a couple of points (reported by "vHanda" on IRC).
628 portability:
630 * Protect the ValueIterator::check() method against Mac OS X SDK headers
631   which define a check() macro.
633 * Fix warning from xlC compiler.
635 * Avoid use of grep -e in configure, as /usr/bin/grep on Solaris doesn't
636   support -e.
638 * Fix check for flags which might be needed for ANSI mode for compilers called
639   'cxx'.
641 * configure: Improve handling of Sun's C++ compiler - trick libtool into not
642   adding -library=Cstd, and prefer -library=stdcxx4 if supported.  Explicitly
643   add -library=Crun which seems to be required, even though the documentation
644   suggests otherwise.
646 Xapian-core 1.2.16 (2013-12-04):
648 API:
650 * PositionIterator,PostingIterator,TermIterator,ValueIterator: Don't segfault
651   if skip_to() or check() is called on an iterator which is already at_end().
652   Reported by David Bremner.
654 * ValueCountMatchSpy: get_description() on a default-constructed
655   ValueCountMatchSpy object no longer fails when xapian-core is built with
656   --enable-log.
658 * ValueCountMatchSpy: get_total() on a default-constructed ValueCountMatchSpy
659   object now returns 0 rather than segfaulting.
661 testsuite:
663 * If -v/--verbose is specified more than once to a test program, show the
664   diagnostic output for passing tests as well as failing/skipped ones.
666 * queryparsertest: Change qp_scale1 to time 5 repetitions of the large query to
667   help average out variations.
669 * queryparsertest: Add test coverage for explicit synonym of a term with a
670   prefix (e.g. ~foo:search).
672 * apitest: Remove code from registry* testcases which tries to test the
673   consequences of throwing an exception from a destructor - it's complex to
674   ensure we don't leak memory while doing this (it seems GCC doesn't release
675   the object in this case, but clang does), and it's generally frowned upon,
676   plus C++11 makes destructors noexcept by default.
678 * Fix "make check" to actually removed cached databases first, as is
679   intended.
681 brass backend:
683 * When moving a cursor on a read-only table, check if the block we want is in
684   the internal cursor.  We already do this for a writable table, as it is
685   necessary for correctness, but it's a cheap check and may avoid asking the
686   OS for a block we actually already have.
688 * Correctly report the database as closed rather than 'Bad file descriptor'
689   in certain cases.
691 * Reuse a cursor for reading values from valuestreams rather than creating
692   a new one each time.  This can dramatically reduce the number of blocks
693   redundantly reread when sorting by value.  The rereads will generally get
694   served from VM cache, but there's still an overhead to that.
696 chert backend:
698 * When moving a cursor on a read-only table, check if the block we want is in
699   the internal cursor.  We already do this for a writable table, as it is
700   necessary for correctness, but it's a cheap check and may avoid asking the
701   OS for a block we actually already have.
703 * Correctly report the database as closed rather than 'Bad file descriptor'
704   in certain cases.
706 * Reuse a cursor for reading values from valuestreams rather than creating
707   a new one each time.  This can dramatically reduce the number of blocks
708   redundantly reread when sorting by value.  The rereads will generally get
709   served from VM cache, but there's still an overhead to that.
711 flint backend:
713 * When moving a cursor on a read-only table, check if the block we want is in
714   the internal cursor.  We already do this for a writable table, as it is
715   necessary for correctness, but it's a cheap check and may avoid asking the
716   OS for a block we actually already have.
718 * Correctly report the database as closed rather than 'Bad file descriptor'
719   in certain cases.
721 build system:
723 * Compress source tarballs with xz instead of gzip.
725 * Split XAPIAN_LIBS out of XAPIAN_LDFLAGS so that -l flags for libraries
726   configure detects are needed appear after -L flags specified by the user
727   that may be needed to find such libraries.  (fixes#626)
729 * XO_LIB_XAPIAN now handles the user specifying a relative path in
730   XAPIAN_CONFIG, e.g.: "./configure XAPIAN_CONFIG=../xapian-core/xapian-config"
732 * Adjust XO_LIB_XAPIAN to strip _gitNNN suffix from snapshot versions.
734 * configure: Handle git snapshot naming when calculating REVISION.
736 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
737   will then jump to the appropriate column for a compiler error or warning, not
738   just the appropriate line.
740 * configure: Report GCC version in configure output.
742 documentation:
744 * The API documentation shipped with the release is now generated with
745   doxygen 1.8.5 instead of 1.5.9, which is most evident in the different
746   HTML styling newer doxygen uses.
748 * Document how Utf8Iterator handles invalid UTF-8 in API documentation.
750 * Improve how descriptions of deprecated features appear in the API
751   documentation.
753 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
754   message.
756 * docs/overview.rst: Correct documentation for how to specify "prog" remote
757   databases in stub files.
759 * Direct users to git in preference to SVN - we'll be switching entirely in
760   the near future.
762 tools:
764 * xapian-chert-update: Fix -b to work rather than always segfaulting (reported
765   in http://bugs.debian.org/716484).
767 * xapian-chert-update: The documented alias --blocksize for -b has never
768   actually been supported, so just drop mentions of it from --help and the man
769   page.
771 * xapian-check:
773   + Fix chert database check that first docid in each doclength chunk is more
774     than the last docid in the previous chunk - previously this didn't actually
775     work.
777   + Fix database check not to falsely report "position table: Junk after
778     position data" whenever there are 7 unused bits (7 is OK, *more* than 7
779     isn't).
781   + Fix to report block numbers correctly for links within the B-tree.
783   + If the METAINFO key is missing, only report it once per table.
785   + Fix database consistency checking to always open all the tables at the same
786     revision - not doing this could lead to false errors being reported after a
787     commit interrupted by the process being killed or the machine crashing.
788     Reported by Joey Hess in http://bugs.debian.org/724610
790 examples:
792 * quest: Add --check-at-least option.
794 portability:
796 * configure: clang doesn't support -Wstrict-null-sentinel or -Wlogical-op, so
797   don't pass it these options.
799 * Fix build errors and warnings with mingw.
801 * Suppress "unused local typedef" warnings from GCC 4.8.
803 * If the compiler supports C++11, use static_assert to implement
804   CompileTimeAssert.
806 * tests/zlib-vg.c: Fix two warnings when compiled with clang.
808 * Fix failure when built with -D_GLIBCXX_DEBUG - we were modifying the top()
809   element of a heap before calling pop(), such that the heap comparison
810   operation (which is called when -D_GLIBCXX_DEBUG is on to verify the heap is
811   valid) would read off the end of the data.  In a normal build, this issue
812   would likely never manifest.
814 * configure: When generating ABI compatibility checks in xapian/version.h, pass
815   $CXXFLAGS and $CPPFLAGS to $CXXCPP as they could contain options which affect
816   the ABI (such as -fabi-version for GCC).  (Fixes #622)
818 * Microsoft GUIDs in binary form have reversed byte order in the first three
819   components compared to standard UUIDs, so the same database would report a
820   different UUID on Windows to on other platforms.  We now swap the bytes to
821   match the standard order.  With this fix, the UUIDs of existing databases
822   will appear to change on Windows (except in rare "palindronic" cases).
824 * Fix a couple of issues to get Xapian to build and work on AIX.
826 * common/safeuuid.h: Remove bogus take-address-of from uuid handling code for
827   NetBSD and OpenBSD.
829 * Under cygwin, use cygwin_conv_path() if using a new enough cygwin version,
830   rather than the now deprecated cygwin_conv_to_win32_path().  Reported by
831   "Haroogan" on the xapian-devel mailing list.
833 * common/safeuuid.h: Add missing '#include <cstdlib>' and qualify free with std.
835 * Fix 'unused label' warning when chert backend is disabled.
837 * xapian.h: Add check for Wt headers being included before us and defining
838   'slots' as a macro - if they are, give a clear error advising how to work
839   around this (previously compilation would fail with a confusing error).
841 debug code:
843 * Fix assertion failure for when an OrPostList decays to an AndPostList - the
844   ordering of the subqueries by estimated termfreq may not be the same as it
845   was when the OrPostList was constructed, as the subqueries may themselves
846   have decayed.  Reported by Michel Pelletier.
848 * Fix -Wcast-qual warning from GCC 4.7 when configured with --enable-log.
850 Xapian-core 1.2.15 (2013-04-16):
852 API:
854 * QueryParser/TermGenerator: Don't include CJK codepoints which are
855   punctuation in N-grams.
857 * TermGenerator: Fix bug where we failed to generate the first bigram
858   from the second sequence of N-grammable CJK characters in a piece of text.
860 brass backend:
862 * Call fdatasync()/fsync() when creating the "iambrass" file.
864 chert backend:
866 * Call fdatasync()/fsync() when creating the "iamchert" file.
868 flint backend:
870 * Call fdatasync()/fsync() when creating the "iamflint" file.
872 build system:
874 * XO_LIB_XAPIAN now handles the user specifying XAPIAN_CONFIG without a path,
875   for example: ./configure XAPIAN_CONFIG=xapian-config-1.3
877 tools:
879 * delve: If -v is specified more than once, show even more info in some cases.
881 portability:
883 * Fix warning due to needlessly casting away const-ness in debug logging.
885 * Fix pointer truncation bug in lemon parser generator, which probably affects
886   regenerating the query parser on WIN64.
888 debug code:
890 * Fix to build when configured with --enable-log.
892 Xapian-core 1.2.14 (2013-03-14):
894 API:
896 * MSet::get_document(): Don't cache retrieved Document objects unless they
897   were requested with fetch().  This avoids using a lot of memory when many
898   MSet entries are retrieved.  (Fixes #604)
900 testsuite:
902 * apitest: Improved test coverage.
904 matcher:
906 * Check if a candidate document has at least the minimum weight needed
907   before checking positional information, which speeds up slow phrase
908   searches (partly addresses #394).
910 brass backend:
912 * Fix multipass compaction not to damage document values, and to merge the
913   database stats correctly.  (fixes #615)
915 chert backend:
917 * Fix multipass compaction not to damage document values, and to merge the
918   database stats correctly.  (fixes #615)
920 flint backend:
922 * Fix multipass compaction bug.  (fixes #615)
924 tools:
926 * xapian-replicate:
928   + Fix handling of delays between replication events - the subtraction of the
929     target time and the current time was reversed, so we wouldn't sleep when
930     before the deadline, but would sleep after it for the amount we'd missed it
931     by.
933   + On Microsoft Windows, we no longer sleep for more than 43 years if the
934     target time for a replication event had already passed.  (Fixes #472)
936 portability:
938 * matcher/queryoptimiser.cc: Need <functional> for mem_fun().
940 * tests/harness/testsuite.cc: Don't provide explicit template types to
941   make_pair - it isn't useful, and breaks with C++11.  Fixes build error with
942   MSVC2012.
944 * examples/quest.cc: Fix to build with Sun Studio 12 compiler.  (ticket#611)
946 Xapian-core 1.2.13 (2013-01-09):
948 API:
950 * TermGenerator: Add new method TermGenerator::set_max_word_length() to allow
951   this limit to be adjusted by the user.
953 * QueryParser: Implicitly close any unclosed brackets at the end of the query
954   string.  Patch from Sehaj Singh Kalra.
956 * DateValueRangeProcessor: Add extra constructor overloaded form so that in
957   DateValueRangeProcessor(1, "date:"), the const char * gets interpreted as
958   std::string rather than bool.
960 testsuite:
962 * apitest: Assorted test coverage improvements.
964 * When reporting valgrind errors, skip any warnings before the error in the
965   valgrind log.
967 matcher:
969 * Improved fix for #590 - count all matching LeafPostList objects with a Weight
970   object rather than trying to prune at the MultiAndPostList level based on
971   max_wt (if wdf is always zero for a term, BM25 gives max_wt of 0, which lead
972   to us never counting that subquery.
974 * Fix calculation of 0.0/0.0 in some cases.  This then got used as a minimum
975   weight, but it seems this gives -nan (at least on x86-64 Linux) so it may
976   have been harmless in practice.
978 * We no longer use the highest weighted MSet entry to calculate percentages, so
979   remove code which finds it.
981 brass backend:
983 * Close excess file handles before we get the fcntl lock, which avoids the
984   lock being released again if one is open on the lock file.  Notably this
985   avoids a situation where multiple threads in the same process could succeed
986   in locking a database concurrently.
988 chert backend:
990 * Close excess file handles before we get the fcntl lock, which avoids the
991   lock being released again if one is open on the lock file.  Notably this
992   avoids a situation where multiple threads in the same process could succeed
993   in locking a database concurrently.
995 flint backend:
997 * Close excess file handles before we get the fcntl lock, which avoids the
998   lock being released again if one is open on the lock file.  Notably this
999   avoids a situation where multiple threads in the same process could succeed
1000   in locking a database concurrently.
1002 remote backend:
1004 * Improve the UnimplementedError message for a MatchSpy subclass which doesn't
1005   implement name() so it's clearer that it is this particular subclass which
1006   can't be used remotely, rather than all MatchSpy objects.
1008 build system:
1010 * The build system is now generated with automake 1.11.6 rather than 1.11.1,
1011   which fixes a security issue in "make distcheck" (not something users will
1012   usually run, but it seems worth addressing).
1014 * Use user-specified LIBS for configure tests, which is what you'd expect to
1015   happen, and provides a way for the user to tell configure where to find
1016   library functions which configure can't find for itself.
1018 * INCLUDES is now deprecated in automake, so use AM_CPPFLAGS instead.
1020 * Test coverage rules now assume lcov 1.10 which allows them to be simpler
1021   and not to require a patched version of lcov.
1023 documentation:
1025 * valueranges.html: Update documentation to reflect change in Xapian 1.1.2 -
1026   DateValueRangeProcessor and StringValueRangeProcessor now support a prefix or
1027   suffix.
1029 * Clarify that the "reverse" parameter of set_sort_by_relevance_then_value()
1030   and set_sort_by_relevance_then_key() only affects the ordering of the
1031   value/key part of the sort.
1033 * docs/quickstart.html: Fix seriously outdated statement that Xapian doesn't
1034   create the database directory - that changed in 0.7.2 (released 2003-07-11).
1036 * HACKING: Try to make it clearer we're looking for a dual-licence on submitted
1037   patches.
1039 tools:
1041 * xapian-replicate:
1043   + Add a --full-copy option to force a full copy to be sent.  (ticket#436)
1045   + Add --quiet option, and be a little more verbose by default.
1047   + Allow files > 32G to be be copied by replication.
1049   + Fix "if (fd > 0)" tests in some replication code to be "if (fd >= 0)".
1050     In practice this is unlikely to actually have caused problems since
1051     stdin is typically still open and using fd 0.
1053   + Simplify how we open the .DB file on the replication slave to just call
1054     open() once with O_CREAT, rather than once without, than stat() if that
1055     fails, and then again with O_CREAT|O_TRUNC if stat() doesn't show an
1056     ordinary file exists.
1058 examples:
1060 * quest:
1062   + New --flags command line option to allow setting arbitrary QueryParser
1063     flags.
1065   + Align option descriptions in --help output, and make the initial letter of
1066     such descriptions consistently lowercase.
1068 portability:
1070 * Fix testsuite harness to compile with GCC 4.7.
1072 * On platforms with the F_MAXFD fcntl but without closefrom(), we were failing
1073   to close the highest numbered open fd in our closefrom() replacement.
1075 * Our closefrom() replacement on Linux now works around valgrind not hiding
1076   some extra fds it has open, but then complaining if we try to close them.
1078 + Pass O_BINARY when opening replication related files in some cases where we
1079   weren't before, which will probably help solve ticket #472.
1081 * configure: socketpair() needs -lnetwork on Haiku.
1083 * Micro-optimisation in Unicode handling - GCC doesn't currently optimise the
1084   arithmetic shift right idiom we use, but it documents that signed right shift
1085   does sign extension so we now just use a right shift for GCC.
1087 debug code:
1089 * Preserve errno over debug logging calls, so they can safely be added to code
1090   which expects errno not to change.
1092 Xapian-core 1.2.12 (2012-06-27):
1094 build system:
1096 * 1.2.11 had its library version information incorrectly set.  This resulted in
1097   the shared library having an incorrect SONAME - e.g. on Linux,
1098   libxapian.so.21 instead of libxapian.so.22.  This release has been made to
1099   fix this problem.
1101 documentation:
1103 * AUTHORS: Add the GSoC students.
1105 Xapian-core 1.2.11 (2012-06-26):
1107 API:
1109 * Add new QueryParser::STEM_ALL_Z stemming strategy, which stems all terms and
1110   adds a Z prefix.  (Patch from Sehaj Singh Kalra, fixes ticket#562)
1112 * Add TermGenerator::set_stemming_strategy() method, with strategies which
1113   correspond to those of QueryParser.  Based on patch from Sehaj Singh Kalra,
1114   with some tweaks for adding term positions in more cases.  (Fixes ticket#563)
1116 * Correct "BM25Weight" to "TradWeight" in exception message from TradWeight.
1118 * We were failing to call init() for user-defined Weight objects providing the
1119   term-independent weight.  These now get called with init(0.0).
1121 * Xapian::Auto::open_stub() now throws a Xapian::DatabaseOpeningError exception
1122   if the stub file can't be opened.  Previously we failed to check for this
1123   condition, which resulted in us treating the file as empty.
1125 testsuite:
1127 * When the testsuite is using valgrind, we used to run remote servers under
1128   valgrind too (but with --tool=none) to get consistent behaviour as valgrind's
1129   emulation of x87 excess precision isn't exact.  Now we only do this if x87 FP
1130   instructions are actually in use (which means x86 architecture and configure
1131   run with --disable-sse).
1133 * Make sure XAPIAN_MAX_CHANGESETS gets unset after replication testcases which
1134   set it, so further testcases don't waste time generating changesets.
1136 * Improved test coverage (including more tests for closed databases -
1137   ticket#337).
1139 brass backend:
1141 * After closing the database, methods which try to use the termlist would throw
1142   FeatureUnavailableError with message "Database has no termlist", assuming
1143   that the termlist table not being open meant it wasn't present.  Fix to check
1144   if the postlist_table is open to determine which case we're in.
1146 chert backend:
1148 * After closing the database, methods which try to use the termlist would throw
1149   FeatureUnavailableError with message "Database has no termlist", assuming
1150   that the termlist table not being open meant it wasn't present.  Fix to check
1151   if the postlist_table is open to determine which case we're in.
1153 inmemory backend:
1155 * Check if the database is closed in metadata_keys_begin() for InMemory
1156   Databases.
1158 build system:
1160 * xapian-config: Don't interpret a missing .la file as meaning that we only
1161   have static libraries.
1163 documentation:
1165 * Fix API documentation for Query constructors - both XOR and ELITE_SET can
1166   take any number of subqueries, not only exactly two.
1168 * Backport missing API documentation comments for operator++ and operator*
1169   methods or PositionIterator, PostingIterator and TermGenerator.
1171 * docs/replication.rst: Update documentation - since 1.2.5, the value of
1172   XAPIAN_MAX_CHANGESETS determines how many changesets we keep.
1174 * docs/admin_notes.rst: Correction - we don't "create a lock file", we "lock a
1175   file".
1177 * Fix API documentation for TradWeight constructor - "k1" should be "k".
1179 portability:
1181 * configure: Overhaul handling of compilers which pretend to be GCC.  Clang
1182   is now detected, and we only pass it warning flags it actually understands.
1183   And we now check for symbol visibility support with Intel's compiler.
1185 * configure: Solaris automatically pulls in library dependencies, so set
1186   link_all_deplibs_CXX=no there.
1188 * configure: We now check -Bsymbolic-functions for all compilers.
1190 * configure: Enable -Wdouble-promotion for GCC >= 4.6.
1192 * Pass -ldl last when compiling zlib-vg.so, as that seems to be needed on
1193   Ubuntu 12.04.
1195 * Fix incorrect use of "delete" which should be "delete []".  This is
1196   undefined behaviour in C++, though the type is POD, so in practice this
1197   probably worked OK on many platforms.
1199 * In BM25Weight when k1 or b is zero (not the default), we used to multiply
1200   an uninitialised double by zero, which is undefined behaviour, but in
1201   practice will often give zero, leading to the desired results.
1203 * xapian.h: Add check for Qt headers being included before us and defining
1204   'slots' as a macro - if they are, give a clear error advising how to work
1205   around this (previously compilation would fail with a confusing error).
1207 Xapian-core 1.2.10 (2012-05-09):
1209 API:
1211 testsuite:
1213 * apitest: Extend tradweight1 to test that TradWeight(0) means that wdf and
1214   document length don't affect the weight of a term.
1216 * termgentest: Check that TermGenerator discards words > 64 bytes.
1218 matcher:
1220 * Don't count unweighted subqueries of MultiAndPostList in percentage
1221   calculations, as OP_FILTER maps to MultiAndPostList now.  (ticket#590)
1223 brass backend:
1225 * When compacting, if the output database is empty, don't write out a metainfo
1226   tag.  Take care not to divide by zero when computing the percentage size
1227   change for a table.
1229 chert backend:
1231 * When compacting, if the output database is empty, don't write out a metainfo
1232   tag.  Take care not to divide by zero when computing the percentage size
1233   change for a table.
1235 documentation:
1237 * API documentation:
1239  + Note version when Database::close() was added.
1241  + Fix switched lower and upper in API documentation for Weight methods
1242    get_doclength_lower_bound() and get_doclength_upper_bound().  Correct
1243    maximum to minimum in get_doclength_lower_bound() comment and note that this
1244    excludes zero length documents.  Fix "An lower" to "A lower".
1246 * docs/admin_notes.html: Mention that postlist and termlist tables also hold
1247   value info for chert.  Mention that xapian-chert-update was removed in 1.3.0.
1248   Mention that you need to use copydatabase from 1.2.x to convert flint to
1249   chert.
1251 * HACKING: Update section on patches to mention git (git diff and git
1252   format-patch), and using "-r" with normal diff, and also that ptardiff offers
1253   a nice way to diff against an unpacked tarball.
1255 debug code:
1257 * Fix use of AssertEq() on NULL, which doesn't compile, at least with recent
1258   GCC.
1260 Xapian-core 1.2.9 (2012-03-08):
1262 API:
1264 * QueryParser: Fix FLAG_AUTO_SYNONYMS not to enable auto multi-word synonyms
1265   too (but in a different way to trunk so as to not break the ABI).
1267 matcher:
1269 * Fix issue with running AND, OR and XOR queries against a database with no
1270   documents in it - this was leading to a divide by zero, which led to
1271   MSet::get_matches_estimated() reporting 2147483648 on i386.
1273 build system:
1275 * Remove configure's --with-stlport and --with-stlport-compiler options, as
1276   they don't allow you to actually specify what you need to (at least to use
1277   the Debian STLport package), and instead document what to pass to configure
1278   to enable building with STLport (though it seems to no longer be actively
1279   maintained, and the debug mode (which is probably the most interesting
1280   feature now) doesn't seem to work on Debian stable).
1282 documentation:
1284 * Document that OP_ELITE_SET with non-term subqueries might pick subqueries
1285   which don't match anything.  Closes ticket#49.
1287 * Document that you can define a static operator delete method in your subclass
1288   if deallocation needs to be handled specially.  (Closes ticket#554)
1290 * Assorted minor documentation improvements.
1292 portability:
1294 * Address new warnings from GCC 4.6.
1296 * Fix argument order when linking xapian-check to fix mingw build.
1297   (ticket#567)
1299 * Add some missing explicit header includes to fix build with STLport.
1301 Xapian-core 1.2.8 (2011-12-13):
1303 API:
1305 * Add support to TermGenerator and QueryParser for indexing and searching CJK
1306   text using n-grams.  Currently this is only enabled when the environmental
1307   variable XAPIAN_CJK_NGRAM is set to a non-empty value.
1309 documentation:
1311 * Add link from index page to apidoc.pdf.
1313 * quickstart.html: Correct link which was to quickstartsearch.cc.html but
1314   should be to quickstartindex.cc.html.
1316 * overview.html,quickstart.html: Fix several factual errors.
1318 * API documentation:
1320   + Improve documentation comments for several methods.
1322   + Add documentation for function parameters which didn't have it.
1324   + Remove bogus paragraph in WritableDatabase::replace_document()
1325     documentation comment which had been cut and pasted from delete_document()
1326     documentation comment.  (Fixes ticket#579)
1328   + Explicitly document which value slot numbers are valid.  (Fixes ticket#555)
1330   + Escape < and > in doxygen comments so "<foo>" doesn't get eaten by doxygen.
1332 portability:
1334 + Some fixes for warnings when cross-compiling to mingw.
1336 * tests/soaktest/soaktest.cc: With Sun's compiler, random() and srandom()
1337   aren't in <cstdlib> so we need to use <stdlib.h> instead.
1339 Xapian-core 1.2.7 (2011-08-10):
1341 API:
1343 * Document objects now track whether any document positions have been modified
1344   so that replacing a modified document can completely skip considering
1345   updating positions if none have changed.  Currently the flint, chert, and
1346   brass backends implement this optimisation.  A common case this speeds up is
1347   adding and/or removing boolean filter terms to/from existing documents - for
1348   example this gives an 18% speedup for adding tags in notmuch.
1350 testsuite:
1352 * Make sure that perftest isn't run with libeatmydata preloaded, as making
1353   fsync() a no-op makes performance tests rather bogus.
1355 remote backend:
1357 * Remove unnecessary call to reopen() in the remote servers in a case where
1358   either we had just called it or we are using a writable database and so
1359   reopen() doesn't do anything.
1361 build system:
1363 * configure: -Wshadow gives bogus warnings with 4.0 (at least on Mac OS X), so
1364   disable it for GCC < 4.1 (like the comments already said we did!)
1366 documentation:
1368 * Improve the documentation comment for Database::close().  (ticket#504)
1370 * Fix typo in documentation comment for Enquire constructor which reversed the
1371   intended sense (though the text was fairly obviously wrong before).
1373 * Improve documentation of QueryParser::add_boolean_prefix()'s exclusive
1374   parameter to talk about terms and prefixes rather than values and fields
1375   (which was confusing since "document value" has a particular meaning in
1376   Xapian).
1378 * docs/facets.html: Expand descriptions for indexing and finding facets.
1379   Fix errors in example code.
1381 * docs/index.html: Add links to Omega and bindings documentation.
1383 * docs/remote_protocol.html: Fixed typo which reversed the intended sense.
1385 * xapian-check --help: Document that checking a whole database performs
1386   additional cross-checks between the tables.
1388 * docs/admin_notes.html: Add note about xapian-chert-update.
1390 * docs/deprecation.html: Note here that WritableDatabase::flush() is
1391   deprecated in favour of WritableDatabase::commit().
1393 portability:
1395 * Fix -Wshadow warnings from GCC 4.6.
1397 * Fix warning from GCC 3.3.
1399 debug code:
1401 * Fix some problems with the templates used to implement output of parameters
1402   and return values in debug logging.
1404 Xapian-core 1.2.6 (2011-06-12):
1406 API:
1408 * QueryParser:
1410   + Add new set_max_wildcard_expansion() method to allow limiting the number of
1411     terms a wildcard can expand to.  (ticket#350)
1413   + If default_op is OP_NEAR or OP_PHRASE then disable stemming of the terms,
1414     since we don't index positional information for stemmed terms by default.
1416 * Spelling correction was failing to correctly handle words which had the same
1417   trigram in an even number of times.
1419 testsuite:
1421 * We now actually include the soaktest code in the release tarballs.
1423 matcher:
1425 * Eliminate some vector copies when handling phrase subqueries in the query
1426   optimiser.
1428 brass backend:
1430 * Kill the child process which holds the lock with SIGKILL as that can't be
1431   ignored, whereas SIGHUP can be in some cases.
1433 chert backend:
1435 * Kill the child process which holds the lock with SIGKILL as that can't be
1436   ignored, whereas SIGHUP can be in some cases.
1438 flint backend:
1440 * Kill the child process which holds the lock with SIGKILL as that can't be
1441   ignored, whereas SIGHUP can be in some cases.
1443 documentation:
1445 * The HTML documentation is now maintained in reStructured Text format.
1447 * docs/queryparser.html: Document the precedence order of operators.
1449 * docs/scalability.html: Bring up-to-date.
1451 * docs/overview.html: Document "remote" in stub databases.
1453 * docs/postingsource.html: Add PostingSource example.  (ticket#503)
1455 * include/xapian/database.h: Add @exception InvalidArgumentError for
1456   Database::get_document() (ticket#542).
1458 * Ship ChangeLog.0 in the tarball.
1460 * Assorted minor improvements.
1462 examples:
1464 * examples/delve: Report has_positions().
1466 * examples/simpleindex: Add short description to usage message.
1468 portability:
1470 * Fix to build for mingw.
1472 Xapian-core 1.2.5 (2011-04-04):
1474 API:
1476 * Enquire::get_eset() now accepts a min_wt argument to allow the minimum wanted
1477   weight to be specified.  Default is 0, which gives the previous behaviour.
1479 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
1480   integer the same way at the end of the query as in the middle.
1482 * Replication:
1484   + Only keep $XAPIAN_MAX_CHANGESETS changeset files when generating a new one
1485     (previously this variable only controlled if we generated changesets or
1486     not).  Closes ticket#278.
1488   + $XAPIAN_MAX_CHANGESETS is reread each time, rather than only when the
1489     database is opened.
1491   + If you build Xapian with DANGEROUS mode enabled, changeset files now
1492     actually have the appropriate flag set (the reader will currently throw an
1493     exception, but that's better than quietly handling them incorrectly).
1495 testsuite:
1497 * Compaction tests which generate stub files now close them before performing
1498   the actual compaction, to avoid issues on Microsoft Windows (ticket#525).
1500 * Improve test coverage.
1502 matcher:
1504 * Fix memory leak if an exception is thrown during the match.
1506 brass backend:
1508 * Bumped format version number (we now store the oldest revision for which we
1509   might have a replication changeset).
1511 * Optimise not to read the bitmaps from the base files when opening a database
1512   for reading (cross-port of equivalent change to chert).
1514 * Optimise not to update doclength when it hasn't changed (cross-port of
1515   equivalent change to chert).
1517 * If we try to delete an old base file and it isn't there, just continue rather
1518   than throwing an exception.  We wanted to get rid of it anyway, and it may be
1519   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
1520   was rather a pessimistic assessment.
1522 chert backend:
1524 * Optimise not to read the bitmaps from the base files when opening a database
1525   for reading.
1527 * Optimise not to update doclength when it hasn't changed.
1529 * xapian-chert-update: Fix to handle larger databases, and databases which
1530   have values set.
1532 * If we try to delete an old base file and it isn't there, just continue rather
1533   than throwing an exception.  We wanted to get rid of it anyway, and it may be
1534   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
1535   was rather a pessimistic assessment.
1537 flint backend:
1539 * Optimise not to read the bitmaps from the base files when opening a database
1540   for reading (cross-port of equivalent change to chert).
1542 * Optimise not to update doclength when it hasn't changed (cross-port of
1543   equivalent change to chert).
1545 * If we try to delete an old base file and it isn't there, just continue rather
1546   than throwing an exception.  We wanted to get rid of it anyway, and it may be
1547   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
1548   was rather a pessimistic assessment.
1550 remote backend:
1552 * xapian-tcpsrv: If we can't bind to the specified port because it is a
1553   privileged one, exit with code 77 (EX_NOPERM) to make it easier to
1554   automatically handle failure when starting the server from a script.
1556 build system:
1558 * Snapshots and releases are now bootstrapped with autoconf 2.68 and libtool
1559   2.4.
1561 * configure: -Wstrict-null-sentinel was added in GCC 4.0.1 and so doesn't work
1562   with GCC 4.0.0.  For simplicity, only enable it for GCC >= 4.1.
1564 documentation:
1566 * INSTALL: Note how to build for a non-default arch on a multi-arch platform.
1568 * include/xapian/enquire.h: Fix doxygen markup so alternative overloaded forms
1569   of Enquire::get_mset() appear in the API documentation.
1571 * collapsing.html: Add missing document (written some time ago, but never
1572   actually added to builds).
1574 * replication.html: Update documentation to make it clear that users shouldn't
1575   create the destination directory for replication themselves.
1577 * docs/intro_ir.html: Update link to a paper.  Update text about book "to be
1578   published in 2008".
1580 * docs/deprecation.html:
1582   + PostingSource now offers a replacement for Enquire::set_bias().
1584   + OmegaScript: $set{spelling,true} is now deprecated.
1586   + Add note about botched removal of Enquire.get_matching_terms from Python
1587     bindings (now fully removed).
1589   + Note removal of "if idx in mset" from Python bindings.
1591   + Deprecate MSet.items and ESet.items from Python bindings (ticket#531).
1593 * docs/admin_notes.html: Update for 1.2.5.
1595 * Updates to documentation of internals.
1597 tools:
1599 * xapian-replicate-server: Fix race condition between checking if a file
1600   exists and opening it to replicate it.
1602 * xapian-replicate: Complain unless host name and port number are specified -
1603   previously these defaulted to an empty string and 0, which resulted in
1604   potentially confusing error messages.
1606 * xapian-replicate: If --master isn't specified, default to DATABASE.
1608 examples:
1610 * quest: Report any spelling correction (requires the database contains
1611   spelling data of course).
1613 * copydatabase: Add --no-renumber option.
1615 portability:
1617 * api/compactor.cc: Add missing header <ctime> for time() (ticket#530).
1619 * api/compactor.cc: Use msvc_posix_rename() under __WIN32__ to atomically
1620   update stub file after compaction (ticket#525).
1622 * Fix uninitialised variable warnings with gcc -O3.
1624 * Eliminate std::string member of global static object used when compiled with
1625   --enable-log which was causes problems on Mac OS X.
1627 * Fix some issues highlighted by clang++ warnings.
1629 Xapian-core 1.2.4 (2010-12-19):
1631 API:
1633 * QueryParser:
1635   + Avoid a double free if Query construction throws an exception in a
1636     particular case.  Fixes ticket#515.
1638   + Allow phrase generators between a probabilistic prefix and the term itself
1639     (e.g. path:/usr/local).
1641   + The correct window size wasn't being set in some cases when default_op was
1642     set to OP_PHRASE.
1644 * Enquire::get_mset():
1646   + Avoid pointlessly trying to allocate lots of memory if the first document
1647     requested is larger than the size of the database.
1649   + An empty query now returns an MSet with firstitem set correctly -
1650     previously firstitem was always 0 in this case.
1652 * Document: Initialise docid to 0 when creating a document from
1653   scratch, as documented.
1655 * Compactor:
1657   + Move the database compaction and merging functionality into this new class,
1658     and make xapian-compact a simple wrapper around this class.  (ticket#175)
1660   + Inputs can now be stub database directories or files, in which case the
1661     databases in the stub are used as inputs.
1663   + Add support for compacting to a stub database, which can be one of the
1664     inputs (for atomic update).
1666   + If spellings and/or synonyms were only present in some source databases,
1667     they weren't copied to the output database, but now they are.
1669 testsuite:
1671 * Improve test coverage (particularly for Xapian::Utf8Iterator and
1672   Xapian::Stem).
1674 * Add zlib-vg.c to distribution tarballs.
1676 * tests/runtest: Add XAPIAN_TESTSUITE_LD_PRELOAD hook to allow libeatmydata to
1677   easily be used to speed up testsuite runs.
1679 matcher:
1681 * The matcher wasn't recalculating the max possible weight after a subquery of
1682   XOR reached its end.  This caused an assertion failure in debug builds, and
1683   is a missed optimisation opportunity.
1685 * Implement SelectPostList::check() so that check() on OP_NEAR and OP_PHRASE
1686   subqueries will just check a single document, not a potentially huge numbers
1687   of documents.
1689 * BM25Weight: Fix calculation order to avoid inconsistent weights due to
1690   rounding when certain non-default parameter combinations are used.
1692 * TradWeight: Fix calculation order to avoid inconsistent weights due to
1693   rounding with TradWeight(0).
1695 * Fix regression in speed of OP_OR queries in certain cases due to optimisation
1696   added in 1.0.21/1.2.1.
1698 * In the query optimiser, use value range bounds to detect value ranges which
1699   must be empty.
1701 remote backend:
1703 * Add support for iterating metadata keys with the remote backend.  This change
1704   necessitated an increase in the minor version of the remote protocol.  If you
1705   are upgrading a live system which uses the remote backend, upgrade the
1706   servers before the clients.
1708 build system:
1710 * xapian-config: Add --static option which makes other options report values
1711   for static linking.
1713 * xapian-config is now removed by "make distclean" not "make clean".
1715 * configure: FreeBSD and OpenBSD don't need explicit dependency libraries, so
1716   set link_all_deplibs_CXX=no there.
1718 * This release uses autoconf 2.67 rather than 2.65.
1720 documentation:
1722 * INSTALL: Raise recommended GCC version from 3.3 to 4.1, since that's the
1723   oldest we regularly test with.
1725 * replication.html: Update and improve in various ways.
1727 * Remove lingering "experimental" marker from PostingSource and
1728   ValueCountMatchSpy API documentation.
1730 * index.html: Add links to replication and facets documents, and fix typo in
1731   serialisation document link.
1733 * internals.html: Add link to replication protocol.
1735 * Change the categorisation document to talk about facets, since that's the
1736   terminology that seems to be most widely used these days, and
1737   "categorisation" can also mean automatically assigning categories to
1738   documents.  Also update to reflect the final API.
1740 * deprecation.html: Add guidelines for supporting other software.
1742 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
1743   currently supported.
1745 * PLATFORMS: Move PLATFORMS information to the wiki and replace with a pointer.
1747 tools:
1749 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
1750   This could have caused problems, though we've had no reports of any (the
1751   bug was found with _GLIBCXX_DEBUG).
1753 * xapian-compact: Add --quiet/-q option to suppress progress output.
1754   (ticket#437)
1756 * xapian-replicate: If a full copy was attempted, but was not put live, display
1757   an explanatory message (in verbose mode).
1759 examples:
1761 * examples/quest: Add command line options to allow prefixes to be specified
1762   for the QueryParser.
1764 * examples/delve: Add '-z' option to count zero-length documents.
1766 * examples/simplesearch: Fix cut-and-paste errors in usage message and
1767   --version output.
1769 portability:
1771 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
1772   control of which SSE instructions to use.
1774 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
1776 * configure: Beef up the test for whether -lm is required and add a special
1777   case to force it to be for Sun's C++ compiler - there's some interaction with
1778   libtool and/or shared objects which means that the previous configure test
1779   didn't think -lm is needed here when it is.
1781 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
1783 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
1784   68030 as well as 68000.
1786 * Fix compilation with Sun's C++ compiler.
1788 * Fix testsuite to build on Solaris < 10.
1790 Xapian-core 1.2.3 (2010-08-24):
1792 API:
1794 * Database::get_spelling_suggestion() will now suggest a correction even if the
1795   passed word is in the dictionary, provided the correction has at least the
1796   same frequency.  Partly addresses #225.
1798 * QueryParser:
1800   + Fix handling of groups of terms which are all stopwords - in situations
1801     where this causes a problem we now disable stopword checks for such groups.
1802     (ticket#245)
1804   + Fix to be smarter about handling a boolean filter term containing ".." in
1805     the presence of valuerangeprocessors.
1807 testsuite:
1809 * New "unittest" program for testing low level functions directly.  Currently
1810   this has tests for the internal resolve_relative_path() function.
1811   (ticket#243)
1813 remote backend:
1815 * Retry select() if it fails with EINTR while waiting for connect(), and
1816   discriminate cases with same failure message to aid debugging.
1818 documentation:
1820 * Fix documentation comment for Xapian::timeout type - it holds a time interval
1821   in milliseconds not microseconds (the API docs for the methods which use it
1822   explicitly correctly document that the timeouts are in milliseconds).
1824 * libuuid moved from e2fsprogs to util-linux-ng about a year ago, so update
1825   documentation, comments, and configure error messages to reflect this.
1827 portability:
1829 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
1830   (ticket#492).
1832 * Fix handling of some obscure cases of resolving relative paths on Microsoft
1833   Windows.  (ticket#243).
1835 * Optimise closing of all unwanted file descriptors after forking by using
1836   closefrom() if available, and otherwise providing our own implementation
1837   (optimised to some extent for many platforms).
1839 * Fix test harness to build under Microsoft Windows (ticket#495).
1841 packaging:
1843 * xapian-core.spec: Add xapian-metadata and cmake related files to RPM
1844   packaging.
1846 * xapian-core.spec: Update BuildRequires to specify libuuid-devel instead of
1847   e2fsprogs-devel.
1849 debug code:
1851 * Improve logging of function parameter placeholder strings.
1853 Xapian-core 1.2.2 (2010-06-27):
1855 brass backend:
1857 * Sync changes from each Btree table to disk right after syncing changes to
1858   its base file, which allows more time for the table changes to be written
1859   and may also be more efficient with some Linux kernel versions.
1861 chert backend:
1863 * Sync changes from each Btree table to disk right after syncing changes to
1864   its base file, which allows more time for the table changes to be written
1865   and may also be more efficient with some Linux kernel versions.
1867 tools:
1869 * xapian-check: Don't try to check document lengths are consistent between the
1870   postlist and termlist tables if it would use more than 1GB of memory, and
1871   handle std::bad_alloc or std::length_error when trying to allocate space
1872   for this.  This issue affected sup users, as sup allocates docids such that
1873   they are sparse and large docids can easily occur.
1875 examples:
1877 * delve: Show the database's UUID.
1879 portability:
1881 * Revert 1.2.1 change to visibility of Xapian::Weight's copy constructor as
1882   it making it private broke compilation with GCC 4.1 (which seems to be a
1883   bug in this compiler version).
1885 * tests/harness/testsuite.cc: Need <cstdio> for sprintf().  Fixes compilation
1886   error which was masked if valgrind was installed.  (ticket#489)
1888 packaging:
1890 * xapian-core.spec: Update for 1.2.x - add e2fsprogs-devel to BuildRequires and
1891   add new files to install.
1893 Xapian-core 1.2.1 (2010-06-22):
1895 This release includes all changes from 1.0.21 which are relevant.
1897 API:
1899 * QueryParser: Add support for open-ended ranges (ticket#480).
1901 * Add new optional parameter to QueryParser::add_boolean_prefix() to allow the
1902   user to indicate a prefix isn't "exclusive" and that multiple instances
1903   should be combined with OP_AND rather than OP_OR.  Fixes ticket#402.  This
1904   change should also improve efficiency as it avoids copying the lists of
1905   prefixes and compares them more efficiently.
1907 * You can now specify a custom stemming algorithm by subclassing
1908   Xapian::StemImplementation, mostly based on patch from Evgeny Sizikov in
1909   ticket#448.
1911 * Fix replication bug: when multiple commits were made to the master database
1912   while a client was performing a full copy, the client would only apply the
1913   first changeset and then try to make the database live, but fail due to
1914   trying to set the wrong revision number.
1916 * Replication no longer sleeps between applying changesets to an offline
1917   database.  It's only necessary to sleep for a live database (to allow readers
1918   to complete a search without getting DatabaseModifiedErrror.
1920 * xapian-replicate: Add new "-r" command line option to specify how long
1921   replication sleeps for between applying changesets to a live database.
1923 * If a Btree table doesn't exist when applying a replication changeset, create
1924   it.  This fixes replicating a revision where a lazy table is created.
1925   (ticket#468)
1927 testsuite:
1929 * zlib can produce "uninitialised" output from "initialised" input - the
1930   output does decode to the input, so this is presumably just some unused bits
1931   in the output, so we use an LD_PRELOAD hack to get valgrind to check the
1932   input is initialised and then tell it that the output is initialised.
1934 * Don't pass NULL to closedir(), which fixes test harness failures on platforms
1935   without /proc/self/fd.
1937 * Use safesyswait.h, fixing build failure on "make check" on FreeBSD.
1939 * Check is SA_SIGINFO is defined before using it as it isn't available
1940   everywhere.  Fixes testsuite build failure on GNU Hurd.
1942 * Add a "soaktest" testsuite, intended to contain long-running tests with
1943   random data.  Currently contains a single test which builds and runs random
1944   queries, checking that the results returned are consistent when asking for
1945   different result ranges.
1947 * Test UUID returned by Database::get_uuid() is 36 characters long.
1949 matcher:
1951 * Xapian no longer forces the wdf_max value to be at least one in
1952   BM25Weight::get_maxpart().  We used to do this so that a non-existent term in
1953   the query would cause it not to achieve 100%, but now we calculate
1954   percentages based on the number of matching subqueries, and it is more
1955   natural for a non-existent term to get zero weight (ditto for a term which
1956   always has wdf 0).
1958 * OP_VALUE_RANGE and OP_VALUE_GE now use value streams directly which is much
1959   more efficient for chert (the default backend in 2.2.x).  As an example, a
1960   range query testcase which previously took 29 seconds now takes 0.4 seconds
1961   (70 times faster).  (ticket#432)
1963 * The term statistics from multiple databases are now gathered in a simpler
1964   way which is a bit faster and uses less memory.
1966 build system:
1968 * Install headers under PREFIX/include not PREFIX/include/xapian.  If you used
1969   XO_LIB_XAPIAN or xapian-config in your build system, the headers would still
1970   have been found.
1972 * Releases and snapshots are now generated with libtool 2.2.10 instead of
1973   2.2.6.
1975 * Fix build failures with some combinations of backends disabled (partially
1976   addresses ticket#361 - some combinations still fail).
1978 * Add check to configure that GCC actually supports visibility for the platform
1979   being built for, which fixes compiler warnings with platforms which don't
1980   (such as Mac OS X and mingw).
1982 documentation:
1984 * Update documentation - replication and PostingSource aren't experimental in
1985   1.2.x.
1987 portability:
1989 * Make use of built-in UUID API on FreeBSD and NetBSD.  (ticket#470)
1991 * Fix mingw build.
1993 debug code:
1995 * Add new pretty printer for values reported by calls and returns in debug
1996   logging - in particular, strings are now reported with non-printable
1997   characters escaped.
1999 * Debug logging should have less runtime overhead when built in but not in use.
2001 * Drop support for --enable-log=profile - dedicated profiling tools are likely
2002   to return more useful results.
2004 Xapian-core 1.2.0 (2010-04-28):
2006 This release includes all changes from 1.0.20 which are relevant.
2008 testsuite:
2010 * Fix --abort-on-error to actually work.
2012 * Exit with status 1 not 0 if we caught an exception from the harness itself.
2014 Xapian-core 1.1.5 (2010-04-16):
2016 This release includes all changes from 1.0.19 which are relevant.
2018 API:
2020 * Database replication now handles an exception while applying a changeset
2021   better.
2023 * If environment variable XAPIAN_MAX_CHANGESETS is set on a replication client
2024   then any changesets read are saved so the replicated copy can itself be
2025   replicated.
2027 testsuite:
2029 * Use sigsetjmp() and siglongjmp() where available so that the set of blocked
2030   signals get restored and the test harness can catch a second incidence of a
2031   particular signal in a run.  Use sigaction() instead of signal() where
2032   available, which allows us to report the address associated with SIGSEGV,
2033   SIGFPE, SIGILL, and SIGBUS.
2035 * Add machinery to check for leaked file descriptors.  Currently this requires
2036   /proc/self/fd to work (which is present on Linux and some other platforms).
2037   Remove the crude ulimit in runtest which has caused problems on some Debian
2038   buildds.
2040 * The test harness now explicitly catches const char * exceptions and reports
2041   their contents.
2043 brass backend:
2045 * Ensure that the wdf upper bound is correctly updated when replacing
2046   documents.
2048 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2050 chert backend:
2052 * Ensure that the wdf upper bound is correctly updated when replacing
2053   documents.
2055 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2057 * xapian-check: Check that the initial doclen chunk exists.
2059 flint backend:
2061 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2063 remote backend:
2065 * Add remote backend support for WritableDatabase::add_spelling() and
2066   WritableDatabase::remove_spelling().  This bumps the remote protocol to
2067   version 35.0 (so both client and servers will need updating).  Suggesting
2068   spelling corrections isn't yet supported.  (ticket#178)
2070 build system:
2072 * XO_LIB_XAPIAN: Give a more specific error message for the cases where
2073   XAPIAN_CONFIG isn't found, is a directory, or isn't executable.
2075 examples:
2077 * delve:
2079   + If any documents are specified with "-d<docid>", "-V<slot>" now only show
2080     values for those documents.
2082   + Remove undocumented -k option, which has been a compatibility alias for -V
2083     since 0.9.10.  Just use -V instead.
2085 * xapian-metadata: Add new example program which allows you to get and set
2086   individual user metadata entries.
2088 Xapian-core 1.1.4 (2010-02-15):
2090 This release includes all changes from 1.0.18 which are relevant.
2092 API:
2094 * Xapian::TermGenerator,Xapian::QueryParser,Xapian::Unicode::is_wordchar():
2095   Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories to is_wordchar(),
2096   which is used by TermGenerator and QueryParser.  Also make TermGenerator and
2097   QueryParser ignore several zero-width space characters.  This is a better
2098   but less compatible version of a fix in 1.0.18.
2100 * Implement support for iterating valuestreams for multidatabases.
2102 * Xapian::Stem: Update the german and german2 stemming algorithms to the latest
2103   versions from Snowball.  These add an extra rule for the "-nisse" ending.
2105 * Xapian::ValueCountMatchSpy: Replace get_values() with values_begin() and
2106   values_end().
2108 * Xapian::MatchSpy: Provide an iterator for accessing the top values found
2109   instead of taking a vector by reference to return them in.
2111 * Xapian::NumericRanges: Remove experimental API we aren't happy with yet.
2113 * Xapian::DatabaseReplica, Xapian::DatabaseMaster: Remove experimental
2114   API we aren't happy with.  Replication is still supported via the
2115   command line programs.  (ticket#347)
2117 * Xapian::score_evenness(): Remove as it turns out not to be useful in practice.
2118   (ticket#435)
2120 * Xapian::ValueWeightPostingSource: A ValueWeightPostingSource with no entries
2121   would report -infinity as its upper bound, which could cause no results to be
2122   incorrectly returned for some queries involving such an object.
2124 * Xapian::WritableDatabase::close() fixed to commit() changes (unless a
2125   transaction is in progress).
2127 testsuite:
2129 * apitest: Improve test coverage in various places.
2131 matcher:
2133 * Uses of values during the match (sorting by value or Sorter, MatchSpy,
2134   MatchDecider, and collapsing) now use value stream iteration which is
2135   a lot more efficient for chert and brass (but may be slower for flint).
2137 brass backend:
2139 * New development backend.  Changes over chert:
2141   + Batched posting list changes during indexing use significantly less memory.
2143   + Instead of using complex code to iterate modified posting lists and
2144     documents length lists, brass can flush individual such lists to disk
2145     and then iterates them from there.
2147   + To iterate all terms, chert flushes all pending postlist changes.  In the
2148     case where a prefix is specified, brass only flushes postlist changes for
2149     terms starting with the specified prefix, and doesn't flush document length
2150     changes.
2152 chert backend:
2154 * Promote chert to being the stable backend.
2156 * Change the packing of integers and strings into sortable keys, which reduces
2157   database size by 2.5% in tests.  This means an incompatible change in the
2158   chert format.  You can use the new xapian-chert-update utility to update a
2159   chert database from the old format to the new format.  It works much like
2160   xapian-compact so should take a similar amount of time (and results in a
2161   compact database).
2163 * xapian-compact:
2165   + Prune unused docids off the end of each database when merging multiple
2166     databases with renumbering.
2168   + Extend --no-renumber to support merging databases, but only if they have
2169     disjoint ranges of used document ids.
2171   + Ensure that the resultant database has a fresh UUID (previously chert
2172     copied the UUID from the first input).
2174 * xapian-check:
2176   + Fix checking of the METAINFO key in chert.  For small databases, the
2177     statistics fit in few enough bytes that incorrect check appeared to
2178     succeed and no errors were reported, but for larger databases an
2179     error was incorrectly reported.
2181   + Rework the checking of postlist chunks to use a cleaner approach which
2182     should report errors better.
2184   + Use a type wider than 32 bits to keep count of items in a table.
2185     Previously xapian-check would report the number of entries modulo
2186     4294967296.
2188 * When iterating a value stream, skip_to() now only assigns the value to a
2189   std::string when it reaches its target.  This saves a lot of unnecessary
2190   string copying - in a real-world test it improved the time for 100 queries
2191   from 3.66s to 3.10s.
2193 * When skipping through a chunk of postings to find the one we want, don't
2194   bother to unpack the wdf values we're skipping over.  This should save a
2195   significant amount of time in certain cases where the profile data shows
2196   about a third of the time is spent in the function where this happens.
2198 * Report locking failure due to running out of file descriptors better.
2200 flint backend:
2202 * xapian-compact:
2204   + Prune unused docids off the end of each database when merging multiple
2205     databases with renumbering.
2207   + Ensure that the resultant database has a fresh UUID (previously flint
2208     didn't set a UUID so one would be generated on demand when next requested,
2209     but only if the database was writable).
2211 * Report locking failure due to running out of file descriptors better.
2213 remote backend:
2215 * Add support for WritableDatabase::set_metadata() and Database::get_metadata()
2216   to the remote backend (based largely on patch in #178).
2218 inmemory backend:
2220 * Read the document data and values lazily for the inmemory backend like we do
2221   for other backends.  They're much less costly to fetch than if a disk or
2222   network access is involved, but it avoids copying potentially large data
2223   which may not be needed.  Consistency here also makes things easier to
2224   understand for both users and developers.
2226 build system:
2228 * This release uses autoconf 2.65 rather than 2.64.
2230 documentation:
2232 * docs/replication.html: Add note about not using reopen() with databases being
2233   updated by the replication client.
2235 * docs/admin_notes.html: Update for chert and other recent changes.
2237 * Remove out-of-date reference in the API documentation comment to an
2238   add_slot() method.  This no longer exists - you need to use multiple
2239   ValueCountMatchSpy objects to monitor more than one slot.
2241 examples:
2243 * simpleexpand,simpleindex,simplesearch: Handle --help and --version.
2245 debug code:
2247 * The debug log now reports boolean values as "true" and "false" (instead of
2248   "1" and "0").
2250 Xapian-core 1.1.3 (2009-09-18):
2252 This release includes all changes from 1.0.15-1.0.17 which are relevant.
2254 API:
2256 * Update Unicode character database to Unicode 5.2.  (ticket#351)
2258 * Rename Xapian::Sorter to Xapian::KeyMaker, paving the way for using it to
2259   build collapse keys too.  Xapian::Sorter remains for compatibility (and is
2260   now a subclass of Xapian::KeyMaker) but is deprecated.
2262 * Resolve the inconsistency in MultiValueSorter::add()'s "forward" parameter
2263   versus the "reverse" parameters which the Enquire sorting functions now take
2264   by replacing the class with MultiKeyMaker with a renamed method add_value()
2265   with a "reverse" parameter.  MultiValueSorter remains with the old semantics
2266   for compatibility but is deprecated.  (ticket#359)
2268 * QueryParser: Don't apply spelling correction to wildcarded terms, or to terms
2269   at the end of the query which we expand under FLAG_PARTIAL.
2271 * Add new Error subclass SerialisationError which we throw for serialisation
2272   related errors (which previously mostly threw NetworkError.
2274 * Rename Xapian::SerialisationContext to Xapian::Registry.
2276 * Add DecreasingValueWeightPostingSource class, which reads weights from a
2277   value slot in which a significant range of the values are in decreasing
2278   order.  This functions similarly to ValueWeightPostingSource, but can be much
2279   more efficient.
2281 * Add new Xapian::MatchSpy class:
2283   + This replaces the use of Xapian::MatchDecider as a "matchspy", which is now
2284     deprecated.  The new class only inspects, and can't reject.  It can work
2285     with remote databases, with the results being serialised to return them
2286     across the link.
2288   + Add subclass ValueCountMatchSpy, which counts the occurrences of each value
2289     in a slot in the search results seen (useful for faceted or categorisation
2290     systems).  The results can be grouped into ranges using the NumericRange
2291     and NumericRanges classes, and the score_evenness() function.  This API is
2292     currently experimental.
2294 * Remove default implementation of Weight::clone() which returns NULL.  We
2295   always need clone() to be implemented because it's called for every term
2296   in the query, not just used for the remote backend.
2298 chert backend:
2300 * Rewrite the low level packing and unpacking functions more efficiently.  As
2301   well as being generally faster, the pack functions now take a reference to a
2302   string to append to, which avoids creating a lot of temporary string objects.
2303   Indexing HTML files with omindex is 5-10% faster.  Searching for "The" on
2304   gmane (which results in a lot of unpacking of postings and document lengths)
2305   is about 35% faster.  (ticket#326)
2307 * xapian-compact: Don't report an absent lazy input table as 0 size.
2309 * Fix ChertModifiedPostList to skip added-but-then-deleted-before-flush
2310   documents.  (ticket#392)
2312 * Fix WritableDatabase::get_doclength() to work properly after a call to commit
2313   for the chert backend (ticket#397).
2315 * Fix to work with the metainfo key stored in the latest format of chert
2316   databases.
2318 * Avoid doing pointless work by trying to delete non-existent lists of values
2319   when we're just adding documents.
2321 * Fix code to find the first docid in the next chunk (ticket#399).
2323 * Add support for chert databases without a termlist table (ticket#181).
2324   Currently the only way to create such a database is to create a chert
2325   database and do "rm termlist.*".
2327 flint backend:
2329 * xapian-compact: Don't report an absent lazy input table as 0 size.
2331 remote backend:
2333 * Remote protocol major version has changed to support serialising MatchSpy
2334   objects.
2336 * Fixed not to sometimes read off the end of the returned matches when
2337   searching multiple databases, some of which are remote, and when the primary
2338   ordering is by relevance.
2340 build system:
2342 * This release uses autoconf 2.64 rather than 2.63.  This means configure now
2343   makes use of shell functions, which makes it ~13% smaller, and should also
2344   make it execute faster.
2346 * configure: Send stderr output from ldconfig to config.log.
2348 * Add optional third parameter to XO_LIB_XAPIAN autoconf macro which specifies
2349   the basename for the "xapian-config" script (defaults to "xapian-config" to
2350   give the current behaviour).
2352 * This release uses doxygen 1.5.9 to generate the API documentation.
2354 documentation:
2356 * Minor improvements to the formatting of the collated API documentation.
2358 portability:
2360 * Fix code to compile with Sun's C++ compiler.
2362 * Fix our uuid_unparse_lower() replacement for older libuuid to actually
2363   compile (really fixes ticket#368).
2365 * Fix xapian-config to work with Solaris 10 /bin/sh.  (ticket#405)
2367 debug code:
2369 * Use C++ syntax for NULL with a type in log output.
2371 Xapian-core 1.1.2 (2009-07-23):
2373 This release includes all changes from 1.0.14 which are relevant.
2375 API:
2377 * Move support for a prefix/suffix from NumberValueRangeProcessor to
2378   StringValueRangeProcessor, and change NumberValueRangeProcessor and
2379   DateValueRangeProcessor to inherit from StringValueRangeProcessor so all
2380   three now support a prefix/suffix.  (ticket#220)
2382 * Query: Trim 4 bytes off the internals.  (ticket#280)
2384 * QueryParser: If default_op is OP_NEAR or OP_PHRASE then make the window size
2385   (9 + no_of_terms) to match the default for an explicit NEAR or PHRASE.
2386   (ticket#254)
2388 testsuite:
2390 * Sort out the clash between two different patches to fix leaking file
2391   descriptors when running tests with the remotetcp backend (broken by
2392   changes in 1.1.1).
2394 matcher:
2396 * If the highest weighted document doesn't match all the terms in the query,
2397   its percentage weight is now calculated by simply counting how many weighted
2398   leaf subqueries match it instead of scaling by the proportion of the weight
2399   which matches (which required accessing the termlist for that document).
2400   (ticket#363).
2402 * XOR with a SYNONYM subquery could previously achieve 100% - this has been
2403   fixed.
2405 flint backend:
2407 * Backport the lazy update changes from chert to flint:
2409   WritableDatabase::replace_document() now updates the database lazily in
2410   simple cases - for example, if you just change a document's values and
2411   replace it with the same docid, then the terms and document data aren't
2412   needlessly rewritten.  Caveats: currently we only check if you've looked at
2413   the values/terms/data, not if they've actually been modified, and only keep
2414   track of the last document read.
2416 build system:
2418 * Update to always use C++ forms for ISO C standard headers (ticket#330).
2420 * Fix several places where Xapian::doccount is used instead of
2421   Xapian::termcount, and similar issues.  It's still not possible to make
2422   these types different sizes, but we're now closer to this goal.
2423   (ticket#385).
2425 documentation:
2427 * Note that PostingSource and Weight objects returned by clone() and
2428   unserialise() methods will be deallocated with "delete".
2430 debug code:
2432 * Fix debug logging not to segfault on NULL Query::Internal pointers.
2434 Xapian-core 1.1.1 (2009-06-09):
2436 This release includes all changes from 1.0.13 which are relevant.
2438 API:
2440 * New Query::OP_SYNONYM operator, which matches the same documents as OP_OR,
2441   but attempts to weight as if the all the subqueries were a single term with
2442   their combined wdf, which should give better relevance weights.
2444 * QueryParser's synonym, wildcard, and partial query features now use
2445   the new OP_SYNONYM operator.
2447 * PostingSource: Add new set_maxweight() method to allow subclasses to tell
2448   the matcher that their maximum weight has decreased.  Make get_maxweight()
2449   a non-virtual method of the baseclass which returns the last set maxweight
2450   (which will require updates to most user subclasses. (ticket#340)
2452 * DatabaseReplica: Fix SEGV when calling get_description() on a default
2453   constructed DatabaseReplica.
2455 * Make Query::MatchAll and Query::MatchNothing const since they're immutable.
2456   All the public methods of Query are const, so this should be completely API
2457   compatible.
2459 * Methods returning an end iterator for a ValueIterator now actually return a
2460   proxy object which silently converts to ValueIterator if required.  This
2461   proxy object allows a comparison with an "_end()" method to be optimised
2462   better so that it just ends up comparing the internal member of the iterator
2463   class with NULL (previously a call to ValueIterator's destructor remained).
2464   This should be API compatible, but note that it is definitely now more
2465   efficient just to compare against the return value of the relevant _end()
2466   method than to store the end iterator explicitly.
2468 testsuite:
2470 * Testcase valuestats4 requires transactions, so indicate that and remove the
2471   explicit SKIP for inmemory.
2473 * Testcase changemaxweightsource1 uses ChangeMaxweightPostingSource, which
2474   doesn't work with multi or remote, so mark the test accordingly.
2476 * We've decided that "going back" with skip_to() or check() should have
2477   unspecified behaviour, so stop testing how this case behaves!
2479 matcher:
2481 * Subclass MultiPostList directly from PostList instead of from LeafPostList.
2482   This gets rid of two unused data members per MultiPostList in exchange for
2483   having to define 5 extra "never called" methods, but 4 of these just
2484   tailcall.
2486 * Store termfreqs and reltermfreqs for query terms in a single map rather than
2487   one map for each, which saves is more compact and likely to be faster.
2489 chert backend:
2491 * xapian-check: For chert, check value stats are the correct format and that
2492   the streamed values are consistent with their stats (ticket#277).
2494 * xapian-check: Chert doesn't store termlist entries for documents without
2495   terms, which resulted in us reporting an error when we found document ids in
2496   the doclength "postlist" which were greater than any with an entry in the
2497   termlist.  Instead compare these entries against db.get_last_docid() if we
2498   are checking a whole db and the db can be opened.  If not, suppress this
2499   check.
2501 remote backend:
2503 * When serialising stats, serialise the termfreq and reltermfreq together,
2504   rather than in separate lists.  This gives a smaller serialised form, and
2505   matches these both being stored in the same map now.  This is an incompatible
2506   remote protocol change, so bump the major version to 32.  (ticket#362)
2508 build system:
2510 * Some build failures with --disable-backend-XXX options have been fixed, but
2511   we haven't exhaustively tested all combinations.
2513 * Ship common/win32_uuid.cc and common/win32_uuid.h (ticket#367).
2515 documentation:
2517 * Update PostingSource documentation to describe how init() is called again if
2518   a PostingSource is reused.  Fixes #352.
2520 portability:
2522 * Fixed to build with GCC 4.4.
2524 * Drop support for GCC 2.95.3 and 3.0.x - we now require at least 3.1 as doing
2525   so eliminates some preprocessor conditionals which we aren't able to test
2526   regularly as we don't have easy access to such old GCC versions.  GCC 3.1 is
2527   nearly 7 years old now, and GCC3 didn't get widespread use until later
2528   versions anyway.  If you still need to use GCC < 3.1, Xapian 1.0.x should
2529   build with 2.95.3 or newer.
2531 * Older versions of libuuid don't have uuid_unparse_lower() so probe for it in
2532   configure, and if it isn't present provide an inline version in safeuuid.h
2533   (ticket#368).
2535 * Fixed to build with MSVC (ticket#379).
2537 * Add static_cast<char>() to str(bool) overload to suppress bogus MSVC warning
2538   (ticket#377).
2540 debug code:
2542 * common/debuglog.h: Add missing initialisation of uncaught_exception variable
2543   in a couple of places.
2545 Xapian-core 1.1.0 (2009-04-22):
2547 API:
2549 * All deprecated xapian-core features listed for removal in 1.1.0 have been
2550   removed.  See deprecation.html for details, and suggested updates.
2552 * The Unicode character categorisation functions have been updated from
2553   Unicode 5.0 to 5.1.
2555 * Add NON_SPACING_MARK to is_wordchar() for better tokenisation of languages
2556   which use such marks - for example, Arabic.  This is better than the stop-gap
2557   fix in 1.0 of treating NON_SPACING_MARK as a phrase-generator character
2558   when parsing queries, but it does mean that databases built from data
2559   containing such characters will need to be rebuilt.  (ticket#355)
2561 * The details of how to subclass Xapian::Weight to implement your own
2562   weighting scheme have changed incompatibly to allow user weighting schemes
2563   to have access to the same statistics as built-in schemes (ticket#213)
2564   If you have a existing subclass of Xapian::Weight you'll need to update it.
2566 * New Database methods get_doclength_upper_bound(), get_doclength_lower_bound()
2567   and get_wdf_upper_bound(), primarily intended for allowing weighting schemes
2568   to calculate tighter upper bounds on weights (which BM25Weight and TradWeight
2569   now do) which allows matcher weight-based optimisations to be more effective.
2570   Chert actually tracks doclength bounds and a global (rather than per term)
2571   upper bound on wdf; other backends return much less tight bounds, but these
2572   still lead to better upper bounds on weights.
2574 * Enquire::get_eset() now uses an unmodified of probabilistic formula, and
2575   doesn't return terms which would get a negative weight from it (since that
2576   means they are expected to be harmful not helpful).
2578 * Add Database::close() method, which will release system resources (in
2579   particular, close filehandles) held by a database.  This is particularly
2580   useful when wrapping the API for languages with garbage collection.
2582 * Change Database::positionlist_begin() not to throw exceptions if the term or
2583   document doesn't exist.
2585 * Xapian databases now have a UUID, readable with Database::get_uuid().
2587 * A new Database replication API has been added (currently experimental).
2589 * MSet::get_termfreq() will now fall back to looking up the term frequency in
2590   the database rather than raising an exception if a term wasn't present in
2591   the query.
2593 * Calling RSet:add_document() with argument 0 now throws InvalidArgumentError.
2595 * QueryParser sped up (new version of lemon); queryparsertest runs 2.2% faster.
2597 * Add ValueSetMatchDecider, which is a matchdecider which is intended to be
2598   passed a set of values to look for in documents, and selects documents based
2599   on the presence of those values.
2601 * Add new Xapian::PostingSource class to allow passing custom sources of
2602   postings and weights to the matcher.  Built-in PostingSource subclasses:
2603   FixedWeightPostingSource, ValueMapPostingSource, ValuePostingSource, and
2604   ValueWeightPostingSource.  (Currently experimental).
2606 * Database: Add get_value_freq(), get_value_lower_bound() and
2607   get_value_upper_bound() methods to get statistics about the values stored in
2608   a slot.  Add support for the value statistics methods to chert, inmemory,
2609   multi and remote databases.
2611 * Enquire::get_eset() now faster for large ESet size.
2613 * Xapian::Document objects now have a reduced memory footprint.
2615 * Enquire::set_collapse_key() now allows you to specify a maximum number of
2616   matches with each collapse key to keep (which defaults to 1, giving the
2617   previous behaviour).  Enquire can now report bounds and an estimate of what
2618   the total number of matches would have been if collapsing wasn't in use.
2620 * WritableDatabase::commit() is a new, preferred alias for
2621   WritableDatabase::flush().  (ticket#266)
2623 * Add methods for serialising documents and queries to strings, and
2624   unserialising back from strings.  (ticket#206)
2626 testsuite:
2628 * stemtest: No longer checks environment variables OM_STEMTEST_SKIP_RANDOM,
2629   OM_STEMTEST_LANGUAGES, and OM_STEMTEST_SEED.
2631 * perftest: New performance testsuite.  This is intended to contain intended to
2632   contain potentially time-consuming performance tests, which log output to
2633   an XML file for later analysis.  It's not run by "make check" - use "make
2634   check-perf" to run it.
2636 * apitest: Now runs tests over both flint and chert for multi, remotetcp, and
2637   remoteprog.
2639 * Wait for subprocesses to finish at end of tests with remotetcp backend, to
2640   avoid test failures when the same database is used for the next testcase.
2642 matcher:
2644 * Internally, pass around non-normalised document lengths as Xapian::termcount
2645   (unsigned integer) not Xapian::doclength (double).  This gives a 3% speedup
2646   for 10 term OR queries!
2648 chert backend:
2650 * New development backend.  Use Chert::open() to explicitly create a chert
2651   format database, or set XAPIAN_PREFER_CHERT=1 in the environment to
2652   prefer chert when creating a new database without an explicit type.
2654 * Quartz and Flint stored the document length alongside every posting list
2655   entry.  Chert instead stores a chunked list of all the document lengths
2656   which saves a lot of space, and is a big win for large queries or those
2657   which don't need the document lengths.  This structure is used to
2658   implement much faster iteration (six times faster in a test) over all
2659   document ids (which speeds up queries using unary NOT, e.g. `NOT apples'),
2660   and to test for the existence of documents (instead of checking the record
2661   table for an entry).
2663 * Document values are now stored in a chunked stream for each slot for
2664   efficient access to the same slot in lots of documents.  This makes
2665   operations like sort by value much more efficient.
2667 * WritableDatabase::replace_document() now updates the database lazily in
2668   simple cases - for example, if you just change a document's values and
2669   replace it with the same docid, then the terms and document data aren't
2670   needlessly rewritten.  Caveats: currently we only check if you've looked at
2671   the values/terms/data, not if they've actually been modified, and only keep
2672   track of the last document read.
2674 flint backend:
2676 * If we can't obtain a write lock while trying to create a new database
2677   we now report the lock failure with DatabaseLockError, not
2678   DatabaseOpeningError - it's more useful to know that the lock attempt failed
2679   in this situation.
2681 * Improve reporting of failures to obtain lock due to unexpected errors.
2683 * xapian-check: Don't stop checking a table after an error in certain cases -
2684   instead increment the error counter and try to continue checking from the
2685   next item.
2687 remote backend:
2689 * The remote database protocol major version has been increased, allowing
2690   a significant amount of compatibility code to be removed.  This change means
2691   that new clients won't work with old servers, and old clients won't work
2692   with new servers.  If upgrading a live system, you will need to take this
2693   into account.
2695 * The remote servers now always default to opening a Database and the client
2696   has to send a protocol message to explicitly request write access.  This
2697   allows a single server to support multiple readers and one writer
2698   simultaneously.  (ticket#145)
2700 * Database::get_document() no longer does an unnecessary copy of the document's
2701   values.
2703 * Change serialisation of queries to be more compact and easier to parse.
2705 stub databases:
2707 * Stub databases used to assume that any relative paths were relative to the
2708   current working directory.  They now assume that relative paths are
2709   relative to the directory holding the stub database file.
2711 * Stub database lines which begin with a '#' character are now ignored,
2712   allowing comments in stub database files.
2714 * New "stub directory" database type - this is a directory containing a stub
2715   database file named "XAPIANDB".
2717 * Don't just ignore lines with no spaces in a stub database file.
2719 * Bad lines in a stub file were being ignored after we'd seen a good entry.
2721 * Add new Auto::open_stub() overload which opens a stub database file
2722   containing a single entry as a WritableDatabase.
2724 * Add support for "inmemory" to stub database (which is useful now that stub
2725   databases can be opened for writing).
2727 * A stub database file is now allowed to contain no database entries, which
2728   results in an empty Database object (this avoids user code having to special
2729   case to handle "0 or more" databases).
2731 build system:
2733 * To allow installations of Xapian 1.0 and 1.1 to easily coexist, the library
2734   is now libxapian-1.1; xapian.m4 is now xapian-1.1.m4; headers are now
2735   installed in $prefix/include/xapian-1.1.  If you use XO_LIB_XAPIAN or
2736   xapian-config as we recommend, this should all be transparent.  Also
2737   programs and scripts have a default program suffix to -1.1 unless overridden
2738   using the --program-suffix argument to configure (if you really want no
2739   suffix, "./configure --program-suffix=" will achieve this).
2741 * On Linux and k*bsd-gnu, override libtool's link_all_deplibs_CXX to "no".
2743 * On Linux, override libtool's sys_lib_dlsearch_path_spec to a list generated
2744   in a more reliable way which includes all the default directories.
2746 * configure: --enable-debug and --enable-debug-verbose have been deprecated
2747   since 1.0.0, so remove specific errors pointing to the replacements.
2749 documentation:
2751 * Disable "JAVADOC_AUTOBRIEF" in doxygen configuration since we always try to
2752   write a brief description explicitly, and JAVADOC_AUTOBRIEF causes problems
2753   in some cases.
2755 * docs/deprecation.html: Describe what "experimental" features are, and why
2756   replication and posting sources are currently experimental.
2758 * docs/deprecation.html: Deprecate Stem_get_available_languages() from the
2759   python bindings.
2761 examples:
2763 * Use C++ forms of C headers in examples (ticket#330).
2765 packaging:
2767 * xapian-core.spec: We no longer need to run autoreconf to work around
2768   libtool's incomplete sys_lib_dlsearch_path_spec or to pick up distro-specific
2769   patches for link_all_deplibs.
2771 debug code:
2773 * Report get_description() rather than the pointer value for
2774   Xapian::Query::Internal* parameters to internal functions.
2776 * The debug logging framework has been overhauled.  See HACKING for details
2777   of how it now works.
2779 * Faster integer to string functions inside the library (this is a general
2780   improvement, but will particularly speed up debug logging as that converts a
2781   lot of integers to strings).
2783 Xapian-core 1.0.23 (2011-01-14):
2785 API:
2787 * QueryParser: Avoid a double free if Query construction throws an exception
2788   in a particular case.  Fixes ticket#515.
2790 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
2791   integer the same way at the end of the query as in the middle.
2793 * Enquire::get_mset(): Avoid pointlessly trying to allocate lots of memory
2794   if the first document requested is larger than the size of the database.
2796 * Enquire::get_mset(): An empty query now returns an MSet with firstitem set
2797   correctly - previously firstitem was always 0 in this case.
2799 matcher:
2801 * The matcher wasn't recalculating the max possible weight after a subquery of
2802   XOR reached its end.  This caused an assertion failure in debug builds, and
2803   is a missed optimisation opportunity.
2805 tools:
2807 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
2808   This could have caused problems, though we've had no reports of any (the
2809   bug was found with _GLIBCXX_DEBUG).
2811 Xapian-core 1.0.22 (2010-10-03):
2813 API:
2815 * Xapian::Document: Initialise docid to 0 when creating a document from
2816   scratch, as documented.
2818 * Xapian::QueryParser: Allow phrase generators between a probabilistic prefix
2819   and the term itself (e.g. path:/usr/local).
2821 matcher:
2823 * Back out the OP_OR efficiency improvement made in 1.0.21 since this change
2824   slows down some other common cases.  We'll address this fully in 1.2.4, but
2825   that fix is more invasive than we are comfortable with for 1.0.x at this
2826   point.
2828 build system:
2830 * xapian-config: Add --static option which makes other options report values
2831   for static linking.
2833 documentation:
2835 * deprecation.html: Add guidelines for supporting other software.
2837 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
2838   currently supported.
2840 * Fix documentation for Xapian::timeout type - it holds a time interval in
2841   milliseconds not microseconds (the API docs for the methods which use it
2842   explicitly correctly document that the timeouts are in milliseconds).
2844 portability:
2846 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
2847   (ticket#492).
2849 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
2850   control of which SSE instructions to use.
2852 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
2854 * configure: Beef up the test for whether -lm is required and add a special
2855   case to force it to be for Sun's C++ compiler - there's some interaction with
2856   libtool and/or shared objects which means that the previous configure test
2857   didn't think -lm is needed here when it is.
2859 * Fix test harness to build under Microsoft Windows (ticket#495).
2861 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
2863 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
2864   68030 as well as 68000.
2866 packaging:
2868 * xapian-core.spec: Add cmake related files to RPM packaging.
2870 Xapian-core 1.0.21 (2010-06-18):
2872 API:
2874 * Xapian::Stem now recognises "nb" and "nn" as additional codes for the
2875   Norwegian stemmer.
2877 * Xapian::QueryParser now correctly parses a wildcarded term in between two
2878   other terms (ticket#484).
2880 testsuite:
2882 * Improve test coverage of OP_VALUE_RANGE and MSet::get_percent().
2884 matcher:
2886 * OP_OR could skip a matching document if it decayed to OP_AND or OP_AND_MAYBE
2887   during the match in some cases.  Fixes ticket#476.
2889 * OP_XOR with non-leaf subqueries could skip matching documents in some cases,
2890   and OP_XOR of three or more sub-queries could return incorrect weights.
2891   Fixes ticket#475.
2893 * OP_OR is now more efficient if a subquery is potentially expensive (e.g.
2894   ValueRangePostList, OP_NEAR, OP_PHRASE).  A 10-fold speed-up with
2895   ValueRangePostList has been observed.
2897 flint backend:
2899 * When iterating a table, if the table changes underneath we could end up
2900   returning the same entry twice.  (Debian#579951)
2902 * A cancelled transaction (or a failing operation implicitly cancelling
2903   pending changes) now marks the tables as unmodified, which fixes an exception
2904   trying to read block 0 if one of the tables is empty on disk.
2906 quartz backend:
2908 * When iterating a table, if the table changes underneath we could end up
2909   returning the same entry twice.  (Debian#579951)
2911 remote backend:
2913 * When daemonising, read the max fd to close with sysconf() instead of using
2914   a hardcoded value of 256, and work even if stdin and stdout have been closed.
2916 build system:
2918 * Install files to make Xapian easier to use with cmake.
2920 documentation:
2922 * Update the list of languages that the Xapian::Stem constructor recognises.
2924 * Assorted minor improvements to the collated API documentation.
2926 portability:
2928 * On x86 processors, Xapian now defaults to using SSE2 FP instructions.  This
2929   avoids issues with excess precision and it a bit faster too.  If you need
2930   to support processors without SSE2 (this means pre-Pentium4 for Intel) then
2931   configure with --disable-sse.  (ticket#387)
2933 * Fix warning when compiling for mingw with GCC 4.2.1.
2935 * Remove mutable from a couple of reference class members - mutable doesn't
2936   make sense for a reference and some compilers warn about it.
2938 Xapian-core 1.0.20 (2010-04-27):
2940 API:
2942 * MSet: Fix incorrect values reported by get_matches_estimated(),
2943   get_matches_lower_bound(), and get_matches_upper_bound() in certain cases
2944   when sorting and collapsing (ticket#464).
2946 documentation:
2948 * deprecation.html: Note how to disable deprecation warnings. (ticket#393)
2950 examples:
2952 * delve: Add -a option to list all terms in a database.
2954 * delve: -d and -V command line options now report out of range and invalid
2955   numbers.
2957 portability:
2959 * The getopt warning fix for Cygwin in 1.0.19 caused build failures on Mac OS X
2960   (and probably some other platforms with non-GNU getopt implementations), so
2961   replace with a fix which is only enabled for Cygwin. (ticket#469)
2963 Xapian-core 1.0.19 (2010-04-15):
2965 API:
2967 * QueryParser: Fix leak if Xapian::Database throws an exception during parsing
2968   (ticket#462).
2970 testsuite:
2972 * Explicitly flush after indexing for quartz and flint, so we see any
2973   exceptions from the flush (the implicit flush from the destructor swallows
2974   any exceptions).
2976 * apitest: Add databasemodified1 testcase to provide some test coverage for
2977   DatabaseModifiedError.
2979 flint backend:
2981 * When updating a document, rather than decoding the old positions, comparing
2982   with the new, and then encoding the new if different, we now just encode the
2983   new and then compare the encoded forms.  (ticket#428)
2985 * Avoid trying to delete the document positions when we know there aren't any.
2987 * Fix memory leak if Database::allterms_begin() throws an exception
2988   (ticket#462).
2990 * xapian-check: Report document id for document length mismatch.
2992 * Fix potential issues with iterators over a WritableDatabase which is modified
2993   during iteration.  No problems have actually been observed with flint, only
2994   in 1.1.4 with chert in cases which don't occur in flint, but it seems likely
2995   the issue can manifest for flint in other situations.  Fixes ticket#455.
2997 * Initialise zlib z_stream structure members zalloc, zfree, and opaque with
2998   Z_NULL rather than 0 cast to the appropriate type, as that's what the zlib
2999   documentation says to do.  Add missing initialisation of opaque for the
3000   inflate z_stream which the zlib docs say is needed (reading the zlib code,
3001   this isn't true for current versions, so this improves robustness rather
3002   than fixing an observable bug).
3004 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
3005   undefined behaviour (as a block overlaps itself).
3007 quartz backend:
3009 * Fix potential issues with iterators over a WritableDatabase which is modified
3010   during iteration.  No problems have actually been observed with quartz, only
3011   in 1.1.4 with chert in cases which don't occur in quartz, but it seems likely
3012   the issue can manifest for quartz in other situations.  Fixes ticket#455.
3014 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
3015   undefined behaviour (as a block overlaps itself).
3017 build system:
3019 * Force -fno-strict-aliasing for GCC 4.2 to avoid bad code being generated due
3020   to a bug in that compiler version.  Fixes ticket#449.  This issue hasn't been
3021   observed to affect Xapian 1.0.x, but it seems prudent to backport the fix.
3023 documentation:
3025 * INSTALL: Correct description of --enable-assertions.  It does NOT enable
3026   debugging symbols, and shouldn't control checks on bad data passed to API
3027   calls (if it does anywhere, that's a bug).  Note that Xapian will run more
3028   slowly with assertions on.
3030 * spelling.html:
3032   + Add section on indexing.
3034   + Add a note about removing automatically added spelling dictionary entries.
3036   + Move the "algorithm" section to the end, as it is really just background
3037     information for the curious.
3039 * include/xapian/queryparser.h: Document the possible exception messages from
3040   QueryParser::parse_query().
3042 * include/xapian/termgenerator.h: Note how TermGenerator handles stopwords.
3044 examples:
3046 * delve: Display the lastdocid value when displaying general database
3047   statistics.
3049 * simpleindex: Explicitly call flush() on the database, as that is good
3050   practice (since you see any exceptions).
3052 portability:
3054 * Fix compilation failure in testsuite on OpenBSD, introduced by new regression
3055   test in 1.0.18.  Fixes ticket#458.
3057 * Fix getopt-related warning on Cygwin.
3059 Xapian-core 1.0.18 (2009-02-14):
3061 API:
3063 * Document: Add new add_boolean_term() method, which is an alias for add_term()
3064   with wdfinc=0.
3066 * QueryParser:
3068   + Add support for quoting boolean terms so they can contain arbitrary
3069     characters (partly addresses ticket#128).
3071   + Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories, plus several
3072     zero-width space characters, as phrase generators.  This mirrors a better
3073     fix in 1.1.4, but without losing compatibility with existing databases.
3075   + Fix handling of an explicit AND before a hated term (foo AND -bar).
3076     (ticket#447)
3078 * TermIterator: Only include trailing '+' or '#' on a term if it isn't followed
3079   by a word character (makes more sense and matches QueryParser's behaviour).
3080   (ticket#446)
3082 * Database: Fix many methods to behave better on a database with no
3083   subdatabases, such as is constructed by Database().  Fixes ticket#415.
3085 testsuite:
3087 * Add test coverage for xapian-compact, and improve coverage for
3088   WritableDatabase::replace_document().
3090 * apitest: Rename matchfunctor<n> to matchdecider<n> to match current
3091   terminology.
3093 flint backend:
3095 * When updating documents, don't update posting entries which haven't changed.
3096   Largely fixes ticket #250.
3098 * If the number of entries in the position table happened to be 4294967296 or
3099   an exact multiple, Xapian would ignore positional data for that table when
3100   running queries, and xapian-compact wouldn't copy its contents.
3102 * Iterating all the terms in the database with a prefix is now slightly more
3103   efficient.
3105 * Fix locking code to work if stdin and/or stdout have been closed.
3107 * If a document is replaced with itself unmodified, we no longer increase the
3108   automatic flush counter.
3110 * When iterating a posting list modified since the last flush(), the reported
3111   wdf is now correct (previously it was too high by its old value).
3113 * Replacing a document deleted since the last flush failed to update the
3114   collection frequency and wdf, and caused an assertion failure when assertions
3115   were enabled.
3117 * WritableDatabase::replace_document() didn't always remove old positional
3118   data (the only effect is that the position table was bloated by unwanted
3119   entries).
3121 * xapian-inspect:
3123   + New "until" command which shows entries until a specified key is reached.
3125   + New "open" command which allows easy switching between tables.
3127 * xapian-compact: Fix typos in --help output.
3129 quartz backend:
3131 * Replacing a document deleted since the last flush failed to update the
3132   collection frequency and wdf, and caused an assertion failure when assertions
3133   were enabled.
3135 * WritableDatabase::replace_document() didn't always remove old positional
3136   data (the only effect is that the position table was bloated by unwanted
3137   entries).
3139 remote backend:
3141 * Throw UnimplementedError if a MatchDecider is used with the remote backend.
3142   Previously Xapian returned incorrect results in this case.
3144 build system:
3146 * configure: With --enable-maintainer-mode, enable -Werror for GCC >= 4.1
3147   rather than >= 4.0 as Apple's GCC 4.0 gives bogus uninitialised variable
3148   warnings.
3150 documentation:
3152 * The API documentation now includes Xapian::Error and subclasses, and doesn't
3153   mention Xapian::Query::Internal.
3155 * Make clear in the Xapian::Document API documentation that this class is a
3156   lazy handle and discuss the issues this can cause.
3158 * INSTALL: Improve text about zlib dependency.
3160 * HACKING: Add details of our licensing policy for accepting patches.
3162 examples:
3164 * quest: If no database is specified, still parse the query and report
3165   Query::get_description() to provide an easy way to check how a query parses.
3167 portability:
3169 * Fix GCC 4.2 warning.
3171 xapian-core 1.0.17 (2009-11-18):
3173 API:
3175 * QueryParser:
3177   + Fix handling of a group of two or more terms which are all stopwords which
3178     notably caused issues when default_op was OP_AND, but could probably
3179     manifest in other cases too.  Fixes ticket#406.
3181   + Fix interaction of FLAG_PARTIAL and FLAG_SYNONYM.  (ticket#407)
3183 * Database: A database created via the default constructor no longer causes a
3184   segfault when the methods get_metadata() or metadata_keys_begin() are called.
3186 flint backend:
3188 * Don't try to close the fd one more than the maximum allowable when locking
3189   the database.  Harmless, except it causes a warning when running under
3190   valgrind.  (ticket#408)
3192 remote backend:
3194 * Xapian::Sorter isn't supported with the remote backend so throw
3195   UnimplementedError rather than giving incorrect results.  (ticket#384)
3197 * Fix potential reading off the end of the MSet which is returned internally
3198   by the remote server.
3200 documentation:
3202 * Various documentation comment improvements for the Database class.
3204 examples:
3206 * examples/quest.cc: Tighten up the type of the error we catch to detect an
3207   unknown stemming language.
3209 portability:
3211 * xapian-config: Need to quote ^ for Solaris /bin/sh.
3213 * configure: Actually use any flags we determine are needed to switch the
3214   compiler to proper ANSI C++ mode, when building xapian-core - this stopped
3215   working in 1.0.12, breaking support for HP's aCC, Compaq's cxx, Sun's CC, and
3216   SGI's CC.
3218 Xapian-core 1.0.16 (2009-09-10):
3220 flint backend:
3222 * Fix a typo which stopped this fix in 1.0.12 from working (ticket #398):
3224   If we fail to get the lock after we spawn the child lock process (the common
3225   case is because the database is already open for writing) then we now clean
3226   up the child process properly.
3228 documentation:
3230 * Improve API documentation of QueryParser::set_default_op() and
3231   QueryParser::get_default_op().
3233 portability:
3235 * Fix build failure on Mac OS X 10.6.
3237 Xapian-core 1.0.15 (2009-08-26):
3239 testsuite:
3241 * Fix the test harness not to report heaps of bogus errors when using valgrind
3242   3.5.0.
3244 flint backend:
3246 * Backport the lazy update changes from 1.1.2:
3248   WritableDatabase::replace_document() now updates the database lazily in
3249   simple cases - for example, if you just change a document's values and
3250   replace it with the same docid, then the terms and document data aren't
3251   needlessly rewritten.  Caveats: currently we only check if you've looked at
3252   the values/terms/data, not if they've actually been modified, and only keep
3253   track of the last document read.
3255 * Fix PostingIterator::skip_to() on an unflushed WritableDatabase to skip
3256   documents which were added and deleted since the last flush.  (ticket#392)
3258 documentation:
3260 * Overhaul the doxygen options we use and tweak various documentation comments
3261   to improve the generated API documentation.
3263 * Explicitly document that an empty prefix argument to
3264   QueryParser::add_prefix() means "no prefix".
3266 * Update the documentation comments for Enable::set_sort_by_value(),
3267   set_sort_by_value_then_relevance(), and set_sort_by_relevance_then_value() to
3268   mention sortable_serialise() as a good way to store numeric values for
3269   sorting.
3271 Xapian-core 1.0.14 (2009-07-21):
3273 API:
3275 * When using more than one ValueRangeProcessor, QueryParser didn't reset the
3276   begin and end strings to ignore any changes made by a ValueRangeProcessor
3277   which returned false, so further ValueRangeProcessors would see any changes
3278   it had made.  This is now fixed, and test coverage improved.
3280 testsuite:
3282 * The test harness code which launches xapian-tcpsrv child processes was
3283   failing to close a file descriptor for each one launched due to a bug in
3284   the code which is meant to track them.  This was causing apitest to fail
3285   on OpenBSD (ticket#382).  Also wait between testcases for any spawned
3286   xapian-tcpsrv processes to exit to avoid spurious failures when a database is
3287   reused by the next testcase.
3289 * tests/runtest.in: Use "ulimit -n" where available to limit the number of
3290   available file descriptors to 64 so we catch file descriptor leaks sooner.
3292 * When measuring CPU time used for scalability tests, we no longer try to
3293   include the CPU time used by child processes, as we can only get that for
3294   child processes which have exited and it's hard to ensure that they have
3295   with the current framework.  Although this means we only tests the
3296   client-side scaling for remote tests, the local backend tests cover most of
3297   the work done by the server part of the remote backend.
3299 * apitest: In testcase topercent2, don't expect max_attained or max_possible to
3300   be exact as rounding errors in different ways of calculating can cause small
3301   variations.  On trunk we already have similar code because the new weighting
3302   scheme stuff gives different bounds in the different cases.  This should fix
3303   testsuite failures seen on some of the Debian and Ubuntu buildds.
3305 * The test harness now always reports the full exception message (was
3306   conditional on --verbose), and output for different exception types and
3307   other causes of failure is now more consistent.
3309 * For scalability tests, the test harness now increases the number of
3310   repetitions until the first run takes more than 0.001 seconds, to avoid
3311   trying to base calculations on a length of time we probably can't reliably
3312   measure to start with.
3314 * Add test coverage for Stem::get_description() for each supported language.
3316 * queryparsertest: Reenable tests which require the inmemory backend to be
3317   enabled by fixing typo XAPIAN_HAS_BACKEND_INMEMORY ->
3318   XAPIAN_HAS_INMEMORY_BACKEND.
3320 flint backend:
3322 * Use F_FULLFSYNC where available (Mac OS X currently) to ensure that changes
3323   have been committed to disk.  (ticket#288)
3325 remote backend:
3327 * Fix handling of percentage weights in various cases when we're searching
3328   multiple remote databases or a mix of local and remote databases.
3330 build system:
3332 * configure: -Wshadow produces false positives with GCC 4.0, so only enable it
3333   for >= 4.1 since we enable -Werror for maintainer-mode builds for GCC >= 4.0.
3335 * configure: Check that we can find the valgrind/memcheck.h header as well as
3336   the valgrind binary.
3338 * Change how snowball generates the data used by its among operation - instead
3339   of using pointers to the strings in struct among, store an offset into a
3340   constant pool, as this reduces the number of relocations by about 2300, which
3341   should decrease the time taken by the dynamic linker when loading the
3342   library.  This also reduces the size of the shared library significantly
3343   (on x86-64 Linux, the stripped shared library is 4% smaller).
3345 Xapian-core 1.0.13 (2009-05-23):
3347 API:
3349 * Xapian::Document no longer ever stores empty values explicitly.  This
3350   wasn't intentional behaviour, and how this case was handled wasn't
3351   documented.  The amended behaviour is consistent with how user metadata
3352   is handled.  This change isn't observable using Document::get_value(),
3353   but can be noticed when iterating with Document::values_begin(), using
3354   Document::values_count(), or trying to delete the value with
3355   Document::remove_value().
3357 testsuite:
3359 * Fix testcase scaleweight4 not to fail on x86 when compiled with -O0.  The
3360   problem was in the testcase code, and was caused by excess precision in
3361   intermediate FP values.
3363 * Testcases which check that operations have the expected O(...) behaviour now
3364   check CPU time instead of wallclock time on most platforms, which should
3365   eliminate occasional failures due to load spikes from other processes.
3366   (ticket#308)
3368 * Fix test failures due to SKIP_TEST_FOR_BACKEND("inmemory") not skipping when
3369   it should due to comparing char * strings with == (on trunk the return value
3370   being tested is std::string rather than const char *).
3372 * Improve test coverage in several corner cases.
3374 * Fix testcase consistency2 to actually be run (fortunately it passes).
3376 * In the generated testcases, call get_description() on the default
3377   constructed object of each class to make sure that works (and doesn't try to
3378   dereference NULL, or fail some assertion, etc).  All currently checked
3379   classes are fine - this is to avoid future regressions or such problems with
3380   new classes.
3382 * In the test coverage build, use "--coverage" instead of "-fprofile-arcs
3383   -ftest-coverage".
3385 * The test harness now has the inmemory backend flagged as supporting
3386   user-specified metadata (apart from iteration over metadata keys).
3388 matcher:
3390 * If a query contains a MatchAll subquery, check for it before checking the
3391   other terms so that the loop which checks how many terms match can exit
3392   early if they all match.
3394 * When an OR or ANY_MAYBE decayed to an AND, we were carefully swapping the
3395   children for maximum efficiency, but the condition was reversed so we were
3396   in fact making things worse.  This was noticed because it was resulting in
3397   the same query running faster when more results were asked for!
3399 * Only build the termname to termfreq and weight map for the first subdatabase
3400   instead of rebuilding it for each one.  Also don't copy this map to return
3401   it.  This should speed up searches a little, especially those over multiple
3402   databases.
3404 * If a submatcher fails but ErrorHandler tells us to continue without it, we
3405   just use a NULL pointer to stand in rather than allocating a special dummy
3406   place-holder object.
3408 * Remove AndPostList, in favour of MultiAndPostList.  AndPostList was only used
3409   as a decay product (by AndMaybePostList and OrPostList), and doesn't appear
3410   to be any faster.  Removing it reduces CPU cache pressure, and is less code
3411   to maintain.
3413 * Call check() instead of skip_to() on the optional branch of AND_MAYBE.
3415 flint backend:
3417 * Fix a bug in TermIterator::skip_to() over metadata keys.
3419 remote backend:
3421 * Fix xapian-tcpsrv --interface option to work on MacOS X (ticket#373).
3423 * Fix typo which caused us to return the docid instead of the maximum weight
3424   a document from a remote match could return!  This could have led to wrong
3425   results when searching multiple databases with the remote backend, but
3426   probably usually didn't matter as with BM25 the weights are generally small
3427   (often all < 1) while docids are inevitably >= 1.
3429 inmemory backend:
3431 * The inmemory backend doesn't support iterating over metadata keys.  Trying
3432   to do so used to give an empty iteration, but has now been fixed to throw
3433   UnimplementedError (and this limitation has now been documented).
3435 build system:
3437 * Remove a lot of unused header inclusions and some unused code which should
3438   make the build faster and slightly smaller.
3440 * Fix to compile under --disable-backend-flint, --disable-backend-remote, and
3441   --disable-backend-inmemory.
3443 * Don't remove any built sources in "make clean" even under
3444   --make-maintainer-mode as that breaks switching a tree away from
3445   maintainer-mode with: make distclean;./configure
3447 * configure: Enable more GCC warnings - "-Woverloaded-virtual" for all
3448   versions, "-Wstrict-null-sentinel" for 4.0+, "-Wlogical-op
3449   -Wmissing-declarations" for 4.3+.  Notably "-Wmissing-declarations" caught
3450   that consistency2 wasn't being run.
3452 * Internally, fix the few places where we pass std::string by value to pass
3453   by const reference instead (except where we need a modifiable copy anyway) as
3454   benchmarking shows that const reference is slightly faster and generates
3455   less code with GCC's reference counted std::string implementation - with a
3456   non-reference counted implementation, const reference should be much faster.
3457   (ticket#140)
3459 documentation:
3461 * INSTALL: We no longer regularly test build with GCC 2.95.4 and we're raising
3462   the minimum GCC version required to 3.1 for Xapian 1.1.x.
3464 * Document what passing maxitems=0 to Enquire::get_mset() does.
3466 * docs/queryparser.html: Add examples of using a prefix on a phrase or
3467   subexpression.
3469 * Correct doxygen comments for user metadata functions:
3470   Database::get_metadata() can't throw UnimplementedError but
3471   WritableDatabase::set_metadata() can.
3473 * Document that Database::metadata_keys_begin() returns an end iterator if the
3474   backend doesn't support metadata.
3476 * HACKING: Update the list of Debian/Ubuntu packages needed for a development
3477   environment.
3479 debug code:
3481 * Fix build with --enable-debug.
3483 * Added some more assertions.
3485 Xapian-core 1.0.12 (2009-04-19):
3487 API:
3489 * WritableDatabase::remove_spelling() now works properly.
3491 * The QueryParser now treats NON_SPACING_MARK Unicode characters as phrase
3492   generators, which improves handling of Arabic.  This is a stop-gap solution
3493   for 1.0.x which will work with existing databases without requiring
3494   reindexing - in 1.1.0, NON_SPACING_MARK will be regarded as part of a word.
3495   (ticket#355)
3497 * Fix undefined behaviour in distribution of OP_NEAR and OP_PHRASE over a
3498   non-leaf subquery (indentified by valgrind on testcase nearsubqueries1).
3499   (ticket#349)
3501 * Enhance distribution of OP_NEAR/OP_PHRASE over non-leaf subqueries to work
3502   when there are multiple non-leaf subqueries (ticket#201).
3504 * Enquire::get_mset() no longer needlessly checks if the documents exist.
3506 * PostingIterator::get_description() output improved visually in some cases.
3508 testsuite:
3510 * Add make targets to assist generating a testsuite code coverage report with
3511   lcov.  See HACKING for details.
3513 * Improved test coverage in a number of places and removed some used code as
3514   shown by lcov's coverage report.
3516 flint backend:
3518 * xapian-compact:
3520   + Now handles databases which contains no documents but have user metadata
3521     (ticket#356).
3523   + Fix test for the total document length overflowing.
3525 * Release the database lock if the database is closed due to an unrecoverable
3526   error during modifications. (ticket#354)
3528 * If we fail to get the lock after we spawn the child lock process (the common
3529   case is because the database is already open for writing) then we now clean
3530   up the child process properly.
3532 build system:
3534 * Overriding CXXFLAGS at make-time (e.g. "make CXXFLAGS=-Os") no longer
3535   overrides any flags configure detected to be required to make the compiler
3536   accept ISO C++ (for GCC, no such flags are required, so this doesn't
3537   change anything).
3539 documentation:
3541 * Update documentation and code comments to reflect that 1.1 will be a
3542   development series, and 1.2 the next release series.
3544 * docs/admin_notes.html: Document the child process used for locking which
3545   exec-s "cat" (ticket #258).
3547 * include/xapian/unicode.h: Fix documentation comment typos.
3549 * include/xapian/matchspy.h: Removed currently unused header to stop doxygen
3550   from generating documentation for it.
3552 Xapian-core 1.0.11 (2009-03-15):
3554 API:
3556 * Enquire::get_mset():
3558   + Now throws UnimplementedError if there's a percentage cutoff and sorting is
3559     primarily by value - this has never been correctly supported and it's
3560     better to warn people than give incorrect results.
3562   + No longer needlessly copies the results internally.
3564   + When searching multiple databases, now recalculates the maximum attainable
3565     weight after each database which may allow it to terminate earlier.
3566     (ticket#336).
3568   + Fix inconsistent percentage scores when sorting primarily by value, except
3569     when a MatchDecider is also being used; document this remaining problem
3570     case.  (ticket#216)
3572 * Enquire::set_sort_by_value() (and similar methods): Rename the wrongly named
3573   "ascending" parameter to "reverse", and note that its value should always be
3574   explicitly given since defaulting to "reverse=true" is confusing and the
3575   default will be deprecated in 1.1.0.  (ticket#311)
3577 * Database::allterms_begin(): Fix memory leak when iterating all terms from
3578   more than one database.
3580 * Query::get_terms_begin(): Don't return "" from the TermIterator (happened
3581   when the query contained or was Query::MatchAll).
3583 * Add QueryParser::FLAG_DEFAULT to make it easier to add flags to those set by
3584   default.
3586 testsuite:
3588 * The testsuite now reports problems detected by valgrind with newer valgrind
3589   versions.  Drop support for running the testsuite under valgrind < 3.3.0
3590   (well over a year old) as this greatly simplifies the configure tests.
3592 * Fix usage message for options which take arguments in --help output from test
3593   programs - "-x=foo" doesn't work, the correct syntax is "-x foo".
3595 * If comparing MSet percentages fails, report the differing percentages if in
3596   verbose mode.
3598 * Add test that backends don't truncate total document length to 32 bits.
3600 * Disable lockfileumask1 (regression testcase added in 1.0.10) on Cygwin and on
3601   OS/2.
3603 flint backend:
3605 * The configure test for pread() and pwrite() got accidentally disabled in
3606   0.8.4 and we've always been using llseek() followed by read() or write()
3607   since then.  The configure test is now fixed, and gives a slight speedup
3608   (3% measured for searching).
3610 * The child process used to implement WritableDatabase locking now changes
3611   directory to / so that it doesn't block unmounting of any partitions and
3612   closes any open file descriptors which aren't relating to locking so that
3613   if those files are closed by our parent and deleted the disk space gets
3614   released right away.
3616 * We now reuse the same zlib zstream structures rather than using a fresh
3617   one for each operation.  This doesn't make a measurable difference in
3618   our own tests on Linux but reportedly is measurably faster on some
3619   systems.  (ticket #325)
3621 quartz backend:
3623 * The pread()/pwrite() fix also speeds up quartz.
3625 remote backend:
3627 * Avoid copying Query::Internal objects needlessly when unserialising Query
3628   objects.
3630 inmemory backend:
3632 * Store the (non-normalised) document lengths as Xapian::termcount (unsigned
3633   int) rather than Xapian::doclength (double) which saves 4 bytes per document.
3635 build system:
3637 * configure: The output of g++ --version changed format (again) with GCC 4.3
3638   which meant configure got "g++" for the version.  Instead use the (hopefully)
3639   more robust technique of using g++ -E to pull out __GNUC__ and
3640   __GNUC_MINOR__.
3642 documentation:
3644 * API documentation:
3646   + WritableDatabase::flush() can't throw DatabaseLockError.
3648   + WritableDatabase's constructor can throw at least DatabaseCorruptError or
3649     DatabaseLockError.
3651   + Document how to get all matches from Enquire::get_mset().
3653   + Other minor improvements.
3655 * docs/sorting.html: Clarify meaning.
3657 portability:
3659 * Fix "#line" directives in generated file queryparser/queryparser_internal.cc
3660   to give a relative path - previously they had a full path when generated by a
3661   VPATH build (as release tarballs are), and this confused GCC 2.95 and
3662   depcomp.
3664 * Fix for compiling with Sun's compiler (untested as we no longer have access
3665   to it).
3667 Xapian-core 1.0.10 (2008-12-23):
3669 API:
3671 * Composing an OP_NEAR query with two non-term subqueries now throws
3672   UnimplementedError instead of AssertionError (in a --enable-assertions build)
3673   or leading to unexpected results (otherwise).  This partly addresses bug#201.
3675 * Using a MultiValueSorter with no values set no longer causes a hang or
3676   segmentation fault (but it is still rather pointless!)
3678 matcher:
3680 * If we're using values for sorting and for another purpose, cache the
3681   Document::Internal object created to get the value for sorting, like we do
3682   between other uses.
3684 flint backend:
3686 * If the disk became full while flushing database changes to disk, the
3687   WritableDatabase object would throw a DatabaseError exception but be left in
3688   an inconsistent state such that further use could lead to the database on
3689   disk ending up in a "corrupt" state (theoretically fixable, but no tool
3690   to fix such a database exists).  Now we try to ensure that the object is
3691   left in a consistent state, but if doing so throws a further exception, we
3692   put the WritableDatabase object in a "closed" state such that further
3693   attempts to use it throw an exception.
3695 * Create the lockfile "flintlock" with permissions 0666 so that the umask is
3696   honoured just like we do for the other files (previously we used 0600).
3697   Previously it wasn't possible to lock a database for update if it was
3698   owned by another user, even if you otherwise had sufficient permissions via
3699   "group" or "other".
3701 * Fix garbled exception message when a base file can't be reread.
3703 quartz backend:
3705 * Fix garbled exception message when a base file can't be reread.
3707 remote backend:
3709 * xapian-tcpsrv and xapian-progsrv now accept -w as a short form of --writable,
3710   as was always intended.
3712 build system:
3714 * This release now uses newer versions of the autotools (autoconf 2.62 ->
3715   2.63; automake 1.10.1 -> 1.10.2).
3717 documentation:
3719 * INSTALL: Add new paragraphs about HP's aCC and IRIX (adapted from footnotes
3720   in PLATFORMS).
3722 * PLATFORMS: HP testdrive has been shut down, so all mark all those machines as
3723   "no longer available".  Update atreus' build report to 1.0.10.
3725 * docs/queryparser.html: Add link to valueranges.html.
3727 examples:
3729 * delve: Add missing "and" to --help output.  Report termfreq and collection
3730   freq for each term we're asked about.
3732 portability:
3734 * Fix to build with GCC 4.4 snapshot.
3736 Xapian-core 1.0.9 (2008-10-31):
3738 API:
3740 * Database::get_spelling_suggestion() is now faster (15% speed up for parsing
3741   queries with FLAG_SPELLING_CORRECTION set in a test on real world data).
3743 * Fix OP_ELITE_SET segmentation fault due to excess floating point precision
3744   on x86 Linux (and possibly other platforms).
3746 * Database::allterms_begin() over multiple databases now gives a TermIterator
3747   with operations O(log(n)) rather than potentially O(n) in the number of
3748   databases.
3750 * Add new Database methods metadata_keys_begin() and metadata_keys_end() to
3751   allow the complete list of metadata in a database to be retrieved (this
3752   API addition is needed so that copydatabase can copy database metadata).
3754 testsuite:
3756 * Remove the cached test databases before running the testsuite.
3758 * apitest: Fix cursordelbug1 to work on Microsoft Windows (bug#301).
3760 * apitest,queryparsertest: Skip tests which fail because the timer granularity
3761   is too coarse to measure how long the test took.  In practice, this is only
3762   an issue on Microsoft Windows (bug#300 and bug#308).
3764 matcher:
3766 * Adjust percent cutoff calculations in the matcher in a way which corresponds
3767   to the change to percentage calculations made in 1.0.7 to allow for excess
3768   precision.
3770 * Query::MatchAll no longer gives match results ranked by increasing document
3771   length.
3773 flint backend:
3775 * xapian-compact: Fix crash while compacting spelling table for a single
3776   database when built with MSVC, and probably other platforms, though Linux
3777   got lucky and happened to work (bug#305).
3779 build system:
3781 * configure: Disable -Wconversion for now - it's not useful for older GCC and
3782   is buggy in GCC 4.3.
3784 * configure: Set -Wstrict-overflow to 1 instead of 5, to avoid unreasonable
3785   warnings under GCC 4.3.
3787 documentation:
3789 * Minor improvements to API documentation, including documenting the
3790   XAPIAN_FLUSH_THRESHOLD environmental variable in WriteableDatabase::flush()
3791   (bug#306).
3793 * valueranges.html: Fix typos in example code, and drop superfluous empty
3794   destructor from ValueRangeProcessor subclass.
3796 * HACKING: Several improvements.
3798 examples:
3800 * copydatabase: Also copy user metadata.
3802 Xapian-core 1.0.8 (2008-09-04):
3804 API:
3806 * Fix output of RSet::get_description
3808 testsuite:
3810 * Report subtotals per backend, rather than per testgroup per backend to make
3811   the output easier to read.
3813 flint backend:
3815 * Fix WritableDatabase::add_document() and replace_document() not to be O(n*n)
3816   in the number of values in the new document.
3818 * Fix handling of a table created lazily after the database has had commits,
3819   and which is then cursored while still in sequential mode.
3821 * Fix failure to remove all the Btree entries in some cases when all the
3822   postings for a term are removed.  (bug#287)
3824 * xapian-inspect: Show the help message on start-up.  Correct the documented
3825   alias for next from ' ' to ''.  Avoid reading outside of input string when it
3826   is empty.  (bug#286)
3828 quartz backend:
3830 * Backport fix from flint for WritableDatabase::add_document() and
3831   replace_document() not to be O(n*n) in the number of values in the new
3832   document.
3834 build system:
3836 * configure: Report bug report URL in --help output.
3838 * xapian-config: Report bug report URL in --help output.
3840 * configure: Fix deprecation error for --enable-debug=full to say to instead
3841   use '--enable-assertions --enable-log' not '--enable-debug --enable-log'.
3843 documentation:
3845 * valueranges.html: Expand on some sections.
3847 examples:
3849 * quest: Fix to catch QueryParserError instead of const char * which
3850   QueryParser threw in Xapian < 1.0.0.
3852 * copydatabase: Use C++ forms of C headers.  Only treat '\' as a directory
3853   separator on platforms where it is.  Update counter every 13 counting up to
3854   the end so that the digits all "rotate" and the counter ends up on the exact
3855   total.
3857 portability:
3859 * Eliminate literal top-bit-set characters in testsuite source code.
3861 Xapian-core 1.0.7 (2008-07-15):
3863 API:
3865 * OP_VALUE_RANGE, OP_VALUE_GE, and OP_VALUE_LE:
3867   + If there were gaps in the document id numbering, these operators could
3868     return document ids which weren't present in the database.  This has been
3869     fixed.
3871   + These operators are now more efficient when there are a lot of "missing"
3872     document ids (bug#270).
3874   + Optimise Query(OP_VALUE_GE, <n>, "") to Query::MatchAll.
3876 * Xapian::QueryParser:
3878   + QueryParser now stops parsing immediately when it hits a syntax error.
3879     This doesn't change behaviour, but does mean failing to parse queries is
3880     now more efficient.
3882   + Cases of O(N*N) behaviour have been fixed.
3884 * Xapian::Stem now recognises "nl" as an alias for "dutch" (debian bug 484458).
3886 * Setting sort by value was being ignored by a Xapian::Enquire object which had
3887   previously had a Xapian::Sorter set (bug#256).
3889 testsuite:
3891 * Improved test coverage in a few places.
3893 matcher:
3895 * When using a MatchDecider, we weren't reducing matches_lower_bound unless
3896   all the potential results were retrieved, which led to the lower bound
3897   being too high in some such cases.
3899 * We now track how many documents were tested by a MatchDecider and how many
3900   of those it rejected, and set matches_estimated based on this rate.  Also,
3901   matches_upper_bound is reduced by the number of rejected documents.
3903 * Fixed matches_upper_bound in some cases when collapsing and using a
3904   MatchDecider.
3906 * Fixed matches_lower_bound when collapsing and using a percentage cutoff.
3908 * When using two or more of a MatchDecider, collapsing, or a percentage
3909   cutoff, we now only round the scaled estimate once, and we also round it to
3910   the nearest rather than always rounding down.  Hopefully this should
3911   improve the estimate a little in such cases.
3913 * Fix problem on x86 with the top match getting 99% rather than 100% (caused
3914   by excess precision in an intermediate value).
3916 flint backend:
3918 * If Database::reopen() is called and the database revision on disk hasn't
3919   changed, then do as little work as possible.  Even if it has changed, don't
3920   bother to recheck the version file (bug#261).
3922 * xapian-compact:
3924   + Fix check for user metadata key to not match other key types we may add in
3925     the future.  When compacting, we can't assume how we should handle them.
3927   + If the same user metadata key is present in more than one source database
3928     with different tag values, issue a warning and copy an arbitrary tag value.
3930   + Fix potential SEGV when compacting database(s) with user metadata but no
3931     postings.
3933   + In error message, refer to "iamflint" as the "version file", not the
3934     "meta file".
3936 * xapian-inspect:
3938   + Print top-bit-set characters as escaped hex forms as they often won't be
3939     valid UTF-8 sequences.
3941   + If we're passed a database directory rather than a single table, issue a
3942     special error message since this is an obvious mistake for users to make.
3944 * Fix cursor handling for a modified table which has previously only had
3945   sequential updates which usually manifested as zlib errors (bug#259).
3947 quartz backend:
3949 * Fix cursor handling for a modified table which has previously only had
3950   sequential updates which usually manifested as incorrect data being returned
3951   (bug#259).
3953 * Calling skip_to() as the first operation on an all-documents PostingIterator
3954   now works correctly.
3956 remote backend:
3958 * Improve performance of matches with multiple databases at least one of which
3959   is remote, and when the top hit is from a remote database (bug#279).
3961 * When remote protocol version doesn't match, the error message displayed
3962   now shows the minor version number supplied by the server correctly.
3964 * We now wait for the connection to close after sending MSG_SHUTDOWN for a
3965   WritableDatabase, which ensures that changes have been written to disk
3966   and the lock released before the WritableDatabase destructor returns
3967   (as is the case with a local database).
3969 * We no longer ever send MSG_SHUTDOWN for a read-only Database - just closing
3970   the connection is enough (and is protocol compatible).
3972 inmemory backend:
3974 * Fix bug which resulted in the values not being stored correctly when
3975   replacing an existing document, or if there are gaps in the document id
3976   numbering.
3978 build system:
3980 * This release now uses newer versions of the autotools (autoconf 2.61 ->
3981   2.62; automake 1.10 -> 1.10.1; libtool 1.5.24 -> 1.5.26).  The newer
3982   autoconf reportedly results in a faster configure script, and warns about
3983   use of unrecognised configure options.
3985 * Fix configure to recognise --enable-log=profile and fix build problems when
3986   this is enabled.
3988 * "make up" in the "tests" subdirectory now does "make" in the top-level.
3990 * Fix "make distcheck" by using dist-hook to install generated files from
3991   either srcdir or builddir, with the appropriate dependency to generate them
3992   automatically in maintainer mode builds.
3994 documentation:
3996 * intro_ir.html: Improve wording a bit.
3998 * The documentation now links to trac instead of bugzilla.  For links to the
3999   main website, we now prefer xapian.org to www.xapian.org.
4001 * Doxygen-generated API documentation:
4003   + Improved documentation in several places.
4005   + The helper macro XAPIAN_VISIBILITY_DEFAULT no longer appears in the output.
4007   + Header and directory relationship graphs are no longer generated as they
4008     aren't actually informative here.
4010 * HACKING: Numerous updates and improvements.
4012 examples:
4014 * quest: Output get_description() of the parsed query.
4016 portability:
4018 * Fix build with GCC 2.95.3.
4020 * Fix build with GCC 4.3.
4022 * Newer libtool features improved support for Mac OS X Leopard and added
4023   support for AIX 6.1.
4025 debug code:
4027 * Database::get_spelling_suggestion() now debug logs with category APICALL
4028   rather than SPELLING, for consistency with all other API methods.
4030 * Added APICALL logging to a few Database methods which didn't have it.
4032 * Remove debug log tracing from get_description() methods since logging for
4033   other methods calls get_description() methods on parameters, so logging these
4034   calls just makes for more confusing debug logs.  A get_description() method
4035   should have no side-effects so it's not very interesting even when explicitly
4036   called by the user.
4038 Xapian-core 1.0.6 (2008-03-17):
4040 API:
4042 * Add new query operators OP_VALUE_LE and OP_VALUE_GE which perform "single
4043   ended" range checks, and a corresponding new Query constructor.
4045 * Add Unicode::toupper() to complement Unicode::tolower().
4047 * Xapian::Stem has been further optimised - stemtest now runs ~2.5% faster.
4049 testsuite:
4051 * tests/runtest: Fixed to handle test programs with a ".exe" extension.
4053 * tests/queryparsertest: Add a couple more testcases which already work to
4054   improve test coverage.
4056 * tests/apitest: Add caseconvert1 testcase to test Unicode::tolower() and
4057   Unicode::toupper().
4059 flint backend:
4061 * xapian-check: Fix not to report an error for a database containing no
4062   postings but some user metadata.
4064 * Update the base files atomically to avoid problems with reading processes
4065   finding partially written ones.
4067 * Create lazy tables with the correct revision to avoid producing a database
4068   which we later report as "corrupt" (bug#232).
4070 * xapian-compact: Fix compaction for databases which contain user metadata
4071   keys.
4073 quartz backend:
4075 * Update the base files atomically to avoid problems with reading processes
4076   finding partially written ones.
4078 remote backend:
4080 * The addition of OP_VALUE_LE and OP_VALUE_GE required an update to the Query
4081   serialisation, which required a minor remote protocol version bump.
4083 * Fix to actually set the writing half as the connection as non-blocking when
4084   a timeout is specified.  This would have prevented timeouts from operating
4085   correctly in some situations.
4087 build system:
4089 * configure: GCC warning flag overhaul:  Stop passing "-Wno-multichar" since
4090   any multi-character character literal is bound to be a typo (I believe we
4091   were only passing it after misinterpreting its sense!)  Pass
4092   "-Wformat-security", and "-Wconversion" for all GCC versions.  Add
4093   "-Winit-self" and "-Wstrict-overflow=5" for GCC >= 4.2.  The latter might
4094   prove too aggressive, but seems reasonable so far.  Fix some minor niggles
4095   revealed by "-Wconversion" and "-Wstrict-overflow=5".
4097 * Add XAPIAN_NORETURN() annotations to functions and non-virtual methods which
4098   don't return.
4100 documentation:
4102 * docs/intro_ir.html: Briefly mention how pure boolean retrieval is supported.
4104 * docs/valueranges.html: Fix example of using multiple VRPs to come out as a
4105   "program listing".
4107 * include/xapian/queryparser.h: Fix incorrect example in doccomment.
4109 * docs/quickstart.html: Remove information covered by INSTALL since
4110   there's no good reason to repeat it and two copies just risks one
4111   getting out of date (as has happened here!)
4113 * docs/quickstart.html: Fix very out of date reference to MSet::items
4114   (bug#237).
4116 * PLATFORMS: Remove reports for 0.8.x as they're too old to be interesting.
4117   Separate out 0.9.x reports.  Add Solaris 9 and 10 success reports from James
4118   Aylett.  Update from Debian buildd logs.
4120 portability:
4122 * Now builds on OS/2, thanks to a patch by Yuri Dario.
4124 * Fix testsuite to build on mingw (broken by changes in 1.0.5).
4126 debug code:
4128 * Fix --enable-assertions build, broken by changes in 1.0.5.
4130 Xapian-core 1.0.5 (2007-12-21):
4132 API:
4134 * More sophisticated sorting of results is now possible by defining a
4135   functor subclassing Xapian::Sorter (bug#100).
4137 * Xapian::Enquire now provides a public copy constructor and assignment
4138   operator (bug#219).
4140 * Xapian::Document::values_begin() didn't ensure that values had been read
4141   when working on a Document read from a database.  However, values_end() did
4142   (and so did values_count()) so this wasn't generally a problem in practice.
4144 * Xapian::PostingIterator::skip_to() now works correctly when running over
4145   multiple databases.
4147 * Xapian::Database::postlist_begin() no longer adds a "MultiPostList" wrapper
4148   for the common case when there's only one subdatabase.
4150 * Xapian::TradWeight now avoids division by zero in the (rare) situation of the
4151   average document length being zero (which can only happen if all documents
4152   are empty or only have terms with wdf 0).
4154 * Calling Xapian::WritableDatabase methods when we don't have exactly one
4155   subdatabase now throws InvalidOperationError.
4157 testsuite:
4159 * apitest:
4161   + Testcases now describe the conditions they need to run, and are
4162     automatically collated by a Perl script.  This makes it significantly
4163     easier to add a new testcase.
4165   + The test harness's "BackendManager" has been overhauled to allow
4166     cleaner implementations of testcases which are currently hard to
4167     write cleanly, and to make it easier to add new backend settings.
4169   + Add a "multi" backend setting which runs suitable tests over two
4170     subdatabases combined.  There's a corresponding new make target
4171     "check-multi".
4173   + Add more feature tests of document values.
4175   + sortrel1 now runs for inmemory too.
4177   + Add simple feature test for TradWeight being used to run a query.
4179   + Fix spell3 to work on Microsoft Windows (bug#177).
4181   + API classes are now tested to check they have copy constructors and
4182     assignment operators, and also that most have a default constructor.
4184   + quartztest testcases adddoc2 and adddoc3 have been reworked as apitest
4185     testcases adddoc5 and adddoc6, which run for other backends.
4187   + stubdb1 now explicitly creates the database it needs - generally this
4188     bug didn't manifest because an earlier test has already created it.
4190 * queryparsertest: Add feature tests to check that ':' is being inserted
4191   between prefix and term when it should be.
4193 * Fix extracting of valgrind error messages in the test harness.
4195 * tests/valgrind.supp: Add more variants of the zlib suppressions.
4197 matcher:
4199 * Xapian::Enquire: When the "first" parameter to get_mset() is non-zero, avoid
4200   copying all the wanted items after performing the match.
4202 * Fix bug in handling a pure boolean match over more than one database under
4203   set_docid_order(ASCENDING) - we used to exit early which isn't correct.
4205 * When collapsing on a value, give a better lower bound on the number of
4206   matches by keeping track of the number of empty collapse values seen.
4208 * Xapian::BM25Weight: Fix bug when k2 is non-zero: a non-initialised value
4209   influenced the weight calculations.  By default k2 is zero, so this bug
4210   probably won't have affected most users.
4212 * The mechanism used to collate term statistics across multiple databases has
4213   been greatly simplified (bug#45).
4215 flint backend:
4217 * xapian-check:
4219   + Update to handle flint databases produced by Xapian 1.0.3 and later.
4221   + Fix not to go into an infinite loop if certain checks fail.
4223 quartz backend:
4225 * quartzcompact: Fix equality testing of C strings to use strcmp() rather than
4226   '=='!  In practice, using '==' often gives the desired effect due to pooling
4227   of constant strings, but this may have resulted in a bug on some platforms.
4229 remote backend:
4231 * If we're doing a match with only one database which is remote then just
4232   return the unserialised MSet from the remote match.  This requires an
4233   update to the MSet serialisation, which requires a minor remote protocol
4234   version bump.
4236 build system:
4238 * XO_LIB_XAPIAN now hooks LT_INIT as well as AC_PROG_LIBTOOL and
4239   AM_PROG_LIBTOOL.
4241 * Distribute preautoreconf, dir_contents, docs/dir_contents and
4242   tests/dir_contents.
4244 * Fix preautoreconf to correctly handle all the sources passed to doxygen to
4245   create the collated internal source documentation, and to work in a VPATH
4246   build.
4248 documentation:
4250 * sorting.html: New document on the topic of sorting match results.
4252 * HACKING,admin_notes.html,bm25.html,glossary.html,intro_ir.html,overview.html,
4253   quickstart.html,scalability.html,termgenerator,html,synonyms.html: Assorted
4254   minor improvements.
4256 * valueranges.html: State explicitly that Xapian::sortable_serialise() is used
4257   to encode values at index time, and give an example of how it is called.
4259 * API documentation:
4261  + Clarify get_wdf() versus get_termfreq().
4263  + We now use pngcrush to reduce the size of PNG files in the HTML version.
4265  + The HTML version no longer includes various intermediate files which doxygen
4266    generates.
4268  + Hide the v102 namespace from Doxygen as it isn't user visible.
4270  + Stop describing get_description() as an "Introspection method", as this
4271    doesn't help to explain what it does, and get_description() doesn't really
4272    fall under common formal definitions of "introspection".
4274 * index.html: Add a list of documents on particular topics and include links to
4275   previously unlinked-to documents.  Weed down the top navigation bar which had
4276   grown to unwieldy length.
4278 * PLATFORMS: Update for Debian buildds.
4280 * Improve documentation comment for Document::termlist_count().
4282 * admin_notes.html: Note that this document is up-to-date for 1.0.5.
4284 * INSTALL: zlib 1.2.0 apparently fixes a memory leak in deflateInit2(), which
4285   we use, so that's another reason to prefer 1.2.x.
4287 portability:
4289 * Add explicit includes of C headers needed to build with the latest snapshots
4290   of GCC 4.3.  Fix new warnings.
4292 * xapian-config: On platforms which we know don't need explicit dependencies,
4293   --ltlibs now gives the same output as --libs.
4295 * The minimum supported GCC version is now 2.95.3 (rather than 2.95) as 2.95.3
4296   added support for '#include <sstream>' which means we no longer need to
4297   maintain our own version.
4299 * Fix build with SGI's compiler on IRIX.
4301 * Fix or suppress some MSVC warnings.
4303 debug code:
4305 * Remove incorrect assertion in MultiAndPostList (bug#209).
4307 * Fix build when configured with "--enable-log --disable-assertions".
4309 Xapian-core 1.0.4 (2007-10-30):
4311 API:
4313 * Query:
4315   + Add OP_SCALE_WEIGHT operator (and a corresponding constructor which
4316     takes a single subquery and a parameter of type "double").  This
4317     multiplies the weights from the subquery by the parameter, allowing
4318     adjustment of the importance of parts of the query tree.
4320   + Deprecate the essentially useless constructor Query(Query::op, Query).
4322 * QueryParser:
4324   + A field prefix can now be set to expand to more than one term prefix.
4325     Similarly, multiple term prefixes can now be applied by default.  This is
4326     done by calling QueryParser::add_boolean_prefix() or
4327     QueryParser::add_prefix() more than once with the same field name but a
4328     different term prefix (previously subsequent calls with the same field name
4329     had no effect).
4331   + Trying to set the same field as probabilistic and boolean now throws
4332     InvalidOperationError.
4334   + Fix parsing of `term1 site:example.org term2', broken by changes in 1.0.2.
4336   + Drop special treatment for unmatched ')' at the start of the query, as it
4337     seems rather arbitrary and not particularly useful and was causing us to
4338     parse `(site:example.org) -term' incorrectly.
4340   + The QueryParser now generates pure boolean Query objects for strings such
4341     as `site:example.org' by applying OP_SCALE_WEIGHT with a factor of 0.0.
4343   + Fix handling of `"quoted phrase" +term' and `"quoted phrase" -term'.
4345   + Fix handling of `site:example.org -term'.
4347   + Fix problem with spelling correction of hyphenated terms (or other terms
4348     joined with phrase generators): the position of the start of the term
4349     wasn't being reset for the second term in the generated phrase, resulting
4350     in out of bounds errors when substituting the new value in the corrected
4351     query string.
4353   + The parser stack is now a std::vector<> rather than a fixed size, so it
4354     will typically use less memory, and can't hit the fixed limit.
4356   + Fix handling of STEM_ALL and update the documentation comment for
4357     QueryParser::set_stemming_strategy() to explain how it works clearly.
4359 * PostingIterator: positionlist_begin() and get_wdf() should now always
4360   throw InvalidOperationError where they aren't meaningful (before in some
4361   cases UnimplementedError was thrown).
4363 testsuite:
4365 * Add tests for new features.
4367 * Add another valgrind suppression for a slightly different error from zlib
4368   in Ubuntu gutsy.
4370 * Remove quartztest's test_postlist1 and test_postlist2, replacing the coverage
4371   lost by extending and adding tests which work with other backends as well.
4373 * If a test throws a subclass of std::exception, the test harness now
4374   reports the class name and the extra information returned by std::exception's
4375   what() method.
4377 matcher:
4379 * Several performance improvements have been made, mainly to the handling
4380   of OP_AND and related operations (OP_FILTER, OP_NEAR, and OP_PHRASE).
4381   In combination, these are likely to speed up searching significantly
4382   for most users - in tests on real world data we've seen savings of 15-55%
4383   in search times).  These improvements are:
4385   + OP_AND of 3 or more sub-queries is now processed more efficiently.
4387   + Sub-queries from adjacent OP_AND, OP_FILTER, OP_NEAR, and OP_PHRASE are now
4388     combined into a single multi-way OP_AND operation, and the filters which
4389     implement the near/phrase restrictions are hoisted above this so they need
4390     to check fewer documents (bug#23).
4392   + If an OP_OR or OP_AND_MAYBE decays to OP_AND, we now ensure that the less
4393     frequent sub-query is on the left, which OP_AND is optimised to expect.
4395 * When the Enquire::get_mset() parameter checkatleast is set, and we're sorting
4396   by relevance with forward ordering by docid, and the query is pure boolean,
4397   the matcher was deciding it was done before the checkatleast requirement was
4398   satisfied.  Then the adjustments made to the estimated and max statistics
4399   based on checkatleast meant the results claimed there were exactly msize
4400   results.  This bug has now been fixed.
4402 * Queries involving an OP_VALUE_RANGE filter now run around 3.5 times faster
4403   (bug#164).
4405 * The calculations behind MSet::get_matches_estimated() were always rounding
4406   down fractions, but now round to the nearest integer.  Due to cumulative
4407   rounding, this could mean that the estimate is now a few documents higher in
4408   some cases (and hopefully a better estimate).
4410 * Implement explicit swap() methods for internal classes MSetItem and ESetItem
4411   which should make the final sort of the MSet and ESet a little more
4412   efficient.
4414 flint backend:
4416 * Fixed a bug introduced in 1.0.3 - trying to open a flint database for reading
4417   no longer fails if it isn't writable.
4419 * We no longer use member function pointers in the Btree implementation which
4420   seems to speed up searching a little.
4422 remote backend:
4424 * The remote protocol minor version has been increased (to accommodate
4425   OP_SCALE_WEIGHT).  If you are upgrading a live system which uses the
4426   remote backend, upgrade the servers before the clients.
4428 build system:
4430 * Added macro machinery to allow branch prediction hints to be specified and
4431   used by compilers which support this (current GCC and Intel C++).
4433 * In a developer build, look for rst2html.py if rst2html isn't found as some
4434   Linux distros have it installed under with an extension.
4436 documentation:
4438 * In the API documentation, explicitly note that Database::get_metadata()
4439   returns an empty string when the backend doesn't support user-specified
4440   metadata, and that WritableDatabase::set_metadata() throws UnimplementedError
4441   in this case.  Also describe the current behaviour with multidatabases.
4443 * README: Remove the ancient history lesson - this material is better left to
4444   the history page on the website.
4446 * deprecation.html:
4448   + Deprecate the non-pythonic iterators in favour of the pythonic ones.
4450   + Move "Stem::stem_word(word)" in the bindings to the right section (it was
4451     done in 1.0.0, as already indicated).
4453   + Improve formatting.
4455 * When running rst2html, using "--verbose" was causing "info" messages to be
4456   included in the HTML output, so drop this option and really fix this issue
4457   (which was thought to have been fixed by changes in 1.0.3).
4459 * install.html: Reworked - this document now concentrates on giving
4460   a brief overview of building which should be suitable for most common cases,
4461   and defers to the INSTALL document in each tarball for more details.
4463 * PLATFORMS: Update from tinderbox and buildbot.
4465 * remote.html: xapian-tcpsrv has been able to handle concurrent read
4466   access since 0.3.1 (7 years ago) so update the very out-of-date information
4467   here.  Also, note that some newer features aren't supported by the remote
4468   backend yet.
4470 * HACKING: Note specifically that std::list::size() is O(n) for GCC.
4472 * intro_ir.html: Add link to the forthcoming book "Introduction to
4473   Information Retrieval", which can be read online.
4475 * scalability.html: Update size of gmane.
4477 * quartzdesign.html: Note that Quartz is now deprecated.
4479 debug code:
4481 * The debug assertion code has been rewritten from scratch to be cleaner and
4482   pull in fewer other headers.
4484 Xapian-core 1.0.3 (2007-09-28):
4486 API:
4488 * Add support for user specified metadata (bug#143).  Currently supported by
4489   the flint and inmemory backends.
4491 * Deprecate Enquire::register_match_decider() which has always been a no-op.
4493 * Improve the lower bound on the number of matching documents for an AND query
4494   - if the sum of the lower bounds for the two sides is greater than the
4495   number of documents in the database, then some of them must have both terms.
4497 * Spelling correction: Fix off-by-one error in loop bounds when initialising
4498   (bug#194).
4500 * If the check_at_least parameter to Enquire::get_mset() is used, but there
4501   aren't that many results, then MSet::get_matches_lower_bound() and
4502   MSet::get_matches_upper_bound() weren't always reported as equal - this
4503   bug is now fixed.
4505 * When sorting by value, and using the check_at_least parameter to
4506   Enquire::get_mset(), some potential matches weren't being counted.
4508 * Failing to create a flint or quartz database because we couldn't create the
4509   directory for it now throws DatabaseCreateError not DatabaseOpeningError.
4511 testsuite:
4513 * Fix display of valgrind output when a test fails because valgrind detected
4514   a problem.
4516 * Add another version of valgrind suppression for the zlib end condition check
4517   as this gives a different backtrace for zlib in Ubuntu gutsy.
4519 flint backend:
4521 * The Flint database format has been extended to support user metadata, and
4522   each termlist entry is now a byte shorter (before compression).  As a
4523   result, Xapian 1.0.2 and earlier won't be able to read Xapian 1.0.3
4524   databases.  However, Xapian 1.0.3 can read older databases.  If you open an
4525   older flint database for writing with Xapian 1.0.3, it will be upgraded
4526   such that it cannot then be read by Xapian 1.0.2 and earlier.
4528 * Zlib compression wasn't being used for the spelling or synonym tables (due
4529   to a typo - Z_DEFAULT_COMPRESSION where it should be Z_DEFAULT_STRATEGY).
4531 * xapian-check: Allow "db/record." and "db/record.DB" as arguments.
4533 * Fix "key too long" exception message by substituting FLINT_BTREE_MAX_KEY_LEN
4534   with its numeric value.
4536 * Assorted minor efficiency improvements.
4538 * If we reach the flush threshold during a transaction, we now write out the
4539   postlist changes, but don't actually commit them.
4541 * Check length of new terms is at most 245 bytes for flint in add_document()
4542   and replace_document() so that the API user gets an error there rather
4543   than when flush() is called (explicitly or implicitly).  Fixes bug#44.
4545 * Flint used to read the value of the environmental variable
4546   XAPIAN_FLUSH_THRESHOLD when the first WritableDatabase was opened and would
4547   then cache this value.  However the program using Xapian may have changed
4548   it, so we now reread it each time a WritableDatabase is opened.
4550 * Implement TermIterator::positionlist_count() for the flint backend.
4552 remote backend:
4554 * Fix the result of MSet::get_matches_lower_bound() when using the
4555   check_at_least parameter to get_mset().
4557 inmemory backend:
4559 * Implement TermIterator::positionlist_count() for the inmemory backend.
4561 build system:
4563 * xapian-config: We always need to include dependency_libs in the output of
4564   `xapian-config --libs` if shared libraries are disabled.
4566 * Distribution tarballs are now in the POSIX "ustar" format.  This supports
4567   pathnames longer than 99 characters (which we now have a few instances of
4568   in the doxygen generated documentation) and also results in a distribution
4569   tarball that is about half the size!  This format should be readable by any
4570   tar program in current use - if your tar program doesn't support it, we'd
4571   like to know (but note that the GNU tar tarball is smaller than the size
4572   reduction in the xapian-core tarball...)
4574 * configure no longer generates msvc/version.h - this is now entirely handled
4575   by the MSVC-specific makefiles.
4577 documentation:
4579 * Add a glossary.
4581 * docs/stemming.html: Reorder the initial paragraphs so we actually answer the
4582   question "What is a stemming algorithm?" up front.
4584 * When running rst2html, use "--exit-status=warning" rather than "--strict".
4585   The former actually gives a non-zero exit status for a warning or worse,
4586   while the former doesn't, but does include any "info" messages in the output
4587   HTML.
4589 * docs/deprecation.rst: Add "Database::positionlist_begin() throwing
4590   RangeError and DocNotFoundError".
4592 * valueranges.rst: Correct out-of-date reference to float_to_string.
4594 * HACKING: Document a few more "coding standards".
4596 * PLATFORMS: Updated.
4598 * docs/overview.html: Restore HTML header accidentally deleted in November
4599   2006.
4601 * Fix several typos.
4603 portability:
4605 * Add missing instances of "#include <string.h>" to fix compilation with recent
4606   GCC 4.3 snapshots.
4608 * Fix some warnings for various compilers and platforms.
4610 Xapian-core 1.0.2 (2007-07-05):
4612 API:
4614 * Xapian now offers spelling correction, based on a dynamically maintained
4615   list of spelling "target" words.  This is currently supported by the
4616   flint backend, and works when searching multiple databases.
4618 * Xapian now offers search-time synonym expansion, based on an externally
4619   provided synonym dictionary.  This is currently supported by the flint
4620   backend, and works when searching multiple databases.
4622 * TermGenerator: now offers support for generating spelling correction
4623   data.
4625 * QueryParser:
4627   + New flag FLAG_SPELLING_CORRECTION to enable spelling correction, and a new
4628     method, "get_corrected_query_string()" to get the spelling corrected
4629     query string.
4631   + New flags have been added to allow the new synonym expansion feature to be
4632     enabled and controlled.  Synonym expansion can either be automatic, or only
4633     for terms explicitly indicated in the query string by the new "~" operator.
4635   + The precedence of the boolean operators has been adjusted to match their
4636     usual precedence in mathematics and programming languages.  "NOT" now binds
4637     as tightly as "AND" (previously "AND NOT" would bind like "AND", but just
4638     "NOT" would bind like "OR"!)  Also "XOR" now binds more tightly than "OR",
4639     but less tightly than "AND" (previously it bound just like "OR").
4641   + '+' and '-' have been fixed to work on bracketed subexpressions as
4642     documented.
4644   + If the stemmer is "none", no longer put a Z prefix on terms; this now
4645     matches the output of TermGenerator.
4647 * Add new Xapian::sortable_serialise() and Xapian::sortable_unserialise()
4648   functions which serialise and unserialise numbers (currently only
4649   doubles) to a string representation which sorts in numeric order.  Small
4650   integers have a short representation.
4652 * NumberValueRangeProcessor has been changed to work usefully.  Previously
4653   the numbers had to be the same length; now numbers are serialised to
4654   strings such that a string sort on the string orders the numbers correctly.
4655   Negative and floating point numbers are also supported now.  The old
4656   NumberValueRangeProcessor is still present in the library to preserve
4657   ABI compatibility, but code linking against 1.0.2 or later will pick
4658   up the new implementation, which really lives in a sub-namespace.
4660 * Documents now have a get_docid() method, to get the document ID from the
4661   database they came from.
4663 * Add support for a new type of match decider, called a "matchspy".  Unlike
4664   the old deciders, this will reliably be tested on every candidate
4665   document, so can be used to tally statistics on them.
4667 * Fixed a segfault when getting a description for a MatchNothing query
4668   joined with AND_NOT (bug #176).
4670 * Header files have been tidied up to remove some unnecessary includes.
4671   Applications using "#include <xapian.h>" will not be affected.  We don't
4672   intend to support direct inclusion of individual header files from the xapian
4673   directory, but if you do that, you may have to update you code.
4675 testsuite:
4677 * Feature tests added for all new features.
4679 * Improved test coverage in queryparsertest.  Some tests in queryparsertest
4680   now use flint databases, so the test now ensures that the .flint
4681   subdirectory exists.
4683 * The test harness no longer creates <dbdir>/log for flint (flint doesn't
4684   create a log like quartz does).
4686 * apitest: "-bremote" must now be "-bremoteprog" (to better match
4687   "-bremotetcp"); "-bvoid" must now be "-bnone" (to better describe not
4688   using a database backend).
4690 * To complement "make check-flint", "make check-quartz", and "make
4691   check-remote", you can now run tests for the remotetcp backend with
4692   "make check-remotetcp", for the remoteprog backend with "make
4693   check-remoteprog", for the inmemory backend with "make check-inmemory", and
4694   tests not requiring a backend with "make check-none".
4696 * Several extra tests of the check_at_least parameter supplied to
4697   get_mset() were added.
4699 * Fix memory leak and fd leak in remotetcp handling, so apitest now passes
4700   under valgrind.
4702 * quartztest: no longer test QuartzPostList::get_collection_freq(), which
4703   has been removed.
4705 * Add regression test emptyquery2 for bug #176.
4707 * Add regression test matchall1 for bug with MatchAll queries.
4709 * Enhanced test coverage of match functor, to check that it returns all
4710   matching documents.
4712 matcher:
4714 * Fix bug when check_at_least was supplied - the matches after the
4715   requested MSet size were being returned to the user.  The parameter is
4716   also now handled in a more efficient way - no extra memory is required
4717   (previously, extra memory proportional to the value of check_at_least was
4718   required).
4720 * Fix bug which used incorrect statistics, and caused assertion failures,
4721   when performing a search using a MatchAll query.
4723 * Optimisation for single term queries: we don't need to look at the top
4724   document's termlist to determine that it matches all the query terms.
4726 flint backend:
4728 * The value and position tables are now only created if there is anything to
4729   add to them.  So if you never use document values, there's no value.DB,
4730   value.baseA, or value.baseB.  This means the table doesn't need to be opened
4731   for searching (saving a file handle and a number of syscalls) and when
4732   flushing changes, we don't need to update baseA/baseB just to keep the
4733   revisions in step.  The flint database version has been increased, but the
4734   new code will happily open and read/update flint databases from Xapian 1.0.0
4735   and 1.0.1.  Xapian 1.0.2 flint databases can't be read by Xapian 1.0.1 or
4736   earlier though.
4738 * Two new optional tables are now supported: "spelling", which is used to
4739   store information for spelling correction, and "synonym", which is used
4740   to store synonym information.
4742 * xapian-compact: Now compacts and merges spelling and synonym tables.
4743   Also has a new option "--no-renumber" to preserve document ids from
4744   source databases.
4746 * xapian-check: Now checks the spelling and synonym tables (only the Btree
4747   structure is currently checked, not the information inside).
4749 * Database::term_exists(), Database::get_termfreq(), and
4750   Database::get_collection_freq() are now slightly more efficient for flint
4751   databases.
4753 * New utility 'xapian-inspect' which allowing interactive inspection of key/tag
4754   pairs in a flint Btree.  Useful for development and debugging, and an
4755   approximate equivalent to quartzdump.
4757 * WritableDatabase::delete_document() no longer cancels pending changes if the
4758   document doesn't exist.
4760 * Fix handling of exceptions during commit - previously, this could result
4761   in tables getting out-of-sync, perhaps even resulting in a corrupt database.
4763 * Optimise iteration of all documents in the case where all the document
4764   IDs up to lastdocid are used; in this case, we no longer need to access disk
4765   to get the document IDs.
4767 quartz backend:
4769 * WritableDatabase::delete_document() no longer cancels pending changes if the
4770   document doesn't exist.
4772 * We no longer create a postlist just to find the termfreq or collection
4773   frequency.
4775 remote backend:
4777 * Calling WritableDatabase::delete_document() on a non-existent document now
4778   correctly propagates DocNotFoundError.
4780 * The minor remote protocol version has increased (to fix the previous issue).
4781   You should be able to cleanly upgrade a live system by upgrading servers
4782   first and then clients.
4784 * progclient: Reopen stderr on the child process to /dev/null rather than
4785   closing it.  This fixes apitest with the remoteprog backend to pass when run
4786   under valgrind (it failed in this case in 1.0.0 and 1.0.1).  It probably
4787   has no effect otherwise.
4789 * check_at_least is now passed to the remote server to reduce the work
4790   needed to produce the match, and the serialised size of the returned MSet.
4792 inmemory backend:
4794 * Bug fix: using replace_document() to add a document with a specific
4795   document id above the highest currently used would create empty documents
4796   for all document ids in between.
4798 build system:
4800 * Work around an apparent bug in automake which causes the entries in .libs
4801   subdirectories generated for targets of bin_PROGRAMS not to be removed on
4802   make clean.  This was causing make distcheck to fail.
4804 * Snapshots and releases are now bootstrapped with automake 1.10, and
4805   libtool 1.5.24.
4807 * HTML documentation generated from RST files is now installed.
4809 documentation:
4811 * The API documentation is now generated with Doxygen 1.5.2, which fixes the
4812   missing docs for Xapian::Query.
4814 * Ship and install internals.html.
4816 * Generating the doxygen-collated documentation of the library internals (with
4817   "make doxygen_source_docs") now only tries to generate an HTML version.  The
4818   PDF version kept exceeding TeX limits, and HTML is a more useful format for
4819   this anyway.
4821 * API docs for Xapian::QueryParser now make it clear that the default value for
4822   the stemming strategy is STEM_NONE.
4824 * API docs now describe the NumberValueRangeProcessor more clearly.
4826 * Several typo fixes and assorted wording improvements.
4828 * queryparser.html: Mention "AND NOT" as an alternative way to write "NOT",
4829   and document synonym expansion.
4831 * admin_notes.html: Updated for changes in this release, and corrected a
4832   few minor errors.
4834 * spelling.rst: New file, documenting the spelling correction feature.
4836 * synonyms.rst: New file, documenting the synonyms expansion feature.
4838 * valueranges.rst: The NumberValueRangeProcessor is now documented.
4840 * HACKING: Mention new libtool, and more details about preferring
4841   pre-increment.  Also add a note about 2 space indentation of protection
4842   level declarations in classes.
4844 * INSTALL: note that zlib must be installed before you can build.
4846 examples:
4848 * copydatabase: Now copies synonym and spelling data.  Also, fix a cosmetic
4849   bug with progress output when a specified database directory has a trailing
4850   slash.
4852 portability:
4854 * Fix to build on with OpenBSD's zlib (xapian-core 1.0.0 and 1.0.1 didn't).
4856 * Fixed to build with older zlib such as zlib 1.1.5 which Solaris apparently
4857   uses (xapian-core 1.0.0 and 1.0.1 didn't).  However, we recommend using zlib
4858   1.2.x as decompressing is apparently about 20% faster.
4860 * msvc/version.h.in: Generated version.h for MSVC build no longer has the
4861   remote backend marked as disabled.
4863 * Fix warnings from Intel's C++ compiler.
4865 * Fixes for compilation with gcc-2.95 and GCC 4.3 snapshots.
4867 packaging:
4869 * RPMs:
4871   + Rename xapian.spec to xapian-core.spec to match tarball name.
4873   + Append the user name to BuildRoot.
4875 debug code:
4877 * Better debug logging from the queryparser internals.
4879 Xapian-core 1.0.1 (2007-06-11):
4881 API:
4883 * Xapian::Error:
4885   + Make Error::error_string member std::string rather than char * to avoid
4886     problems with double free() with copied Error objects.  Unfortunately
4887     this mean an incompatible ABI change which we had hoped to avoid until
4888     1.1.0, but in this case there didn't seem to be a sane way to fix the
4889     problem without an ABI change.
4891   + Error::get_description() now converts my_errno to error_string if it hasn't
4892     been already rather than not including any error description in this case.
4894   + Add new method "get_description()" to get a string describing the error
4895     object.  This is used in various examples and scripts, improving their
4896     error reporting.
4898 * Xapian::Database: Add new form of allterms_begin() and allterms_end()
4899   which allow iterating of all terms with a particular prefix.  This
4900   is easier to use than checking the end condition yourself, and is
4901   more efficiently implemented for the remote backend (fixes bug#153).
4903 * Xapian::Enquire: Passing an uninitialised Database object to Enquire will
4904   now cause InvalidArgumentError to be thrown, rather than causing a segfault
4905   when you call Enquire::get_mset().  If you really want an empty database,
4906   you can use Xapian::InMemory::open() to create one.
4908 * Xapian::QueryParser: Multiple boolean prefixed terms with the same term
4909   prefix are now combined with OR before such groups are combined with AND
4910   (bug#157).  Multiple value ranges on the same value are handled similarly.
4912 * Xapian::Query OP_VALUE_RANGE: Avoid calling db->get_lastdocid() repeatedly
4913   as we know the answer won't change - this reduces the run time of a
4914   particular test case by 25%.
4916 testsuite:
4918 * Add test for serialisation of error strings.
4920 * Improved output in various situations:
4922   + Quote strings in TEST_STRINGS_EQUAL().
4924   + queryparsertest: Use TEST_STRINGS_EQUAL when comparing query descriptions
4925     against their expected output, since this makes it much easier to see the
4926     differences.
4928   + Report whole message for exceptions, rather than a truncated version, in
4929     verbose mode.
4931   + Make use of Xapian::Error::get_description(), giving better error
4932     reports.
4934 * queryparsertest: New test of custom ValueRangeProcessor subclass
4935   (qp_value_customrange1).
4937 * apitest: flintdatabaseformaterror1 and flintdatabaseformaterror2 now use a
4938   genuine Xapian 0.9.9 flint database for their tests, and more cases are
4939   tested.  The two tests have also been split into 3 now.
4941 * Fix test harness not to invoke undefined behaviour in cases where a paragraph
4942   of test data contains two or fewer characters.
4944 * Implement a better fix for the MSVC ifstream issue which was fixed in 1.0.0.
4945   This fixes an unintentional side-effect of the previous fix which meant that
4946   apitest's consistency1 wasn't working as intended (it now has a regression
4947   test to make sure it is testing what we intend).
4949 flint backend:
4951 * xapian-compact: Don't uncompress and recompress tags when compacting a
4952   database.  This speeds up xapian-compact rather a lot (by more than 50% in a
4953   quick test).
4955 * If the docid counter wraps, Flint now throws DatabaseError (fixes bug#152).
4957 * Remove the special case error message for pre-0.6 databases since they'll
4958   be quartz format (the check is only in flint because this code was taken from
4959   quartz).
4961 quartz backend:
4963 * If the docid counter wraps, Quartz now throws DatabaseError (fixes bug#152).
4965 remote backend:
4967 * The remote protocol now has a minor version number.  If the major
4968   version number is the same, a client can work with any server with
4969   the same or higher minor version number, which makes upgrading live
4970   systems easier for most remote protocol changes - just upgrade the servers
4971   first.
4973 * When a read-only remote database is closed, the client no longer sends a
4974   (totally bogus) MSG_FLUSH to the server, and the reply is also eliminated.
4975   This reduces the time taken to close a remote database a little (fixes
4976   bug#149).
4978 inmemory backend:
4980 * skip_to() on an allterms TermIterator from an InMemory Database can no longer
4981   move backwards.
4983 * An allterms TermIterator now initialises lazily, which can save some work if
4984   the first operation is a skip_to() (as it often will be).
4986 build system:
4988 * Fix VPATH compilation in maintainer mode with gcc-2.95.
4990 * Fix multiple target rule for generating the queryparser source files in
4991   parallel builds.
4993 * Distribute missing stub Makefiles for "bin", "examples", and
4994   "include/xapian".
4996 documentation:
4998 * Document the design flaw with NumberValueRangeProcessor and why it shouldn't
4999   be used.
5001 * ValueRangeProcessor and subclasses now have API documentation and an overview
5002   document.
5004 * Expand documentation of value range Query constructor.
5006 * Improved API documentation for the TermGenerator class.
5008 * docs/deprecation.rst:
5010   + Fix copy and paste error - set_sort_forward() should be changed to
5011     set_docid_order().
5013   + Improve entry for QueryParserError.
5015 * PLATFORMS: Updated from tinderbox.
5017 examples:
5019 * copydatabase: Rewritten to use the ability to iterate over all the documents
5020   in a database.  Should be much more efficient for databases with sparsely
5021   distributed document IDs.
5023 * simpleindex: Rewritten to use the TermGenerator class, which eliminates a
5024   lot of non-Xapian related code and is more typical of what a user is likely
5025   to want to do.
5027 * simplesearch,simpleexpand: Rewritten to use the QueryParser class, which
5028   is more typical of what a user is likely to want to do.
5030 portability:
5032 * xapian-config: Add special case check for host_os matching linux* or
5033   k*bsd-gnu since vanilla libtool doesn't correctly probe link_all_deplibs=no
5034   for them.
5036 packaging:
5038 * RPMs: Add "# norootforbuild" comment which SuSE's build scripts look for.
5039   Rename "Source0:" to "Source:" as there's only one tarball now.  Add gcc-c++
5040   and zlib-devel to "Build-Requires:".
5042 * The required automake version has been lowered to 1.8.3, so RPMs can now be
5043   built on RHEL 4 and SLES 9.
5045 Xapian-core 1.0.0 (2007-05-17):
5047 API:
5049 * Xapian::Database:
5051   + The Database(const std::string &) constructor has been marked as "explicit".
5052     Hopefully this won't affect real code, but it's possible.  Instead of
5053     passing a std::string where a Xapian::Database is expected, you'll now
5054     have to explicitly write `Xapian::Database(path)' instead of `path'.
5056   + Fixed problem when calling skip_to() on an allterms iterator over multiple
5057     databases which could cause a debug assertion in debug builds, and possible
5058     misbehaviour in normal builds.
5060 * Xapian::Error:
5062   + The constructors of Error subclasses which take a `const std::string &'
5063     parameter are now explicit.  This is very unlikely to affect any real code
5064     but if it does, just write `Xapian::Error(msg)' instead of `msg'.
5066   + Xapian::Error::get_type() now returns const char* rather than std::string.
5067     Generally existing code will just work (only one change was required in
5068     Xapian itself) - the simplest change is to write `std::string(e.get_type())'
5069     instead of `e.get_type()'.
5071   + Previously, the errno value was lost when an error was propagated from
5072     a remote server to the client, because errno values aren't portable
5073     between platforms.  To fix this, Error::get_errno() is now deprecated and
5074     you should use Error::get_error_string() instead, which returns a string
5075     expanded from the errno value (or other system error code).
5077 * Xapian::QueryParser:
5079   + Now assumes input text is encoded as UTF-8.
5081   + We've made several changes to term generation strategy.  Most notably:
5082     Unicode support has been added; '_' now counts as a word character; numbers
5083     and version numbers are now parsed as a single term; single apostrophes are
5084     now included in a term; we now store unstemmed forms of all terms; and we
5085     no longer try to "normalise" accents.
5087   + parse_query() now throws the new Xapian::Error subclass QueryParserError
5088     instead of throwing const char * (bug#101).
5090   + Pure NOT queries are now supported (for example, `NOT apples' will match
5091     all documents not indexed by the stemmed form of `apples').  You need
5092     to enable this feature by passing QueryParser::FLAG_PURE_NOT in flags
5093     to QueryParser::parse_query().
5095   + We now clear the stoplist when we parse a new query.
5097   + Queries such as `+foo* bar', where no terms in the database match the
5098     wildcard `foo*', now match no documents, even if `bar' exists.  Handling
5099     of `-foo*' has also been fixed.
5101   + Now supports wildcarding the last term of a query to provide better support
5102     for incremental searching.  Enabled by QueryParser::FLAG_PARTIAL.
5104   + The default prefix can now be specified to parse_query() to allow parsing
5105     of text entry boxes for particular fields.
5107   + QueryParser::set_stemming_options() has been deprecated since 0.9.0 and
5108     has now been removed.
5110 * Xapian::Stem:
5112   + Now assumes input text is encoded as UTF-8.
5114   + We've updated to the latest version of the Snowball stemmers.  This means
5115     that a small number of words produce different (and generally better)
5116     stems and that some new stemmers are supported: german2 (like german but
5117     normalises umlauts), hungarian, kraaij_pohlmann (a different Dutch
5118     stemmer), romanian, and turkish.
5120 * Xapian::TermGenerator:
5122   + New class which generates terms from a piece of text.
5124 * Xapian::Enquire:
5126   + The Enquire(const Database &) constructor has been marked as "explicit".
5127     This probably won't affect real code - certainly no Xapian API methods
5128     or functions take an Enquire object as a parameter - but calls to user
5129     methods or functions taking an Enquire object could be affected.  In
5130     such cases, you'll now have to explicitly write `Xapian::Enquire(db)'
5131     instead of `db'.
5133   + Enquire::get_eset() now produces better results when used with multiple
5134     databases - without USE_EXACT_TERMFREQ they should be much more similar to
5135     results from an equivalent single database; with USE_EXACT_TERMFREQ they
5136     should be identical.
5138   + Track the minimum weight required to be considered for the MSet separately
5139     from the minimum item which could be considered.  Trying to combine the two
5140     caused several subtle bugs (bug#86).
5142   + Enquire::get_query() is now `const'.  Should have no effect on user code.
5144   + Enquire::get_mset() now handles the common case of an "exact" phrase search
5145     (where the window size is equal to the number of terms) specially.
5147   + Enquire::include_query_terms and Enquire::use_exact_termfreq are now
5148     deprecated in favour of capitalised versions Enquire::INCLUDE_QUERY_TERMS
5149     and Enquire::USE_EXACT_TERMFREQ (for consistency with our other manifest
5150     constants, and general C/C++ conventions).
5152 * Xapian::RSet:
5154   + RSet::contains(MSetIterator) is now `const'.  Should have no effect on user
5155     code.
5157 * Xapian::SimpleStopper::add() now takes `const std::string &' not `const
5158   std::string'.  Should have no effect on user code.
5160 * Xapian::Query:
5162   + We now only perform internal validation on a Query object when it's either
5163     constructed or changed, to avoid O(n^2) behaviour in some cases.
5165   + Xapian::Query::MatchAll (an alias for Query("")) matches all terms in the
5166     document (useful for "pure NOT" queries) and Xapian::Query:MatchNothing
5167     is now a more memorable alias for Query().
5169 * Instead of explicitly checking that a term exists before opening its
5170   postlist, we now do both in one operation, which is more efficient.
5172 * MatchDecider::operator() now returns `bool' not `int'.
5174 * ExpandDecider::operator() now returns `bool' not `int'.
5176 * Xapian::TermIterator::get_termfreq() now throws InvalidOperationError
5177   if called on a TermIterator from a freshly created Document (since
5178   there's no meaningful term frequency as there's no Database for
5179   context).
5181 * <xapian/output.h> is no longer available as an externally visible header.
5182   It's not been included by <xapian.h> since 0.7.0.  Instead of using
5183   `cout << obj;' use `cout << obj.get_description();'.
5185 * New constant Xapian::BAD_VALUENO which is -1 cast to Xapian::valueno.
5187 * New Xapian::ValueRangeProcessor hierarchy: DateValueRangeProcessor,
5188   NumberValueRangeProcessor, and StringValueRangeProcessor.  In
5189   conjunction with the new QueryParser::add_valuerangeprocessor()
5190   method and the new Query::OP_VALUE_RANGE op these allow you to
5191   implement ranges in the query parser, such as `$50..100',
5192   `10..20kg', `01/02/2007..03/04/2007'.
5194 testsuite:
5196 * Many new and improved testcases in various areas.
5198 * If a test throws an unknown exception, say so in the test failure message.
5199   If it throws std::string, report the first 40 characters (or first line if
5200   less than 40 characters) of the string even in non-verbose mode.
5202 * Use of valgrind improved:
5204   + The test harness now only hooks into valgrind if environment variable
5205     XAPIAN_TESTSUITE_VALGRIND is set, which makes it easy to run test programs
5206     under valgrind in the normal way.  The runtest script sets this
5207     automatically.
5209   + runtest now passes "--leak-resolution=high" to valgrind to prevent
5210     unrelated leak reports related to STL classes from being combined.
5212   + configure tests for valgrind improved and streamlined.
5214   + New runsrv script to run xapian-tcpsrv and xapian-progsrv.  We need to
5215     run these under valgrind to avoid issues with excess numerical precision
5216     in valgrind's FP handling, but we can use "--tool=none" which is a lot
5217     faster than running them under valgrind's default memcheck tool.
5219 * The test harness now starts xapian-tcpsrv in a more reliable way - it will
5220   try sequentially higher port numbers, rather than failing because a
5221   xapian-tcpsrv (or something else) is already using the default port.
5222   It also no longer leaks file descriptors (which was causing later tests
5223   to fail on some platforms), and if xapian-tcpsrv fails to start, the error
5224   message is now reported.
5226 * remotetest has been removed and its testcases have either been added to
5227   apitest or just removed if redundant with tests already in apitest.
5229 * termgentest is a new test program which tests the Xapian::TermGenerator
5230   class.
5232 * TEST_EQUAL_DOUBLE() now uses a slightly less stringent threshold -
5233   DBL_EPSILON is too strict for calculations which include multiple
5234   steps.  Also, we now use it instead of doubles_are_equal_enough() and
5235   weights_are_equal_enough() which try to perform the same job.
5237 * New macro TEST_STRINGS_EQUAL() which displays the strings on separate lines
5238   so the differences can be clearly seen.
5240 * Test programs are now linked with '-no-install' which means that libtool
5241   doesn't need to generate shell script wrappers for them on most platforms.
5243 * runtest: Now turns on MALLOC_CHECK_ and MALLOC_PERTURB_ for glibc if
5244   valgrind isn't being used.
5246 * Better support for Microsoft Windows:
5248   + test_emptyterm2 no longer tries to delete a database from disk while a
5249     WritableDatabase object still exists for it, since this isn't supported
5250     under Microsoft Windows.
5252   + Fallback handling when srcdir isn't specified how takes into account .exe
5253     extensions and different path separators.
5255 flint backend:
5257 * Flint is now the default backend.
5259 * xapian-check: New program which performs consistency checks on a flint
5260   database or table.
5262 * xapian-compact: Now prunes unused docids off the start of each source
5263   database's range of docids.
5265 * Positional information is now encoded using a highly optimised fls()
5266   implementation, which is much faster than the FP code 0.9.x used.
5267   Unfortunately the old encoding could occasionally add extra bits
5268   on some architectures, which was harmless except the databases
5269   wouldn't be portable.  Because of this, the flint format has had to
5270   be changed incompatibly.
5272 * The lock file is now called "flintlock" rather than "flicklock" (which
5273   was a typo!)
5275 * Flint now releases its lock correctly if there's an error in
5276   WritableDatabase's constructor.  Previously the lock would remain until
5277   the process exited.
5279 * Flint now throws new Xapian::Error subclass DatabaseVersionError instead of
5280   DatabaseOpeningError when it fails to open a database because it has an
5281   unsupported version.  DatabaseVersionError is a subclass of
5282   DatabaseOpeningError so existing code should continue to work, but it's
5283   now much easier to determine if the problem is that a database needs
5284   rebuilding.
5286 * If you try to open a flint database with an older or newer version than
5287   flint understands, the exception message now gives the version understood,
5288   rather than "I only understand FLINT_VERSION" (literally).
5290 * If we fail to obtain the lock, report why in the exception message.
5292 * Flint now compresses tags in the record and termlist tables using zlib.
5294 * More robust code to handle the flint locking child process, in case of
5295   unexpected errors.
5297 * If a document was replaced more than once between flushes, the document
5298   length wouldn't be updated after the first change.
5300 quartz backend:
5302 * Quartz is still supported, but use in new projects is deprecated (use Flint
5303   instead).  Quartz will be removed eventually.
5305 * quartzcheck: Test if this is a quartz database by looking at "meta" not
5306   "record_DB".  If "record_DB" is >= 2GB and we don't have a LFS aware stat
5307   function then stat can fail even though the file is there.  Also open the
5308   database explicitly as a Quartz database for extra robustness.
5310 * If a document was replaced more than once between flushes, the document
5311   length wouldn't be updated after the first change.
5313 remote backend:
5315 * The remote backend is now supported under Microsoft Windows.
5317 * Open a fresh copy of the database(s) on each connection to a xapian-tcpsrv
5318   rather than relying on being able to share a database across fork() or
5319   between threads (which we don't promise will work).
5321 * xapian-tcpsrv: New "--interface" option allows the hostname or address of the
5322   interface to listen on to be specified (the default is the previous behaviour
5323   of listening on all interfaces).
5325 * If name lookup fails, report the h_errno code from gethostbyname() rather
5326   than whatever value errno happens to currently have!
5328 * Fix bugs in query unserialisation.
5330 * The remote backend now supports all operations (get_lastdocid(), and
5331   postlist_begin() have now been implemented).
5333 * Currently a read-only server can be opened as a WritableDatabase (which is
5334   a minor bug we plan to fix).  In this case, operations which write will fail
5335   and the exception is now InvalidOperationError not NetworkError.
5337 * If a remote server catches NetworkTimeoutError then it will now only
5338   propagate it if we can send it right away (since the connection is
5339   probably unhappy).  After that (and for any other NetworkError) we now
5340   just rethrow it locally to close the connection and let it be logged if
5341   required.
5343 * The timeout parameter to RemoteDatabase wasn't being used, instead the
5344   client would wait indefinitely for the server to respond.
5346 * A timeout of zero to the remote backend now means "never timeout".  This
5347   is now the default idle timeout for WritableDatabase (the connection
5348   timeout default is now 10 seconds, rather than defaulting to the idle
5349   timeout).
5351 * Fix handling of the document length in remote termlists.
5353 * The remote backend now checks when decoding serialised string that the
5354   length isn't more than the amount of data available (bug#117).
5356 * The remote backend now handles the unique term variants of delete_document
5357   and replace_document on the server side.
5359 * The RSet serialisation now encodes deltas between docids (rather than the
5360   docids themselves) which greatly reduces the size of the encoding of a
5361   sparse RSet for a large database.
5363 * We now encode deltas between term positions when sending data after calling
5364   positionlist_begin() on a remote database.
5366 * When using a MatchDecider with remote database(s), don't rerun the
5367   MatchDecider on documents which a remote server has already checked.
5369 * Apply the "decreasing weights with remote database" optimisation which we use
5370   in the sort_by_relevance case in the sort_by_relevance_then_value case too.
5372 * We now throw NetworkError rather than InternalError for invalid data received
5373   over the remote protocol.
5375 * We now close stderr of the spawned backend program when using the "prog" form
5376   of the remote backend.  Previously stderr output would go to the client
5377   application's stderr.
5379 muscat36 backend:
5381 * Support for the old Muscat 3.6 backends has been completely removed.  It's
5382   still possible to convert Muscat 3.6 databases to Xapian databases by
5383   building 0.9.10 and using copydatabase to create a quartz database, which can
5384   then be read by 1.0.0 (and converted to a flint database using copydatabase
5385   again).
5387 build system:
5389 * We've added GCC visibility annotations to the library, which when using GCC
5390   version 4.0 or later reduce the size and load time of the library and
5391   increase the runtime speed a little.  Under x86_64, the stripped library is
5392   6.4% smaller (1.5% smaller with debug information).
5394 * configure: If using GCC, use -Bsymbolic-functions if it is supported
5395   (it requires a very recent version of ld currently).  This option reduces the
5396   size and load time of the shared library by resolving references within the
5397   library when it's created.
5399 * We automatically define _FORTIFY_SOURCE in config.h if GCC is in use
5400   and it's not already set (you can override this as documented in INSTALL).
5401   This adds some checking (mostly at compile time) that important return
5402   values aren't ignored and that array bounds aren't exceeded.
5404 * `./configure --enable-quiet' already allows you to specify at configure time
5405   to pass `--quiet' to libtool.  Now you can override this at make-time by
5406   using `make QUIET=' (to turn off `--quiet') or `make QUIET=y' (to turn on
5407   `--quiet').
5409 * In non-maintainer mode, we don't need the tools required to rebuild some of
5410   the documentation, so speed up configure by not even probing for them in
5411   this common case.
5413 * The makefiles now use non-recursive make in all directories except "docs" and
5414   "tests".  For users, this means that the build is faster and requires less
5415   disk space (bug#97).
5417 * configure: Add proper detection for SGI's C++ (check stderr output of
5418   "CC -v") and automatically pass -ptused in CXXFLAGS for xapian-core and any
5419   applications using xapian-config --cxxflags since it seems to be required to
5420   avoid template linking errors.
5422 * XO_LIB_XAPIAN now checks for the case where XAPIAN_CONFIG wasn't specified
5423   and xapian-config wasn't found, but the library appears to be installed -
5424   this almost certainly means that the user has installed xapian-core from
5425   a package, but hasn't installed the -dev or -devel package, so include
5426   that advice in the error message.
5428 * `./configure --with-stlport-compiler' now requires a compiler name as an
5429   argument.
5431 * configure: Disable probes for f77, gcj, and rc completely by preventing
5432   the probe code from even appearing in configure - this reduces the size of
5433   configure by 209KB (~25%) and should speed it up significantly.
5435 * configure: Suppress more unhelpful warnings and "remarks" for HP's aCC, and
5436   turn on "+wlint", which seems useful.
5438 * A number of cases of unnecessary header inclusions have been addressed,
5439   which should speed up compilation (fewer headers to parse when compiling
5440   many source files).  This also reduces dependencies within the source code,
5441   and thus the number of files which need to be rebuilt when a header is
5442   changed.
5444 * configure: Cache the results of some of our custom tests.
5446 documentation:
5448 * The documentation has all been updated for changes in Xapian 1.0.0.
5450 * Many of the documentation comments in the API headers (which are collated
5451   using doxygen to generated the API reference) have been improved, and some
5452   missing ones added.  Also, internal classes, members, and methods are now all
5453   marked as such so that none should appear in the generated documentation.  In
5454   particular, the class inheritance graphs should be a lot clearer.  A few other
5455   problems have also been addressed.
5457 * docs/internals.html: New separate index page for the "internal"
5458   documentation.
5460 * docs/deprecated.html: New document describing deprecation policy.  This
5461   includes lists of features which have been removed, or which are deprecated
5462   and scheduled for removal, along with suggested replacements.
5464 * docs/admin_notes.html: New document introducing Xapian for sysadmins.
5466 * docs/termgenerator.html: New document describing the new term generation
5467   strategy implemented by the Term::Generator class.
5469 * docs/bm25.html,docs/intro_ir.html: These have been overhauled to make them
5470   fit better with the rest of the documentation, and with Xapian itself.
5472 * docs/overview.html: Fixed links to error classes in generated API
5473   documentation.
5475 * HACKING,INSTALL: Many updates and improvements.
5477 * xapian-config: Improve --version output so that help2man produces a better
5478   man page.
5480 * PLATFORMS: Remove reports for 0.7.* and demote reports for 0.8.* to "older
5481   reports" status.  All SF compilefarm machines are now "no longer available",
5482   so update the symbols and key to reflect this.  Update with recent success
5483   reports from the tinderbox and other sources.
5485 * AUTHORS: Thanks several bug reporters I missed before, as well as recent
5486   contributors.
5488 * docs/code_structure.html now looks nicer and includes links to
5489   svn.xapian.org.
5491 * docs/remote_protocol.html: Fixed several typos and other errors, and document
5492   all the new messages.
5494 * We no longer include docs/apidoc/latex/* in the xapian-core tarballs since
5495   it's just useless bloat.
5497 examples:
5499 * delve:
5501   + Report the exception error string if open a database fails.
5503   + Rename "-k" to "-V" since "keys" were renamed to "values" long ago.  Keep
5504     "-k" as an alias for now, but don't advertise it.  Add handling so "-V3"
5505     shows value #3 for every document in the database.
5507   + No longer stems terms by default.  Add "-s/--stemmer" option to allow a
5508     stemmer to be specified.
5510 * quest: Add "--stemmer" option to allow stemming language to be set, or
5511   stemming to be disabled.
5513 portability:
5515 * Fix compilation with GCC 4.3 snapshot.
5517 * Always use pid_t not int for holding a process id, and use AC_TYPE_PID_T to
5518   `#define pid_t int' if <sys/types.h> doesn't provide pid_t.
5520 * Pass the 4th parameter of setsockopt() as char* which works whether the
5521   function actually takes char* or void* (since C++ allows implicit conversion
5522   from char* to void*).
5524 * Most warnings in the MSVC build have been fixed.
5526 * Refactored most portability workarounds into safeXXXX.h headers.
5528 * Building for mingw in a cygwin environment should work better now.
5530 packaging:
5532 * RPM spec file:
5534   + Updated for the changes in this release.
5536   + ChangeLog.examples is now packaged.
5538 debug code:
5540 * Rename --enable-debug* configure options - conflating the options to "turn on
5541   assertions" and "turn on logging" is confusing. `--enable-debug[=partial]'
5542   becomes `--enable-assertions'; `--enable-debug-verbose' becomes
5543   `--enable-log' and `--enable-debug=full' becomes `--enable-assertions
5544   --enable-log'.  For now the old options give an error telling you the new
5545   equivalent.
5547 * Debug logging from expand is now all of type EXPAND (some was of types
5548   MATCHER and WTCALC before).
5550 * Hook the debug tracing in the lemon generated parser into Xapian's debug
5551   logging framework.
5553 * New assertion types: AssertEqParanoid() and AssertNeParanoid().
5555 * Retry write() if it fails when writing a debug log entry to ensure to avoid
5556   the risk of a partial write.
5558 Xapian-core 0.9.10 (2007-03-04):
5560 API:
5562 * Fix WritableDatabase::replace_document() not to lose positional information
5563   for a document if it is replaced with itself with unmodified postings.
5565 * QueryParser: Add entries to the "unstem" map for prefixed boolean filters
5566   (e.g. type:html).
5568 * Fix inconsistent ordering of documents between pages with
5569   Enquire::set_sort_by_value_then_relevance (fixes bug#110).
5571 testsuite:
5573 * Workaround apparent bug in MSVC's ifstream class.
5575 flint and quartz backends:
5577 * Fix possible double-free after a transaction fails.
5579 * Fix code for recovering from failing to open a table for reading
5580   mid-modification.  If modifications are so frequent that opening for reading
5581   fails 100 times in a row, throw DatabaseModifiedError not
5582   DatabaseOpeningError.
5584 * Don't call std::string::append(ptr, 0) when ptr may be uninitialised
5585   or NULL (rather suspect, and reported to cause SEGV-like behaviour with
5586   MSVC).
5588 * Ensure both_bases is set to false if we don't have both bases when
5589   opening a table using an existing object.
5591 * Use MS Windows API calls to delete files and open files we might want to
5592   delete while they are still open (i.e. the flint and quartz btree base
5593   files).  This fixes a problem when a writer can't discard an old revision at
5594   the exact moment a reader is opening it (bug #108).
5596 remote backend:
5598 * Fix WritableDatabase::has_positions() to refetch the cached value if it
5599   might be out of date.
5601 * Fix incorrect serialisation of a query with non-default termpositions.
5603 inmemory backend:
5605 * If replace_document is used to set the docid of a newly added document which
5606   has previously existed, ensure we mark that document as valid.
5608 documentation:
5610 * Assorted improvements to API documentation.
5612 * docs/Makefile.am: The larger pool_size we set in 0.9.9 for building
5613   sourcedoc.pdf was a bit marginal, so increase it further.
5615 * docs/stemming.html,docs/install.html: Correct 2 references to "CVS" to say
5616   "SVN" instead.
5618 * HACKING: Update the release checklist.
5620 portability:
5622 * Fix flint and quartz to allow 2GB+ B-tree tables when compiling with MSVC.
5624 packaging:
5626 * RPMs: Remove "." from end of "Summary:".  Package the new man page for
5627   xapian-progsrv.
5629 Xapian-core 0.9.9 (2006-11-09):
5631 testsuite:
5633 * Use popen() to run xapian-tcpsrv and wait for "Listening..." before returning
5634   rather than just sleeping for 1 second and hoping that's enough.
5636 * If we can't start xapian-tcpsrv because the port is in use, try higher
5637   numbered ports.
5639 remote backend:
5641 * xapian-tcpsrv: If the port requested is in use, exit with code 69
5642   (EX_UNAVAILABLE) which is useful if you're trying to automate launching of
5643   xapian-tcpsrv instances.
5645 * xapian-tcpsrv: Output "Listening..." once the socket is open and read for
5646   connections (this allows the testsuite to wait until xapian-tcpsrv is ready
5647   before connecting to it).
5649 * xapian-progsrv: Now supports --help, --version, and has a man page.  Fixes
5650   Bug #98.
5652 * Turn on TCP_NODELAY for the TCP variant of the remote backend which
5653   dramatically improves the latency of operations on the database.
5655 build system:
5657 * internaltest: Disable serialiselength1 and serialisedoc1 when the remote
5658   backend is disabled to fix build error in this case.
5660 * Move libbtreecheck.la from testsuite/ to backends/quartz/.
5662 * Move the testsuite harness from testsuite/ to tests/harness/.
5664 documentation:
5666 * Ship our custom INSTALL file rather than the generic one from autoconf which
5667   we've accidentally been shipping instead since 0.9.5.
5669 * docs/Makefile.am: Building sourcedoc.pdf needs a larger pool_size now we're
5670   using pdflatex.
5672 * HACKING: Update debian packaging checklist.
5674 * PLATFORMS: Updated with results from tinderbox.
5676 portability:
5678 * Create "safefcntl.h" as a replacement for <fcntl.h> instead of using
5679   "utils.h" for this purpose, since "utils.h" pulls in many other things we
5680   often don't need.
5682 packaging:
5684 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
5686 Xapian-core 0.9.8 (2006-11-02):
5688 API:
5690 * QueryParser: Don't require a prefixed boolean term to start with an
5691   alphanumeric - allow the same set of characters as we do for the second
5692   and subsequent characters.
5694 flint backend:
5696 * Only force a flush on WritableDatabase::allterms_begin() if there are
5697   actually pending changes.
5699 quartz backend:
5701 * Only force a flush on WritableDatabase::allterms_begin() if there are
5702   actually pending changes.
5704 * quartzcheck: Avoid dying because of an unhandled exception if the Btree
5705   checking code finds an error in the low-level Btree structure.  Add a
5706   catch for any other unknown exceptions.
5708 build system:
5710 * When building with GCC, turn on warning flag -Wshadow even when not in
5711   maintainer mode (provided it is supported by the GCC version being used).
5713 * testsuite/backendmanager.cc: Fix compilation when valgrind is detected by
5714   configure.
5716 * If generating apidoc.pdf fails, display the logfile pdflatex generates since
5717   that is likely to show what failed.
5719 documentation:
5721 * Produce a PDF for apidoc rather than PostScript, since the PDF is smaller,
5722   plus at least as easy to print and easier to view for most users.  Use
5723   pdflatex to generate the PDF directly rather than going via a DVI file which
5724   apparently produces a better result and also avoids problems on some Linux
5725   distros where latex is a symlink to pdfelatex (bug#81, bug#95).
5727 * HACKING: Mention automake 1.10 is out but we've not tested it yet.
5729 * HACKING: Add entries to release checklist: make sure new API methods
5730   are wrapped by the bindings, and that bug submitters are thanked.
5732 * HACKING: Note that on Debian, tetex-extra is needed for
5733   fancyhdr.sty.
5735 * HACKING: Note that dch can be used to update debian/changelog.
5737 * docs/code_structure.html: Document backends/remote.
5739 * PLATFORMS: Update from tinderbox.
5741 portability:
5743 * configure: When checking if we need -lm, don't use a constant argument to
5744   log() as the compiler might simply evaluate the whole expression at compile
5745   time.
5747 * configure: Redhat's GCC 2.96 doesn't support -Wundef even though real GCC
5748   version before and after it do!
5750 * configure: Avoid use of double quotes in double-quoted backticks since
5751   it causes problems on some platforms.
5753 * backends/flint/flint_io.cc: Fix compilation on windows (needs to
5754   #include "safewindows.h" to get definition of SSIZE_T).
5756 * Fix our implementation of om_ostringstream to compile so that the build
5757   works once more on older compilers without <sstream> (regression probably
5758   introduced in 0.9.7).
5760 packaging:
5762 * xapian.spec: Package xapian-progsrv.
5764 Xapian-core 0.9.7 (2006-10-10):
5766 API:
5768 * QueryParser:
5770   + Allow a distance to be optionally specified for NEAR - e.g.
5771     "cats NEAR/3 dogs" (bug#92).
5773   + Implement "ADJ" operator - like "NEAR" except the terms must
5774     appear in matching documents in the same order as in the query.
5776   + Fix bug in how we handle prefixed quoted phrases and prefixed brackets.
5778   + Fix parsing of loved and hated prefixed phrases and bracketted expressions.
5780   + Fix handling of stopwords in boolean expressions.
5782   + Don't ignore a stopword if it's the only query term.
5784 * Document::add_value() failed to replace an existing value with the same
5785   number, contrary to what the documentation says (bug #82).
5787 * Enquire::set_sort_by_value(): Don't fetch the document data when fetching
5788   the value to sort on.  Simple benchmarking showed this to speed up sort by
5789   value by a factor of between 3 and 9!
5791 * Implement transactions for flint and quartz.  Also supported are "unflushed"
5792   transactions, which provided an efficient way to atomically group a number
5793   of database modifications.
5795 * The Xapian::Error and Xapian::ErrorHandler classes have been reimplemented.
5796   The new versions have better, clearer documentation comments and are cleaner
5797   internally.
5799 * Change how doubles are serialised by TradWeight, BM25Weight, and in the
5800   remote backend protocol.  The new encoding allows us to transfer any double
5801   value which can be represented by both machines precisely and compactly.
5803 testsuite:
5805 * Add targets "check-flint", "check-quartz", and "check-remote" in tests and at
5806   the top level which run the subset of tests which test the respective backend.
5808 * apitest: Run tests on flint if flint is enabled, rather than if quartz is
5809   enabled!
5811 * apitest: Speed up deldoc4 when run in verbose mode - some stringstream
5812   implementations are very inefficient when the string grows long.
5814 * Turn on GLIBCXX_FORCE_NEW when running tests under valgrind to stop the GNU
5815   C++ STL from using a pooling allocator.  This helps make velgrind's leak
5816   tracking more reliable.
5818 * Probe for required valgrind logging options at configure time rather than
5819   when running the test program.  This saves about 2 seconds per test program
5820   invocation.
5822 * Fix testsuite harness to show valgrind output when a test fails (when running
5823   under valgrind in verbose mode).  This had stopped working, probably due to
5824   changes in valgrind 3.
5826 * internaltest: Check that the destructor on a temporary object gets called
5827   at the correct time (Sun C++ deliberately gets this wrong by default, and it
5828   would be good to catch any other compilers which do the same).
5830 * apitest: When running tests on the remote backend and running under valgrind,
5831   run xapian-tcpsrv and xapian-progsrv under valgrind too to avoid issues
5832   with the precision of doubles (bug#94).
5834 flint backend:
5836 * Retry on EINTR from fcntl or waitpid when creating or releasing the flint
5837   lock file.
5839 * xapian-compact: Add --blocksize option to allow the blocksize to be set
5840   (default is 8K as before.)
5842 * WritableDatabase::replace_document(did, doc) was double-incrementing the
5843   "changes" counter when document did didn't exist so it would flush twice
5844   as often - fixed.
5846 * WritableDatabase::postlist_begin(): Remove forced flush when iterating the
5847   posting list of a term which has modified postings pending.
5849 quartz backend:
5851 * quartzcompact: Add --blocksize option to allow the blocksize to be set
5852   (default is 8K as before.)
5854 * WritableDatabase::replace_document(did, doc) was double-incrementing the
5855   "changes" counter when document did didn't exist so it would flush twice
5856   as often - fixed.
5858 remote backend:
5860 * Most of the remote backend has been rewritten.  It now supports most
5861   operations which a local database does (including writing!), the protocol
5862   used is more compact, and a number of layers of classes have been eliminated
5863   and the sequences of method calls simplified, so the code should be easier to
5864   understand and maintain despite doing more.  A number of bugs have been fixed
5865   in the process.
5867 * xapian-tcpsrv: Report errno if we catch a Xapian::Error which has it set.
5869 * xapian-tcpsrv: Fix memory leak in query unserialisation.
5871 build system:
5873 * Now using autoconf 2.60 for snapshots and releases.  Also now using a
5874   libtool patch which improves support for Sun C++'s -library=stlport4 option.
5876 * configure: Fix generation of version.h to work with Solaris sed.
5878 * automake adds suitable rules for rebuilding doxygen_api_conf and
5879   doxygen_source_conf, so remove our less accurate versions.  Also fix
5880   dependencies for regenerating the doxygen documentation, and make the
5881   documentation build work with parallel make.
5883 * Make use of the dist_ prefix to avoid having to list files in EXTRA_DIST as
5884   well as in *_DATA and man_MANS.
5886 * Removed a few unused #include-s.
5888 * include/xapian/error.h: Add hook to allow SWIG bindings to be built using
5889   GCC's visibility support.
5891 * configure: Turn on automake's -Wportability to help ensure our Makefile.am's
5892   are written in a portable way.
5894 * configure: Disable probing and short-cut tests for a FORTRAN compiler.  We
5895   don't use one, but current libtool versions always check for it regardless.
5897 * xapian-config: Prune -L/usr/lib from output of `xapian-config --libs'.
5899 documentation:
5901 * docs/scalability.html: quartzcompact and xapian-compact now allow you to set
5902   the blocksize, so there's no need to use copydatabase if you want to migrate
5903   a database to a larger blocksize.  Mention gmane.  Other minor tweaks.
5905 * Eliminate "XAPIAN_DEPRECATED" from generated documentation.
5907 * PLATFORMS: Added success report for Nexenta (alpha 5), MSVC, and sparc linux.
5908   Updated other results from tinderbox.
5910 * Add links to the wiki from README and the documentation index.
5912 * docs/overview.html: Add discussion of uses of terms vs values.
5914 * docs/overview.html: Rewrite the section on Xapian::Document to remove some
5915   very out-of-date information and make it clearer.
5917 * include/xapian/database.h: Note that automatically allocated document IDs
5918   don't reuse IDs from deleted documents.
5920 * include/xapian/enquire.h: Note that "set_sort_by_relevance" is the default
5921   setting.
5923 * docs/queryparser.html,include/xapian/queryparser.h: Add note that
5924   FLAG_WILDCARD requires you to call set_database.
5926 * HACKING: Add some advice regarding debugging using -D_GLIBCXX_DEBUG,
5927   valgrind, and gdb.
5929 * HACKING: Give URL to Alexandre Duret-Lutz's autotools tutorial, which is much
5930   more up-to-date than the "goat book".
5932 * HACKING: Update and expand the information about the debian packaging.
5934 * Add missing dir_contents files.
5936 portability:
5938 * xapian/version.h: Add a check that _GLIBCXX_DEBUG is set compatibly if we're
5939   compiling with GNU C++ 3.4 or newer.
5941 * Add configure check to see if "-lm" is needed to get maths functions since
5942   newer versions of Sun's C++ compiler seem to require this.
5944 * Automatically put Sun's C++ compiler into "ANSI C++ compliant library" mode
5945   (using -library=stlport4).  This allows us to remove most of the special
5946   case bits of code we've accumulated for just this compiler, which improves
5947   maintainability.
5949 * Sun's C++ compiler implements non-standards-conforming lifetimes for
5950   temporary objects by default.  This means database locks don't get released
5951   when they should, so we now always pass "-features=tmplife" for Sun C++
5952   which selects the behaviour specified by the C++ standard.
5954 Xapian-core 0.9.6 (2006-05-15):
5956 API:
5958 * Rename Xapian::xapian_version_string() and companions to
5959   Xapian::version_string(), etc.  Keep the old functions as aliases which are
5960   marked as deprecated.
5962 * QueryParser: Add rules to handle a boolean filter with a "+" in front (such
5963   as +site:xapian.org).
5965 testsuite:
5967 * queryparsertest: Add another prefix testcase to improve coverage.
5969 build system:
5971 * configure: Simpler check for VALGRIND being set to empty value.
5973 * include/Makefile.am: Add xapian/version.h.timestamp as a dependency on
5974   all-local so that xapian/version.h actually gets regenerated when required.
5976 * Eliminate XAPIAN_BUILD_BACKEND_* from config.h and just use
5977   XAPIAN_HAS_*_BACKEND from xapian/version.h instead.
5979 documentation:
5981 * remote_protocol.html: Document keep-alive messages.
5983 * xapian/enquire.h: Remove bogus documentation for a parameter which doesn't
5984   exist.
5986 * PLATFORMS: Added a summary.  Updated and pruned old entries for which we
5987   have a newer close match.
5989 * HACKING: Expand on details of what's required when changing Xapian (discuss
5990   documentation requirements, and more on why feature tests are vital).
5992 * HACKING: Update section on building debian packages.
5994 portability:
5996 * The tarball is generated with a patched version of libtool 1.5.22 which
5997   fixes libtool bugs on HP-UX and some BSD platforms.
5999 * configure: Fix problems with test for snprintf which affected cygwin, and
6000   possibly some other platforms.
6002 * configure: Tweak version.h generation to cope with CXXCPP putting carriage
6003   returns into its output as can happen on cygwin.
6005 * Fix renaming of "iamflint.tmp" for MS Windows where you can't rename an open
6006   file.
6008 * Fixed MSVC7 warnings.
6010 * Added workaround for newlib header bug.
6012 Xapian-core 0.9.5 (2006-04-08):
6014 API:
6016 * QueryParser:
6018   + Fix FLAG_BOOLEAN_ANY_CASE to really allow any case combination - previously
6019     it only allowed all uppercase or all lowercase.
6021   + Fix QueryParser's handling of terms with trailing "#", "+", or "-" when
6022     set_database has been called and the term doesn't exist in the database
6023     with the suffix.
6025 * Add mechanism to allow xapian-bindings to override deprecation warnings so
6026   we can continue to wrap deprecated methods without lots of warnings.
6028 * Move Enquire::get_matching_terms_end() and Document::termlist_end() inline in
6029   header.
6031 * Database::termlist_begin(): Eliminate the MultiTermList wrapper in the common
6032   case where we're only dealing with a single database.
6034 * Fix TermIterator::positionlist_begin() to work on TermIterator from
6035   Database::termlist_begin().  Make TermList::positionlist_begin() pure
6036   virtual and put dummy implementations in BranchTermList and other
6037   subclasses which can't (or don't) implement it.  This makes it hard to
6038   accidentally fail to implement it in a backend's TermList subclass.
6040 * TermIterator::positionlist_begin() with the remote backend now throws
6041   UnimplementedError instead of InvalidOperationError.
6043 * Implement Enquire::set_sort_by_relevance_then_value().
6045 testsuite:
6047 * Added missing feature test for QueryParser::FLAG_BOOLEAN_ANY_CASE.
6049 * remotetest: Check mset size in tcpmatch1.
6051 flint backend:
6053 * xapian-compact: Fixed segfault from passing an unknown option (e.g.
6054   "xapian-compact --foo").
6056 quartz backend:
6058 * quartzdump,quartzcompact: Fixed segfault from passing an unknown option
6059   (e.g.  "quartzdump --foo").
6061 remote backend:
6063 * xapian-tcpsrv: Don't perform a name lookup on the IP address which an
6064   incoming connection is from as that could easily slow down the search
6065   response - instead just print the IP address itself if output is verbose.
6067 * xapian-tcpsrv: Allow up to 5 connections in the listen queue instead of just
6068   one.
6070 build system:
6072 * Removed unused code from the matcher and the remote, quartz, and flint
6073   backends.
6075 documentation:
6077 * All installed binaries now support --help and --version and have a man page
6078   (which is generated using help2man).
6080 * docs/overview.html: Bring up to date.
6082 * docs/remote_protocol.html: Document messages for requesting and sending a
6083   termlist and a document.
6085 * PLATFORMS, AUTHORS: Updated.
6087 * INSTALL: Improve wording.
6089 * HACKING: Note that we now use a lightly patched version of libtool 1.5.22.
6091 * HACKING: aclocal is part of automake, not autoconf.
6093 portability:
6095 * Added some tweaks to help support compilation with MSVC.
6097 packaging:
6099 * RPMs: package the new man pages.
6101 debug code:
6103 * Add missing spaces in some debug output.
6105 Xapian-core 0.9.4 (2006-02-21):
6107 API:
6109 * Flag deprecated methods such that the compiler gives a warning, for compilers
6110   which support such a feature (most notably GCC >= 3.1).
6112 * Correct typo in name of definition of function xapian_revision().
6114 testsuite:
6116 * Updated uses of deprecated methods in the testsuite.
6118 build system:
6120 * xapian-config: Set exec_prefix and prefix at top of script so that
6121   xapian-config works after xapian-core is installed.
6123 documentation:
6125 * Add documentation comment for Enquire::set_sort_by_value_then_relevance().
6127 * README: Add pointer to HACKING.  Change "CVS access" to "SVN access".
6129 * PLATFORMS: Updated from tinderbox.
6131 * COPYING: Update second occurrence of old FSF address.
6133 Xapian-core 0.9.3 (2006-02-16):
6135 API:
6137 * Added 4 functions to report version information for the library version being
6138   used (which may not be the same as that compiled against if shared libraries
6139   are in use):  xapian_version_string(), xapian_major_version(),
6140   xapian_minor_version(), xapian_revision().
6142 * Xapian::QueryParser:
6144   + Fix handling of "+" terms in a query when the default query operator is
6145     AND.  Added regression test for this.
6147   + Added "AND NOT" as a synonym for "NOT".  Added feature tests for this.
6149 * Fix prototype for ESet::operator[] to take parameter of type termcount
6150   instead of doccount (doccount and termcount are both typedefs to the same
6151   type so this really just makes the prototype more consistent).
6153 * Xapian::Stem: Check for malloc and calloc failing to allocate memory and
6154   throw an exception.  Richard has fixed this upstream in snowball, so this is
6155   a temporary fix until we import a new version of snowball.
6157 * Xapian::Database: Trying to open a database for reading which doesn't exist
6158   now fails with DatabaseOpeningError instead of FeatureUnavailableError.
6159   Added regression test for this.
6161 * Add Stopper::get_description() and SimpleStopper::get_description().
6163 testsuite:
6165 * Fixed testsuite harness to work with valgrind on 64 bit platforms.
6167 * Merged the "running tests" section of docs/tests.html into the similar
6168   section in HACKING, and make docs/tests.html refer the reader to HACKING for
6169   more information.
6171 * Tidied and enhanced environmental variables which the test suite harness
6172   recongnises:
6174   + OM_TEST_BACKEND: Removed support since the "-b" switch to apitest allows
6175     you control which backend is used, making OM_TEST_BACKEND pretty much
6176     redundant.
6178   + XAPIAN_SIG_DFL: Renamed to XAPIAN_TESTSUITE_SIG_DFL.
6180   + XAPIAN_TESTSUITE_OUTPUT: New environmental variable to control use of
6181     ANSI colour escape sequences in test output (set to "plain" to disable
6182     them, unset, empty, or "auto" to check if stdout is a tty, or anything
6183     else to force colour).
6185 flint backend:
6187 * xapian-compact: Added "--multipass" option to merge postlists in pairs or
6188   triples until all are merged.  Generally this is faster than an N-way merge,
6189   but it does require more disk space for temporary files so it's not the
6190   default.
6192 quartz backend:
6194 * quartzcheck: If the database is too broken to open, emit a warning message
6195   and bump the error count.
6197 build system:
6199 * Now generate snapshots and releases with automake 1.9.6 (was 1.9.5) and
6200   libtool 1.5.22 (was 1.5.18).
6202 * configure: If not cross-compiling, try to actually run a test program built
6203   with the C++ compiler, not just link one.
6205 * configure: Fix to actually skip the check for valgrind if VALGRIND is set to
6206   an empty value.
6208 * configure: Add sanity check for MS Windows that "find" is Unix-like find, not
6209   MSDOS-like.
6211 * Fix conditional compilation of flint backend - it was being disabled when
6212   quartz was, not when flint was supposed to be.
6214 documentation:
6216 * INSTALL,README: Updated.
6218 * Give pointer to replacements for the deprecated Enquire sorting methods
6219   in the doxygen collated documentation.
6221 * PLATFORMS: Added success reports for ppc64 linux and Fedora Core 4.  Updated
6222   from the tinderbox.
6224 * HACKING: Note platforms valgrind now has solid support for; Improve
6225   phrasing in a few places.
6227 * Upgrade to using doxygen 1.4.6 for generating API documentation.
6229 * Change title of the "full source" documentation to "Internal Source
6230   Documentation" rather than "Full source documentation" to make it
6231   clearer it's only useful if you want to modify Xapian itself.
6233 * Fix documentation comments for the values of QueryParser::feature_flag so
6234   doxygen actually pulls out the documentation for them.  Add documentation for
6235   the parameters of QueryParser::parse_query().
6237 * queryparser.html: Document wildcards.
6239 portability:
6241 * Fix compilation with GCC 4.0.1 and later (need to forward declare class
6242   InMemoryDatabase) (bug #69).
6244 * Fix compilation under cygwin (broken in 0.9.2).
6246 * Don't pass NULL for the second parameter of execl() - the Linux man page
6247   says execl takes "one or more pointers to null-terminated strings".  Also
6248   cast the NULL to (void*) to avoid "missing sentinel" warning from GCC4.
6250 * Use snprintf instead of sprintf where available (we were attempting to
6251   do this in some places before, but the configure test was broken so
6252   sprintf was always being used).
6254 * Enable more warnings under aCC and fix minor issues highlighted.  Suppress
6255   "Entire translation unit was empty" warning which isn't useful to us.
6257 * Write top-bit set characters in the source using \xXX notation to avoid
6258   warnings from Intel's C++ compiler.
6260 * configure: TYPE_SOCKLEN_T fails hard, so only run it if we've successfully
6261   run other socket tests.
6263 * queryparser/accentnormalisingitor.h: #include <limits.h> for CHAR_BIT.
6265 * bin/xapian-compact.cc: Fix printf type mismatch on 64 bit platforms.
6267 * Replace pair<bool, string> with a simple class BoolAndString - the pair
6268   results in a 4328 byte symbol on HP-UX which gets truncated (to 4000 bytes).
6269   Most likely this is harmless, but it causes a warning.
6271 * configure: Disable flint backend by default if building for djgpp or msdos.
6273 * xapian-config: Previously when linking without libtool we've always thrown
6274   in dependency_libs, even though only some platforms need it (because it's
6275   generally pretty harmless).  However some Linux distros have an unhelpful
6276   policy of not packaging .la files, so libxapian.la isn't available to
6277   extract dependency_libs from.  Linux is a platform which doesn't require
6278   dependency_libs to be explicitly linked, so extend xapian-config to not
6279   pull in dependency_libs if libtool's link_all_deplibs_CXX=no.
6281 * xapian-config: If the current platform needs dependency_libs and
6282   libxapian.la's dependency_libs contains another .la file, transform it into a
6283   pair of -L and -l options, and recursively expand its dependency_libs (if
6284   any).
6286 * Don't pass functions with C++ linkage to places wanting pointers to functions
6287   with C linkage.  So far this has worked for us, but it causes warnings with
6288   some compilers, and may not be portable.
6290 * Compaq C++ 7.1 doesn't suffer from the problem which previously prevented
6291   it from building Xapian.  This release includes workarounds for some
6292   oddities with errno.h support in this compiler, but currently the build
6293   fails when trying to link a binary with the library.
6295 packaging:
6297 * RPM: Invoke %setup correctly in xapian.spec.
6299 debug code:
6301 * Add missing '#include <iostream>' when TIMING_PATCH is defined.
6303 Xapian-core 0.9.2 (2005-07-15):
6305 API:
6307 * QueryParser:
6309   + Added optional "flags" argument to parse_query method.
6311   + Add flag FLAG_BOOLEAN_ANY_CASE which tells the QueryParser that boolean
6312     operators such as "AND", "OR", and "NEAR" should be recognised even if
6313     they aren't fully capitalised (so "and", "And", "aNd", etc will work too).
6315   + Add flag FLAG_WILDCARD which tells the QueryParser to allow right
6316     truncation e.g. "xap*".
6318   + Fixed to handle "-site:microsoft.com" where site is a boolean prefix.
6319     Added testcases for this.
6321 testsuite:
6323 * The test harness was incorrectly creating a quartz database when a flint one
6324   was requested, which meant tests weren't being run against flint and so it
6325   had bugs rendering it pretty much unusable.
6327 * Added regression test longpositionlist1 (to check encoding/decoding a long
6328   position list, which flint had problems with).
6330 flint backend:
6332 * Bumped format version number.
6334 * Added new "xapian-compact" program which can compact and merge flint
6335   databases in a similar way to how quartzcompact does for quartz databases.
6337 * Fixed to auto-detect database type when opening an existing Flint database
6338   as a WritableDatabase.
6340 * The code to encode the position list size, first entry, and last entry
6341   didn't match the code to decode them!  Reworked both to match, using a
6342   slightly more compact encoding.
6344 * We were failing to append "DB" to the path when opening a table for reading.
6346 * Rewrite of FlintAllTermsList with several fewer member variables.  The
6347   rewrite fixes a bug too - the old version wasn't ignoring the metainfo
6348   entry which is now in the postlist table.
6350 * It seems we need to explicitly kill the child process used for locking.
6351   Otherwise when we have two databases locked just closing the connection
6352   doesn't cause the child to die.  I don't understand why it's needed, but this
6353   fix is at least clean.
6355 quartz backend:
6357 * quartzcompact: Fix mis-repacking of keys in positionlist table when merging
6358   several databases.
6360 * Disable assertion in allterms iteration which is incorrect in a corner case.
6361   This is only a problem if a termname contains zero bytes and you're using a
6362   debug build.  Add regression test test_specialterms2.
6364 remote backend:
6366 * Implement sorting on a value with the remote backend.
6368 build system:
6370 * Pass automake options to AM_INIT_AUTOMAKE rather than specifying them in
6371   Makefile.am.  This way, the version requirements for autoconf and automake
6372   are stated close together.
6374 * configure: -Wshadow causes false positives with GCC 3.0.4, so only enable it
6375   for 3.1 and up.
6377 * configure: Eliminate use of "ln -s" when generating include/xapian/version.h
6378   since it seems to cause problems on Solaris in some setups and isn't really
6379   necessary.
6381 * Add dependency mechanism so version.h gets regenerated when the template is
6382   changed.
6384 * configure: Check for spaces in build directory, source directory, or install
6385   prefix and die with a helpful message.
6387 * Add dependency to generate queryparser_token.h.
6389 * Eliminated TOP_SRCDIR and TOP_BUILDDIR - it's better to just use top_srcdir
6390   and top_builddir directly.
6392 * configure: Generate the list of source files to feed to doxygen by inspecting
6393   all the Makefile.am files prior to running autoreconf rather than by using
6394   "find" when the user runs ./configure.  This speeds up configure, avoids
6395   generating docs for random .cc and .h files which aren't part of xapian-core,
6396   and avoids problems with picking up FIND.EXE on MS Windows.
6398 documentation:
6400 * Expanded explanation of the "descending docid with boolean weighting" trick
6401   for fast date ordered searching in Enquire::set_docid_order() API docs.
6403 * docs/intro_ir.html: Citeseer has moved, so update link.
6405 * testsuite/testsuite.cc: Update URL for valgrind FAQ in comment.
6407 * COPYING: Update FSF address.
6409 * HACKING: Minor updates to release checklist.
6411 portability:
6413 * Assorted tweaks towards allowing compilation with MSVC.
6415 packaging:
6417 * xapian.spec.in: Package xapian-compact.
6419 Xapian-core 0.9.1 (2005-06-06):
6421 API:
6423 * Fix SEGV on get_terms_begin() on an empty Query object.  This was causing
6424   a SEGV in Omega with an empty query.
6426 * Put Query::get_terms_end() inline in header.
6428 flint backend:
6430 * Added the new "flint" backend, which starts out as a copy of the quartz
6431   backend plus some modifications and replacements.  When creating a database
6432   without a specified backend, quartz is still used unless the environmental
6433   variable XAPIAN_PREFER_FLINT is set to a non-empty value.
6435 * apitest now runs tests on flint as well as the other backends.
6437 * Removed undocumented (and hence the little used) quartz "log" feature.
6439 * Implement new fork+fcntl+exec based locking (for Unix) and CreateFile based
6440   locking (for Windows - currently untested).
6442 * Move the special key/tag pair holding the total document length and doc id
6443   high water mark from the record table to the postlist table.  This means that
6444   when appending documents, the insertion point will now always be at the end
6445   of the record table which is more efficient.  We need to jump around the
6446   postlist table to merge postings in anyway.
6448 * Changed metafile magic to be different from quartz, and make the metafile
6449   version a datestamp which we'll change each time the format changes.
6451 * Check the return value of close() when writing the metafile.
6453 * Flint position list table now stores entries using interpolative coding
6454   (which is significantly more compact).
6456 quartz backend:
6458 * quartzcheck: Fixed corner case where you couldn't check a single Btree table
6459   which was just the DB and baseA/baseB files in a directory (Xapian doesn't
6460   produce anything like this, but btreetest does while unit testing the
6461   Btree code).
6463 build system:
6465 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
6467 * configure: Pass more -W flags to g++ (including -Wundef which caught the
6468   getopt problem fixed in this release).  Fixed new GCC warnings from these new
6469   flags.
6471 * Fixed a lingering DOXYGEN_HAVE_DOT reference.
6473 * Fixed accidentally pruned #define which meant that getopt code was being
6474   included even on systems which use glibc (on such systems, we should use
6475   the glibc copy of the code instead).
6477 * queryparser/queryparser.lemony: Add missing '#include <config.h>'.
6479 documentation:
6481 * Added missing documentation comments for a QueryParser methods added in
6482   0.9.0.
6484 * docs/quartzdesign.html: Removed warning that quartz is still in development.
6486 * PLATFORMS: Updated from tinderbox.
6488 * configure: Describe CC_FOR_BUILD in configure --help output.
6490 * HACKING: Updated release instructions to refer to SVN, and note that release
6491   tarballs are now built specially rather than being copies of snapshots.
6492   Update information about the SVN tag name to use for debian files.
6494 * HACKING: Add "email Fabrice" to the release checklist so that RPM
6495   spec files don't lag behind.
6497 * Fixed a few spelling mistakes.
6499 packaging:
6501 * xapian.spec: Remove bogus %setup line left over from when we packaged
6502   xapian-core and xapian-examples together from separate tarballs.
6504 debug code:
6506 * api/omqueryinternal.cc: Fixed compilation with --enable-debug.
6508 * common/omdebug.h: Replace C style cast with static_cast<> which reveals that
6509   we were discarding const (harmlessly though).
6511 Xapian-core 0.9.0 (2005-05-13):
6513 API:
6515 * Query objects really need to be immutable after construction (otherwise we
6516   need a copy-on-write mechanism).  To achieve this the following API changes
6517   were required:
6519   + Remove Query::set_length() in favour of an optional length
6520     parameter to Enquire::set_query().
6522   + Eliminated Query::set_elite_set_size() in favour of optional parameter
6523     to constructor.
6525   + Eliminated Query::set_window() in favour of an optional parameter to the
6526     constructor.
6528 * Removed OP_WEIGHT_CUTOFF, since it doesn't actually seem to add useful
6529   functionality over using Enquire::set_cutoff().
6531 * MSet::max_size() (which only exists so that MSet is an STL container) now
6532   returns MSet::size() and is inlined from the header.
6534 * Added ESet::max_size() (for STL compatibility).
6536 * Fixed Xapian::RSet to have the same "it's a handle" copy semantics as most of
6537   the other classes.
6539 * Rewritten QueryParser class:
6541   + Uses Lemon instead of Bison to generate the parser, which enables us to
6542     stop using static data, so this class is at last reentrant.
6544   + QueryParser now uses a PIMPL style with reference counted internals like
6545     most of the other Xapian classes.
6547   + Direct access to member variables has gone, which unfortunately forces an
6548     API change (but this fixes bug #39).  Instead of accessing
6549     QueryParser::termlist member variable, iterate over terms using
6550     Query::get_terms_begin() and get_terms_end() on the returned Query object.
6551     Direct access to stoplist is replaced by QueryParser::get_stoplist_begin()
6552     and get_stoplist_end(); and to unstem by get_unstem_begin() and
6553     get_unstem_end().
6555   + The rewrite parses many real world examples better than the old version.
6557   + Now allow searches for C#, etc.  If a database has been set, for this and +
6558     and - suffixes, check if the term actually exists, and if not, ignore the
6559     suffix if the unsuffixed term exists.
6561   + Added QueryParser::get_description() method (not very descriptive yet!)
6563   + Added backward compatibility wrapper for old version of
6564     QueryParser::set_stemming_options().
6566   + xapian.h now automatically includes xapian/queryparser.h.  Directly
6567     including xapian/queryparser.h will continue to work for now, but is
6568     deprecated.
6570   + QueryParser::parse_query() was failing to clear termlist and unstem
6571     - the rewrite fixes this.
6573   + New QueryParser parses "term prefix:(term2 term3)" correctly.
6575 * Added Xapian::SimpleStopper which just stops terms specified by a pair of
6576   iterators.  This should be sufficient for the majority of uses.
6578 * Tidied up the Enquire sorting API and added ability to reverse sort on a
6579   value.  Removed sort_bands support.
6581 * Enquire::get_description() improved.
6583 * Methods which return an end iterator where the internals are just NULL are
6584   now inline in the header for efficiency.  Should we ever need to change an
6585   implementation, we can easily move methods back into the library and bump the
6586   library version suitably.
6588 * Added Stem::operator() as preferred alternative to Stem::stem_word().
6590 * Simplified Stem internal design by restructuring to eliminate a few internal
6591   methods.
6593 * BM25Weight: Avoid fetching document length if we're simply going to multiply
6594   it by zero!
6596 testsuite:
6598 * Fixed TEST_EQUAL_DOUBLE to use DBL_EPSILON correctly.
6600 * Rewrite of index_utils test harness code, removing unused and unusual
6601   features.  Data files for tests are now easier to write.  These changes
6602   also fix the bug that ^x didn't actually decode hex values correctly.
6604 * tests/testdata/etext.txt: Stripped carriage returns.
6606 * apitest: Extended stemlang1 to check that trying to create
6607   a stemmer for a non-existent language throws InvalidArgumentError.
6609 * queryparsertest:
6611   + Moved into tests/ subdirectory.
6613   + Reworked to use the standard testsuite harness.
6615   + Added tests for new features in the rewritten QueryParser.
6617 quartz backend:
6619 * quartzcheck: Now checks the structure of all the tables, not
6620   just the postlist table, and cross-checks doclen values between
6621   termlist and postlist tables.  Recognises "--help" option.  Should
6622   now continue after an error (typically it would crash before), and
6623   counts the number of errors found.  Now exits with non-zero status
6624   if any errors were found.  More readable output.
6626 * quartzcompact: Extended to allow merging several quartz
6627   databases to produce a single compact quartz database.  This
6628   allows for faster building - simple index in chunks, then merge
6629   the chunks.
6631 * quartzcompact: Made full compaction a tiny bit more compact.
6633 * quartzcompact: Added "fuller compaction" mode, which ignores the usual "at
6634   least 4 items per block" rule.  This achieves slightly tighter compaction,
6635   though it's probably not advisable to use this option if you plan to update
6636   the compacted database.
6638 * Improved compaction by a few % in non-full case.  Tighter bound on amount of
6639   memory to reserve to read the tag into.
6641 * Fix skip_to on an allterms TermIterator to set the current term when the
6642   skip_to-ed term is in the database.  Add regression test for this
6643   (allterms5).
6645 * Values are stored in sorted order so we can stop unpacking the list once we
6646   get to one after the one we're looking for (in the case where the one we're
6647   looking for doesn't exist).
6649 build system:
6651 * configure: Check that the C++ compiler can actually link a program.
6652   AC_LANG_CXX doesn't, and if it can't find a C++ compiler it'll just return
6653   "g++" which just leads to a later configure test failing in a confusing way.
6655 * configure: corrected configure output of "none known for yes" or "none known
6656   for no" to "none known for g++-3.2" or similar.
6658 * include/xapian/version.h: Define XAPIAN_HAS_xxx_BACKEND for each backend
6659   which is enabled.  The bindings need this, and user code might find it useful
6660   too.
6662 * include/xapian/database.h: Don't declare the backend factory functions if the
6663   corresponding backend has been disabled.  This means that trying to use a
6664   disabled backend will be caught at compile time rather than link time.
6666 * configure: Enhanced valgrind test to (a) see if --tool=memcheck
6667   is needed and (b) see if valgrind actually works (we don't want to
6668   try to use an x86 valgrind on an x86_64 box).
6670 * configure: Suppress 2 Intel C++ warnings which we can't easily code around,
6671   and enable -Werror automatically with --enable-maintainer-mode.
6673 * Clearer make rules for building Postscript doxygen docs.
6675 * Removed some no longer used code.
6677 * Moved a number of method definitions out of headers because they are virtual,
6678   or too large to be sensible candidates for inlining.
6680 * Eliminated the extra library for the queryparser - it's tiny compared to the
6681   main library and having it around just complicates things.
6683 * configure: We no longer need Bison, but we do need CC_FOR_BUILD to compile
6684   Lemon with.
6686 * Snapshot generator now appends _svn6789 or similar to the version string.
6687   Adjusted configure and XO_LIB_XAPIAN macro to take this into account.
6689 * configure: If any tools needed for documentation are missing
6690   and we're in maintainer mode, die with a suitable error in
6691   configure rather than with strange errors when building the
6692   documentation.
6694 * docs/Makefile.am: Explicitly set the pool_size for latex, because we
6695   now seem to overflow the default setting on some systems.
6697 * docs/Makefile.am: Use $(MAKE) instead of make.
6699 documentation:
6701 * Numerous improvements to documentation comments.  Added documentation
6702   comments for QueryParser class.
6704 * HACKING: Added better description of how reference-counted API
6705   classes are structured.
6707 * HACKING: Note that '#include <limits>' isn't supported by GCC 2.95,
6708   and other assorted minor tweaks.
6710 * HACKING: Note how to disable use of VALGRIND on the make check
6711   command line, or when using runtest directly.
6713 * Updated all documentation mentions of CVS to talk about Subversion
6714   instead.
6716 * PLATFORMS: Updated from tinderbox and other sources.
6718 * PLATFORMS: Added minimal testcase which fails to compile with
6719   Compaq's C++ compiler (cxx).
6721 * INSTALL,README: Updated.
6723 * docs/queryparser.html: Note that + and - work on phrases and
6724   bracketed expressions.
6726 * docs/intro_ir.html: Corrected two errors.
6728 * docs/stemming.html: Stemming appears to be applicable to Japanese
6729   so don't say it isn't!
6731 examples:
6733 * Moved xapian-examples module to examples subdirectory of xapian-core.
6735 * quest: Added stopword handling.
6737 portability:
6739 * configure: autoconf identifies Intel's C++ compiler as GCC, so probe for
6740   which we actually have.
6742 * Xapian will now compile cleanly with Intel C++ 8.1 on ia64 Linux and
6743   on x86 Linux.
6745 * backends/quartz/btree.cc: Fixed GCC compilation warning.
6747 * tests/api_db.cc: Fixed warning from Sun's C++ compiler.
6749 * configure: Automatically enable ANSI C++ mode for SGI's compiler
6750   with '-LANG:std'; check that any automatically determined flags
6751   for ANSI C++ mode actually allow us to compile a trivial program
6752   - if they don't it probably means the compiler isn't the one we
6753   were expecting, but one installed with the same name, so we now
6754   drop the flags in this case.
6756 * The compile on IRIX with SGI compiler is now warning free, apart from two
6757   "unused variable" warnings in Snowball generated code.
6759 * On WIN32, don't define NOMINMAX if it is already defined.
6761 packaging:
6763 * xapian.spec: Don't say "%makeinstall" in a comment since rpm
6764   tries to expand it and explodes.
6766 * xapian.spec: '/usr/share' -> '%{_datadir}'.
6768 * xapian.spec: Put the .so in the -devel package (it's only useful
6769   for linking to - the .so.* files are all that's needed at runtime).
6771 debug code:
6773 * net/socketserver.cc: Fixed typo in debug code.
6775 Xapian-core 0.8.5 (2004-12-23):
6777 quartz backend:
6779 * quartzcompact: When full_compaction is enabled, don't fill the last few bytes
6780   of a block if that would mean we needed an extra item and the overhead for
6781   that item would use up more of the next block than we save.  This reduces the
6782   table size after full compaction by up to 0.2% in my tests!
6784 * quartzcompact: Tables sizes will always be a whole number of Kbytes, since
6785   the blocksize is, so report the size in K.  Also report the change in size as
6786   well as the before and after sizes.
6788 * quartzcompact: Added missing '#include <config.h>' so that largefile support
6789   is enabled when we call stat() and we report compression statistics for
6790   tables > 2G.
6792 * quartzcompact: Added --no-full / -n option to disable full compaction.  This
6793   may be useful if you want to update the database after compacting it (need to
6794   test to see if this option is actually useful).
6796 * Renamed Btree::compress() to Btree::compact() for consistency with
6797   "full_compaction" and "quartzcompact".  Also, "compress" is confusing since
6798   we use that term in the zlib patch.
6800 build system:
6802 * xapian-config: Fixed --libs output to not include libxapian.la.
6804 * Added missing '#include <config.h>' to various .cc files (the omissions were
6805   probably harmless, but config.h should be included as the first thing any
6806   source file does).
6808 documentation:
6810 * Minor updates.
6812 packaging:
6814 * RPM spec file: %makeinstall puts the wrong paths in the .la files so use
6815   "make DESTDIR=... install" instead.
6817 debug code:
6819 * Fixed to build with AssertParanoid enabled.
6821 Xapian-core 0.8.4 (2004-12-08):
6823 API:
6825 * Added constructors to Database and WritableDatabase which fulfil the role
6826   that the Auto::open() factory functions currently do.  Auto::open() is
6827   now deprecated.
6829 * Removed the ability to write a Xapian object to an ostream directly, as
6830   it's little used and potentially dangerous ('cout << mset[i];' will
6831   compile, but you almost certainly meant 'cout << *mset[i];').  You can
6832   get the old effect by writing 'cout << obj->get_description();' instead
6833   of 'cout << obj;'.  Note that including xapian.h no longer pulls in
6834   fstream, which code may have been implicitly relying on - if this is
6835   a problem add '#include <fstream>' after '#include <xapian.h>'.
6837 * QueryParser: Be smarter about when to add a ':' when adding a term prefix.
6839 * BoolWeight::unserialise() now returns BoolWeight*, and similarly for
6840   TradWeight and BM25Weight.  BoolWeight::clone() now returns BoolWeight *.
6842 * If a database contains no positional information, change NEAR and PHRASE
6843   queries into AND queries (as otherwise they'd return no matches at all)
6844   (bug #56).  Added feature test phraseorneartoand1.
6846 * Renamed BM25 parameters to match standard naming in papers and elsewhere
6847   (A->k3, B->k1, C->k2, D->b), eliminated the extra factor of 2 which our C
6848   had, and reordered the parameters to k1, k2, k3.  This is an incompatible API
6849   change for BM25Weight(), so if you are using custom parameters for BM25
6850   you'll need to update your code.
6852 * During query expansion, if we estimate the term frequency, ensure it has a
6853   sane value (>= r and <= N - R + r) rather than bodging around the problem
6854   later on.
6856 * TradWeight, BM25Weight: termfreq is always exact for matching (we only
6857   approximate it for query expansion) so replace code to work around bad
6858   approximations with Assert() to make sure this never happens.
6860 testsuite:
6862 * runtest: Enhanced to allow it to run test programs under valgrind and other
6863   tools (gdb was already supported).
6865 * runtest: now works with valgrind 2.1.2 and later (valgrind's --logfile-fd
6866   option was renamed to --log-fd).
6868 * runtest: Allow VALGRIND environmental variable to override the value we got
6869   from configure.
6871 * Added a dependency so "make check" regenerates runtest if necessary.
6873 * The test programs now point the user to the runtest script if srcdir can't
6874   be guessed.  And they no longer look for the test program in the tests
6875   subdirectory of the current directory.
6877 * btreetest: Fixed memory leaks in test_cursor1 (the testcase itself was
6878   causing the leak, not the library).
6880 * apitest: Fixed mset_range_is_same() and mset_range_is_same_weights() helper
6881   functions which were only comparing the first item in the range.  Thankfully
6882   the tests still all pass so this wasn't hiding any bugs.
6884 * apitest: A modified version of changequery1 fails - the bug is obscure and
6885   subtle, and the fix is tricky so set the modified test to SKIP for now.
6887 * apitest: Added test_weight1 which tests the built-in Xapian::Weight
6888   subclasses and test_userweight1 which tests user defined weighting schemes
6889   (bug#8).
6891 * quartztest: Test with DB_CREATE_OR_OPEN in writelock1.
6893 quartz backend:
6895 * An interrupted update could cause any further updates to fail with "New
6896   revision too low" because the new revision was being calculated incorrectly -
6897   fixed (bug#55).
6899 * Fixed Bcursor::del() which didn't always leave the cursor on the next item
6900   like it should.  This may have been causing problems when trying to remove
6901   the last references to a particular term.
6903 * Fixed ultra-obscure bug in the code which finds a key suitable to
6904   discriminating between two blocks in a B-tree branch (discovered by reading
6905   the code).  Comparing the keys didn't consider the length of the second, so
6906   it is possible the code would miscompare.  But in reality this is extremely
6907   unlikely to happen, and even then would probably just mean that the
6908   discriminating key wouldn't be as short as it could be (wasting a few bytes
6909   but otherwise harmless).
6911 * If we're removing a posting list entirely, often there will only be one
6912   chunk, so avoid creating a Bcursor in this case.
6914 * Simplified Btree::compare_keys() by removing the last case which was dead
6915   code as it was covered by an earlier case.
6917 * Check that any user specified block size is a power of 2.  If the block
6918   size passed is invalid, use the default of 8192 rather than throwing an
6919   exception.
6921 * Started to refactor the Btree manager by introducing Item and Key classes
6922   which take care of handling the on-disk format, and eliminated duplicated
6923   tag reading code in Btree and Bcursor.  These changes will pave the way for
6924   improvements to the on disk format.
6926 * Applied the Quartz "DANGEROUS" patch, but disabled for now.  This way it
6927   won't keep being broken by changes to the code.
6929 * quartzcompact: Added --help and --version; Check that the source path and
6930   desitination path aren't the same; Report each table name when we start
6931   compacting it, and some simple stats on the compaction achieved when we
6932   finish.
6934 muscat36 backend:
6936 * Removed a default parameter value from one variant of
6937   Xapian::Muscat36::open_db() so that there's only one candidate for
6938   open_db(string).
6940 build system:
6942 * xapian-config: If flags are needed to select ANSI mode with the current
6943   compiler, then make xapian-config --cxxflags include them so that Xapian
6944   users don't have to jump through the same hoops we do.
6946 * xapian-config: Added --swigflags option for use with SWIG.
6948 * XO_LIB_XAPIAN now passes ac_top_srcdir to xapian-config which uses it
6949   (if provided) to say "configure.ac" or "configure.in" rather than
6950   "configure.in (or configure.ac)" in the "Add AC_PROG_LIBTOOL"
6951   error message.
6953 * Cleaned up the build system in a few places.
6955 * Removed a few totally unneeded header includes.
6957 * Moved a number of functions and methods out of headers because they're not
6958   good inlining candidates (too big or virtual methods).
6960 * Changed C style casts to C++ style.  The syntax is ugly, but they do make the
6961   intent clearer which is a good thing.  Note this as a coding style guideline
6962   in HACKING.
6964 * configure.ac: Automatically add -Werror to CFLAGS and CXXFLAGS if
6965   maintainer mode is enabled and we're using GCC3 or newer.  Don't do
6966   this for older GCCs as GCC 2.95 issues spurious warnings.
6968 * Reworked how include/xapian/version.h is generated so that it works
6969   better with compilers other than GCC, and with HP-UX sed.
6971 * XAPIAN_VERSION is now a string (e.g. "0.8.4").
6973 * Added new #define XAPIAN_REVISION (which is 4 for version 0.8.4).
6975 documentation:
6977 * docs/bm25.html,docs/intro_ir.html: Reworked to talk about Xapian
6978   rather than Muscat.  Also improved the appearance of the formulae.
6980 * HACKING: Valgrind now supports x86 FreeBSD and PowerPC Linux.
6982 * Documented parameters of Enquire::register_match_decider().
6984 * We now use doxygen 1.3.8 to build documentation for snapshots and releases.
6986 * PLATFORMS: Updated from the tinderbox (which now runs builds on machines
6987   available in HP's testdrive scheme) and other assorted reports.
6989 * PLATFORMS: Removed reports from versions prior to 0.7.0.  So much
6990   has changed that these are of little value.
6992 * docs/scalability.html: Added note warning about benchmarking from cold.
6994 * Assorted other minor documentation improvements.
6996 portability:
6998 * configure.ac: Improved snprintf configure test to actually
6999   check that it works (older implementations may have different
7000   semantics for the return value, and at least one ignores the length
7001   restriction entirely!)
7003 * Reworked the GNU getopt source we use so that the header is clean and
7004   suitable for use from a reasonably ISO-conforming C++ compiler instead of
7005   being full of cruft for working around quirky C compilers which C++ compilers
7006   tend to stumble over.
7008 * Use SOCKLEN_T for the type we need to pass to various socket calls, since
7009   HPUX defines socklen_t yet wants int in those calls.  Reworked the
7010   TYPE_SOCKLEN_T test we use.
7012 * On Windows, we want winsock2.h instead of sys/socket.h.  Mingw doesn't seem
7013   to even have the latter, so I think previously we've been compiling by
7014   picking one up from somewhere random!
7016 * Change the small number of C sources we have to be C++ so we can compile
7017   everything with the C++ compiler.  This way we don't need to worry about
7018   configure choosing a mismatching pair of compilers, or about whether
7019   configure tests with the C compiler don't apply to the C++ compiler, or vice
7020   versa.
7022 * Compiles and passes testsuite with HP's aCC (we have to compile in
7023   ANSI mode, so we automatically add -AA to CXXFLAGS).
7025 * If the link test detects pread and pwrite are present, get configure to try
7026   out prototypes for pread and pwrite.  This is much cleaner than trying to
7027   find the right combination of preprocessor defines to get each platform's
7028   system headers to provide prototypes.
7030 * configure: Disable probing for pread/pwrite on HP-UX as they're present but
7031   don't work when LFS (Large File Support) is enabled, and we definitely want
7032   LFS.
7034 * Fixed some warnings from Sun's C++ compiler.
7036 * Provide our own C_isalpha(), etc replacements for isalpha(), etc
7037   which always work in the C locale and avoid signed char problems.
7039 * For mingw/cygwin, pass -no-undefined when linking libxapianqueryparser.la
7040   so libtool builds a shared library.  Also pass the magic linker flag
7041   -Wl,--enable-runtime-pseudo-reloc if configure has determined it is needed.
7043 * For cygwin, use the underlying MoveFile API call for locking, as link()
7044   doesn't work on FAT partitions.  And don't rely on HAVE_LINK to control
7045   whether we use link() otherwise - if the configure test somehow misfires, a
7046   compilation error is better than using rename() on Unix as that would cause a
7047   second writer to smash the lock of the first.
7049 * Closer to building with Compaq C++ - add "-std strict_ansi" to CXXFLAGS, and
7050   tweaked the code in several places.  It currently dies trying to compile
7051   the PIMPL smart pointer template code which looks hard to fix.
7053 debug code:
7055 * HACKING: Document that %% in XAPIAN_DEBUG_LOG is substituted with
7056   the process-id, and that setting XAPIAN_DEBUG_FLAGS to -1 enables
7057   all debug messages.
7059 * Removed compatibility code for checking environment variables OM_DEBUG_FILE
7060   and OM_DEBUG_TYPES.
7062 Xapian-core 0.8.3 (2004-09-20):
7064 API:
7066 * Fixed bug which caused a segmentation fault or odd "Document not found"
7067   exceptions when new check_at_least parameter to Enquire::get_mset() was used
7068   and there weren't many matches (regression test checkatleast1).
7070 remote backend:
7072 * Renamed omtcpsrv to xapian-tcpsrv and omprogsrv to xapian-progsrv.
7074 packaging:
7076 * RPM packaging now has a separate package for the runtime libraries to
7077   allow 32 and 64 bit versions to be installed concurrently.
7079 * RPM for xapian-core now includes binaries from xapian-examples.
7081 debug code:
7083 * Fixed to compile with debug tracing enabled.
7085 Xapian-core 0.8.2 (2004-09-13):
7087 API:
7089 * Removed the compatibility layer which allowed programs written against the
7090   pre-0.7.0 API to be compiled.
7092 * Added new ESet methods swap(), back() and operator[].
7094 * Xapian::WritableDatabase::replace_document can now be used
7095   to add a document with a specific docid (to allow keeping docids
7096   in sync with numeric UIDs from another system).
7098 * Added Xapian::WritableDatabase::replace_document and
7099   delete_document variants which take a unique id term name rather
7100   than a document id.
7102 * Enquire::get_mset(): If a matchdecider is specified and no matches
7103   are requested, the lower bound on the number of matches must be 0
7104   (since the matchdecider could reject all the matches).
7106 * Renamed Query::is_empty() to Query::empty() for consistency.  Keep
7107   Query::is_empty() for now as a deprecated alias.
7109 * Enquire::set_sorting() now takes an optional third parameter which allows
7110   you to specify a sort by value, then relevance, then docid instead of
7111   by value then docid.
7113 * Enquire::get_mset() now takes an optional "check_at_least" parameter
7114   which allows Omega's MIN_HITS functionality to be implemented in the matcher
7115   (where it can be done a bit more efficiently).
7117 testsuite:
7119 * Reworked quartztest's positionlist1 into a generic api test as apitest's
7120   poslist3.
7122 * apitest: Reenabled allterms2, but with the iterator copying parts removed -
7123   TermIterator is an input_iterator so that part was invalid.
7125 * Overhauled btreetest and quartztest - tests at the Btree level are now all
7126   in btreetest.  Those at the QuartzDatabase level are in quartztest.
7128 * Split api_db.cc into 3 files as it has grown rather large.
7130 * tests/runtest: Added support for easily running gdb on a test program,
7131   automatically sorting out srcdir and libtool.
7133 quartz backend:
7135 * Refactored the quartz backend code to reduce the number of layered classes
7136   and eliminate unnecessary buffering, reducing memory usage so that more
7137   posting list changes can be batched together (see next change) and database
7138   building can be done several times faster.
7140 * Added tunable flush threshold - set XAPIAN_FLUSH_THRESHOLD=50000 to flush
7141   every 50000 documents.  The default is now every 10000 documents (was
7142   every 1000 documents previously).  The optimum value will most likely
7143   depend on your data and hardware.
7145 * WritableDatabase::get_document() no longer forces pending changes to be
7146   flushed.  The document will read things lazily from the database, and that
7147   reading may trigger a forced flush).
7149 * WritableDatabase::get_avlength() no longer forces pending changes to be
7150   flushed.  This means you can now search a modified WritableDatabase without
7151   causing a flush unless the search includes a term whose postlist has pending
7152   modifications.
7154 * Reduced quartz postlist chunk threshold from "2048 or a few bytes more" to
7155   "2000 or a few bytes more" so that full size chunks won't get split by the
7156   Btree.
7158 * Improved the "Db block overwritten" message.  The DatabaseCorruptError
7159   version now suggests multiple writers may be the cause, while the
7160   DatabaseModifiedError version uses less alarming wording and says to call
7161   Database::reopen().
7163 * QuartzWritableDatabase now stores the total document length and the last
7164   docid itself rather than tallying added and removed document length and
7165   writing the last docid back every time a document is added.  This gives
7166   cleaner code and a small performance win.
7168 * Make the first key null for blocks more than 1 away from the leaves.
7169   It saves disk space for a tiny CPU and RAM cost so is bound to be
7170   a win overall.
7172 * matcher/localmatch.cc: Fixed problems handling termweights in queries with
7173   the same term repeated (bug #37) and added regression test (qterminfo2).
7175 * Sped up iteration over all the terms in a database (QuartzCursor now only
7176   reads the tag from the Btree if asked to).
7178 * Cancelling an operation is now implemented more efficiently.
7180 inmemory backend:
7182 * Fixed bugs with deleting a document while a PostingIterator over it is
7183   active.
7185 muscat36 backend:
7187 * Fixed to compile now that internal_end_session() has gone (broken in 0.8.1).
7189 build system:
7191 * Fixed to compile when configured with --disable-inmemory (bug #33).
7193 * XO_LIB_XAPIAN now AC_SUBSTs XAPIAN_VERSION so your application's build
7194   system can easily check for a particular version of Xapian.
7196 * When compiling with GCC, we check that the compiler used to compile the
7197   library and the compiler used to compile the application have compatible
7198   C++ ABI versions.  Unfortunately GCC 3.1 incorrectly reports the same
7199   ABI version as GCC 3.0, so we now special case that test.
7201 * Bumped the versions of the autotools we require for bootstrapping, and
7202   updated the documentation of these in the HACKING document.
7204 * Quote macro names to fix warnings from newer aclocal.
7206 documentation:
7208 * Improved API documentation for Xapian::WritableDatabase::replace_document and
7209   delete_document.
7211 * Added documentation comments for MSet methods size(), empty(), swap(),
7212   begin(), end(), back().
7214 * Removed bogus documentation comments saying that some Enquire methods can
7215   throw DatabaseOpeningError.
7217 * Updated quartz design docs to reflect recent changes.  Also pulled
7218   out the Btree and Bcursor API docs and slotted them in as doxygen
7219   documentation comments - this way they're much more likely to
7220   be kept up-to-date.
7222 * Corrected multiple occurrences of "an Xapian::XXX" to "a Xapian::XXX"
7223   (presumably these all resulted from replacing "Om" with "Xapian::").
7225 * Various minor updates and improvements.
7227 portability:
7229 * Reworked how we cope with fcntl.h #define-ing open on Solaris.  This change
7230   finally allows Sun's C++ compiler to produce a working Xapian build on
7231   sparc Solaris!
7233 * configure.ac: Don't define DATADIR - we no longer use it and clashes
7234   with more recent mingw headers.
7236 * matcher/andpostlist.cc: Initialise lmax and rmax to 0.  This cures
7237   the SIGFPE on apitest's qterminfo2 on alpha linux.
7239 Xapian-core 0.8.1 (2004-06-30):
7241 API:
7243 * New method Xapian::Database::get_lastdocid which returns the highest used
7244   document id for a database (useful for re-synchronizing an indexer which
7245   was interrupted).  Implemented for quartz and inmemory.
7247 * Xapian::MSet::get_matches_*() methods now take collapsing into account, and
7248   the documentation has been clarified to state explicitly that collapsing and
7249   cutoffs are taken into account (bug#31).
7251 * Xapian::MSet: Need to adjust index by firstitem when indexing into items
7252   (bug#28).
7254 * MSetIterator and ESetIterator are now bidirectional iterators (rather than
7255   just input iterators)
7257 * Fixed post-increment forms of PostingIterator, TermIterator,
7258   PositionIterator, and ValueIterator so that *i++ works (as it must for them
7259   to be true input iterators).
7261 * Xapian::QueryParser: If we fail to parse a query, try stripping out
7262   non-alphanumerics (except '.') and reparsing.
7264 * Fixed memory leaked upon Xapian::QueryParser destruction.
7266 * Removed several unused Xapian::Error subclasses (these were used by the
7267   indexer framework which we decided was a failed experiment).
7269 testsuite:
7271 * queryparsertest: Pruned near-duplicate queryparsertest testcases.
7273 * queryparsertest: Added test case for `term NOT "a phrase'.
7275 * remotetest: Use 127.0.0.1 instead of localhost so that tcpmatch1 doesn't fail
7276   just because the network setup is broken.
7278 * apitest: Make emptyquery1 check that Query("") causes an InvalidArgumentError
7279   exception.
7281 quartz backend:
7283 * Fixed bug which meant we sometimes failed to remove a posting when deleting
7284   or replacing a document.
7286 * Fixed PostlistChunkReader to take a copy of the postlist data being read to
7287   avoid problems with reading data from a string that's been deleted.
7289 * Fixed bug in postlist merging which could occasionally extend a postlist
7290   chunk to overlap the docid range of the next chunk.
7292 * Eliminated the split cursor in each Btree object - we only actually need a
7293   single block buffer to handle splitting blocks.  This reduces the memory
7294   overhead of each Bcursor (and hence each QuartzPostList).
7296 * Changed 2 calls to abort() to throw Xapian::DatabaseCorruptError instead,
7298 * If Btree is writable, throw DatabaseCorruptError if we detect overwritten.
7300 * Check the return value of fdatasync()/fsync()/_commit() and raise an error.
7301   If they fail, we really want to know as it could cause data corruption.
7303 * Assorted clean ups, improved comments, debug tracing, assertions.
7305 * When merging in postlist changes, removed an unneeded call to
7306   QuartzBufferedTable::get_or_make_tag() in a case when we're using a cursor
7307   which has already fetched the tag.
7309 * Added SON_OF_QUARTZ define to disable incompatible changes to database
7310   formats by default, and use it to control the docid encoding for keys such
7311   that we're always inserting at the end of the table when added new documents.
7313 * Reopening the readonly version of a writable Btree is now more efficient
7314   (we used to close and reopen all the files and destroy and recreate a lot
7315   of objects and buffers).
7317 * Share file descriptors between the read and write Btree objects so that a
7318   quartz WritableDatabase now uses 5 fds rather than 10.
7320 * Added configure test for glibc, because otherwise we need to include a header
7321   before we can check for glibc in order to define something we should be
7322   defining before we include any headers!  Defining _XOPEN_SOURCE on OpenBSD
7323   seems to do the opposite to Linux and *disable* pread and pwrite!
7325 backends:
7327 * Stripped out the session machinery - all that is actually required is to
7328   ensure that any unflushed changes are flushed when the destructor runs.
7330 * A few other backend interface cleanups.
7332 build system:
7334 * Unified the shlib version numbers (the small benefit of tracking them
7335   individually makes it hard to justify the extra work required, and having one
7336   version simplifies debian packaging too).
7338 * configure.in: Fix typo (STLPORT_CXXLAGS -> STLPORT_CXXFLAGS)
7340 * Removed trivial m4/Makefile.am and autoconf/Makefile.am and do the work
7341   from the top level Makefile.am instead.  It's easier to see the structure
7342   this way, and it also removes a couple of recursive make invocations which
7343   will speed up builds a little.
7345 documentation:
7347 * HACKING: Added a list of subtasks when doing a release.
7348   Currently it's always me that does this, but it may not always be
7349   and anyhow it'll help me to have a list to run through.
7351 * include/xapian/database.h: Remove references to sessions in doxygen
7352   comments.
7354 * docs/quickstart.html: Corrected lingering reference to "om.h" and
7355   note that we need <iostream>.
7357 * docs/quickstartindex.cc.html,docs/quickstartexpand.cc.html,
7358   docs/quickstartsearch.cc.html: Add <iostream>.
7360 * PLATFORMS,AUTHORS: Updated.
7362 * docs/quartzdesign.html: Corrected various pieces of out of date
7363   information, and improved wording in a couple of places.
7365 * docs/scalability.html: Removed the reference to the Quartz update bottleneck
7366   "currently being addressed for Xapian 0.8" as it's now been addressed!  Also
7367   reworded to remove use of first person (it was originally a message sent to
7368   the mailing list).
7370 Xapian-core 0.8.0 (2004-04-19):
7372 * Omega, xapian-examples and xapian-bindings now have their own NEWS files.
7374 API:
7376 * Throw an exception when an empty query is used to build in the binary
7377   operator Query constructor (previously this caused a segfault.  Added
7378   regression test.
7380 * Made the TradWeight constructor explicit.  This is technically an API change
7381   as before you could pass a double where a Xapian::Weight was required - now
7382   you must pass Xapian::TradWeight(2.0) instead of 2.0.  That seems desirable,
7383   and it's unlikely any existing code will be affected.
7385 * Added "explicit" qualifier to constructors for internal use which take a
7386   single parameter.
7388 * Renamed Xapian::Document::add_term_nopos to Xapian::Document::add_term
7389   (with forwarding wrapper method for compatibility with existing code).
7391 * The reference counting mechanism used by most API classes now handles
7392   creating a new object slightly more efficiently.
7394 * Xapian::QueryParser: Don't use a raw term for a term which starts with a
7395   digit.
7397 testsuite:
7399 * apitest, quartztest: Added a couple of tests, and commented out some test
7400   lines which fail in debug builds.
7402 * quartztest: cause a test to fail if there's still a directory after a call
7403   to rmdir(), or if there isn't a directory after calling mkdir().
7405 * apitest: Check returned docids are the expected values in a couple more
7406   cases.  Improved wording of a comment.
7408 quartz backend:
7410 * We now merge a batch of changes into a posting list in a single pass which
7411   relieves an update bottleneck in previous versions.
7413 * When storing the termlist, pack the wdf into the same byte as the reuse
7414   length when possible - doing so typically makes the termlist 14% smaller!
7415   This change is backward compatible (0.7 database will work with 0.8, but
7416   databases built or updated with 0.8 won't work with 0.7).
7418 * quartzcheck: Check the structure within the postlist Btree as well as
7419   the Btree structures themselves.
7421 * Reduced code duplication in the btree manager and btreechecking code.
7423 * quartzdump: Backslash escape space and backslash in output rather than hex
7424   encoding them; renamed start-term and end-term to start-key and end-key;
7425   removed rather pointless "Calling next" message; if there's an error, write
7426   it to stderr not stdout, and exit with return code 1.
7428 * Corrected a number of comments in the source.
7430 * Removed several needless inclusions of quartz_table_entries.h.
7432 * Removed OLD_TERMLIST_FORMAT code - it has been disabled for since 0.6.0.
7434 * Removed all the quartz lexicon code and docs.  It's been disabled for ages,
7435   and we've not missed it.
7437 build system:
7439 * XO_LIB_XAPIAN autoconf macro can now be called without arguments in the
7440   common case where you want the test to fail if Xapian isn't found.
7442 * Fixed the configure test for valgrind - it wasn't working correctly when
7443   valgrind was installed but was too a version to support VALGRIND_COUNT_ERRORS
7444   and VALGRIND_COUNT_LEAKS.
7446 * GCC 2.95 supported -Wno-long-long and is our minimum recommended version, so
7447   unconditionally use -Wno-long-long with GCC, and don't test for it on other
7448   compilers (the old test incorrectly decided to use it with SGI's compiler
7449   resulting in a warning for every file compiled).
7451 documentation:
7453 * Updated the quickstart tutorial and removed the warning that "this
7454   document isn't up to date".
7456 * docs/intro_ir.html: Added a link to "Information Retrieval" by Keith van
7457   Rijsbergen which can be downloaded from his website!
7459 * docs/quartzdesign.html: Some minor improvements.
7461 * docs/matcherdesign.html: Merged in more details from a message sent to the
7462   mailing list.
7464 * docs/queryparser.html: Grammar fixes.
7466 * Doxygen wasn't picking up the documentation for PostingIterator and
7467   PositionListIterator - fixed.  Added doxygen comments for Xapian::Stopper
7468   and Xapian::QueryParser.
7470 * PLATFORMS: Updated with many results from tinderbox and from users.
7472 * AUTHORS: Updated the list of contributors.
7474 * HACKING: XAPIAN_DEBUG_TYPES should be XAPIAN_DEBUG_FLAGS.
7476 * HACKING: Updated to mention that building from CVS requires
7477   `./configure --enable-maintainer-mode' (or use bootstrap).
7479 * HACKING: Added notes about using "using", and pointers to a couple of useful
7480   C++ web resources.
7482 portability:
7484 * Solaris: Code tweaks for compiling with Sun's C++ compiler.
7486 * IRIX: Code tweaks for compiling with SGI's C++ compiler.
7488 * NetBSD mkdir() doesn't cope with a trailing / on the path - fixed our code to
7489   cope with this.
7491 * mingw/cygwin: Only use O_SYNC (on the debug log) if the headers define it.
7493 * backends/quartz/quartz_table_manager.cc: Fix for building on mingw.
7495 * mingw: Added configure test for link() to avoid infinite loop in our C++
7496   wrapper for link.
7498 * mingw and cygwin both need -Wl,--enable-runtime-pseudo-reloc passing when
7499   linking.  Arrange for xapian-config to include this, and check that the ld
7500   installed is a new enough version (or at least that it was at configure
7501   time).  Also pass to programs linked as part of the xapian-core build.
7503 * cygwin: Close a QuartzDatabase or QuartzWritableDatabase before trying to
7504   overwrite it - cygwin doesn't allow use to delete open/locked files...
7506 * backends/quartz/quartz_termlist.cc: Use Xapian::doccount instead of
7507   unsigned int in set_entries().
7509 * Database::Internal::Internal::keep_alive() should be
7510   Database::Internal::keep_alive().
7512 * Make Xapian::Weight::Weight() protected rather than private as we want to be
7513   able to call it from derived classes (GCC 3.4 flags this, other compilers
7514   seem to miss it).
7516 debug code:
7518 * Open debug log with flag O_WRONLY so that we can actually write to it!
7520 * backends/quartz/quartz_values.cc: Fixed problem with dereferencing
7521   a pointer to the end of a string in debug output.
7523 Xapian 0.7.5 (2003-11-26):
7525 API:
7527 * Xapian::QueryParser now supports prefixes on phrases and expressions (e.g.
7528   author:(twain OR poe) subject:"space flight").
7530 * Added missing default constructors for TermIterator, PostingIterator, and
7531   PositionIterator classes.
7533 * Fixed PositionIterator assignment operator.
7535 testsuite:
7537 * queryparsertest: Added testcase for new phrase and expression prefix support.
7539 * apitest: Added regression tests for API fixes.
7541 backends:
7543 * quartzcompact: Fix the name that the meta file gets copied to (was
7544   /path/to/dbdirmeta rather than /path/to/dbdir/meta).
7546 build system:
7548 * Changed to using AM_MAINTAINER_MODE.  If you're doing development work on
7549   Xapian itself, you should configure with "--enable-maintainer-mode" and
7550   ideally use GNU make.
7552 * Fixed configure test for fdatasync to work (I suspect a change in a recent
7553   autoconf broke it as it relied on autoconf internal naming).
7555 * Fully updated to reflect move of libbtreecheck.la from backends/quartz
7556   to testsuite.  btreetest and quartzcheck should build correctly now.
7558 documentation:
7560 * Added first cut of documentation for Xapian::QueryParser query syntax.
7562 * Fixed incorrectly formatted doxygen documentation comments which resulted in
7563   some missing text in the collated API and internal classes documentation.
7565 * Documented --enable-maintainer-mode and problems with BSD make in HACKING.
7567 * Fixed typo in docs/scalability.html.
7569 * PLATFORMS: Updated from the tinderbox.
7571 omega:
7573 * omega: Parsing of the probabilistic query is now delayed until we need some
7574   information from it.  This means that we can now use options set by the
7575   omegascript template to control the behaviour of the query parser.
7576   $set{stemmer,...} now controls the stemming language (e.g. $set{stemmer,fr})
7577   and $setmap{prefix,...} now sets the QueryParser prefix map (e.g.
7578   $setmap{prefix,subject,XT,abstract,XA}).
7580 * omega: Fixed $setmap not to add bogus entries.
7582 * docs/omegascript.txt: Expanded documentation of $set and $setmap to list
7583   values which Omega itself makes use of.
7585 * omega: Cleaned up the start up code quite a bit.
7587 * omega: Removed the unfinished code for caching omegascript command
7588   expansions.  Added code to cache $dbsize.  The only other value correctly
7589   marked for caching is already being cached!
7591 Xapian 0.7.4 (2003-10-02):
7593 API:
7595 * Fixed small memory leak if Xapian::Enquire::set_query() is called more than
7596   once.
7598 * Xapian::ESet now has reference counted internals (library interface version
7599   bumped because of this).
7601 * Removed unused OmDocumentTerm::termfreq member variable.
7603 * OmDocumentTerm ctor now takes wdf, and replaced set_wdf() with inc_wdf() and
7604   dec_wdf().
7606 * Removed unused open_document() method from SubMatch and derived classes.
7608 * Calls made by the matcher to Document::Internal::open_document() now use the
7609   lazy flag provided for precisely this purpose, but apparently never used -
7610   this should give quite a speed boost to any matcher options which use values
7611   (e.g. sort, collapse).
7613 testsuite:
7615 * Finished off support for running tests under valgrind to check for memory
7616   leaks and access to uninitialised variables.
7618 * apitest: Sped up deldoc4.
7620 * btreetest: Removed superfluous `/'s from constructed paths.
7622 * quartztest: adddoc2 now checks that there weren't any extra values created.
7624 backends:
7626 * quartz: don't start the document's TermIterator from scratch on every
7627   iteration in replace_document().  Should be a small performance win.
7629 * quartz: Pass 0 for the lexicon/postlist table when creating a termlist just
7630   to find the doc length.
7632 * quartz: quartz_table_entries.cc: Removed rather unnecessary use of
7633   const_cast.
7635 * quartz: quartz_table.cc: Removed unused variable.
7637 * quartz: Improved encapsulation of class Btree.
7639 build system:
7641 * libbtreecheck.la now has an explicit dependency on libxapian.la.
7643 * We now set the dependencies for libxapian correctly so that linking
7644   applications will pull in other required libraries.
7646 * matcher/Makefile.am: Ship networkmatch.cc even if "make dist" is run from a
7647   tree with the remote backend disabled.
7649 * configure.in: Sorted out tests for gethostbyname and gethostbyaddr using
7650   standard autoconf macros.
7652 * configure.in: If fork is found, but socketpair isn't, automatically disable
7653   the remote backend rather than configure dying with an error.
7655 * autoconf/: Removed various unused autoconf macros.
7657 portability:
7659 * xapian-config.in: Link with libxapianqueryparser before libxapian, since
7660   that's the dependency order.
7662 * Removed or replaced uses of <iostream> and <iosfwd> in the library sources
7663   - we don't need or want the library to pull in cin and friends.
7665 * extra/queryparser.yy: Fixed to build with Sun's C++ compiler.
7667 * Make the dummy source file C++ rather than C so that automake tells libtool
7668   that this is a C++ library - vital for correct linking on some platforms.
7670 * Makefile.am: Pass -no-undefined to libtool so that we can build build a DLL
7671   on MS Windows.
7673 * configure.in: Fixed check for socketpair - we were automatically disabling
7674   the remote backend on platforms where socketpair is in libsocket
7675   (such as Solaris).
7677 * Use O_BINARY for binary I/O if it exists.
7679 * common/utils.h: mkdir() only takes one argument on mingw.
7681 * common/utils.h,testsuite/backendmanager.cc: Touch file using open() rather
7682   than system().
7684 * common/utils.cc: Fixed to compile if snprintf isn't available.
7686 documentation:
7688 * docs/scalability.html: Fixed slip (32GB should be 32TB);  Added note about
7689   Linux 2.4 and ext2 filesize limits.
7691 * PLATFORMS: Updated.
7693 * NEWS: Fixed a few typos.
7695 bindings:
7697 * xapian.i: using namespace std in SWIG parsed segment to sort out typemaps.
7699 packaging:
7701 * Updated RPM packaging.
7703 omega:
7705 * omega: $topdoc now ensures the match has been run; $date no longer ensures
7706   the match has been run.
7708 * omega: Fixed to build with Sun's C++ compiler.
7710 Xapian 0.7.3 (2003-08-08):
7712 API:
7714 * MSetIterator: Fixed MSetIterator::get_document() to work when get_mset() was
7715   called with first != 0 (regression test msetiterator3).
7717 testsuite:
7719 * internaltest: Changed test exception1 to actually test something (hopefully
7720   what was originally intended!)
7722 * Added long option support to the testsuite programs (and quartzdump).
7724 * Testsuite now builds on platforms for which we use our own stringstream
7725   implementation.
7727 * Only use \r in test output if the output is a tty.
7729 * Increased default timeout used by tests running on the remote backend from 10
7730   seconds to 5 minutes to avoid tests failing just because the machine running
7731   them is slow and/or busy.
7733 * Fixed check for broken exception handling - we were getting "Xapian::"
7734   prefixed to one version and not on the other.
7736 * tests/runtest: Set srcdir if it isn't already to make it easy to manually run
7737   test programs from a VPATH build.
7739 * apitest: Check termfreq in allterms4.
7741 backends:
7743 * quartz: Fixed allterms TermIterator to not give duplicate terms when a
7744   posting list is chunked; added regression test (allterms4).
7746 * quartz: Check for EINTR when reading or writing blocks and retry the
7747   operation.  This should mean quartz won't fail falsely if a signal is
7748   received (e.g. if alarm() is used).
7750 build system:
7752 * Renamed libomqueryparser to libxapianqueryparser - for backward compatibility
7753   we still provide a library with the old name for now.
7755 * xapian.m4: Added XO_LIB_XAPIAN to replace OM_PATH_XAPIAN.  XO_LIB_XAPIAN will
7756   automagically enable use of "xapian-config --ltlibs" if A[CM]_PROG_LIBTOOL is
7757   used in configure.in.
7759 * xapian-config: Now supports linking with libtool - using libtool means that
7760   the run-time library path is set and that you can now link with an
7761   uninstalled libxapian.  Also xapian-config will now work once xapian-core's
7762   configure has been run, rather than only after "make all".
7764 * xapian-config: Now automatically tries to link libxapianqueryparser too.
7766 * bootstrap: Removed bootstrap scripts in favour of top-level bootstrap which
7767   creates a top-level configure you can optionally use to configure all checked
7768   out Xapian modules with one command, and which creates a top level Makefile
7769   to build all checked out Xapian modules with one command.
7771 * Added versioning information to libxapian and libxapianqueryparser.
7773 * xapian-example/omega: Use libtool and XO_LIB_XAPIAN so we can link with an
7774   uninstalled Xapian, and so the run time load path gets built into the
7775   binaries (no need to set LD_LIBRARY_PATH just because you install Xapian with
7776   a non-standard prefix).
7778 * configure: Stop the API documentation from being regenerated when
7779   include/xapian/version.h changes (since it's generated by configure).
7781 * Fixed "make dist" in VPATH builds.
7783 portability:
7785 * common/getopt.h: #include <stdlib.h>, <stdio.h>, and <unistd.h> before
7786   defining getopt as a macro - this avoids problems with clobbering prototypes
7787   of getopt() in system headers.
7789 * bin/quartzcompact.cc: Need stdio.h for rename().
7791 * languages/Makefile.am: Fixed compilation for compilers other than GCC.
7793 * Moved rset serialisation into a method of RSet::Internal, so
7794   omrset_to_string() is now just glue code.  This eliminates the need for it to
7795   be a friend of RSet::Internal which Sun's C++ compiler didn't seem to be able
7796   to cope with.
7798 documentation:
7800 * Fix incorrect documentation comment for Enquire::set_set_forward().  (Looked
7801   like a cut&paste error)
7803 * COPYING: Updated FSF address, and reinstated missing section: "How to Apply
7804   These Terms to Your New Programs"
7806 * PLATFORMS: Updated some linux results: RH7.3 on x86, and Debian on alpha and
7807   arm; Updated FreeBSD success report; Updated with results from the tinderbox.
7809 * docs/mkdoc.pl: Don't choke on a comment at the end of the DIST_SUBDIRS line
7810   in a Makefile.am.
7812 * HACKING: Improved note about why libtool 1.5 is needed.
7814 * HACKING: Added note about additional tools needed for building a
7815   distribution.
7817 bindings:
7819 * Fixed VPATH builds.
7821 * python: Fixed to link with libomqueryparser.
7823 * guile,tcl8: Updated typemaps to SWIG 1.3 style.
7825 omega:
7827 * omindex.cc: Added missing `#include <errno.h>'.
7829 * omindex/scriptindex: Fixed signed character issue in accent normalisation.
7831 * omindex: fixed memory and file descriptor leak on indexing a zero-sized file.
7833 * omindex: Fixed sense of test for unreadable files.
7835 * omindex: Improved log messages to distinguish re-indexed/added.
7837 * omindex,omega,scriptindex: Fixed to compile with mingw.
7839 * omindex: Fixed to compile with GNU getopt so we can build on non-glibc
7840   platforms.
7842 examples:
7844 * msearch: Quick fix to get mingw building going.
7846 * getopt: Copied over our fixes for better C++ compatibility.
7848 * simplesearch: Stem search terms.
7850 * simpleindex: Fixed not to run words together between lines.
7852 * simpleindex: Create database if it doesn't exist.
7854 Xapian 0.7.2 (2003-07-11):
7856 testsuite:
7858 * Fixed NULL pointer dereference when a test threw an unexpected exception.
7860 backends:
7862 * Quartz: When asked to create a quartz database, try to create the directory
7863   if it doesn't already exist.  Then we don't have to do it in every single
7864   Xapian program which wants to create a database...
7866 portability:
7868 * common/getopt.h: Fixed to work better with C++ compilers on non-glibc
7869   platforms.
7871 * common/utils.h: missing #include <ctype.h>
7873 * Quartz: Defined _XOPEN_SOURCE=500 for GLIBC so we get pread() and pwrite().
7875 * common/utils.h: Improved mingw implementation of rmdir().
7877 documentation:
7879 * PLATFORMS: Added MacOS X 10.2 success report.
7881 * Improvements to doxygen-generated documentation.
7883 bindings:
7885 * Moved to separate xapian-bindings module.
7887 * Added configure check for SWIG version (require at least 1.3.14).
7889 * bindings/swig/xapian.i: Fixed over-enthusiastic automatic conversion of
7890   termname to std::string.
7892 * PHP4 bindings much closer to working once again; updated guile and tcl8
7893   somewhat.
7895 omega:
7897 * omega: If the same database is listed more than once, only search the first
7898   occurrence.
7900 * omega: use snprintf to help guard against buffer overflows.
7902 Xapian 0.7.1 (2003-07-08):
7904 testsuite:
7906 * Fixed testsuite programs to not try to use "rm -rf" under mingw.
7908 backends:
7910 * Quartz: Use pread() and pwrite() on platforms which support them.  Doing so
7911   avoids one syscall per block read/write.
7913 * Quartz block count is now unsigned, which should nearly double the size of
7914   database for a given block size.  Not tested this yet.
7916 omega:
7918 * omindex: Fixed compilation problem in 0.7.0.
7920 documentation:
7922 * Added new document discussing scalability issues.
7924 * PLATFORMS: Updated.
7926 Xapian 0.7.0 (2003-07-03):
7928 API:
7930 * Moved everything into a Xapian namespace, which the main header now being
7931   xapian.h (rather than om/om.h).
7933 * Three classes have been renamed for better naming consistency:
7934   OmOpeningError is now Xapian::DatabaseOpeningError, OmPostListIterator is
7935   now Xapian::PostingIterator, and OmPositionListIterator is now
7936   Xapian::PositionIterator.
7938 * xapian.h includes <iosfwd> rather than <iostream> - if you were relying on
7939   the implicit inclusion, you'll need to add an explicit "#include <iostream>".
7941 * Replaced om_termname with explicit use of std::string - om_termname was just
7942   a typedef for std::string and the typedef doesn't really buy us anything.
7944 * Older code can be compiled by continuing to use om/om.h which uses #define
7945   and other tricks to map the old names onto the new ones.
7947 * Define XAPIAN_VERSION (e.g. 0.7.0), XAPIAN_MAJOR_VERSION (e.g. 0), and
7948   XAPIAN_MINOR_VERSION (e.g. 7).
7950 * Updated omega and xapian-examples to use Xapian namespace.
7952 queryparser:
7954 * Xapian::QueryParser: Accent normalisation added; Improved error reporting;
7955   Fixed to handle the most common examples found in the wild which used to give
7956   "parse error".
7958 bindings:
7960 * Python bindings brought up to date - use ./configure --enable-bindings to
7961   build them.  Requires Python >= 2.0 - may require Python >= 2.1.
7963 * Enabled optional building of bindings as part of normal build process.  Old
7964   Perl and Java bindings dropped; for Perl, use Search::Xapian from CPAN; Java
7965   JNI bindings will be replaced with a SWIG-based implmentation.
7967 internal implementation changes:
7969 * Removed one wrapper layer from the internal implementation of most API
7970   classes.
7972 * Xapian::Stem now uses reference counted internals.
7974 * Internally a lot of cases of unnecessary header inclusion have been removed
7975   or replaced with forward declarations of classes.  This should speed up
7976   compilation and recompilation of the Xapian library.
7978 * Suppress warnings in Snowball generated C code.
7980 * Reworked query serialisation in the remote backend so that the code is now
7981   all in one place.  The serialisation is now rather more compact and no longer
7982   relies on flex for parsing.
7984 testsuite:
7986 * Moved all the core library tests to tests subdirectory.
7988 * apitest now allows backend to be specified with "-b" rather than having to
7989   mess with environmental variables.
7991 * Testsuite programs can now hook into valgrind for leak checking, undefined
7992   variable checking, etc.
7994 backends:
7996 * Fixed parsing of port number in remote stub databases.
7998 * Quartz: Improved error message when asked to open a pre-0.6 Quartz database.
8000 * Quartz backend: Workaround for shared_level problem turns out to
8001   be arguably the better approach, so made it permanent and tidied up
8002   code.
8004 build system:
8006 * Build system fixed to never leave partial files in place of the expected
8007   output if a build is interrupted.
8009 * quartzcheck, quartzdump, and quartzcompact are now built by "make" rather
8010   than only by "make check".
8012 * xapian-config: Removed --prefix and --exec-prefix - you can't reliably
8013   install Xapian with a different prefix to the one it was configured with,
8014   yet these options give the impression you can.
8016 miscellaneous:
8018 * Fixed sending debug output to a file with XAPIAN_DEBUG_LOG with a value which
8019   didn't contain "%%" (%% expands to the current PID).
8021 * Fixed Xapian::MSetIterator::get_collapse_count() to work as intended.
8023 omega:
8025 * omindex,scriptindex: Normalise accents in probabilistic terms.
8027 * omindex: Read output from pstotext and pdftotext via pipes rather
8028   than temporary files to side-step the whole problem of secure temporary file
8029   creation; Use pdfinfo to get the title and keywords from when indexing a PDF;
8030   Safe filename escaping tweaked to not escape common safe punctuation.
8032 * omindex: Implement an upper limit on the length of URL terms - this is a
8033   slightly conservative 240 characters.  If the URL term would be longer than
8034   this, its last few bytes are replaced by a hash of the tail of the URL.  This
8035   means that (apart from hopefully very rare collisions) urlterms should still
8036   be unique ids for documents.  This is forward and backward compatible for
8037   URLs less than 240 characters.
8039 * omindex: Clean up processing of HTML documents:
8040   - Ignore the contents of <script> and <style> tags in HTML.
8041   - Strip initial whitespace in each tag in an HTML document.
8042   - Try not to split words in half when truncating title and summary.
8044 * query.cc: Set STEM_LANGUAGE near the start of the file so it's easy
8045   for users to change until we get better configurability.
8047 * omega: Replaced half-hearted logging support with flexible OmegaScript-based
8048   approach with new $log command.  Also added $now to allow the current
8049   date/time to be logged.
8051 * templates/xml: added collapse info to xml template.
8053 documentation:
8055 * Assorted minor documentation improvements.
8057 * PLATFORMS: Updated.
8059 rpms:
8061 * Improved RPM packaging of xapian-core and omega.
8063 Xapian 0.6.5 (2003-04-10):
8065 * OmEnquire: optimised the handling when sort_bands == 1 and fixed incorrect
8066   results in this and some other sorting cases; added some sorting testcases.
8068 * OmMSetIterator: added get_collapse_count() which returns a lower bound on
8069   the number of items which were removed by collapsing onto the current item.
8071 * OmStem: added default OmStem constructor and "none" language.  Both of these
8072   give a stemmer object which leaves terms unchanged which should allow for
8073   simpler logic in programs using Xapian.  The default constructor also removes
8074   the need to mess with pointers in some cases.
8076 * Automatically disable the remote backend if we don't have fork() since the
8077   remote backend requires it in several places.
8079 * Fixed to build with debug enabled.
8081 * testsuite: fixed to still build when some backends are disabled.
8083 * extra/parsequerytest.cc: Fixed to build with GCC 2.95.
8085 * Testsuite: Added regression test for Quartz bug which caused problems with
8086   long terms on machines with signed chars.
8088 * testsuite/index_utils.cc: Handling of ^x was just downright wrong due to a
8089   typo.
8091 * Improved portability: Fix for 64 bit machines.  Fixed btreetest to build with
8092   older compilers lacking <sstream>.  Xapian is now much closer to building
8093   with Sun's CFront-based Sun Pro C++ compiler, and with a Linux to mingw
8094   cross-compiler.
8096 * PLATFORMS: Updated with the results of many test builds.
8098 * Improved RPM packaging of xapian-core and omega.
8100 * Documentation: Use http://www.doxygen.org/ as URL for doxygen; Fixed bad link
8101   to our own website in overview.html; code_structure.html now only includes
8102   directories in the build system.
8104 * HACKING: updated.
8106 * Removed bugs/todo.xml, TODO, TODO.release, docs/todo.html, and
8107   docs/todo-release.html from the distribution.  Bugs and todo items will be
8108   tracked in Bugzilla instead.
8110 * Install docs in /usr/share/doc/xapian-core instead of /usr/share/xapian-core.
8112 * omega: If xP and P are both empty, there may be a boolean query, so don't
8113   force first page of hits.
8115 * omega: Fixed off-by-one error in rounding down topdoc - it was possible to
8116   get to an empty page of hits if there were exactly a multiple of HITSPERPAGE
8117   matches and the matcher over-estimated the number of matches and Omega
8118   displayed page links.
8120 * omega: Fixed handling of multiple DB parameters to be as documented.
8122 * omega: Added $collapsed to report get_collapse_count() for the current hit.
8124 * omega: Added $transform{} which does regexp manipulation (currently disabled
8125   until configure tests for regexp library are added)
8127 * omega: Added $uniq{} to eliminate duplicates from a sorted list.
8129 * omega: Don't force page 1 for a query with repeated terms!
8131 * omega: removed duplicates from terms listed in term frequencies.
8133 * omega: Added cgi parameter COLLAPSE to collapse on key values
8135 * omega: Added $value{key[,docid]} support to omegascript
8137 * omega: Renamed DATE1, DATE2, and DAYSMINUS to the more meaningful START, END,
8138   and SPAN (NB SPAN is days before END, or after START, or before today -
8139   whereas SPAN was before *DATE1* or before today).  The old parameters names
8140   are supported (with the original semantics) for now.
8142 * omega: Actually install documentation!
8144 * templates/query: propagate B boolean filters
8146 * templates/godmode: removed link to EuroFerret image
8148 * templates/godmode: added value dumping, for values from 0-255
8150 * omindex: Report correct version number (was hard-wired to 1.0!)
8152 * scriptindex: Allow '_' in fieldnames.  Diagnose bad characters in fieldnames
8153   better.
8155 * dbi2omega: Added DBUSER and DBPASSWD environmental variable support so that
8156   password protected DBs can easily be used
8158 * scriptindex.cc: added missing "#include <stdio.h>" which caused builds
8159   to fail for some platforms.
8161 Xapian 0.6.4 (2002-12-24):
8163 * Quartz backend: Fixed double setting of position list when updating a
8164   document with term position information (overall result was correct, just
8165   inefficient); when deleting a position_list, don't check if it's empty,
8166   just ask the layer below to delete it and let it handle the case when
8167   there's nothing to delete; Fixed unpacking of termlist on platforms where
8168   char is signed.
8170 * OmQueryParser: Added support for searching probabilistic fields (using
8171   <field>:<term>); the unstem multimap now includes "." on the end of a
8172   term if it was there in the query.
8174 * Don't include "om.h" as a dependency for the api docs since it's generated
8175   a configure time and the dependency was forcing users to regenerate the
8176   documentation, which requires doxygen to be installed.
8178 * Bindings: Python bindings updated to work with the updated API (still
8179   disabled by default).
8181 * Muscat 3.6 backend: Fixed to build with the new database factory functions;
8182   fixed compilation warnings; Muscat 3.6 DA and DB databases don't support
8183   positional information.  Instead of throwing an exception when we try to
8184   access it, return an empty position list (like a quartz database with no
8185   position information would).  This allows copydatabase to be used to convert
8186   a Muscat 3.6 database to a quartz one.
8188 * Documentation: quartzdesign and todo list updated.
8190 * quartzcheck: default mode changed to "v" rather than "+", since "+" is too
8191   verbose for a btree of any size; if you pass a quartz database directory,
8192   quartzcheck will now check all the tables which make up a quartz database.
8194 * quartzcompact: new tool which makes a copy of a quartz database with full
8195   compaction turned on - this results in a smaller database which is faster
8196   to search.  The next update will result in a lot of block splitting though
8197   (since all blocks are as full as possible).
8199 * omega: Added $unstem to map a stemmed term to the form(s) used in the query;
8200   $queryterms now only includes the first occurrence of each stemmed form;
8201   $prettyterm makes use of the unstem map; prefer MINHITS to MIN_HITS and
8202   RAWSEARCH to RAW_SEARCH since none of the other CGI parameter names have
8203   _ separating words (continue to support old names for now); fixed default
8204   template to not generate topterms twice, and fixed topterms to not stick
8205   outside the green box; corrected omegascript docs - it's $setrelevant
8206   not $set_relevant.
8208 * scriptindex: index=nopos with new indexnopos action; index and indexnopos now
8209   take an optional prefix argument; index=nopos is handled specially for
8210   backwards compatibility; added new data action to generate terms for date
8211   range searching.
8213 Xapian 0.6.3 (2002-12-14):
8215 * Updated PLATFORMS and todo list.  Noted in HACKING that Bison 1.50 seems to
8216   work with Xapian.
8218 * OmQueryParser now creates an "unstem" multimap to allow probabilistic
8219   query terms to be converted back to the form the user originally typed.
8221 * Updated documentation for remote protocol description and the quickstart
8222   tutorial which were both very out of date.
8224 * No longer use OmSettings to pass matcher parameters.  This completes the
8225   removal of OmSettings.
8227 * Added workaround for problem with cursors sharing levels in the btree.
8228   This should fix sporadic problems with large databases (small databases
8229   have fewer btree levels so aren't affected).
8231 * Stub databases now work again, though with a different format.  The new
8232   format allows multiple databases to be specified in the stub file.
8234 * OmEnquire::get_eset() now takes a flags argument of bit constants |-ed
8235   together instead of 2 bools.
8237 * Applied Martin Porter's better fix for the btree sequential addition bug
8238   which Richard fixed a few months ago.  Richard's fix resulted in a correct
8239   btree, but didn't always utilise space as efficiently as possible.
8241 * Fixed the remote backend to handle weighting schemes after the OmSettings
8242   changes.  You can now even implement your own weighting scheme and use it
8243   with the remote backend provided you register it with SocketServer at
8244   runtime (this feature has been on the todo list for ages).
8246 Xapian 0.6.2 (2002-12-07):
8248 * Set env var XAPIAN_SIG_DFL to stop the testsuite installing its
8249   signal handler (may be useful with some debugging tools).
8251 * backends/quartz/btree.cc: max_item_size wasn't being set due to
8252   some over-zealous code pruning.  It was defaulting to 0, and
8253   was causing the code to write off the end of allocated memory
8254   blocks.
8256 * matcher/localmatch.cc: fixed handling of wtscheme() - we were
8257   trying to use it for the extra weights, and then double
8258   deleting it!
8260 * common/omdebug.cc,common/omdebug.h: Fixed permissions on newly
8261   created log file (was getting 000!); Simplified class internals;
8262   Renamed env vars: OM_DEBUG_FILE is now XAPIAN_DEBUG_LOG,
8263   OM_DEBUG_TYPES is now XAPIAN_DEBUG_FLAGS (old versions still work
8264   for now).
8266 * testsuite/testsuite.cc: Fixed so running "gdb .libs/apitest"
8267   finds srcdir (for an in-tree build at least).
8269 * Fixed to compile with --enable-debug=full.
8271 * docs/remote.html: Updated from OmSettings to factory functions.
8273 * PLATFORMS: ixion is actually Linux 2.2.
8275 * OmWritableDatabase now has a default constructor.
8277 * Weighting scheme now specified by passing OmWeight object to OmEnquire.
8278   This also allows user weighting schemes (just subclass OmWeight and
8279   pass in an instance of this new class).  [This doesn't currently work
8280   with the remote backend.]
8282 * No longer use OmSettings to specify parameters for constructing databases.
8283   Instead there's a factory function for each database type - temporary naming
8284   scheme is OmXxx__open(), mostly because it's easy to grep for later.
8285   Instead of create and overwrite flags, we pass in a value - a new possible
8286   opening mode is "create or open".  [At present stub databases and the
8287   machinery in InMemory to allow the multierrhandler1 test aren't working.
8288   Everything else should be.]
8290 * OmEnquire::get_eset() takes parameters instead of an OmSettings object.
8292 * Fixed reversed sense of use_query_terms (and fixed reversed sense test in
8293   apitest which meant this wasn't spotted).
8295 * Documentation: Link to annotated class lists in doxygen generated
8296   documentation instead of the rather empty index pages; added doxygen
8297   markup so that apidoc now documents header files; updated todo list.
8299 * Documentation: intro doc thing was very out of date in places - fixed.
8301 * Omega: index .php files as HTML, with the PHP code stripped out; omindex
8302   return non-zero return code if an unexpected exception is caught; fixed
8303   HTML parser to not read one character past the end of the document in
8304   some cases; updated in line with OmSettings related changes to the API;
8305   Fixed $dbname to return "default" for the default database instead of "";
8306   templates/query: Removed now unused xDEFAULTOP hidden field, and superfluous
8307   "}"; dbi2omega now more efficient and can be restricted to listed fields.
8309 Xapian 0.6.1 (2002-11-28):
8311 * Fixed to compile with GCC 3.0.
8313 * PLATFORMS: Updated.
8315 Xapian 0.6.0 (2002-11-27):
8317 * Quartz database backend: lexicon disabled (./configure CXXFLAGS=-DUSE_LEXICON
8318   to reenable it), and encoding schemes simplified and made more compact;
8319   extended and added test cases; minimum block size is now 2048 bytes (as
8320   documented before, but now we actually enforce this); btree checking code
8321   split off and only linked in when required; tidied up btreetest's output.
8323 * Replaced our stemmers with those from Snowball.  These give better results,
8324   and are actively maintained by Martin Porter (who wrote the original Xapian
8325   stemmers too).  It also means that Xapian now has stemmers for Finnish,
8326   and Russian, and an implementation of Lovins' English stemmer.
8328 * Assorted improvements to the documentation, especially the documentation
8329   of the internals of the Quartz backend.
8331 * Removed the three uses of RTTI (typeid() and dynamic_cast<>) - one was
8332   totally superfluous, and the other two easily avoided.
8334 * Omega and simpleindex example: limit probabilistic term length to 64
8335   characters to stop the index filling up with junk terms which nobody will
8336   ever search for.
8338 * Omega: Added dbi2omega perl script to dump any database which perl DBI can
8339   access into the dump format expected by scriptindex.
8341 Xapian 0.5.5 (2002-12-04):
8343 * Fixed compilation with --enable-debug.
8345 * Minor documentation updates.
8347 * Omega: Fixed paging on default database; removed xDEFAULTOP from the query
8348   template as it's no longer used; removed bogus unmatched '}' from query
8349   template; added dbi2omega perl script to dump any database which perl DBI
8350   can access into the dump format expected by scriptindex; limit length of
8351   probabilistic terms generated to 64 characters.
8353 Xapian 0.5.4 (2002-10-16):
8355 * Fixed a compilation error with "make check" when using GCC 3.2.
8357 * PLATFORMS: checked 0.5.3 works on OpenBSD and Solaris 7.
8359 Xapian 0.5.3 (2002-10-12):
8361 Notable changes: Improvements to the test suite, and internal code cleanups:
8363 * Internal code cleanups on Quartz Btree implementation.
8365 * Minor documentation updates (TODO and PLATFORMS updated; Martin Porter's
8366   stemming paper removed - see the Snowball site for background stemmer
8367   info).
8369 * Implemented QuartzAllTermsList::get_approx_size().
8371 * Removed a couple of occurrences of "using std::XXX;" from externally
8372   visible headers.
8374 * With GCC, add warning flags "-Wall -W" rather than "-Wall -Wunused" (-Wall
8375   implies -Wunused anyway).  Fixed all the warnings this throws up, except in
8376   languages/ (that code is to be replaced with Snowball soon).
8378 * Test suite: Disable colour test output if stdout isn't a terminal and
8379   reworked check for broken exception handling as the previous  version never
8380   seemed to fire.  Other assorted minor improvements.
8382 * include/om/om.h is now removed on "make distclean" rather than "make clean".
8384 Xapian 0.5.2 (2002-10-06):
8386 Further improvements to documentation and portability:
8388 * docs/: converted all text docs to HTML (except omsettings which will
8389   has odd markup (LaTeX?) and will probably soon be obsolete anyway).
8391 * remote backend: Fixed handling of timeouts which are now in the past - fixes
8392   test failures with redhat/x86.
8394 * quartz backend: now works on 64 bit platforms.
8396 * test suite: try to spot mishandled exceptions and stop them causing bogus
8397   OMEXCEPT failures.
8399 Xapian 0.5.1 (2002-10-02):
8401 This release fixes features improved documentation and some build system
8402 portability fixes.
8404 * PLATFORMS: updated with more test results.
8406 * docs/: tidied up layout of HTML documentation; converted the notes about
8407   BM25 into HTML; updated stemmer docs to reflect intention to use Snowball
8408   instead; included HTML versions of quickstart*.cc.
8410 * automake 1.6.3 and autoconf 2.54 are now required for those working
8411   from CVS to fix a problem with the generated Makefiles and Solaris
8412   make.
8414 * net/Makefile.am: Fixed building of readquery.cc from readquery.ll.
8416 * buildall script is now deprecated - use the new streamlined bootstrap script
8417   in preference.
8419 Xapian 0.5.0 (2002-09-20):
8421 The last release of the software that is now known as Xapian was OmSee 0.4.1 on
8422 November 24th 2000, not far from 2 years ago.
8424 There's been a significant amount of development in this time, so we've
8425 summarised the most notable changes and improvements:
8427   * The project is now called "Xapian". We've renamed the modules in the light
8428     of this change:
8430       + "om" is now "xapian-core"
8431       + "om-examples" is now "xapian-examples", and now contains small,
8432         instructive examples which demonstrate how to use Xapian to implement
8433         particularly features.
8434       + Added "xapian-applications" which contains larger sample applications
8436   * Much improved build system - should now build "out of the box" on many Unix
8437     platforms. Can now VPATH build with vendor tools on most platforms. Builds
8438     as cleanly as we can achieve with GCC 2.95.* (some bogus warnings due to
8439     compiler bugs). Should build without warnings on GCC 3.0, 3.1, and 3.2.
8441   * If using GCC, om/om.h now contains a check that the compiler used to build
8442     Xapian and the compiler used to build the application have compatible C++
8443     ABIs. So you get a clear error message early from the first attempt to
8444     compile a file rather than a confusing error from the linker near the end
8445     of the build.
8447   * RPM packages are now available. We intend to prepare Debian packages in the
8448     near future too.
8450   * xapian-config no longer support "--uninst". It's hard to make this work
8451     reliably and portably, and the effort is better expended elsewhere.
8452     Configure with a prefix and install to a temporary directory instead.
8454   * Xapian can now work with files > 2Gb on OSes which support them.
8456   * Restructured and reworked documentation.
8458   * Removed thread locks. We intend to be "thread-friendly" so different
8459     threads can access different objects without problems. In the rare event
8460     that you want to concurrently call methods on the same object from
8461     different threads you need to create a mutex and lock it. Thus the thread
8462     lock overhead is only incurred when it's necessary.
8464   * Indexgraph removed from core library. It will reappear as an add-on library
8465     at some point.
8467   * Omega's query parser has now been reworked as a separate library.
8469   * Terminology change - "keys" are now known as "values" to avoid confusion,
8470     since they're not like keys in a relational database. The exception is when
8471     a value is used as a key in some operation, e.g. "match_collapse_key".
8473   * Database backends:
8475       + Auto backend: can now be used to create a new database.
8476       + Auto backend: added support for "stub" databases - a text file
8477         specifying the settings for the database to be opened (particularly
8478         useful for allowing easy access to specific remote databases).
8479       + Quartz backend: many fixes and improvements, and the code has been
8480         cleaned up a lot. Implemented deleting of items from postlists.
8481       + Remote backend: implemented term_exists() and get_termfreq();
8482       + Multi-backend: the document length is now fetched from the sub-postlist
8483         rather than the database, which provides a huge speed-up in some cases.
8484       + Sleepycat backend: this experimental backend has been removed.
8485       + Muscat 3.6 backends: now disabled by default.
8487   * Tests:
8489       + Test cases added for most bug fixes and new features.
8490       + stemtest: rewritten in C++ rather than part C++, part perl. Now 15%
8491         faster.
8492       + includetest: removed - it's no longer useful now the code has matured.
8493       + Removed problematic leak checking from testsuite. We plan to use
8494         valgrind instead soon.
8496   * Matcher:
8498       + Fixed several matcher bugs which could cause incorrect results in some
8499         situations.
8500       + Fix bug in expander due to nth_element being called on the wrong
8501         element.
8502       + Added sorting within relevance bands to the matcher.
8503       + Matcher now calculates percentages differently, such that 100%
8504         relevance is actually achievable.
8505       + Matcher now uses a min-heap rather than nth-element to maintain the
8506         proto-mset. This is cleaner and more efficient.
8507       + New operator OP_ELITE_SET replaces match_max_or_terms option.
8508       + Implemented multiple XOR queries.
8509       + Add a new query operator, OP_WEIGHT_CUTOFF, which returns only those
8510         documents from a query which have a weight greater than a specified
8511         cutoff value.
8512       + Removed OmBatchEnquire from system: it may return at a later date, but
8513         for now it is simply out of date and a maintenance liability, and
8514         gives no significant advantage.
8515       + Added experimental match bias functors.
8517   * The API has been cleaned up in various places:
8519       + OmDocumentContents and OmIndexDoc merged to become OmDocument
8520       + OmQuery interface cleaned up
8521       + OmData and OmKey removed - methods which used them now just pass a
8522         string instead
8523       + OmESetItem replaced by OmESetIterator; OmMSetItem by OmMSetIterator;
8524         om_termname_list by OmTermIterator
8525       + OmDocumentTerm and OmDocumentParams removed
8526       + OmMSet::mbound replaced by OmMSet::matches_
8527         {lower_bound,estimated,upper_bound}, giving more information
8528       + Xapian iterators now have default constructors
8529       + Most API classes now have reference counted internals, so assignment
8530         and copying are cheap
8531       + OmStem now has copy constructor and assignment operator
8532       + and more...