Reimplement Language Modelling weights
[xapian.git] / xapian-core / NEWS
blob739fa31686d0bab3be49c6727c0347b29b1e116a
1 Xapian-core 1.4.22 (2023-02-02):
3 testsuite:
5 * Expand canceltransaction1 to test value changes are rolled back.
7 matcher:
9 * Minor optimisations to DPHWeight and TfIdfWeight weighting formulae
10   calculations.
12 * Optimise LatLongDistancePostingSource to avoid pow() call on each document
13   with default k2 setting.
15 glass backend:
17 * Fix bug in recovery from WritableDatabase::commit() failing.
19   If renaming to switch the new version file live fails (e.g. due to the disk
20   being full) we discard the changes, try to write and switch to a different
21   new version file with an increased revision (on failure of this too we close
22   the database), then throw DatabaseError.
24   Unfortunately the roll-back of state is not complete, and if we successfully
25   switch to the different new version file then that bad state persists on
26   disk.
28   In order for this bug to manifest, repeating essentially the same operation
29   which just failed needs to succeed which seems more likely to be a happen
30   when using a filing system which has more sophisticated freespace handling
31   (the reporter was using btrfs), though it's possible with any FS if another
32   process frees up disk space in the small window between the two operations.
34   Thanks to Uwe Kleine-König for reporting and especially for coming up with an
35   easy way to reproduce.
37 build system:
39 * configure: Enable -fno-math-errno if supported.  We don't make use of maths
40   function setting errno and if we tell the compiler that it can optimise them
41   better in some cases.
43 documentation:
45 * INSTALL: Document assumptions about platform features
47 * INSTALL: Add section on clang version requirements.
49 Xapian-core 1.4.21 (2022-09-22):
51 glass backend:
53 * Avoid throwing InvalidArgument when searching for overlong terms in some
54   cases.  Such terms can't match, but are valid to query for.  Patch from
55   Robert Stepanek in https://github.com/xapian/xapian/pull/313.
57 chert backend:
59 * Avoid throwing InvalidArgument when searching for overlong terms in some
60   cases.  Such terms can't match, but are valid to query for.
62 build system:
64 * Clean up cygwin and mingw configure checks.  When we check $host_os, always
65   anchor at the start (e.g. cygwin* not *cygwin*), and check for msys* as well
66   since that's a derivative of cygwin and behaves similarly for the things
67   we're checking here.
69 * Update to use AX_CXX_COMPILE_STDCXX which is a replacement for
70   AX_CXX_COMPILE_STDCXX_11 (which we were using) which also supports newer C++
71   standards versions which will be useful.  For C++11 the only difference seems
72   to be that the macro now checks for attribute support - we use C++11
73   attributes so that seems a good thing.
75 documentation:
77 * INSTALL: Restructure MSVC section for clarity.
79 * INSTALL: Mention -D_FORTIFY_SOURCE=3 too (fairly new - requires GCC 12).
81 * Consistently say "macOS" not "Mac OS X", "OS X", etc.
83 * admin_notes.rst:
85   + Update locking section to cover Open File Description locks
87   + Add some discussion of block sizes (fixes #819, reported by mgautier)
89   + Fix cut-and-paste error - we were suggesting that the docdata table only
90     exists if there's positional data.  Noted by Gaurav Arora.
92   + Improve markup
94 examples:
96 * Stop using std::endl in examples since this seems to be C++ best practice
97   as it causes a flush of the stream, which is rarely actually wanted.  Also
98   often the replacement \n can be combined with a string literal.
100 portability:
102 * Stop trying to check for incompatible C++ ABI between the compiler used to
103   build xapian-core and the compiler used to build code using xapian-core.
105   This check was helpful in the GCC 3 days, but ABI versions 2 and up are
106   compatible aside from obscure corner cases, and GCC now defaults to using the
107   latest ABI version it supports.  The result is that this check is no longer
108   useful enough to justify the noise.
110   We still check for incompatible _GLIBCXX_DEBUG between the library and
111   application builds, since that will cause things not to work, and the normal
112   error message doesn't make it clear what's wrong.
114   Reported by David Bremner.
116 * Fix new warnings from GCC 12.
118 * Avoid undefined value use when unpacking a key in a corrupted glass docdata
119   table.  We now skip further checks on the entry in this case.
121 * Merge allocations in MSVC directory reading compatibility code so we can
122   allocate in a single malloc() call.
124 * Add accept() wrapper which checks an assumption that Microsoft's SOCKET type
125   only actually holds 32 bit values even in 64 bit platforms and throws an
126   exception if violated.
128 * Eliminate a use of sprintf.
130 * Squash some unhelpful MSVC deprecation warnings.
132 * Declare dummy invalid parameter handler noexcept to fix a warning from MSVC.
134 * Include <stdlib.h> in configure check for sys_errlist as that's where it is
135   with mingw and MSVC.
137 debug code:
139 * Fix debug logging for Xapian::Internal::intrusive_ptr<const T>.
141   GCC 12.2 warned about infinite recursion in the old version, and this seems
142   to be the case.  This code has been there a long time, but is only used when
143   debug logging is enabled.  It does seem to be used, so presumably nobody's
144   tried to log something which triggered it.
146 Xapian-core 1.4.20 (2022-07-04):
148 API:
150 * Throw DatabaseNotFoundError when the database directory doesn't exist or
151   when it doesn't contain a Xapian database.  Patch from Germán Méndez Bravo
152   in https://github.com/xapian/xapian/pull/258
154 * Improve exception message for attempting to remove an empty term (the
155   exception type is still InvalidArgumentError).  Reported by David Bremner.
157 testsuite:
159 * Enable queryparser testcase for OR under NEAR, which has been supported since
160   1.4.3.
162 * Expand some query-related testcases.
164 matcher:
166 * Optimise when a value range is a superset of the slot bounds but the value
167   slot frequency is not equal to the document count by replacing the lower
168   bound with an empty string to make the bounds check very cheap.
170 * Avoid creating a PostList tree for an empty shard.  This avoids pointless
171   work in an uncommon case, but also by handling this up front the code in
172   PostList subclasses for query operators can assume the shard isn't empty
173   which simplifies the code in several places.
175 * Remove lingering handling for database backends without slot bounds since
176   all backends have been required to support these since 1.4.11.
178 * Fix collection frequency estimates for positional operators.  This affects
179   the weighting of positional operators in subqueries of OP_SYNONYM with
180   weighting schemes which use the collection frequency.
182 glass backend:
184 * xapian-check: Test decompress data in the spelling and synonym tables.
185   We don't have structure checking for these tables, but we can at least fetch
186   each entry and check for decompression problems.
188 * Improve error if a block is detected as overwritten in WritableDatabase.
189   Drop "are there multiple writers?" as it's rarely a useful question to ask
190   since we started using fcntl() locking as it's now very hard to get multiple
191   concurrent writers on a database.  Instead suggest running xapian-check,
192   which is probably the best next step for a user who hits this problem.
194 documentation:
196 * Document precedence of NEAR and ADJ.
198 * INSTALL: Note that MSVS 2022 works.
200 tools:
202 * quest: Add --freqs option to show term frequencies.
204 * xapian-delve -v: Show value slot bounds and freq
206 portability:
208 * Fix to build with a C++20 compiler.
210 * configure now probes for a declaration of strerror_r() before using it, since
211   a declaration is required in C++ code.
213 * MSVC: Use intrinsics to implement addition with overflow check.
215 Xapian-core 1.4.19 (2021-12-31):
217 API:
219 * New QueryParser::FLAG_NO_POSITIONS flag.  With this flag enabled, any query
220   operations which would use positional information are replaced by the nearest
221   equivalent which doesn't (so phrase searches, NEAR and ADJ will result in
222   OP_AND).  This is intended to replace the automatic conversion of OP_PHRASE,
223   etc to OP_AND when a database has no positional information, which will no
224   longer happen in the release series after 1.4.
226 * Give a compile error for code which adds a Database to WritableDatabase.
228   Prior to 1.4.19, this compiled and effectively created a "black-hole" shard
229   which quietly discarded any changes made to it.
231   In 1.4.19 it's still possible to perform this operation by assigning the
232   WritableDatabase to a Database first, which is harder to fix.  This case
233   throws an exception on git master where it's easier to address.
235   Reported by David Bremner on #xapian.
237 * Fix TermIterator::skip_to() with sharded databases which sometimes was
238   failing to advance all the way to the requested term.  Uncovered while
239   addressing warning from GCC's -Wduplicated-cond, reported by dcb in #816.
241 * Clamp edit distance to one less than the length of the word we've been asked
242   to correct, which makes the algorithm we use more efficient.  We already
243   require suggestion to have at least one character in common, so the only
244   change to suggestions is we'll no longer suggest corrections which are
245   twice as long or longer even if the edit distance would allow it, which
246   seems like an improvement in itself.
248 * Minor optimisation expanding wildcards.
250 * PostingIterator::get_description(): For an all-docs iterator on a glass
251   database, get_description() would call get_docid() which isn't valid to
252   do once the iterator has reached the end.
254 testsuite:
256 * Expand allterms test coverage.
258 matcher:
260 * Fetch wdf upper bound from postlist which avoids an extra postlist table
261   cursor seek per weighted query term, and also means we now use a per-shard
262   wdf upper bound for local shards which will in typically give a tighter
263   weight upper bound which will tend to make various other matcher
264   optimisations more effective.  Eric Wong reported this speeds up a
265   particularly slow case from ~2 minutes to ~3 seconds.
267   With this change, OP_ELITE_SET can now select a different subset of terms for
268   each shard regardless of shard type (previously this only happened for remote
269   shards).
271 * Avoid triggering a pointless maximum weight recalculation if an unweighted
272   child of a MultiAndPostList prunes.
274 * Only check if the database has positional information when the query
275   uses positional information.  This should help improve notmuch delete
276   performance.  Thanks to andreas on #notmuch for analysis of the problem.
278 glass backend:
280 * Optimise Glass::Inverter::has_positions().  Use const auto& instead of just
281   auto for the loop variables.  Reported to be faster by andreas on #notmuch.
283 * Cache result of Glass::Inverter::has_positions() since calculating it is
284   potentially very expensive, while maintaining a cached answer is very cheap.
286 remote backend:
288 * Add missing closing parenthesis to reported remote prog context, which has
289   been missing since this code was first added over 20 years ago!  Spotted by
290   Gaurav Arora.
292 build system:
294 * Enable compiler option -fno-semantic-interposition if supported.
296   This GCC option allows the compiler to optimise essentially assuming
297   that functions/variables aren't replaced at dynamic link time.
299   Such replacement is not something that it's useful to do for Xapian
300   symbols, and we already turn on -Bsymbolic-functions by default which
301   prevents such replacement anyway by resolving references within the
302   library at build time.
304   Reduces the size of the stripped library on x86-64 Debian unstable by
305   ~1%, and likely makes it faster too.
307 * Avoid bogus deprecation warning when compiling with GCC without optimisation.
308   In this situation, GCC emits a deprecation warning for code in the definition
309   of QueryParser::add_valuerangeprocessor() which is provided for backwards
310   API compatibility even if this method is never used anywhere.
312   This isn't helpful, especially if the user is using -Werror, so disable the
313   -Wdeprecated-deprecations warning for this code.
315   Reported by starmad on #xapian.
317 * Fix GCC -Wmaybe-uninitialized warning.  The warning seems bogus as it's about
318   the this pointer being passed to a method which doesn't reference the object,
319   but we can just make the method static to avoid the warning, and that's
320   arguably cleaner for a method called from the object initialiser list.
322 * Automatically enable GCC warnings -Wduplicated-cond and -Wduplicated-branches
323   if using a GCC version new enough to support them.  The usefulness of
324   -Wduplicated-cond was highlighted by dcb in #816.
326 * Replace uses of obsolete autoconf macros, fixing warnings if configure is
327   regenerated with a recent release of autoconf.
329 * Simplify configure probe for sigsetjmp and siglongjmp.  Just probe
330   individually with AC_CHECK_DECLS and then check that both exist with a
331   preprocessor check.
333 * Update XO_LIB_XAPIAN to fix warning that AC_ERROR is obsolete with modern
334   autoconf.
336 * Support linking against static libxapian with cmake. Patch from Anonymous
337   Maarten in https://github.com/xapian/xapian/pull/317
339 * Clean up handling of libs we link libxapian with - previously any libraries
340   explicitly specified to configure by the user via LIBS=... as well as -lm
341   (if configure determined it was needed) could get added to XAPIAN_LIBS
342   multiple times, as well as also getting added to the libxapian link command
343   anyway by automake/libtool standard handling.
345   Specifying a library more than once on the link line is not a problem on
346   common platforms, but may be an issue somewhere (and it's on less common
347   platforms where the user is more likely to have to specify LIBS to configure
348   and/or where -lm may be needed).
350 documentation:
352 * configure: Add missing AC_ARG_VAR for all programs so that they are
353   documented in --help output, and so that autoconf knows they are "precious"
354   and preserves them if configure is rerun even when they're specified via an
355   environment variable.
357 * Don't use x^2 to mean x squared in API docs.  This is potentially confusing
358   since in C/C++ (and some other languages), ^ means exclusive-or.  Write x²
359   instead, which should be clear to all readers.
361 * Improve docs for Xapian::Stopper and SimpleStopper.
363 * docs/intro_ir.rst: Fixed an incorrect term index.  Patch from Jaak Ristioja
364   in https://github.com/xapian/xapian/pull/321.
366 * Update for the IRC channel move from freenode to libera.chat.
368 examples:
370 * quest: Don't enable spelling correction by default.  It was really only on by
371   default because the spelling correction support in quest was added before
372   --flags.  It seems more helpful for the default to match the
373   Xapian::QueryParser API, and also this fixes the weird situation that
374   `--flags default` isn't the default you get without any `--flags` option.
376 * quest: Multiple `--flags` options now get combined - previously only the last
377   was used.
379 portability:
381 * Don't automatically use _FORTIFY_SOURCE on mingw-w64.  Recent mingw-w64
382   versions require -lssp to be linked when _FORTIFY_SOURCE is enabled, so just
383   skip the automatic enabling.  Users who want to enable it can specify it
384   explicitly.
386   Fixes #808, reported by xpbxf4.
388 * Workaround NFS issue in test harness function for deleting test databases.
389   On NFS, rmdir() can fail with EEXIST or ENOTEMPTY (POSIX allows either)
390   due to .nfs* files which are used by NFS clients to implement the Unix
391   semantics of a deleted but open file continuing to exist.  We now sleep
392   and retry a few times in this situation to give the NFS client a chance
393   to process the closing of the open handle.  Problem mentioned in #631.
395 * configure: Drop -lm special case for Sun C++ as this no longer seems to
396   be required.  Tested with Sun C++ 5.13, which is the oldest version we
397   now support due to us now requiring C++11.
399 * Use strerrordesc_np() if available. This is a GNU-specific replacement for
400   sys_errlist and sys_nerr.  It was added in glibc 2.32 since which sys_errlist
401   and sys_nerr are no longer declared in the headers.
403 * Update debug logging to use std::uncaught_exceptions() under C++17 and later
404   since this allows the debug logging to detect a function without RETURN()
405   annotation which exits normally while there's an uncaught exception
406   (previously the debug logging would think the stack was being unwound through
407   the function).  This also avoids deprecation warnings - the old
408   std::uncaught_exception() (note: singular) function was deprecated by
409   C++17 and removed in C++20.
411 * Increase size of buffer passed to strerror_r() from 128 to 1024 bytes, which
412   is the size recommended by the man page on Linux.
414 * Fix -Wdeprecated-copy warning from clang 13.
416 Xapian-core 1.4.18 (2021-01-14):
418 API:
420 * QueryParser::FLAG_ACCUMULATE: New flag.  Previously the unstem and stoplist
421   data was always reset by a call to QueryParser::parse_query(), which makes
422   sense if you use the same QueryParser object to parse a series of independent
423   queries.  If you're using the same QueryParser object to parse several fields
424   on the same query form, you may want to have the unstem and stoplist data
425   combined for all of them, in which case you can use this flag to prevent this
426   data from being reset.
428 * QueryParser::unstem_begin(): Eliminate unnecessary copying of the data.
430 * Fix typo in Swedish stopword list, syncing change made to Snowball by Daniel
431   Gómez Villanueva.
433 * Remove some French stop words with other meanings, syncing change made to
434   Snowball by PhilippeOuellet.
436 testsuite:
438 * Run testcase testlock4 using backend chert, not just using glass
440 * Skip testcase testlock4 on platforms that don't allow us to implement
441   Database::locked() (which notably include GNU Hurd and Microsoft Windows).
443 documentation:
445 * List DB_NO_TERMLIST in the WritableDatabase constructor API documentation
446   where we already list the other DB_* constants.
448 portability:
450 * Eliminate single use of std::mem_fun() which was deprecated in C++11 and
451   removed in C++17.  Reported by Mateusz Pusz in #806.
453 * Add missing includes for std::numeric_limits<>.  Reported by stac47 in #805.
455 * Work around mingw.org header issue.  MSVC seems to implicitly include
456   <winerror.h> but mingw.org's headers don't, leading to ERROR_PIPE_CONNECTED
457   not being defined.  Fixes https://github.com/xapian/xapian/pull/318, reported
458   by Alex Sandro.
460 * Suppress MSVC warnings about possible loss of data.  The values involved are
461   the number of set bits in a value of integer type, so these warnings are
462   bogus.
464 * Include <sys/types.h> for size_t and off_t, which is the appropriate header,
465   and needed with Android's bionic libc.  Patch from Matthieu Gautier.
467 * Use a temporary file for the Doxygen configuration to work around Doxygen
468   1.8.19 bug which truncates a config file read from stdin to 4096 bytes
469   (https://github.com/doxygen/doxygen/issues/7975).
471 Xapian-core 1.4.17 (2020-08-21):
473 API:
475 * Database::get_average_length(): Add this as an alias for
476   Database::get_avlen().  In git master we've added this as a preferred new
477   name - adding it to 1.4.x too will make it easier for users to update to
478   using this.
480 * Database::get_spelling_suggestion(): Optimise edit distance initialisation
481   loop to significantly reduce the cost of a typical edit distance calculation.
483 * Fix query expansion on sharded databases.  The mechanism for passing in which
484   shard a TermList is from wasn't hooked up and as a result we'd always think
485   it's from the first shard, meaning the statistics would be wrong and that our
486   suggested terms may not have been as good as they should be in this
487   situation.
489 * Enquire::get_eset(): Use string::compare() to avoid 1/3 of the string compares
490   on average.
492 documentation:
494 * Update doxygen HTML headers and footers to resolve issues with some
495   interactive features of the API docs not working.  Reported by Enrico Zini.
497 * Stop specifying obsolete doxygen settings PERL_PATH and MSCGEN_PATH.
499 * Clarify API docs for MSet::get_termfreq() to make it clear that this
500   considers all documents in the database, not only those that matched the
501   searched (it would sometimes be useful to be able to report the number of
502   occurrences of a term in the matched documents, but it's not something we
503   currently keep track of).  Reported by Tadeusz Sośnierz and Peter Salomonsen.
505 Xapian-core 1.4.16 (2020-06-08):
507 API:
509 * MSet::snippet(): The snippet now includes trailing punctuation which carries
510   meaning or gives useful context.  See
511   https://github.com/xapian/xapian/pull/180, reported by Robert Stepanek.
513 * MSet::snippet(): Fix segfault generating snippet from default-constructed
514   MSet.  This probably isn't something you'd typically do, but it shouldn't
515   crash.  Found during extended testing of #803 (which only affected git
516   master) which was reported by Robert Stepanek.
518 * Remove trailing full stop from exception messages.  We conventionally don't
519   include one, but a few cases didn't follow that convention.
521 testsuite:
523 * Replace direct use of ftime() which gives deprecation warnings with recent
524   mingw.  Reported by srinivasyadav22.
526 matcher:
528 * Fix segfault in rare cases in the query optimiser.  We keep a pointer to the
529   most recent posting list to use as a hint for opening the next posting list,
530   but the existing mechanism to take ownership of this hint had a flaw.  We now
531   invalidate the hint in situations where it might be indirectly deleted which
532   is safe, but somewhat conservative.
534 * Improve the optimisation of an always-matching OP_VALUE_GE to also take
535   effect when the value slot's lower bound is equal to the limit of the
536   OP_VALUE_GE.  Patch from boda sadalla.
538 glass backend:
540 * Report the correct errno value if commit() fails.  We were potentially
541   reporting ENOENT from an unlink() call cleaning up a temporary file prior to
542   throwing the exception instead.
544 documentation:
546 * Fix missing menus in API documentation.  Newer doxygen generates .js files
547   which we also need to distribute and install.  Reported by sec^nd on #xapian.
549 * Note OP_FILTER ignored subquery bug fixed in 1.4.15 as present in 1.4.14 and
550   older.
552 portability:
554 * Use our own autoconf cache variable namespace (xo_cv_ prefix instead of
555   ac_cv_) to avoid colliding with standard autoconf macro use if config.site or
556   a shared config.cache is used.  The former case caused a build failure for
557   the OpenBSD port with 1.4.15, reported by Lucas R.
559 * Use clock_gettime() and nanosleep() under modern mingw as these allow higher
560   precision than what we previously used.
562 Xapian-core 1.4.15 (2020-02-24):
564 API:
566 * Database::check(): Fix checking of replication changesets.  This reverts a
567   change incorrectly made in 1.3.7.
569 * Database::locked(): Return false instead of true for a closed inmemory DB.
571 * Database::commit(): If commit() failed with an exception while trying to add
572   pending changes (e.g. InvalidArgumentError due to a long term containing zero
573   bytes) then a subsequent commit() on the same object would throw the same
574   exception.  Now we clear the pending changes in this situation (like we
575   already did for failure at other stages in the commit).  This bug remains
576   unfixed for the chert backend as it's harder to fix there and the effort to
577   fix it and extra risk of breakage don't seem justified for a backend we
578   recommend people migrate away from.
580 * QueryParser::parse_query(): Optimise parsing of multi-word synonyms.
582 testsuite:
584 * Use 50-word synonym for qp_scale1 "large" case.  50 divides exactly into the
585   number of repetitions we do for the "small" case, which 60 (as used before)
586   doesn't.  This makes the two cases a little more comparable and should help
587   make this testcase less flaky (see #764).
589 * Adjust testcase matches1 to work with remote shards where the matcher can
590   return slightly better bounds on the number of matches in some cases.
591   Resolves 2 XFAILs.
593 * The testharness get_remote_database() method is now supported for sharded
594   databases.  This is needed for keepalive1 to run successfully under multi
595   test backends.  Resolves 2 XFAILs of keepalive1.
597 * Improved test coverage:
599   + Test locked() on a closed WritableDatabase, which already returns false (as
600     expected) in 1.4.x (but was broken on master).
602   + Check multi databases in testsuite - this has been supported by
603     Database::check() since 1.4.12.
605   + Also test OP_SYNONYM and OP_MAX in emptydb1.
607   + Backport testcases boolorbug1, emptynot1, emptymaybe1 and
608     phraseweightcheckbug1 from git master - these are regression tests for
609     fixed bugs which only affected git master, but it's useful to confirm that
610     these bugs don't currently affect 1.4, and ensure they don't get introduced.
612 * perftest: Store memory sizes as long long since on Microsoft Windows long is
613   only 32 bits, which is less than common memory sizes.
615 matcher:
617 * Hoist positional check above OP_FILTER.
619 * Handle OP_FILTER with more than two subqueries correctly.  Previously we'd
620   only check the first two subqueries in some situations.
622 remote backend:
624 * For a remote WritableDatabase, the client now keeps track of whether there
625   are pending changes, and if there aren't then we now do nothing for commit()
626   or cancel() calls.  In particular this saves a message exchange when the
627   WritableDatabase destructor is called when changes have already been
628   committed with an explicit call to commit() (which is what we recommend
629   doing, since with an explicit call to commit() you get to see any exception
630   which gets thrown).
632 * When closing a remote prog WritableDatabase, previously an exception could
633   leave the remote connection open with the remote server running, and we'd
634   then wait for the specified timeout before closing the connection.  Now we
635   close the connection before letting the exception propagate.
637 * Don't swallow exceptions from Database::close() on a remote database.  If
638   we aren't in a transaction and so try to commit() and that fails then
639   previously the caller would have no indication of the failure.
641 * Fix handling the reported term weight when remote shards are searched.
642   Fixes 5 XFAILs in the testsuite.
644 * Add missing space to mismatching protocol versions error message.
646 build system:
648 * Fix to build when configured with --disable-backend-remote, broken by changes
649   in 1.4.14.  Fixes #797, reported by Дилян Палаузов.
651 * The clang and icc compilers both define __GNUC__, which led our ABI mismatch
652   message to report them as "g++" with a bogus version (the version of GCC that
653   these compilers advertise themselves as, which for clang is always 4.2.0) -
654   now we report clang++ or icc along with the actual version of that compiler.
656 documentation:
658 * AUTHORS: Apply missed update to the thankyou list for 1.4.14.
660 * INSTALL: Note that MSVC 2019 works.
662 * INSTALL: Note that Xapian can use the system uuid.h on AIX and OpenBSD.
664 portability:
666 * Simplify probes for snprintf.  The broken snprintf in libbsd in Linux libc4
667   is from ~25 years ago so way too ancient to matter now, and all callers
668   already handle the pre-ISO semantics of returning -1 for an undersize buffer
669   so we don't need to run a test program to probe for this at configure time,
670   which is more cross-compile friendly.
672 * Don't quote messages in #error - the quotes aren't required and appear in the
673   compiler output (at least with GCC and clang) making it less readable.
675 * Use a different approach for getting a 64-bit capable stat() for mingw32.
676   This means we now use the same stat variant for mingw32 and MSVC, which
677   seems a better plan.
679 * Work around unhelpful config.status behaviour.  It comments out any #undef
680   lines in config.h, even those added via AH_TOP and AH_BOTTOM.  Splitting
681   these lines means they don't match the regex hammer config.status uses.
683 * Avoid -Wdeprecated-copy warnings from clang 10.
685 * Avoid deprecation warning on recent Linux.  We were including sys/sysctl.h if
686   it existed, which it does on Linux but we don't actually use it there.
687   Including it now warns that it is deprecated, so skip including it under
688   Linux.  Reported on IRC by kumaran.
690 * Suppress GCC -Wduplicated-branches warning from our API headers in a
691   different way which avoids needing a compiler-specific #pragma.
693 * Workaround closefrom1 failure on macOS.  It seems under macOS our fd tracking
694   can end up using fd 10 so start from 13 when testing closefrom() so we don't
695   close the fd which our fd tracking is using internally.
697 debug code:
699 * Log RemoteConnection::read_at_least() return value.
701 Xapian-core 1.4.14 (2019-11-23):
703 API:
705 * Xapian::QueryParser: Handle "" inside a quoted phrase better.  In a quoted
706   boolean term, "" is treated as an escaped ", so handle it in a compatible way
707   for quoted phrases.  Previously we'd drop out of the phrase and start a new
708   phrase.  Fixes #630, reported by Austin Clements.
710 * Xapian::Stem: The constructor which takes a stemmer name now takes an
711   optional second bool parameter - if this is true, then an unknown stemmer
712   name falls back to using the "none" stemmer instead of throwing an exception.
713   This allows simply constructing a stemmer from an ISO language code without
714   having to worry about whether there's a stemmer for that language, and
715   without having to handle an exception if there isn't.
717 * Xapian::Stem: Fix a bug with handling 4-byte UTF-8 sequences which
718   potentially affects most of the stemmers.  None of the stemmers work in
719   languages where 4-byte UTF-8 sequences are part of the alphabet, but this
720   bug could result in invalid UTF-8 sequences in terms generated from text
721   containing high Unicode codepoints such as emoji, which can cause issues (for
722   example, in some language bindings).  Fix synced from Snowball git post
723   2.0.0.  Reported by Ilari Nieminen in
724   https://github.com/snowballstem/snowball/issues/89.
726 * Xapian::Stem: Add a new is_none() method which tests if this is a "none"
727   stemmer.
729 * Xapian::Weight: The total length of all documents is now made available to
730   Xapian::Weight subclasses, and this is now used by DLHWeight, DPHWeight and
731   LMWeight.  To maintain ABI compatibility, internally this still fetches the
732   average length and the number of documents, multiplies them, then rounds the
733   result, but in the next release series this will be handled directly.
735 * Xapian::Database::locked() on an inmemory database used to always return
736   false, but an inmemory Database is always actually a WritableDatabase
737   underneath, so now we always report true in this case because it's really
738   always report being locked for writing.
740 testsuite:
742 * Fix failing multi_glass_remoteprog_glass tests on x86.  When the tests are
743   run under valgrind, remote servers should be run using the runsrv wrapper
744   script, but this wasn't happening for remote servers in multi-databases - now
745   it is.  Also, previously runsrv only used valgrind for the remote for an x86
746   build that didn't use SSE, but it seems there are x87 instructions in libc
747   that are affected by valgrind not providing excess precision, so do this for
748   x86 builds which use SSE too.  Together these changes fix failures of
749   topercent2, xor2, tradweight1 under backend multi_glass_remoteprog_glass on
750   x86.
752 * Fix C++ One-Definition Rule (ODR) violation in testsuite code.  Two different
753   source files linked into apitest were each defining a different `struct
754   test`.  Wrap each in an anonymous namespace to localise it to the file it is
755   defined and used in.  This was probably harmless in practice, unless trying
756   to build with Link-Time Optimisation or similar (which is how it was
757   detected).
759 * Test all language codes in stemlangs1.  The testsuite hardcodes a list of
760   supported language codes which hadn't been updated since 2008.
762 * Improve DateRangeProcessor test coverage.
764 matcher:
766 * Handle pruning under a positional check.  This used to be impossible, but
767   since 1.4.13 it can happen as we now hoist AND_NOT to just below where we
768   hoist the positional checks.  The code on master already handles pruning here
769   so this bug is specific to the RELEASE/1.4 branch.  Fixes #796, reported by
770   Oliver Runge.
772 * When searching with collapsing over multiple shards, at least some of which
773   are remote, uncollapsed_upper_bound could be too low and
774   uncollapsed_lower_bound too high.  This was causing assertion failures in
775   testcases msize1 and msize2 under test harness backends
776   multi_glass_remoteprog_glass and multi_remoteprog_glass.
778 * Internally we no longer calculate a bogus total_term_count as the sum of
779   total_length * doc_count for all shards.  Instead we just use the sum of
780   total_length, which gives the total number of term occurrences.  This change
781   should improve the estimated collection_freq values for synonyms.
783 * Several places where we might divide zero by zero in a database where wdf was
784   always zero have been fixed.
786 build system:
788 * configure: Stop using AC_FUNC_MEMCMP.  The autoconf manual marks it as
789   "obsolescent", and it seems clear that nobody's relying on it as we're
790   missing the "'AC_LIBOBJ' replacement for 'memcmp'" which it would try to
791   use if needed.
793 documentation:
795 * HACKING: Replace release docs with pointer to the developer guide where they
796   are now maintained.
798 portability:
800 * Eliminate 2 uses of atoi().  These are potentially problematic in a
801   multithreaded application if setlocale() is called by another thread at the
802   same time.  See #665.
804 * Don't check __GNUC__ in visibility.h as the configure probe before defining
805   XAPIAN_ENABLE_VISIBILITY checks that the visibility attributes work.  This
806   probably makes no difference in practice, as all compilers we're aware of
807   which support symbol visibility also define __GNUC__.
809 * Document Sun C++ requires --disable-shared.  Closes #631.
811 Xapian-core 1.4.13 (2019-10-14):
813 API:
815 * Fix write one past end of std::vector on certain QueryParser parser errors.
816   This is undefined behaviour, but the write was always into reserved space, so
817   in practice we'd actually get away with it (it was noticed because it
818   triggers an error when running under ubsan and using libc++).  Reported by
819   Germán M. Bravo.
821 * MSet::get_matches_estimated(): Improve rounding of result - a bug meant we
822   would almost always round down.
824 * Optimise test for UTF-8 continuation character.  Performing a signed char
825   comparison shaves an instruction or two on most architectures.
827 * Database::get_revision(): Return revision 0 for a Database with no shards
828   rather that throwing InvalidOperationError.
830 * DPHWeight: Avoid dividing by 0 when searching a sharded database when one
831   shard is empty.  The result wasn't used in this case, but it's still
832   undefined behaviour.  Detected by UBSan.
834 testsuite:
836 * The "singlefile" test harness backend manager now creates databases by
837   compacting the corresponding underlying backend database (creating it first
838   if need be) rather than always creating a temporary database to compact.
840 * Enable compaction testcases for multi and singlefile test harness backends.
842 * Add generated database support for remoteprog and remotetcp test harness
843   backends.  Implemented by Tanmay Sachan.
845 * Add test harness support for running testcases using a multi database
846   comprised of one local and one remote shard, or two remote shards.
847   Implemented by Tanmay Sachan.
849 * Check if removing existing multi stub failed.  Previously if removing an
850   existing stub failed, the test harness would create a temporary new stub and
851   then try to rename it over the old one, which will always fail on Microsoft
852   Windows.
854 * Wait for xapian-tcpsrv processes to finish before moving on to the next
855   testcase under __WIN32__ like we already do on POSIX platforms.
857 matcher:
859 * Optimise OP_AND_NOT better.  We now combine its left argument with other
860   connected and-like subqueries, and gather up and hoist the negated subqueries
861   and apply them together above the combined and-like subqueries, just below
862   any positional filters.
864 * Optimise OP_AND_MAYBE better.  We now combine its left argument with other
865   connected and-like subqueries, and gather up and hoist the optional
866   subqueries and apply them together above the combined and-like subqueries and
867   any hoisted positional filters.
869 * Treat all BoolWeight queries as scaled by 0 - we can optimise better if we
870   know the query is unweighted.
872 glass backend:
874 * Allow zlib compression to reduce size by one byte.  We were specifying an
875   output buffer size one byte smaller than the input, but it appears zlib won't
876   use the final byte in the buffer, so we actually need to pass the input size
877   as the output buffer size.
879 * Only try to compress Btree item values > 18 bytes, which saves CPU time
880   without sacrificing any significant size savings.
882 remote backend:
884 * Fix match stats when searching with collapsing over multiple shards and at
885   least some shards are remote.  Bug discovered by Tanmay Sachan's test harness
886   improvements.
888 * Ignore orphaned remote protocol replies which can happen when searching with
889   a remote shard if an exception is thrown by another shard.  Bug discovered
890   by Tanmay Sachan's test harness improvements.
892 * Wait for xapian-progsrv child to exit when a remote Database or
893   WritableDatabase object is closed under __WIN32__ like we already do for
894   POSIX platforms.
896 documentation:
898 * Correct documentation of initial messages in replication protocol.
900 tools:
902 * quest: Report bounds and estimate of number of matches.
904 * xapian-delve: Improve output when database revision information is not
905   available.  We now specially handle the cases of a DB with multiple shards
906   and a backend which doesn't support get_revision().
908 portability:
910 * Fix warning from GCC 9 with -Wdeprecated-copy (which is enabled by -Wextra)
911   if a reference to an Error object is thrown.
913 * Suppress GCC warning in our API headers when compiling code using Xapian with
914   GCC and -Wduplicated-branches.
916 * Mark some internal classes as final (following GCC -Wsuggest-final-types
917   suggestions to allow some method calls to be devirtualised).
919 * Fix to build with --enable-maintainer-mode and Perl < 5.10, which doesn't
920   have the `//=` operator.  It's unlikely developers will have such an old
921   Perl, but the mingw environment on appveyor CI does.  The use of `//=` was
922   introduced by changes in 1.4.10.
924 Xapian-core 1.4.12 (2019-07-23):
926 API:
928 * Xapian::PostingSource: When a PostingSource without a clone() method is used
929   with a Database containing multiple shards, the documented behaviour has
930   always been that Xapian::InvalidOperationError is thrown.  However, since at
931   least 1.4.0, this exception hasn't been thrown, but instead a single
932   PostingSource object would get used for all the shards, typically leading to
933   incorrect results.  The actual behaviour now matches what was documented.
935 * Xapian::Database: Add size() method which reports the number of shards.
937 * Xapian::Database::check(): You can now pass a stub database which will check
938   all the databases listed in it (or throw Xapian::UnimplementedError for
939   backends which don't support checking).
941 * Xapian::Document: When updating a document use a emplace_hint() to make the
942   bulk insertion O(n) instead of O(n·log(n)), and use std::move() to avoid
943   copying OmDocumentTerm objects.
945 * Xapian::Query: Add missing get_unique_terms_end() method.
947 * Xapian::iterator_valid(): Implement for Utf8Iterator
949 testsuite:
951 * Fix keepalive1 failures on some platforms.  On some platforms a timeout
952   gives NetworkTimeoutError and on others NetworkError - since 1.4.10 changed
953   to checking the exact exception type, keepalive1 has been failing on the
954   former set of platforms.  We now just check for NetworkError or a subclass
955   here (since NetworkTimeoutError is a subclass of NetworkError).
957 * Run cursordelbug1 testcase with multi databases too.
959 matcher:
961 * Ownership of PostingSource objects during the match now makes use of the
962   optional reference-counting mechanism rather than a separate flag.
964 remote backend:
966 * Fix remote protocol design bug.  Previously some messages didn't send a reply
967   but could result in an exception being sent over the link.  That exception
968   would then get read as a response to the next message instead of its actual
969   response so we'd be out of step.  Fixes #783, reported by Germán M. Bravo.
970   This fix necessitated a minor version bump in the remote protocol (to 39.1).
971   If you are upgrading a live system which uses the remote backend, upgrade the
972   servers before the clients.
974 * Fix socket leaks on errors during opening a database.  Fixes
975   https://github.com/xapian/xapian/pull/237 and #781, reported by Germán M.
976   Bravo.
978 * Don't close remote DB socket on receiving EOF as the levels above won't
979   know it's been closed and may try to perform operations on it, which would be
980   problematic if that fd gets reused in the meantime.  Leaving it open means
981   any further operations will also get EOF.  Reported by Germán M. Bravo.
983 * We add a wrapper around the libc socket() function which deals with the
984   corner case where SOCK_CLOEXEC is defined but socket() fails if it is
985   specified (which can happen with a newer libc and older kernel).
986   Unfortunately, this wrapper wasn't checking the returned value from socket()
987   correctly, so when SOCK_CLOEXEC was specified and non-zero it would create
988   the socket() with SOCK_CLOEXEC, then leak that one and create it again
989   without SOCK_CLOEXEC.  We now check the return value properly.
991 * Fix potential infinite loop in ValueCountMatchSpy::merge_results() if passed
992   serialised results with extra data appended (which shouldn't happen in normal
993   use).
995 build system:
997 * Current versions of valgrind result in false positives on current versions of
998   macOS, so on this platform configure now only enables use of valgrind if it's
999   specified explicitly.  Fixes #713, reported by Germán M. Bravo.
1001 * Refactor macros to probe for compiler flags so they automatically cache
1002   their results and consistently report success/failure.
1004 * Rename our custom TYPE_SOCKLEN_T macro to XAPIAN_TYPE_SOCKLEN_T.  The
1005   AX_TYPE_SOCKLEN_T macro defines an alias of TYPE_SOCKLEN_T for itself which
1006   means it can get used instead in some situations, but it isn't compatible
1007   with our macro.  We can't just switch to AX_TYPE_SOCKLEN_T as it doesn't
1008   handle cases we need, so just rename our macro to avoid potential problems.
1010 documentation:
1012 * Improve API documentation for Xapian::Query class.  Add missing doc
1013   comments and improve some of the existing ones.  Problems highlighted by
1014   Дилян Палаузов in #790.
1016 * Add Unicode consortium names and codes for categories from Chapter 4, Version
1017   11 of the Unicode standard.  Patch from David Bremner.
1019 * Improve configure --help output - drop "[default=no]" for --enable-*
1020   options which default off.  Fixes #791, reported by and patch from Дилян
1021   Палаузов.
1023 * Fix API documentation typo - Query::op (the type) not op_ (a parameter name).
1025 * Note which version Document::remove_postings() was added in.
1027 * In the remote protocol documentation, MSG_REPLACEDOCUMENTTERM was documented
1028   as not having a reply, but actually REPLY_ADDDOCUMENT is sent.
1030 * Update list of <xapian/iterator.h> users.
1032 tools:
1034 * copydatabase: A change in 1.4.6 which added support for \ as directory
1035   separator on platforms where that's the norm broke the code in copydatabase
1036   which removes a trailing slash from input databases.  Bug reported and
1037   culprit commit identified by Eric Wong.
1039 portability:
1041 * Resolve crash on Windows when using clang-cl and MSVC.  Reported by Christian
1042   Mollekopf in https://github.com/xapian/xapian/pull/256.
1044 * Add missing '#include <cstring>'.  Patch from Tanmay Sachan.
1046 * Fix str() helper function when converting the most negative value
1047   of a signed integer type.
1049 * Avoid calling close() on fd we know must actually be a WIN32 SOCKET.
1051 * Include <ios> not <iomanip> for std::boolalpha.
1053 * Rework setenv() compatibility handling.  Now that Solaris 9 is dead we can
1054   assume setenv() is provided by Unix-like platforms (POSIX requires it).  For
1055   other platforms, provide a compatibility implementation of setenv() which
1056   so the compatibility code is encapsulated in one place rather than replicated
1057   at every use.
1059 * Fix maintainer-mode builds on Solaris where /bin/tr is not POSIX compliant.
1060   We now use the simple workaround suggested by the autoconf manual.
1062 * Improve support for Sun C++ (see #631):
1064   + Suppress unhelpful warning for lambda with multiple return statements.
1066   + Enable reporting the tags corresponding to warnings, which we need
1067     to know in order to suppress any new unhelpful warnings.
1069   + Adjust our workaround for bug with this compiler's <cmath> header to avoid
1070     a compiler warning.
1072   + Use -xldscope=symbolic for Sun C++.  This flag is roughly equivalent to
1073     -Bsymbolic-functions which we've probed for with GNU ld since Xapian 1.0.0.
1075 Xapian-core 1.4.11 (2019-03-02):
1077 API:
1079 * MSet::SNIPPET_CJK_NGRAM - new flag for use with MSet::snippet() to enable
1080   support for selecting and highlighting snippets which works with the
1081   QueryParser and TermGenerator FLAG_CJK_NGRAM flags.  This mode can also be
1082   enabled by setting environment variable XAPIAN_CJK_NGRAM to a non-empty
1083   value.  (There was nominally already support for XAPIAN_CJK_NGRAM in
1084   MSet::snippet(), but it didn't work usefully - the highlighting added was all
1085   empty start/end pairs at the end of the span of CJK characters containing the
1086   CJK ngram terms, which to the user would typically look like it was selecting
1087   the end of the text and not highlighting anything).
1089 * Deprecate XAPIAN_CJK_NGRAM environment variable.  There are now flags which
1090   can be used instead in all cases, and there's sadly no portable thread-safe
1091   way to read an environment variable so checking environment variables is
1092   problematic in library code that may be used in multithreaded programs.
1094 * Query::OP_ELITE_SET currently incorrectly recursively flattens any OP_OR (or
1095   OP_OR-like) subqueries into the list of subqueries it selects from - until
1096   that's fixed, we now select from the full exploded list rather than the last
1097   n (where n is the number of direct subqueries of the OP_ELITE_SET).
1099 testsuite:
1101 * Testcases which need a generated database now get run with a sharded
1102   database.
1104 * Avoid using strerror() in the testsuite which removes an obstacle to running
1105   tests in parallel in separate threads.
1107 matcher:
1109 * Extend detection of cases of OP_SYNONYM with disjoint subqueries (which means
1110   we don't need document length) which was added in 1.4.8 - we now detect when
1111   all subqueries are different terms, or when all subqueries are
1112   non-overlapping wildcards.  The second case is what QueryParser produces for
1113   a wildcard or partial query with a query prefix which maps to more than one
1114   term prefix.
1116 glass backend:
1118 * Handle an empty value slot lower bound gracefully.  This shouldn't happen for
1119   a non-empty slot, but has been reported by a notmuch user so it seems there
1120   is (or perhaps was as the database was several years old) a way it can come
1121   about.  We now check for this situation and set the smallest possible valid
1122   lower bound instead, so other code assuming a valid lower bound will work
1123   correctly.  Reported by jb55.
1125 chert backend:
1127 * Handle an empty value slot lower bound gracefully, equivalent to the change
1128   made for glass.
1130 documentation:
1132 * HACKING: We no longer use auto_ptr<>.
1134 * NEWS: Correct factual error in old entry - the 0.4.1 release was Open Muscat
1135   not OmSee (the OmSee name was only applied after that final release was made,
1136   and only used internally to BrightStation).
1138 portability:
1140 * Suppress more clang -Wself-assign-overloaded warnings in testcases which are
1141   deliberately testing handling of self-assignment.
1143 * Add missing includes of <cerrno>.  Fixes #776, reported by Matthieu Gautier.
1145 debug code:
1147 * When configured with --enable-log, the O_SYNC flag was always specified when
1148   opening the logfile, with the intention that the most recent log entries
1149   wouldn't get lost if there was a crash, but O_SYNC can incur a significant
1150   performance overhead and most debugging is not of such crashes.  So we no
1151   longer specify O_SYNC by default, but you can now request synchronous logging
1152   by including %! anywhere in the filename specified with XAPIAN_DEBUG_LOG
1153   (the %! is replaced with the empty string).  We also now use O_DSYNC if
1154   available in preference to O_SYNC, since the mtime of the log file isn't
1155   important.
1157 Xapian-core 1.4.10 (2019-02-12):
1159 API:
1161 * DatabaseClosedError: New exception class thrown instead of DatabaseError when
1162   an operation is attempted which can't be completed because it involves a
1163   database which close() was previously called on.  DatabaseClosedError is a
1164   subclass of DatabaseError so existing code catching DatabaseError will still
1165   work as before.  Fixes #772, reported by Germán M. Bravo.  Patch from
1166   Vaibhav Kansagara.
1168 * DatabaseNotFoundError: New exception class thrown instead of
1169   DatabaseOpeningError when the problem is the problem is "file not found" or
1170   similar.  DatabaseNotFoundError is a subclass of DatabaseOpeningError so
1171   existing code catching DatabaseOpeningError will still work as before.  Fixes
1172   #773, reported by Germán M. Bravo.  Patch from Vaibhav Kansagara.
1174 * Query: Make &=, |= and ^= on Query objects opportunistically append to
1175   an existing query with a matching query operator which has a reference
1176   count of 1.  This provides an easy way to incrementally build flatter query
1177   trees.
1179 * Query: Support `query &= ~query2` better - this now is handled exactly
1180   equivalent to `query = query & ~query2` and gives `query AND_NOT query2`
1181   instead of `query AND (<alldocuments> AND_NOT query2)`.
1183 * QueryParser: Now uses &=, |= and ^= to produce flatter query trees.  This
1184   fixes problems with running out of stack space when handling Query object
1185   trees built by abusing QueryParser to parse very large machine-generated
1186   queries.
1188 * Stopper: Fix incorrect accents in Hungarian stopword list.  Patch from David
1189   Corbett.
1191 testsuite:
1193 * Test MSet::snippet() with small and zero lengths.  Fixes #759.  Patch from
1194   Vaibhav Kansagara.
1196 * Fix testcase stubdb4 annotations - this testcase doesn't need a backend.
1198 * Add PATH annotation for testcases needing get_database_path() to avoid having
1199   to repeatedly list the backends where this is supported in testcase
1200   annotations.
1202 * TEST_EXCEPTION helper macro now checks that the exact specified exception
1203   type is thrown.  Previously it would allow a subclass of the specified
1204   exception type, but in testcases we really want to be able to test for an
1205   exact type.  Issue noted by Vaibhav Kansagara on IRC.
1207 matcher:
1209 * Map OP_VALUE_GE/OP_VALUE_LE on an empty slot to EmptyPostList.  We already do
1210   this for OP_VALUE_RANGE, and it's a little more efficient than creating a
1211   postlist object which checks the empty value slot.
1213 glass backend:
1215 * We no longer flush all pending positional changes when a postlist, termlist
1216   or all-terms is opened on a modified WritableDatabase.  Doing so was
1217   incurring a significant performance cost, and the first of these happens
1218   internally when `replace_document(term, doc)` is used, which is the usual way
1219   to support non-numeric unique ids.  We now only flush pending positional
1220   changes when committing.  Reported and diagnosed by Germán M. Bravo.
1222 remote backend:
1224 * Use poll() where available instead of select().  poll() is specified by
1225   POSIX.1-2001 so should be widely available by now, and it allows watching any
1226   fd (select() is limited to watching fds < FD_SETSIZE).  For any platforms
1227   which still lack poll() we now workaround this select() limitation when a
1228   high numbered fd needs to be watched (for example, by trying a non-blocking
1229   read or write and on EAGAIN sleeping for a bit before retrying).
1231 * Stop watching fds for "exceptional conditions" - none of these are relevant
1232   to our usage.
1234 * Remove 0.1s timeout in ready_to_read().  The comment says this is to avoid a
1235   busy loop, but that's out of date - the matcher first checks which remotes
1236   are ready to read and then does a second pass to handle those which weren't
1237   with a blocking read.
1239 build system:
1241 * Stop probing for header sys/errno.h which is no longer used - it was only
1242   needed for Compaq C++, support for which was dropped in 1.4.8.
1244 documentation:
1246 * docs/valueranges.html: Update to document RangeProcessor instead of
1247   ValueRangeProcessor - the latter is deprecated and will be gone in the next
1248   release series.
1250 * Document RangeProcessor::operator()() returns OP_INVALID to signal it doesn't
1251   recognise a range.
1253 * Update some URLs for pages which have moved.
1255 * Use https for URLs where available.
1257 * HACKING: Update "empty()" section for changes in C++11.
1259 portability:
1261 * Suppress clang warnings for self-assignment tests.  Some testcases trigger
1262   this new-ish clang warning while testing that self-assignment works, which
1263   seems a useful thing to be testing - at least one of these is a regression
1264   test.
1266 * Add std::move to fix clang -Wreturn-std-move warning (which is enabled by
1267   -Wall).
1269 * Add casts to fix ubsan warnings.  These cases aren't undefined behaviour, but
1270   are reported by ubsan extra checks implicit-integer-truncation and/or
1271   implicit-conversion which it is useful to be able to enable to catch
1272   potential bugs.
1274 * Fix check for when to use _byteswap_ulong() - in practice this would only
1275   have caused a problem if a platform provided _byteswap_ushort() but not
1276   _byteswap_ulong(), but we're not aware of any which do.
1278 * Fix return values of do_bswap() helpers to match parameter types (previously
1279   we always returned int and only supported swapping types up to 32 bits, so
1280   this probably doesn't result in any behavioural changes).
1282 * Only include <intrin.h> if we'll use it instead of always including it when
1283   it exists.  Including <intrin.h> can result in warnings about duplicate
1284   declarations of builtin functions under mingw.
1286 * Remove call to close()/closesocket() when the argument is always -1 (since
1287   the change to use getaddrinfo() in 1.3.3).
1289 Xapian-core 1.4.9 (2018-11-02):
1291 API:
1293 * Document::add_posting(): Fix bugs with the change in 1.4.8 to more
1294   efficiently handle insertion of a batch of extra positions in ascending
1295   order.  These could lead to missing positions and corrupted encoded
1296   positional data.
1298 remote backend:
1300 * Avoid hang if remote connection shutdown fails by not waiting for the
1301   connection to close in this situation.  Seems to fix occasional hangs seen on
1302   macOS.  Patch from Germán M. Bravo.
1304 Xapian-core 1.4.8 (2018-10-25):
1306 API:
1308 * QueryParser,TermGenerator: Add new stemming mode STEM_SOME_FULL_POS.
1309   This stores positional information for both stemmed and unstemmed terms,
1310   allowing NEAR and ADJ to work with stemmed terms.  The extra positional
1311   information is likely to take up a significant amount of extra disk space so
1312   the default STEM_SOME is likely to be a better choice for most users.
1314 * Database::check(): Fetch and decompress the document data to catch problems
1315   with the splitting of large data into multiple entries, corruption of the
1316   compressed data, etc.  Also check that empty document data isn't explicitly
1317   stored for glass.
1319 * Fix an incorrect type being used for term positions in the TermGenerator API.
1320   These were Xapian::termcount but should be Xapian::termpos.  Both are
1321   typedefs for the same 32-bit unsigned integer type by default (almost always
1322   "unsigned int") so this change is entirely compatible, except that if you
1323   were configuring 1.4.7 or earlier with --enable-64bit-termcount you need to
1324   also use the new --enable-64bit-termpos configure option with 1.4.8 and up or
1325   rebuild your applications.  This change was necessary to make
1326   --enable-64bit-termpos actually useful.
1328 * Add Document::remove_postings() method which removes all postings in a
1329   specified term position range much more efficiently than by calling
1330   remove_posting() repeatedly.  It returns the number of postings removed.
1332 * Fix bugs with handling term positions >= 0x80000000.  Reported by Gaurav
1333   Arora.
1335 * Document::add_posting(): More efficiently handle insertion of a batch of
1336   extra positions in ascending order.
1338 * Query: Simplify OP_SYNONYM with single OP_WILDCARD subquery by converting to
1339   OP_WILDCARD with combiner OP_SYNONYM, which means such cases can take
1340   advantage of the new matcher optimisation in this release to avoid needing
1341   document length for OP_WILDCARD with combiner OP_SYNONYM.
1343 testsuite:
1345 * Catch and report std::exception from the test harness itself.
1347 * apitest: Drop special case for not storing doc length in testcase postlist5 -
1348   all backends have stored document lengths for a long time.
1350 * test_harness: Create directories in a race-free way.
1352 matcher:
1354 * Avoid needing document length for an OP_WILDCARD with combiner OP_SYNONYM.
1355   We know that we can't get any duplicate terms in the expansion of a wildcard
1356   so the sum of the wdf from them can't possibly exceed the document length.
1358 * OP_SYNONYM: No longer tries to initialise weights for its subquery, which
1359   should reduce the time taken to set up a large wildcard query.
1361 * OP_SYNONYM: Fix frequency estimates when OP_SYNONYM is used with a
1362   subquery containing OP_XOR or OP_MAX - in such cases the frequency
1363   estimates for the first subquery of the OP_XOR/OP_MAX were used for
1364   all its subqueries.  Also the estimated collection frequency is
1365   now rounded to the nearest integer rather than always being rounded
1366   down.
1368 glass backend:
1370 * Revert change made in 1.4.6:
1372     Enable glass's "open_nearby_postlist" optimisation (which especially helps
1373     large wildcard queries) for writable databases without any uncommitted
1374     changes as well.
1376   The amended check isn't conservative enough as there may be postlist changes
1377   in the inverter while the table is unmodified.  This breaks testcase
1378   T150-tagging.sh in notmuch's testsuite, reported by David Bremner.
1380 * When indexing a document without any terms we now avoid some unnecessary work
1381   when storing its termlist.
1383 build system:
1385 * New --enable-64bit-termpos configure option which makes Xapian::termpos a
1386   64-bit type and enables support for storing 64-bit termpos values in the
1387   glass backend in an upwardly compatible way.  Few people will actually want
1388   to index documents more than 4 billion words long, but the extra numbering
1389   space can be helpful if you want to use term positions in "interesting" ways.
1391 * Hook up configure --disable-sse/--enable-sse=sse options for MSVC.
1393 * Fix configure probes for builtin functions for clang.  We need to specify the
1394   argument types for each builtin since otherwise AC_CHECK_DECLS tries to
1395   compile code which just tries to take a pointer to the builtin function
1396   causing clang to give an error saying that's not allowed.  If the argument
1397   types are specified then AC_CHECK_DECLS tries to compile a call to the
1398   builtin function instead.
1400 documentation:
1402 * Fix documentation comment typo.
1404 tools:
1406 * xapian-delve: Test for all docs empty using get_total_length() which is
1407   slightly simpler internally than get_avlength(), and avoids an exact floating
1408   point equality check.
1410 examples:
1412 * quest: Support --weight=coord.
1414 * xapian-pos: New tool to show term position info to help debugging when using
1415   positional information in more complex ways.
1417 portability:
1419 * Fix undefined behaviour from C++ ODR violation due to using the same name
1420   two different non-static inline functions.  It seems that with current GCC
1421   versions the desired function always ends up being used, but with current
1422   clang the other function is sometimes used, resulting in database corruption
1423   when using value slots in docid 16384 or higher with the default glass
1424   backend.  Patch from Germán M. Bravo.
1426 * Suppress alignment cast warning on sparc Linux.  The pointer being cast is to
1427   a record returned by getdirentries(), so it should be suitable aligned.
1429 * Drop special handling for Compaq C++.  We never actually achieved a working
1430   build using it, and I can find no evidence that this compiler still exists,
1431   let alone that it was updated for C++11 which we now require.
1433 * Create new database directories in race-free way.
1435 * Avoid throwing and handling an exception in replace_document() when
1436   adding a document with a specified docid which is <= last_docid but currently
1437   unused.
1439 * Use our portable code for handling UUIDs on all platforms, and only use
1440   platform-specific code for generating a new UUID.  This fixes a bug with
1441   converting UUIDs to and from string representation on FreeBSD, NetBSD and
1442   OpenBSD on little-endian platforms which resulted in reversed byte order in
1443   the first three components, so the same database would report a different
1444   UUID on these platforms compared to other platforms.  With this fix, the
1445   UUIDs of existing databases will appear to change on these platforms
1446   (except in rare "palindronic" cases).  Reported by Germán M. Bravo.
1448 * Fix to build with a C++17 compiler.  Previously we used a "byte" type
1449   internally which clashed with "std::byte" in source files which use
1450   "using namespace std;".  Fixes #768, reported by Laurent Stacul.
1452 * Adjust apitest testcase stubdb2 to allow for NetBSD oddity: NetBSD's
1453   getaddrinfo() in IPv4 mode seems to resolve ::1 to an IPv4 address on the
1454   local network.
1456 * Avoid timer_create() on OpenBSD and NetBSD.  On OpenBSD it always fails with
1457   ENOSYS (and there's no prototype in the libc headers), while on NetBSD it
1458   seems to work, but the timer never seems to fire, so it's useless to us (see
1459   #770).
1461 * Use SOCK_NONBLOCK if available to avoid a call to fcntl().  It's supported by
1462   at least Linux, FreeBSD, NetBSD and OpenBSD.
1464 * Use O_NOINHERIT for O_CLOEXEC on Windows.  This flag has essentially the same
1465   effect, and it's common in other codebases to do this.
1467 * On AIX O_CLOEXEC may be a 64-bit constant which won't fit in an int.  To
1468   workaround this stupidity we now call the non-standard open64x() instead
1469   of open() when the flags don't fit in an int.
1471 * Add functions to add/multiply with overflow check.  These are implemented
1472   with compiler builtins or equivalent where possible, so the overflow check
1473   will typically just require a check of the processor's overflow or carry
1474   flag.
1476 Xapian-core 1.4.7 (2018-07-19):
1478 API:
1480 * Database::check(): Fix bogus error reports for documents with length zero
1481   due to a new check added in 1.4.6 that the doclength was between the stored
1482   upper and lower bounds, which failed to allow for the lower bound ignoring
1483   documents with length zero (since documents indexed only by boolean terms
1484   aren't involved in weighted searches).  Reported by David Bremner.
1486 * Query: Use of Query::MatchAll in multithreaded code causes problems because
1487   the reference counting gets messed up by concurrent updates.  Document that
1488   Query(string()) should be used instead of MatchAll in multithreaded code, and
1489   avoid using it in library code.  Reported by Germán M. Bravo.
1491 * Stem:
1493   + Stemming algorithms added for Irish, Lithuanian, Nepali and Tamil.
1495   + Merge Snowball compiler changes which improve code generation.
1497   + Merge optimisations to the Arabic and Turkish stemmers.
1499 testsuite:
1501   + Fix duplicate test in apitest closedb10 testcase.  Patch from Guruprasad
1502     Hegde.
1504 glass backend:
1506 * A long-lived cursor on a table in a WritableDatabase could get into
1507   an invalid state, which typically resulted in a DatabaseCorruptError
1508   being thrown with the message:
1510       Db block overwritten - are there multiple writers?
1512   But in fact the on-disk database is not corrupted - it's just that
1513   the cursor in memory has got into an inconsistent state.  It looks
1514   like we'll always detect the inconsistency before it can cause on-disk
1515   corruption but it's hard to be completely certain.
1517   The bug is in code to rebuild the cursor when the underlying table
1518   changes in ways which require that, which is a fairly rare occurrence
1519   to start with, and only triggers when a block in the cursor has been
1520   released, reallocated, and we tried to load it in the cursor at the
1521   same level - the cursor wrongly assumes it has the current version
1522   of the block.
1524   Reported with a reproducer by Sylvain Taverne.  Confirmed by David
1525   Bremner as also fixing a problem in notmuch for which he hadn't managed
1526   to find a reduced reproducer.
1528 documentation:
1530 * INSTALL: Document need to have MSVC command line tools on PATH.
1532 portability:
1534 * Cygwin: Work around oddity where unlink() sometimes seems to indicate failure
1535   with errno set to ECHILD.
1537 Xapian-core 1.4.6 (2018-07-02):
1539 API:
1541 * API classes now support C++11 move semantics when using a compiler which
1542   we are confident supports them (currently compilers which define
1543   __cplusplus >= 201103 plus a special check for MSVC 2015 or later).
1544   C++11 move semantics provide a clean and efficient way for threaded code to
1545   hand-off Xapian objects to worker threads, but in this case it's very
1546   unhelpful for availability of these semantics to vary by compiler as it
1547   quietly leads to a build with non-threadsafe behaviour.  To address this,
1548   user code can #define XAPIAN_MOVE_SEMANTICS before #include <xapian.h> to
1549   force this on, and will then get a compilation failure if the compiler lacks
1550   suitable support.
1552 * MSet::snippet():
1554   + We were only escaping output for HTML/XML in some cases, which would
1555     potentially allow HTML to be injected into output (this has been assigned
1556     CVE-2018-0499).
1558   + Include certain leading non-word characters in snippets.  Previously we
1559     started the snippet at the start of the first actual word, but there are
1560     various cases where including non-word characters in front of the actual
1561     word adds useful context or otherwise aids comprehension.  Reported by
1562     Robert Stepanek in https://github.com/xapian/xapian/pull/180
1564 * Add MSetIterator::get_sort_key() method.  The sort key has always been
1565   available internally, but wasn't exposed via the public API before, which
1566   seems like an oversight as the collapse key has long been available.
1567   Reported by 张少华 on xapian-discuss.
1569 * Database::compact():
1571   + Allow Compactor::resolve_duplicate_metadata() implementations to delete
1572     entries.  Previously if an implementation returned an empty string this
1573     would result in a user meta-data entry with an empty value, which isn't
1574     normally achievable (empty meta-data values aren't stored), and so will
1575     cause odd behaviour.  We now handle an empty returned value by interpreting
1576     it in the natural way - it means that the merged result is to not set a
1577     value for that key in the output database.
1579   + Since 1.3.5 compacting a WritableDatabase with uncommitted changes throws
1580     Xapian::InvalidOperationError when compacting to a single-file glass
1581     database.  This release adds similar checks for chert and when compacting
1582     to a multiple-file glass database.
1584   + In the unlikely event that the total number of documents or the total
1585     length of all documents overflow when trying to compact a multi-database,
1586     we throw an exception.  This is now a DatabaseError exception instead of a
1587     const char* exception (a hang-over from before this code was turned into a
1588     public API in the library).
1590 * Document::remove_term(): Handle removing term at current TermIterator
1591   position - previously the underlying iterator was invalidated, leading to
1592   undefined behaviour (typically a segmentation fault).  Reported by Gaurav
1593   Arora.
1595 * TermIterator::get_termfreq() now always returns an exact answer.  Previously
1596   for multi-databases we approximated the result, which is probably either a
1597   hang-over from when this method was used during Enquire::get_eset(), or else
1598   due to a thinking that this method would be used in that situation (it
1599   certainly is not now).  If the user creates a TermIterator object and asks it
1600   for term frequencies then we really should give them the correct answer - it
1601   isn't hugely costly and the documentation doesn't warn that it might be
1602   approximated.
1604 * QueryParser::parse_query():
1606   + Now adds a colon after the prefix when prefixing a boolean term which
1607     starts with a colon.  This means the mapping is reversible, and matches
1608     what omega actually does in this case when it tries to reverse the mapping.
1609     Thanks to Andy Chilton for pointing out this corner case.
1611   + The parser now makes use of newer features in the lemon parser generator to
1612     make parsing faster and use less memory.
1614 * Enquire::get_mset(): Fix bug with get_mset(0, 0, X) when X > 0 which was
1615   causing an attempt to access an element in an empty vector.  Reported by
1616   sielicki in #xapian.
1618 * Stem:
1620   + Add Indonesian stemming algorithm.
1622   + Small optimisations to almost all stemming algorithms.
1624 * Stopper:
1626   + Add Indonesian stopword list.
1628   + The installed version of the Finnish stopword list now has one word per
1629     line.  Previously it had several space-separated words on some lines, which
1630     works with C++'s std::istream_iterator but may be inconvenient for use from
1631     some other languages.
1633   + The installed versions of stopword lists are now sorted in byte order
1634     rather than whatever collation order is specified by LC_COLLATE or similar
1635     at build time.  This makes the build more reproducible, and also may be
1636     more efficient for loading into some data structures.
1638 * WritableDatabase::replace_document(term, doc): Check for last_docid wrapping
1639   when used on a sharded database.
1641 * Database::locked(): Consistently throw FeatureUnavailableError on platforms
1642   where we can't test for a database lock without trying to take it.
1643   Previously GNU Hurd threw DatabaseLockError while platforms where we don't
1644   use fcntl() locking at all threw UnimplementedError.
1646 * Database and WritableDatabase constructors: Fix handling of entries for
1647   disabled backends in stub database files to throw FeatureUnavailableError
1648   instead of DatabaseError.
1650 * Database::get_value_lower_bound() now works correctly for sharded databases.
1651   Previously it returned the empty string if any shard had no values in the
1652   specified slot.
1654 * PostingIterator was failing to keep an internal reference to the parent
1655   Database object for sharded databases.
1657 * ValueIterator::skip_to() and check() had an off-by-one error in their docid
1658   calculations in some cases with sharded databases.
1660 testsuite:
1662 * apitest:
1664   + Enable testcases flagged metadata, synonym and/or writable to run on
1665     sharded databases.
1667   + Enable testcases flagged writable to run on sharded databases.  Writing to
1668     a sharded WritableDatabase has been supported since 1.3.2, but the test
1669     harness wasn't running many of the tests that could be with a sharded
1670     WritableDatabase.  This uncovered three bugs which are fixed in this
1671     release.
1673   + Support "generated" testcases for the inmemory backend, which uncovered a
1674     bug which is fixed in this release.
1676   + Skip testcase testlock1 on platforms that don't allow us to implement
1677     Database::locked() (which notably include GNU Hurd and Microsoft Windows).
1679   + Disable testlock2 on sharded databases as it fails for platforms which
1680     don't actually support testing the lock.
1682   + Extend tests of behaviour after database close.  Patch from Guruprasad
1683     Hegde.  Fixes https://trac.xapian.org/ticket/337
1685   + Enable testcase closedb5 for remote backends.  This testcase failed for
1686     remote backends when it was added and the cause wasn't clear, but it turns
1687     out it was actually a bug in the disk based backends, which was fixed way
1688     back in 2010.  Reported by Guruprasad Hegde.
1690   + Check for select() failing in retrylock1 testcase.  Retry on EINTR or
1691     EAGAIN, and report other errors rather than trying the read() anyway.
1692     Previously the read() would likely fail for the same reason the select()
1693     did, but at best this is liable to make what's going on less clear if the
1694     testcase fails.
1696 * Report bool values as true/false not 1/0.
1698 * Assorted minor testcase improvements.
1700 * The test harness now supports testcases which are expected to fail (XFAIL).
1701   Based on patch from Richard Boulton in https://trac.xapian.org/ticket/156.
1703 * Fix demangling of std::exception subclass names which wasn't happening due
1704   to a typo in the preprocessor check for the required header.  This was broken
1705   by changes in 1.4.2.
1707 * Make TEST_EQUAL() arguments side-effect free.  The TEST_EQUAL() macro
1708   evaluates its arguments a second time if the test fails in order to report
1709   their values.  This isn't ideal and really ought to be addressed, but for now
1710   fix uses where the argument has side-effect (e.g. *i++) such that the
1711   reported value should match the tested value.
1713 * runtest: Show usage if first option starts '-'.  Previously we ended up
1714   passing such options to libtool, so putting -v on runtest instead of apitest
1715   would run the tests but -v would effectively do nothing (it would make
1716   libtool verbose, but that doesn't make any difference in this case):
1717   ./runtest -v ./apitest
1719 * Suppress output from xcopy on MS Windows.
1721 * The test harness machinery for detecting file descriptor leaks should now
1722   work on any platform which has /dev/fd.
1724 * Implement recursive delete of a database directory in the test harness
1725   using nftw() if available (and not buggy like mingw64's seems to be), rather
1726   than running "rm -rf" as an external command.  This avoids the overhead of
1727   starting a new process each time we clean up a test database, which happens a
1728   lot during a test run.
1730 * Speed up generated test databases a little by adding a stat() check to avoid
1731   throwing and catching an exception when the database doesn't yet exist.
1733 * Skip timed tests when configured with --enable-log.  The logging can easily
1734   turn O(1) operations into O(n), and that's hard to avoid.  Fixes
1735   https://trac.xapian.org/ticket/757, reported by Guruprasad Hegde.
1737 matcher:
1739 * OP_VALUE_*: When a value slot's lower and upper bound are equal, we know
1740   that exactly how many documents the subquery can match (either 0 or those
1741   bounds).  This also avoids a division by zero which previously happened
1742   when trying to calculate the estimate.
1744 * Speed up sorting by keys.  Use string::compare() to avoid having to call
1745   operator< if operator> returns false.
1747 * Fix clamping of maxitems argument to get_mset() - it was being clamped
1748   to db.get_doccount(), now it's clamped to db.get_doccount() - first.  In
1749   practice this doesn't actually seem to cause any issues.
1751 * If a match time limit is in effect, when it expires we now clamp
1752   check_at_least to first + maxitems instead of to maxitems.  In practice this
1753   also doesn't seem to actually cause any issues (at least we've failed to
1754   construct a testcase where it actually makes an observable difference).
1756 * Fix percentages when only some shards have positions.  If the final shard
1757   didn't have positions this would lead to under-counting the total number leaf
1758   of subqueries which would lead to incorrect positional calculations (and a
1759   division by zero if the top level of the query was positional.  This bug was
1760   introduced in 1.4.3.
1762 * OP_NEAR: Fix "phantom positions", where OP_NEAR would think a term without
1763   positional information occurred at position 1 if it had the lowest term
1764   frequency amongst the OP_NEAR's subqueries.
1766 * Fix termfreq used in weight calculations for a term occurring more than once
1767   in the query.  Previously the termfreq for such terms was multiplied by the
1768   number of different query positions they appeared at.
1770 * OP_SYNONYM: We use the doclength upper bound for the wdf upper bound of a
1771   synonym - now we avoid fetching it twice when the doclength upper bound is
1772   explicitly needed.
1774 * Short-cut init() when factor is 0 in most Weight subclasses.  This indicates
1775   the object is for the term-independent weight contribution, which is always 0
1776   for most schemes, so there's no point fetching any stats or doing any
1777   calculations.  This fixes a divide by zero for TfIdfWeight, detected by
1778   UBSan.
1780 * OP_OR: Fix bug which caused orcheck1 to fail once hooked up to run with the
1781   inmemory backend.
1783 glass backend:
1785 * Fix glass freelist bug when changes to a new database which didn't modify the
1786   termlist table were committed.  In this corner case, a block which had been
1787   allocated to be the root block in the termlist table was leaked.  This was
1788   largely harmless, except that it was detected by Database::check() and caused
1789   it to report an error.  Reported by Antoine Beaupré and David Bremner.
1791 * Fix glass freelist bug with cancel_transaction().  The freelist wasn't
1792   reset to how it was before the transaction, resulting in leaked blocks.
1793   This was largely harmless, except that it was detected by Database::check()
1794   and caused it to report an error.
1796 * Improve the per-term wdf upper bound.  Previously we used min(cf(term),
1797   wdf_upper_bound(db)) which is tight for any terms which attain that
1798   upper bound, and also for terms with termfreq == 1 (the latter are common
1799   in the database (e.g. 66% for a database of wikipedia), but probably
1800   much less common in searches).  When termfreq > 1 we now use
1801   max(first_wdf(term), cf(term) - first_wdf(term)), which means terms with
1802   termfreq == 2 will also attain their bound (another 11% for the same
1803   database) while terms with higher termfreq but below the global bound will
1804   get a tighter bound.
1806 * Fix Database::locked() on single-file glass db to just return false (such
1807   databases can't be opened as a WritableDatabase so there can't be a write
1808   lock).  Previously this failed with: "DatabaseLockError: Unable to get write
1809   lock on /flintlock: Testing lock"
1811 * Fix compaction when both the input and output are specified as a file
1812   descriptor.  Previously this threw an exception due to an overeager check
1813   that destination != source.
1815 * Use O_TRUNC when compacting to single file.  If the output already exists but
1816   is larger than our output we don't want to just overwrite the start of it.
1817   This case also used to result in confusing compaction percentages.
1819 * Enable glass's "open_nearby_postlist" optimisation (which especially helps
1820   large wildcard queries) for writable databases without any uncommitted
1821   changes as well.
1823 * Make get_unique_terms() more efficient for glass.  We approximate
1824   get_unique_terms() by the length of the termlist (which counts boolean terms
1825   too) but clamp this to be no larger than the document length.  Since we need
1826   to open the termlist to get its length, it makes more sense to get the
1827   document length from that termlist for no extra cost rather than looking it
1828   up in the postlist table.
1830 * Database::check() now checks document lengths against the stored document
1831   length lower and upper bounds.  Patch from Uppinder Chugh.  Fixes
1832   https://trac.xapian.org/ticket/617.
1834 * Fix bogus handling of most-recently-read value slot statistics.  It seems
1835   that we get lucky and this can't actually cause a problem in practice due
1836   to another layer of caching above, but if nothing else it's a bug waiting to
1837   happen.
1839 * If we fail to create the directory for a new database because the path
1840   already exists, the exception now reports EEXIST as the errno value rather
1841   than whatever errno value happened to be set from an earlier library call.
1843 remote backend:
1845 * xapian-tcpsrv --one-shot no longer forks.  We need fork to handle multiple
1846   concurrent connections, but when handling a single connection forking just
1847   adds overhead and potentially complicates process management for our caller.
1848   This aligns with the behaviour under __WIN32__ where we use threads instead
1849   of forking, and service the connection from the main thread with --one-shot.
1851 * Fix repeat call to ValueIterator::check() on the same docid to not always
1852   set valid to true for remote backend.
1854 inmemory backend:
1856 * Fix repeat call to ValueIterator::check() on the same docid to not always
1857   set valid to true for inmemory backend.
1859 build system:
1861 * configure: Fix potentially confusing messages suggesting snprintf was added
1862   in C90 - it was actually standardised in C99.
1864 * Eliminate configure probes related to off_t by using C++11 features.
1866 * The installed xapian-config script is now cleaned up by removing code to
1867   handle use before installation.  This extra code contained build paths
1868   which meant the build wasn't bit-for-bit reproducible unless the same
1869   build directory name was used.  This change also eliminates use of
1870   automake's $(transform) (which seems to be intended an internal mechanism)
1871   and fixes "make uninstall" to remove xapian-config when a program-prefix or
1872   -suffix is in use (e.g. there's a default -1.5 suffix for git master
1873   currently).
1875 * Directory separator knowledge is now factored out into configure, based on
1876   $host_os and __WIN32__ (it seems hard to probe for this in a way which works
1877   when cross-compiling).
1879 * Fix build with --disable-backend-remote.
1881 * In an out-of-tree build configured with --enable-maintainer-mode
1882   and --disable-dependency-tracking we would fail to create the
1883   "tests/soaktest" and "unicode" directories in the build directory.
1884   Patch from Gaurav Arora.
1886 * Improve handling of multitarget rule stamp files.  Clean them on "make
1887   maintainer-clean" and ship them so that --enable-maintainer-mode when
1888   building from a tarball doesn't needlessly rerun the multitarget rules.
1890 * Split out allsnowballheaders.h again to avoid include path issues with
1891   unittest in out-of-tree maintainer-mode builds.
1893 * xapian-core.pc: Both the Name and Description were too long compared to
1894   pkg-config norms, and the Description was trying to be multi-line which it
1895   seems pkg-config doesn't support.  Fixes
1896   https://github.com/xapian/xapian/pull/203, reported by orbea.
1898 documentation:
1900 * Stop describing Xapian as "Probabilistic" - we've also had non-probabilistic
1901   weighting schemes since 1.3.2.
1903 * Improve API docs for MSet::snippet().
1905 * Correct some class names in doxygen file documentation comments.
1907 * Mark up shell command as code-block:: sh.
1909 tools:
1911 * xapian-delve:
1913   + Document values can contain binary data, so escape them by default for
1914     output.  Other options now supported are to decode as a packed integer
1915     (like omindex uses for last modified), decode using
1916     Xapian::sortable_unserialise(), and to show the raw form (which was the
1917     previous behaviour).
1919   + Report current database revision.
1921 * xapian-inspect:
1923   + Report entry count when opening table
1925   + Support inspecting single file DBs via a new --table option (which can also
1926     be used with a non-single-file DB instead of specifying the path to the
1927     table).
1929   + Add "first" and "last" commands which jump to the first/last entry in the
1930     current table respectively.
1932   + "until" now counts and reports the number of entries advanced by.
1934   + Document "until" with no arguments - this advances to the end of the table,
1935     but wasn't mentioned in the help.
1937   + Commands "goto" and "until" which take a key as an argument now expect the
1938     key in the same escaped form that's used for display.  This makes it much
1939     simpler to interact with tables with binary keys.
1941   + Fix to expect .glass not .DB extension of glass tables.
1943 portability:
1945 * Sort out building using MSVC with the standard build system, and fix assorted
1946   problems.  MSVC 2015 or later is required for decent C++11 support.  Both 32-
1947   and 64-bit builds are now supported.
1949 * Remove code specific to old MSVC nmake build system.  The latter has been
1950   removed already.
1952 * Don't use WIN32 API to parse/unparse UUIDs.  So much glue code is needed that
1953   it's simpler to just do the parsing and unparsing ourselves, and we already
1954   have an implementation which is used when generating UUIDs using /proc on
1955   Linux.  We still use UuidCreate() to generate a new UUID.
1957 * Improve compiler visibility attribute detection to check that using the
1958   attributes doesn't result in a warning - previously we'd enable them even on
1959   platforms which don't support them, which would result in a compiler warning
1960   for every file compiled.  We now probe for -fvisibility=hidden and
1961   -fvisibility-inlines-hidden together as it seems all compilers implement both
1962   or neither, and it's faster to do one probe instead of two.
1964 * Don't pass the same FDSET twice in same select() - this appears not to be
1965   allowed by current POSIX, and causes warnings with GCC8.
1967 * Fix compacttofd testcases to specify O_BINARY so they pass on platforms
1968   where O_BINARY matters.
1970 * configure: Probe for declaration of _putenv_s.  It seems that the symbol is
1971   always present in the MSVCRT DLL, but older mingw may not provide a
1972   declaration for it.
1974 * Fix "may be used uninitialised" warning with GCC 4.9.2 and -Os.
1976 * Suppress mingw32 deprecation warning for useconds_t.  We've already switched
1977   away from useconds_t on git master, but it's not easy to do for 1.4.x without
1978   ABI breakage.
1980 * Fix signed vs unsigned warnings with assertions on.
1982 * Use $(SED) instead of hard-coding "sed".  The rules concerned are all ones
1983   that only maintainers currently need to run, but we're likely to enable
1984   maintainer-mode by default at some point and then portability here will
1985   matter more.
1987 * Add missing explicit <algorithm> for std::max()/std::min().
1989 * Check for EAGAIN as well as EINTR from select().  The Linux select(2) man
1990   page says: "Portable programs may wish to check for EAGAIN and loop, just as
1991   with EINTR" and that seems to be necessary for Cygwin at least.
1993 * Probe for exp10() declaration as Cygwin seems to have the symbol but lacks a
1994   declaration in the headers.  Just ignoring it is simplest and we'll use GCC's
1995   __builtin_exp10() instead.
1997 * Fix warnings when building Snowball compiler with recent GCC.
1999 * Fix Perl script used during maintainer builds to work with Perl < 5.10.  Such
2000   old perl versions shouldn't really be relevant for maintainer builds at this
2001   point, but appveyor's mingw install has such a Perl version.
2003 * Remove unused macro STATIC_ASSERT_TYPE_DOMINATES (unused, except by
2004   internaltest unit test for it, since the flint backend was removed in 2011)
2005   and replace uses of STATIC_ASSERT_UNSIGNED_TYPE with C++11 features
2006   static_assert and std::is_unsigned instead.
2008 * Don't retry on (errno == EINTR) when read() or pread() indicates end-of-file.
2009   This could potentially have put us into an infinite loop if we encountered
2010   this situation and errno happened to be EINTR from a previous library call.
2012 * Make read-only data arrays consistently static and const.
2014 * Avoid casting invalid value to enum reply_type if an invalid reply code is
2015   received from a remote server.  This is technically undefined behaviour,
2016   though in practice probably not a problem.
2018 * Eliminate an array of function pointers and some char* array members in
2019   library, reducing the number of relocations needed at shared library load
2020   time, which reduces the total time to load the library.
2022 packaging:
2024 * Use https for tarball URLs in .spec files.  This provides protection against
2025   MITM attacks on people building packages using these spec files, and is also
2026   slightly more efficient as the http: URLs redirect to the https: versions
2027   anyway.
2029 debug code:
2031 * Fix build when configured with --enable-log due to bugs in debug logging
2032   annotations.  Patch from Uppinder Chugh.
2034 * Fix assertion for value range on empty slot.
2036 * Use AssertEq() rather than Assert with ==, the former reports the two
2037   values if the assertion fails.
2039 Xapian-core 1.4.5 (2017-10-16):
2041 API:
2043 * Add Database::get_total_length() method.  Previously you had to calculate
2044   this from get_avlength() and get_doccount(), taking into account rounding
2045   issues.  But even then you couldn't reliably get the exact value when total
2046   length is large since a double's mantissa has more limited precision than an
2047   unsigned long long.
2049 * Add Xapian::iterator_rewound() for bidirectional iterators, to test if the
2050   iterator is at the start (useful for testing whether we're done when
2051   iterating backwards).
2053 * DatabaseOpeningError exceptions now provide errno via get_error_string()
2054   rather than turning it into a string and including it in the exception
2055   message.
2057 * WritableDatabase::replace_document(): when passed a Document object which
2058   came from a database and has unmodified values, we used to always read
2059   those values into a memory structure.  Now we only do this if the document
2060   is being replaced to the same document ID which it came from, which should
2061   make other cases a bit more efficient.
2063 * Enquire::get_eset(): When approximating term frequencies we now round to the
2064   nearest integer - previously we always rounded down.
2066 testsuite:
2068 * Improve Xapian::Document test coverage.
2070 * Pass --child-silent-after-fork=yes to valgrind which stops us creating a
2071   .valgrind.log.* file for every remote testcase run.  This option was added in
2072   valgrind 3.3.0 which is already the minimum version we support.
2074 * Open and unlink valgrind log before option parsing so we no longer leave a
2075   log file behind if there's an error parsing options or for options like
2076   --help which report and exit.
2078 * Delete .valgrind.log.* on "make clean" - if tests are run under valgrind and
2079   the test is killed at just the wrong moment then a log file may be left
2080   behind.
2082 * Fix the NetworkError with ECHILD check added in 1.4.4 - this will no longer
2083   segfault if the test harness catches a NetworkError without an error string.
2085 matcher:
2087 * Iterating of positions has been sped up, which means phrase matching is now
2088   faster (by a little over 5% in some simple tests).
2090 * Fix use after free of QueryOptimiser hint in certain cases involving
2091   multiple databases only some of which have positional information.
2092   This bug was introduced by changes in xapian-core 1.4.3.  Fixes #752,
2093   reported and analysed by Robert Stepanek.
2095 * An unweighted OP_AND_MAYBE is now optimised to just its left branch - the
2096   other branch or branches only contribute weight, so can be completely ignored
2097   when the operator is unweighted.
2099 inmemory backend:
2101 * Use binary chop instead of linear search in all places where we're searching
2102   for a term or document - we weren't taking advantage of the sorted order
2103   everywhere.
2105 build system:
2107 * xapian-core.pc: Specify Libs.private in pkgconfig file, which is needed for
2108   static linking, and probably also for shared libraries on platforms without
2109   DT_NEEDED or something equivalent.  Fixes #751, reported by Matthieu Gautier.
2111 documentation:
2113 * Document that QueryParser::set_default_op() supports OP_MAX - this
2114   has been the case since OP_MAX was added, but the API docs for
2115   set_default_op() weren't updated to reflect this.
2117 * Document OP_MAX and OP_WILDCARD.
2119 * Fix documentation of TermGenerator stop_strategy values STOP_ALL and
2120   STOP_STEMMED.  Reported by Matthieu Gautier in #750.  Thanks to Gaurav Arora
2121   for additional investigation.
2123 * net/remote_protocol.rst: Update the current version of the remote protocol
2124   version (39 not 38).  The differences between the two are only in the Query
2125   and MSet serialisations which aren't documented in detail here.
2127 * Link get_unique_terms_begin() and get_terms_begin() API documentation -
2128   the cross-referencing is useful in itself, but also helps to highlight
2129   the difference between the two.
2131 * Fix "IPv5" -> "IPv6" comment typo.  Noted by James Clarke
2133 * deprecation.html:
2135   + Add deprecated Enquire::get_eset() overload - this was marked as deprecated
2136     in the header file, but hadn't been added here.
2138   + Move deprecated typedefs to the "to be removed" list - they'd been
2139     accidentally added to the "removed" list.
2141   + Improve descriptions of several deprecated features.
2143 * QueryParser::set_max_expansion() is now discussed in the API documentation
2144   instead of the deprecated set_max_wildcard_expansion().
2146 * Clarify PostList::check() API documentation:  If valid is set to false, then
2147   NULL must be returned (pruning in this situation doesn't make sense) and
2148   at_end() shouldn't be called (because it implicitly depends on the current
2149   position being valid).
2151 * HACKING:
2153   + Update re -Wold-style-cast which we enabled and then had to disable again.
2155   + Update links to C++ FAQ and libstdc++'s debug mode.
2157   + Update several URLs to use https.
2159   + The 1.2 release branch has now been retired, so remove 1.2-specific
2160     backporting tips.
2162 portability:
2164 * Also check <errno.h> for sys_nerr and sys_errlist.  This is probably a more
2165   common location for them than Linux's <stdio.h> (even on Linux the man page
2166   says they're in <errno.h> but that doesn't match reality).
2168 * Use $(CC) not $(CC_FOR_BUILD) to build zlib-vg.so.  The test for whether we
2169   need it is based on the host OS, so it makes more sense to use the host
2170   compiler to build it when cross compiling.
2172 * On Hurd F_GETLK currently always fails with errno set to ENOSYS - treat this
2173   the same way as ENOLCK.  This fixes the testsuite on GNU Hurd, broken since
2174   the addition on Database::locked() in 1.4.3.
2176 * Add missing #include "safesyssocket.h", needed on at least FreeBSD to get
2177   AF_INET and SOCK_STREAM defined.  Fixes
2178   https://github.com/xapian/xapian/pull/154, reported by Po-Chuan Hsieh
2179   (alternative fix applied was suggested by James Aylett).
2181 * configure: Fixed the probe for whether the test harness can use RTTI with
2182   IBM's xlC compiler (which defaults to not generating RTTI).  Previously the
2183   probe would always think RTTI was available.
2185 debug code:
2187 * Fix some incorrect class/method names in debug logging.
2189 * Stop disabling ccache for coverage builds as ccache 3.2.2 now supports
2190   caching compilations with --coverage, and they work as far back as ccache 3.0
2191   (caching is automatically disabled by these older versions).
2193 * Drop --enable-quiet from in COVERAGE_CONFIGURE - this option no longer does
2194   anything since 1.3.1.
2196 Xapian-core 1.4.4 (2017-04-19):
2198 API:
2200 * Database::check():
2202   + Fix checking a single table - changes in 1.4.2 broke such checks unless you
2203     specified the table without any extension.
2205   + Errors from failing to find the file specified are now thrown as
2206     DatabaseOpeningError (was DatabaseError, of which DatabaseOpeningError is
2207     a subclass so existing code should continue to work).  Also improved the
2208     error message when the file doesn't exist is better.
2210 * Drop OP_SCALE_WEIGHT over OP_VALUE_RANGE, OP_VALUE_GE and OP_VALUE_LE in the
2211   Query constructor.  These operators always return weight 0 so OP_SCALE_WEIGHT
2212   over them has no effect.  Eliminating it at query construction time is cheap
2213   (we only need to check the type of the subquery), eliminates the confusing
2214   "0 * " from the query description, and means the OP_SCALE_WEIGHT Query object
2215   can be released sooner.  Inspired by Shivanshu Chauhan asking about the query
2216   description on IRC.
2218 * Drop OP_SCALE_WEIGHT on the right side of OP_AND_NOT in the Query
2219   constructor.  OP_AND_NOT takes no weight from the right so OP_SCALE_WEIGHT
2220   has no effect there.  Eliminating it at query construction time is cheap
2221   (just need to check the subquery's type), eliminates the confusing "0 * "
2222   from the query description, and means the OP_SCALE_WEIGHT object can be
2223   released sooner.
2225 testsuite:
2227 * Add more tests of Database::check().  Fixes #238, reported by Richard
2228   Boulton.
2230 * Make apitest testcase nosuchdb1 fail if we manage to open the DB.
2232 * Skip testcases which throw NetworkError with errno value ECHILD - this
2233   indicates system resource starvation rather than a Xapian bug.  Such failures
2234   are seen on Debian buildds from time to time, see:
2235   https://bugs.debian.org/681941
2237 matcher:
2239 * Fix incorrect results due to uninitialised memory.  The array holding max
2240   weight values in MultiAndPostList is never initialised if the operator is
2241   unweighted, but the values are still used to calculate the max weight to pass
2242   to subqueries, leading to incorrect results.  This can be observed with an OR
2243   under an unweighted AND (e.g. OR under AND on the right side of AND_NOT).
2244   The fix applied is to simply default initialise this array, which should lead
2245   to a max weight of 0.0 being passed on to subqueries.  Bug reported in
2246   notmuch by Kirill A. Shutemov, and forwarded by David Bremner.
2248 documentation:
2250 * Correct "Query::feature_flag" -> "QueryParser::feature_flag".  Fixes #747,
2251   reported by James Aylett.
2253 * Rename set_metadata() `value` parameter to `metadata`.  This change is
2254   particularly motivated by making it easier to map this case specially in SWIG
2255   bindings, but the new name is also clearer and better documents its purpose.
2257 * Rename value range parameters.  The new names (`range_limit` instead of
2258   `limit`, `range_lower` instead of `begin` and `range_upper` instead of `end`)
2259   are particularly motivated by making it easier to map them specially in SWIG
2260   bindings, but they're also clearer names which better document their
2261   purposes.
2263 * Change "(key, tag)" to "(key, value)" in user metadata docs.  The user
2264   metadata is essentially what's often called a "key-value store" so users
2265   are likely to be familiar with that terminology.
2267 * Consistently name parameter of Weight::unserialise() overridden forms.
2268   In xapian/weight.h it was almost always named `serialised`, but LMWeight
2269   named it `s` and CoordWeight omitted the name.
2271 * Fix various minor documentation comment typos.
2273 portability:
2275 * Fix configure probe for __builtin_exp10() to work around bug on mingw - there
2276   GCC generates a call to exp10() for __builtin_exp10() but there is no exp10()
2277   function in the C library, so we get a link failure.  Use a full link test
2278   instead to avoid this issue.  Reported by Mario Emmenlauer on xapian-devel.
2280 * Fix configure probe for log2() which was failing on at least some platforms
2281   due to ambiguity between overloaded forms of log2().  Make the probe
2282   explicitly check for log2(double) to avoid this problem.
2284 * Workaround the unhelpful semantics of AI_ADDRCONFIG on platforms which follow
2285   the old RFC instead of POSIX (such as Linux) - if only loopback networking is
2286   configured, localhost won't resolve by name or IP address, which causes
2287   testsuites using the remote backend over localhost to fail in auto-build
2288   environments which deliberately disable networking during builds.  The
2289   workaround implemented is to check if the hostname is "::1", "127.0.0.1" or
2290   "localhost" and disable AI_ADDRCONFIG for these.  This doesn't catch all
2291   possible ways to specify localhost, but should catch all the ways these might
2292   be specified in a testsuite.  Fixes https://bugs.debian.org/853107, reported
2293   by Daniel Schepler and the root cause uncovered by James Clarke.
2295 debug code:
2297 * Adjust assertion in InMemoryPostList.  Calling skip_to() is fine when the
2298   postlist hasn't been started yet (but the assertion was failing for a term
2299   not in the database).  Latent bug, triggered by testcases complexphrase1 and
2300   complexnear1 as updated for addition of support for OP_OR subqueries of
2301   OP_PHRASE/OP_NEAR.
2303 Xapian-core 1.4.3 (2017-01-25):
2305 API:
2307 * MSet::snippet(): Favour candidate snippets which contain more of a diversity
2308   of matching terms by discounting the relevance of repeated terms using an
2309   exponential decay.  A snippet which contains more terms from the query is
2310   likely to be better than one which contains the same term or terms multiple
2311   times, but a repeated term is still interesting, just less with each
2312   additional appearance.  Diversity issue highlighted by Robert Stepanek's
2313   patch in https://github.com/xapian/xapian/pull/117 - testcases taken from his
2314   patch.
2316 * MSet::snippet(): New flag SNIPPET_EMPTY_WITHOUT_MATCH to get an empty snippet
2317   if there are no matches in the text passed in.  Implemented by Robert
2318   Stepanek.
2320 * Round MSet::get_matches_estimated() to an appropriate number of significant
2321   figures.  The algorithm used looks at the lower and upper bound and where the
2322   estimate sits between them, and then picks an appropriate number of
2323   significant figures.  Thanks to Sébastien Le Callonnec for help sorting out a
2324   portability issue on OS X.
2326 * Add Database::locked() method - where possible this non-invasively checks if
2327   the database is currently open for writing, which can be useful for
2328   dashboards and other status reporting tools.
2330 testsuite:
2332 * Use terms that exist in the database for most snippet tests.  It's good to
2333   test that snippet highlighting works for terms that aren't in the database,
2334   but it's not good for all our snippet tests to feature such terms - it's
2335   not the common usage.
2337 matcher:
2339 * Improve value range upper bound and estimated matches.  The value slot
2340   frequency provides a tighter upper bound than Database::get_doccount().
2341   The estimate is now calculated by working out the proportion of possible
2342   values between the slot lower and upper bounds which the range covers
2343   (assuming a uniform distribution).  This seems to work fairly well in
2344   practice, and is certainly better than the crude estimate we were using:
2345   Database::get_doccount() / 2
2347 * Handle arbitrary combinations of OP_OR under OP_NEAR/OP_PHRASE, partly
2348   addressing #508.  Thanks to Jean-Francois Dockes for motivation and testing.
2350 * Only convert OP_PHRASE to OP_AND if full DB has no positions.  Until now the
2351   conversion was done independently for each sub-database, but being consistent
2352   with the results from a database containing all the same documents seems more
2353   useful.
2355 * Avoid double get_wdf() call for first subquery of OP_NEAR and OP_PHRASE,
2356   which will speed them up by a small amount.
2358 documentation:
2360 * INSTALL: Update section about -Bsymbolic-functions which is not a new
2361   GNU ld feature at this point.
2363 tools:
2365 * xapian-delve: Uses new Database::locked() method to report if the database
2366   is currently locked.
2368 portability:
2370 * Fix build failure cross-compiling for android due to not pulling in header
2371   for errno.
2373 * Fix compiler warnings.
2375 Xapian-core 1.4.2 (2016-12-26):
2377 API:
2379 * Add XAPIAN_AT_LEAST(A,B,C) macro.
2381 * MSet::snippet(): Optimise snippet generation - it's now ~46% faster in a
2382   simple test.
2384 * Add Xapian::DOC_ASSUME_VALID flag which tells Database::get_document() that
2385   it doesn't need to check that the passed docid is valid.  Fixes #739,
2386   reported by Germán M. Bravo.
2388 * TfIdfWeight: Add support for the L wdf normalisation.  Patch from Vivek Pal.
2390 * BB2Weight: Fix weights when database has just one document.  Our existing
2391   attempt to clamp N to be at least 2 was ineffective due to computing
2392   N - 2 < 0 in an unsigned type.
2394 * DPHWeight: Fix reversed sign in quadratic formula, making the upper bound a
2395   tiny amount higher.
2397 * DLHWeight: Correct upper bound which was a bit too low, due to flawed logic
2398   in its derivation.  The new bound is slightly less tight (by a few percent).
2400 * DLHWeight,DPHWeight: Avoid calculating log(0) when wdf is equal to the
2401   document length.
2403 * TermGenerator: Handle stemmer returning empty string - the Arabic stemmer
2404   can currently do this (e.g. for a single tatweel) and user stemmers can too.
2405   Fixes #741, reported by Emmanuel Engelhart.
2407 * Database::check(): Fix check that the first docid in each doclength chunk is
2408   more than the last docid in the previous chunk - this code was in the wrong
2409   place so didn't actually work.
2411 * Database::get_unique_terms(): Clamp returned value to be <= document length.
2412   Ideally get_unique_terms() ought to only count terms with wdf > 0, but that's
2413   expensive to calculate on demand.
2415 glass backend:
2417 * When compacting we now only write the iamglass file out once, and we write it
2418   before we sync the tables but sync it after, which is more I/O friendly.
2420 * Database::check(): Fix in SEGV when out == NULL and opts != 0.
2422 * Fix potential SEGV with corrupt value stats.
2424 chert backend:
2426 * Fix potential SEGV with corrupt value stats.
2428 build system:
2430 * Add XO_REQUIRE autoconf macro to provide an easy way to handle version checks
2431   in user configure scripts.
2433 tools:
2435 * quest: Support BM25+, LM and PL2+ weighting schemes.
2437 * xapian-check: Fix when ellipses are shown in 't' mode.  They were being shown
2438   when there were exactly 6 entries, but we only start omitting entries when
2439   there are *more* than 6.  Fix applies to both glass and chert.
2441 portability:
2443 * Avoid using opendir()/readdir() in our closefrom() implementation as these
2444   functions can call malloc(), which isn't safe to do between fork() and exec()
2445   in a multi-threaded program, but after fork() is exactly where we want to
2446   use closefrom().  Instead we now use getdirentries() on Linux and
2447   getdirentriesattr() on OS X (OS X support bugs shaken out with help from
2448   Germán M. Bravo).
2450 * Support reading UUIDs from /proc/sys/kernel/random/uuid which is especially
2451   useful when building for Android, as it avoids having to cross-build a UUID
2452   library.
2454 * Disable volatile workaround for excess precision SEGV for SSE - previously it
2455   was only being disabled for SSE2.
2457 * When building for x86 using a compiler where we don't know how to disable
2458   use of 387 FP instructions, we now run remote servers for the testsuite under
2459   valgrind --tool=none, like we do when --disable-sse is explicitly specified.
2461 * Add alignment_cast<T> which has the same effect as reinterpret_cast<T> but
2462   avoids warnings about alignment issues.
2464 * Suppress warnings about unused private members.  DLHWeight and DPHWeight
2465   have an unused lower_bound member, which clang warns about, but we need to
2466   keep them there in 1.4.x to preserve ABI compatibility.
2468 * Remove workaround for g++ 2.95 bug as we require at least 4.7 now.
2470 * configure: Probe for <cxxabi.h>.  GCC added this header in GCC 3.1, which
2471   is much older than we support, so we've just assumed it was available if
2472   __GNUC__ was defined.  However, clang lies and defines __GNUC__ yet doesn't
2473   seem to reliably provide <cxxabi.h>, so we need to probe for it.
2475 * Fix "unused assignment" warning.
2477 * configure: Probe for __builtin_* functions.  Previously we just checked for
2478   __GNUC__ being defined, but it's cleaner to probe for them properly -
2479   compilers other than GCC and those that pretend to be GCC might provide these
2480   too.
2482 * Use __builtin_clz() with compilers which support it to speed up encoding
2483   and especially decoding of positional data.  This speeds up phrase searching
2484   by ~0.5% in a simple test.
2486 * Check signed right shift behaviour at compile time - we can use a test on a
2487   constant expression which should optimise away to just the required version
2488   of the code, which means that on platforms which perform sign-extension
2489   (pretty much everything current it seems) we don't have to rely on the
2490   compiler optimising a portable idiom down to the appropriate right shift
2491   instruction.
2493 * Improve configure check for log2().  We include <cmath> so the check really
2494   should succeed if only std::log2() is declared.
2496 * Enable win32-dll option to LT_INIT.
2498 debug code:
2500 * xapian-inspect:
2502   + Support glass instead of chert.
2504   + Allow control of showing keys/tags.
2506   + Use more mnemonic letters than X for command arguments in help.
2508 Xapian-core 1.4.1 (2016-10-21):
2510 API:
2512 * Constructing a Query for a non-reference counted PostingSource object will
2513   now try to clone the PostingSource object (as happened in 1.3.4 and
2514   earlier).  This clone code was removed as part of the changes in 1.3.5 to
2515   support optional reference counting of PostingSource objects, but that breaks
2516   the case when the PostingSource object is on the stack and goes out of scope
2517   before the Query object is used.  Issue reported by Till Schäfer and analysed
2518   by Daniel Vrátil in a bug report against Akonadi:
2519   https://bugs.kde.org/show_bug.cgi?id=363741
2521 * Add BM25PlusWeight class implementing the BM25+ weighting scheme, implemented
2522   by Vivek Pal (https://github.com/xapian/xapian/pull/104).
2524 * Add PL2PlusWeight class implementing the PL2+ weighting scheme, implemented
2525   by Vivek Pal (https://github.com/xapian/xapian/pull/108).
2527 * LMWeight: Implement Dir+ weighting scheme as DIRICHLET_PLUS_SMOOTHING.
2528   Patch from Vivek Pal.
2530 * Add CoordWeight class implementing coordinate matching.  This can be useful
2531   for specialised uses - e.g. to implement sorting by the number of matching
2532   filters.
2534 * DLHWeight,DPHWeight,PL2Weight: With these weighting schemes, the formulae
2535   can give a negative weight contribution for a term in extreme cases.  We
2536   used to try to handle this by calculating a per-term lower bound on the
2537   contribution and subtracting this from the contribution, but this idea
2538   is fundamentally flawed as the total offset it adds to a document depends on
2539   what combination of terms that document matches, meaning in general the
2540   offset isn't the same for every matching document.  So instead we now clamp
2541   each term's weight contribution to be >= 0.
2543 * TfIdfWeight: Always scale term weight by wqf - this seems the logical
2544   approach as it matches the weighting we'd get if we weighted every non-unique
2545   term in the query, as well as being explicit in the Piv+ formula.
2547 * Fix OP_SCALE_WEIGHT to work with all weighting schemes - previously it was
2548   ignored when using PL2Weight and LMWeight.
2550 * PL2Weight: Greatly improve upper bound on weight:
2551   + Split the weight equation into two parts and maximise each separately as
2552     that gives an easily solvable problem, and in common cases the maximum is
2553     at the same value of wdfn for both parts.  In a simple test, the upper
2554     bounds are now just over double the highest weight actually achieved -
2555     previously they were several hundred times.  This approach was suggested by
2556     Aarsh Shah in: https://github.com/xapian/xapian/pull/48
2557   + Improve upper bound on normalised wdf (wdfn) - when wdf_upper_bound >
2558     doclength_lower_bound, we get a tighter bound by evaluating at
2559     wdf=wdf_upper_bound.  In a simple test, this reduces the upper bound on
2560     wdfn by 36-64%, and the upper bound on the weight by 9-33%.
2562 * PL2Weight: Fix calculation of upper_bound when P2>0.  P2 is typically
2563   negative, but for a very common term it can be positive and then we should
2564   use wdfn_lower not wdfn_upper to adjust P_max.
2566 * Weight::unserialise(): Check serialised form is empty when unserialising
2567   parameter-free schemes BoolWeight, DLHWeight and DPHWeight.
2569 * TermGenerator::set_stopper_strategy(): New method to control how the Stopper
2570   object is used.  Patch from Arnav Jain.
2572 * QueryParser: Fix handling of CJK query over multiple prefixes.  Previously
2573   all the n-gram terms were AND-ed together - now we AND together for each
2574   prefix, then OR the results.  Fixes #719, reported by Aaron Li.
2576 * Add Database::get_revision() method which provides access to the database
2577   revision number for chert and glass, intended for use by xapiand.  Marked
2578   as experimental, so we don't have to go through the usual deprecation cycle
2579   if this proves not to be the approach we want to take.  Fixes #709,
2580   reported by Germán M. Bravo.
2582 * Mark RangeProcessor constructor as `explicit`.
2584 testsuite:
2586 * OP_SCALE_WEIGHT: Check top weight is non-zero - if it is zero, tests which
2587   try to check that OP_SCALE_WEIGHT works will always pass.
2589 * testsuite: Check SerialisationError descriptions from Xapian::Weight
2590   subclasses mention the weighting scheme name.
2592 matcher:
2594 * Fix stats passed to Weight with OP_SYNONYM.  Previously the number of
2595   unique terms was never calculated, and a term which matched all documents
2596   would be optimised to an all-docs postlist, which fails to supply the
2597   correct wdf info.
2599 * Use floating point calculation for OR synonym freq estimates.  The division
2600   was being done as an integer division, which means the result was always
2601   getting rounded down rather than rounded to the nearest integer.
2603 glass backend:
2605 * Fix allterms with prefix on glass with uncommitted changes.  Glass aims to
2606   flush just the relevant postlist changes in this case but the end of the
2607   range to flush was wrong, so we'd only actually flush changes for a term
2608   exactly matching the prefix.  Fixes #721.
2610 remote backend:
2612 * Improve handling of invalid remote stub entries: Entries without a colon now
2613   give an error rather than being quietly skipped; IPv6 isn't yet supported,
2614   but entries with IPv6 addresses now result in saner errors (previously the
2615   colons confused the code which looks for a port number).
2617 build system:
2619 * XO_LIB_XAPIAN: Check for user trying to specify configure for XAPIAN_CONFIG
2620   and give a more helpful error.
2622 * Fix XO_LIB_XAPIAN to work without libtool.  Modern versions of GNU m4 error
2623   out when defn is used on an undefined macro.  Uncovered by Amanda Jayanetti.
2625 * Clean build paths out of installed xapian-config, mostly in the interests of
2626   facilitating reproducible builds, but it is also a little more robust as the
2627   "uninstalled tree" case can't then accidentally be triggered.
2629 * Drop compiler options that are no longer useful:
2630   + -fshow-column is the default in all GCC versions we now support
2631     (checked as GCC 4.6).
2632   + -Wno-long-long is no longer necessary now that we require C++11 where
2633     "long long" is a standard type.
2635 documentation:
2637 * Add API documentation comments for all classes, methods, constants, etc which
2638   were lacking them, and improve the content of some existing comments.
2640 * Stop hiding undocumented classes and members.  Hiding them silences doxygen's
2641   warnings about them, so it's hard to see what is missing, and the stub
2642   documentation produced is perhaps better than not documenting at all.
2643   Fixes #736, reported by James Aylett.
2645 * xapian-check: Make command line syntax consistent with other tools.
2647 * Note when MSet::snippet() was added.
2649 * deprecation.rst: Recommend unsigned over useconds_t for timeout values (but
2650   leave the API using useconds_t for 1.4.x for ABI compatibility.  The type
2651   useconds_t is now obsolete and anyway was intended to represent a time in
2652   microseconds (confusing when Xapian's timeouts are in milliseconds).  The
2653   Linux usleep man page notes: "Programs will be more portable if they never
2654   mention this type explicitly."
2656 portability:
2658 * Suppress compiler warnings about pointer alignment on some architectures.
2659   We know the data is aligned in these cases.
2661 * Fix replicate7 under Cygwin.
2663 debug code:
2665 * Add missing forward declaration needed by --enable-log build.
2667 Xapian-core 1.4.0 (2016-06-24):
2669 API:
2671 * Update to Unicode 9.0.0.
2673 portability:
2675 * Fix build on big-endian architectures.  The new unaligned word access
2676   functions expect WORDS_BIGENDIAN to be set, but configure.ac wasn't invoking
2677   AC_C_BIGENDIAN to arrange for this to be set.
2679 * Suppress compiler warnings about pointer alignment.  We know the data is
2680   suitably aligned, because the whole point of these functions is to allow
2681   reading an aligned word.
2683 Xapian-core 1.3.7 (2016-06-01):
2685 API:
2687 * Reimplement ESet and ESetIterator as we did for MSet and MSetIterator in
2688   1.3.5.  ESetIterator internally now counts down to the end of the ESet, so
2689   the end test is now against 0, rather than against eset.size().  And more of
2690   the trivial methods are now inlined, which reduces the number of relocations
2691   needed to load the library, and should give faster code which is a very
2692   similar size to before.
2694 * MSetIterator and ESetIterator are now STL-compatible random_access_iterators
2695   (previously they were only bidirectional_iterators).
2697 testsuite:
2699 * Merge queryparsertest and termgentest into apitest.  Their testcases now use
2700   the backend manager machinery in the testharness, so we don't have to
2701   hard-code use of inmemory and chert backends, but instead run them under all
2702   backends which support the required features.  This fixes some test failures
2703   when both chert and glass are disabled due to trying to run spelling tests
2704   with the inmemory backend.
2706 * Avoid overflowing collection frequency in totaldoclen1.  We're trying to test
2707   total document length doesn't wrap, so avoid collection freq overflowing in
2708   the process, as that triggers errors when running the testsuite under ubsan.
2709   We should handle collection frequency overflow better, but that's a separate
2710   issue.
2712 * Add some test coverage for ESet::get_ebound().
2714 matcher:
2716 * Fix upper bound on matches for OP_XOR.  Due to a reversed conditional, the
2717   estimate could be one too low in some cases where the XOR matched all the
2718   documents in the database.
2720 * Improve lower bound on matches for OP_XOR.  Previously the lower bound was
2721   always set to 0, which is valid, but we can often do better.
2723 glass backend:
2725 * Fix Database::check() parsing of glass changes file header.  In practice this
2726   was unlikely to actually cause problems.
2728 build system:
2730 * --disable-backend-remote now disables replication too which makes it
2731   actually usable (currently replication and the remote backend share most of
2732   their network code, so disabling them together probably makes sense anyway).
2734 * Improve builds with various combinations of backends disabled (see #361).
2736 portability:
2738 * Revert change to handle a self-initialised PIMPL object (e.g. Xapian::Query
2739   q(q);), added in 1.3.6.  It seems this case is actually undefined behaviour,
2740   so there's not much point trying to do anything about it.  Clang warns about
2741   the testcase for it (tested with 3.5), but sadly current GCC doesn't (tested
2742   with 6.1).
2744 * Use <cstdint> for integer types of known widths now we require C++11.
2746 * Replace unaligned word access functions with optimised versions which use
2747   memcpy() and (on little-endian platforms) a byte-swap (via compiler builtins
2748   where available).  Access revision numbers in database blocks with an aligned
2749   load, since we know they are suitably aligned.
2751 * Simplify handling of platforms where timer_create() exists but isn't
2752   suitable for our needs - AIX and GNU Hurd both have timer_create() but it
2753   always seems to fail (on Hurd this is because there's a dummy implementation
2754   in glibc which always fails with ENOSYS).  Trying a call at runtime which
2755   will never succeed is a waste of time, so we want to avoid defining
2756   HAVE_TIMER_CREATE in such cases.  Probing for this properly in configure
2757   would need us to compile and run a test program, which is unhelpful when
2758   cross-compiling, so for now just test against a blacklist of platforms we
2759   know don't provide a suitable timer_create() function.
2761 * Check _POSIX_MONOTONIC_CLOCK and if it's not defined, use CLOCK_REALTIME
2762   instead of CLOCK_MONOTONIC.  The existing hard-coded platform checks still
2763   seem to be needed, as on these platforms CLOCK_MONOTONIC is available for
2764   some functions, but doesn't work with timer_create() for one reason or
2765   another.  But the new check should avoid failures on platforms without any
2766   monotonic clock support.
2768 * Make opt_intrusive_base symbols visible to avoid UBSAN warnings.
2770 * Avoid potential set-but-unused warning - with both chert and glass disabled,
2771   last_docid's final set value isn't used, which GCC doesn't warn about, but
2772   other compilers might.
2774 * Avoid explicit recursive return of void - we've had warnings for such cases
2775   from some compilers in the past, and it's an odd thing to do outside of a
2776   template.
2778 Xapian-core 1.3.6 (2016-05-09):
2780 API:
2782 * TfIdfWeight: Support freq and squared IDF normalisations.  Patch from Vivek
2783   Pal.
2785 * New Xapian::Query::OP_INVALID to provide an "invalid" query object.
2787 * Reject OP_NEAR/OP_PHRASE with non-leaf subqueries early to avoid a
2788   potential segmentation fault if the non-leaf subquery decayed at
2789   just the wrong moment.  See #508.
2791 * Reduce positional queries with a MatchAll or PostingSource subquery to
2792   MatchNothing (since these subqueries have no positional information, so
2793   the query can't match).
2795 * Deprecate ValueRangeProcessor and introduce new RangeProcessor class as
2796   a replacement.  RangeProcessor()::operator()() method returns Xapian::Query,
2797   so a range can expand to any query.  OP_INVALID is used to signal that
2798   a range is not recognised.  Fixes #663.
2800 * Combining of ranges over the same quantity with OP_OR is now handled by
2801   an explicit "grouping" parameter, with a sensible default which works
2802   for value range queries.  Boolean term prefixes and FieldProcessor now
2803   support "grouping" too, so ranges and other filters can now be grouped
2804   together.
2806 * Formally deprecate WritableDatabase::flush().  The replacement commit()
2807   method was added in 1.1.0, so code can be switched to use this and still
2808   work with 1.2.x.
2810 * Fix handling of a self-initialised PIMPL object (e.g. Xapian::Query q(q);).
2811   Previously the uninitialised pointer was copied to itself, resulting in
2812   undefined behaviour when the object was used.  This isn't something you'd see
2813   in normal code, but it's a cheap check which can probably be optimised away
2814   by the compiler (GCC 6 does).
2816 testsuite:
2818 * Fix testcase notermlist1 to check correct table extension - ".glass" not
2819   ".DB" (chert doesn't support DB_NO_TERMLIST).
2821 build system:
2823 * Bootstrap with autoconf 2.69.  This requires GNU m4 >= 4.6, but that should
2824   no longer be an issue on developer machines.
2826 * Fix build with --enable-log.  Debug logging was trying to log
2827   compress_strategy parameter which was removed recently.  Reported by Ankit
2828   Paliwal on xapian-devel.
2830 documentation:
2832 * Fix misfiled deprecation notes.  Various things marked as deprecated and
2833   removed in 1.3.x have in fact been deprecated but not removed (they were just
2834   added to the wrong list).  One instance queried by David Bremner on #xapian,
2835   and a review found several more.
2837 * Improve docs for lcov makefile targets - say that these are targets in the
2838   xapian-core directory (noted by poe_ on #xapian), document
2839   coverage-reconfigure-maintainer-mode target, and clarify what the example of
2840   how to use GENHTML_ARGS actually does.
2842 * Note that Java bindings use xapian/iterator.h.
2844 * Update release checklist.  The script to build the release tarballs now
2845   automates some of the changes needed in trac.
2847 portability:
2849 * Fix build with Android NDK which declares sys_errlist and sys_nerr in the
2850   C library headers, but doesn't actually define them in the library itself.
2851   The configure test now tries to link a trivial program which uses these
2852   symbols.  Patch from Tejas Jogi.
2854 Xapian-core 1.3.5 (2016-04-01):
2856 This release includes all changes from 1.2.23 which are relevant.
2858 API:
2860 * The Snipper class has been replaced with a new MSet::snippet() method.
2861   The implementation has also been redone - the existing implementation was
2862   slower than ideal, and didn't directly consider the query so would sometimes
2863   selects a snippet which doesn't contain any of the query terms (which users
2864   quite reasonably found surprising).  The new implementation is faster, will
2865   always prefer snippets containing query terms, and also understands exact
2866   phrases and wildcards.  Fixes #211.
2868 * Add optional reference counting support for ErrorHandler, ExpandDecider,
2869   KeyMaker, PostingSource, Stopper and TermGenerator.  Fixes #186, reported
2870   by Richard Boulton.  (ErrorHandler's reference counting isn't actually used
2871   anywhere in xapian-core currently, but means we can hook it up in 1.4.x if
2872   ticket #3 gets addressed).
2874 * Deprecate public member variables of PostingSource.  The new getters and/or
2875   setters added in 1.2.23 and 1.3.5 are preferred.  Fixes #499, reported by
2876   Joost Cassee.
2878 * Reimplement MSet and MSetIterator.  MSetIterator internally now counts down
2879   to the end of the MSet, so the end test is now against 0, rather than against
2880   mset.size().  And more of the trivial methods are now inlined, which reduces
2881   the number of relocations needed to load the library, and should give faster
2882   code which is a very similar size to before.
2884 * Only issue prefetch hints for documents if MSet::fetch() is called.  It's not
2885   useful to send the prefetch hint right before the actual read, which was
2886   happening since the implementation of prefetch hints in 1.3.4.  Fixes #671,
2887   reported by Will Greenberg.
2889 * Fix OP_ELITE_SET selection in multi-database case - we were selecting
2890   different sets for each subdatabase, but removing the special case check for
2891   termfreq_max == 0 solves that.
2893 * Remove "experimental" marker from FieldProcessor, since we're happy with the
2894   API as-is.  Reported by David Bremner on xapian-discuss.
2896 * Remove "experimental" marker from Database::check().  We've not had any
2897   negative feedback on the current API.
2899 * Databse::check() now checks that doccount <= last_docid.
2901 * Database::compact() on a WritableDatabase with uncommitted changes could
2902   produce a corrupted output.  We now throw Xapian::InvalidOperationError in
2903   this case, with a message suggesting you either commit() or open the database
2904   from disk to compact from.  Reported by Will Greenberg on #xapian-discuss
2906 * Add Arabic stemmer.  Patch from Assem Chelli in
2907   https://github.com/xapian/xapian/pull/45
2909 * Improve the Arabic stopword list.  Patch from Assem Chelli.
2911 * Make functions defined in xapian/iterator.h 'inline'.
2913 * Don't force the user to specify the metric in the geospatial API -
2914   GreatCircleMetric is probably what most users will want, so a sensible
2915   default.
2917 * Xapian::DBCHECK_SHOW_BITMAP: This was added in 1.3.0 (so has never been in
2918   a stable release) and was superseded by Xapian::DBCHECK_SHOW_FREELIST in
2919   1.3.2, so just remove it.
2921 * Make setting an ErrorHandler a no-op - this feature is deprecated and we're
2922   not aware of anyone using it.  We're hoping to rework ErrorHandler in 1.4.x,
2923   which will be simpler without having to support the current behaviour as well
2924   as the new.  See #3.
2926 testsuite:
2928 * unittest: We can't use Assert() to unit test noexcept code as it throws an
2929   exception if it fails.  Instead set up macros to set a variable and return if
2930   an assertion fails in a unittest testcase, and check that variable in the
2931   harness.
2933 glass backend:
2935 * Make glass the default backend.  The format should now be stable, except
2936   perhaps in the unlikely event that a bug emerges which requires a format
2937   change to address.
2939 * Don't explicitly store the 2 byte "component_of" counter for the first
2940   component of every Btree entry in leaf blocks - instead use one of the upper
2941   bits of the length to store a "first component" flag.  This directly saves 2
2942   bytes per entry in the Btree, plus additional space due to fewer blocks and
2943   fewer levels being needed as a result.  This particularly helps the position
2944   table, which has a lot of entries, many of them very small.  The saving would
2945   be expected to be a little less than the saving from the change which shaved
2946   2 bytes of every Btree item in 1.3.4 (since that saved 2 bytes multiple times
2947   for large entries which get split into multiple items).  A simple test
2948   suggests a saving of several percent in total DB size, which fits that.  This
2949   change reduces the maximum component size to 8194, which affects tables
2950   with a 64KB blocksize in normal use and tables with >= 16KB blocksize with
2951   full compaction.
2953 * Refactor glass backend key comparison - == and < operations are replaced by
2954   a compare() function returns negative, 0 or positive (like strcmp(), memcmp()
2955   and std::string::compare()).  This allows us to avoid a final compare to
2956   check for equality when binary chopping, and to terminate early if the binary
2957   chop hits the exact entry.
2959 * If a cursor is moved to an entry which doesn't exist, we need to step back to
2960   the first component of previous entry before we can read its tag.  However we
2961   often don't actually read its tag (e.g. if we only wanted the key), so make
2962   this stepping back lazy so we can avoid doing it when we don't want to read
2963   the tag.
2965 * Avoid creating std::string objects to hold data when compressing and
2966   decompressing tags with zlib.
2968 * Store minimum compression length per table in the version file, with 0
2969   meaning "don't compress".  Currently you can only change this setting with a
2970   hex editor on the file, but now it is there we can later make use of it
2971   without needing a database format change.
2973 * Database::check() now performs additional consistency checks for glass.
2974   Reported by Jean-Francois Dockes and Bob Cargill via xapian-discuss.
2976 * Database::check(): check docids don't exceed db_last_docid when checking
2977   a single glass table.
2979 * We now throw DatabaseCorruptError in a few cases where it's appropriate
2980   but we didn't previously, in particular in the case where all the files in a
2981   DB have been truncated to zero size (which makes handling of this case
2982   consistent with chert).
2984 * Fix compaction to a single file which already exists.  This was hanging.
2985   Noted by Will Greenberg on #xapian.
2987 chert backend:
2989 * When using 64-bit Xapian::docid, consistently use the actual maximum valid
2990   docid value rather instead of the maximum value the type can hold.
2992 build system:
2994 * Default to only building shared libraries.  Building both shared and static
2995   means having to compile the files which make up the library twice on most
2996   platforms.  Shared libraries are the better option for most users, and if
2997   anyone really wants static libraries they can configure with --enable-static
2998   (or --enable-static=xapian-core if configuring a combined tree with the
2999   bindings).
3001 * Fix XAPIAN_TEST_LINKER_FLAG macro to actually test if it's possible to link
3002   with the option in LDFLAGS - previously we attempted to guess based on
3003   whether the error message from $CXX $flag contained the option name, which
3004   doesn't actually work very well.
3006 documentation:
3008 * Document that OP_WILDCARD expansion limits currently work per sub-db.
3010 * Remove reference to ChangeLog files, as we are no longer updating them.
3012 * Remove link to apidoc.pdf which we no longer generate this by default.
3014 * Clarify LatLongCoord::operator< purpose in API documentation.
3016 * Fix documentation comment typo - LatLongDistancePostingSource is a posting
3017   source, not a match decider!
3019 * HACKING: Recommend lcov 1.11 as it uses much less memory
3021 tools:
3023 * xapian-replicate: Obviously corrupt replicas now self-heal.  If a replica
3024   database fails to open with DatabaseCorruptError then a full copy is now
3025   forced.
3027 portability:
3029 * Eliminate arrays of C strings, which result in relocations at library load
3030   time, slowing startup and making pages containing them unsharable.
3032 * Refactor MSet::fetch() to reduce load time relocations.
3034 debug code:
3036 * Fix to build when configured with --enable-assertions.
3038 * Fix to build when configured with --enable-log.  Reported by Tim McNamara
3039   on #xapian-discuss.
3041 Xapian-core 1.3.4 (2016-01-01):
3043 This release includes all changes from 1.2.22 which are relevant.
3045 API:
3047 * Update to Unicode 8.0.0.  Fixes #680.
3049 * Overhaul database compaction API.  Add a Xapian::Database::compact() method,
3050   with the Database object specifying the source database(s).
3051   Xapian::Compactor is now just a functor to use if you want to control
3052   progress reporting and/or the merging of user metadata.  The existing API
3053   has been reimplemented using the new one, but is marked as deprecated.
3055 * Add support for a default value when sorting.  Fixes #452, patch from
3056   Richard Boulton.
3058 * Make all functor objects non-copyable.  Previously some were, some weren't,
3059   but it's hard to correctly make use of this ability.  Fixes #681.
3061 * Fix use after free with WILDCARD_LIMIT_MOST_FREQUENT.  If we tried to open a
3062   postlist after processing such a wildcard, the postlist hint could be
3063   pointing to a PostList object which had been deleted.  Fixes #696, reported
3064   by coventry.
3066 * Add support for optional reference counting of MatchSpy objects.
3068 * Improve Document::get_description() - the output is now always valid UTF-8,
3069   doesn't contain implementation details like "Document::Internal", and more
3070   clearly reports if the document is linked to a database.
3072 * Remove XAPIAN_CONST_FUNCTION marker from sortable_serialise_() helper, as it
3073   writes to the passed in buffer, so it isn't const or pure.  Fixes
3074   decvalwtsource2 testcase failure when compiled with clang.
3076 * Make PostingSource::set_maxweight() public - it's hard to wrap for the
3077   bindings as a protected method.  Fixes #498, reported by Richard Boulton.
3079 testsuite:
3081 * Add unit test for internal C_isupper(), etc functions.
3083 matcher:
3085 * Optimise value range which is a superset of the bounds.  If the value
3086   frequency is equal to the doccount, such a range is equivalent to MatchAll,
3087   and we now avoid having to read the valuestream at all.
3089 * Optimise OP_VALUE_RANGE when the upper bound can't be exceeded.  In this
3090   case, we now use ValueGePostList instead of ValueRangePostList.
3092 glass backend:
3094 * Shave 2 bytes of every Btree item (which will probably typically reduce
3095   database size by several percent).
3097 * More compact item format for branch blocks - 2 bytes per item smaller.  This
3098   means each branch block can branch more ways, reducing the number of Btree
3099   levels needed, which is especially helpful for cold-cache search times.
3101 * Track an upper bound on spelling word frequency.  This isn't currently used,
3102   but will be useful for improving the spelling algorithm, and we want to
3103   stabilise the glass backend format.  See #225, reported by Philip Neustrom.
3105 * Support 64-bit docids in the glass backend on-disk format.  This changes the
3106   encoding used by pack_uint_preserving_sort() to one which supports 64 bit
3107   values, and is a byte smaller for values 16384-32767, and the same size for
3108   all other 32 bit values.  Fixes #686, from original report by James Aylett.
3110 * Use memcpy() not memmove() when no risk of overlap.
3112 * Store length of just the key data itself, allowing keys to be up to 255 bytes
3113   long - the previous limit was 252.
3115 * Change glass to store DB stats in the version file.  Previously we stored
3116   them in a special item in the postlist table, but putting them in the version
3117   file reduces the number of block reads required to open the database, is
3118   simpler to deal with, and means we can potentially recalculate tight upper
3119   and lower bounds for an existing database without having to commit a new
3120   revision.
3122 * Add support for a single-file variant for glass.  Currently such databases
3123   can only be opened for reading - to create one you need to use
3124   xapian-compact (or its API equivalent).  You can embed such databases within
3125   another file, and open them by passing in a file descriptor open on that file
3126   and positioned at the offset the database starts at).  Database::check() also
3127   supports them.  Fixes #666, reported by Will Greenberg (and previously
3128   suggested on xapian-discuss by Emmanuel Engelhart).
3130 * Avoid potential DB corruption with full-compaction when using 64K blocks.
3132 * Where posix_fadvise() is available, use it to prefetch postlist Btree blocks
3133   from the level below the root block which will be needed for postlists of
3134   terms in the query, and similarly for the docdata table when MSet::fetch() is
3135   called.  Based on patch by Will Greenberg in #671.
3137 chert backend:
3139 * Where posix_fadvise() is available, use it to prefetch postlist Btree blocks
3140   from the level below the root block which will be needed for postlists of
3141   terms in the query, and similarly for the record table when MSet::fetch() is
3142   called.  Based on patch by Will Greenberg in #671.
3144 remote backend:
3146 * Fix hook for remote support of user weighting schemes.  The commented-out
3147   code used entirely the wrong class - now we use the server object we have
3148   access to, and forward the method to the class which needs it.
3150 build system:
3152 * New configure options --enable-64bit-docid and --enable-64bit-termcount,
3153   which control the size of these types.  Because these types are used in
3154   the API, libraries built with different combinations of them won't be ABI
3155   compatible.  Based heavily on patch from James Aylett and Dylan Griffith.
3156   Fixes #385.
3158 * Sort out hiding most of the internal symbols which had public visibility
3159   for various reason.  Mostly addresses #63.
3161 tools:
3163 * xapian-inspect: We no longer install this - it's really an aid to Xapian
3164   development rather than a user tool.
3166 portability:
3168 * Minimum supported GCC version is now documented as GCC 4.7, for C++11
3169   support.  Previously we documented 4.7 as the oldest known to work.
3171 * Use CLOCK_REALTIME with timer_create() on Cygwin.
3173 * Don't include winsock headers on Cygwin.  Instead include <arpa/inet.h> for
3174   htons() and htonl().
3176 * Handle AI_ADDRCONFIG not being defined by some mingw versions.
3178 * Fix to handle mingw now providing a nanosleep() function.
3180 * Use WSAAddressToString instead of inet_ntop under __WIN32__ - at least under
3181   mingw we don't seem to have inet_ntop().
3183 * Fix testsuite to compile when S_ISSOCK() isn't defined.
3185 debug code:
3187 * Add missing parameters to debug logging for a few methods.
3189 Xapian-core 1.3.3 (2015-06-01):
3191 This release includes all changes from 1.2.20-1.2.21 which are relevant.
3193 API:
3195 * Database:
3197   + Add new flag Xapian::DB_RETRY_LOCK which allows opening a database for
3198     writing to wait until it can get a write lock.  (Fixes #275, reported by
3199     Richard Boulton).
3201   + Fix Database::get_doclength_lower_bound() over multiple databases when some
3202     are empty or consist only of zero-length documents.  Previously this would
3203     report a lower bound of zero, now it reports the same lowest bound as a
3204     single database containing all the same documents.
3206   + Database::check(): When checking a single table, handle the ".glass"
3207     extension on glass database tables, and use the extension to guide the
3208     decision of which backend the table is from.
3210 * Query:
3212   + Add new OP_WILDCARD query operator, which expands wildcards lazily, so now
3213     we create the PostList tree for a wildcard directly, rather than creating
3214     an intermediate Query tree.  OP_WILDCARD offers a choice of ways to limit
3215     wildcard expansion (no limit, throw an exception, use the first N by term
3216     name, or use the most frequent N).  (See tickets #48 and #608).
3218 * QueryParser:
3220   + Add new set_max_expansion() method which provides access to OP_WILDCARD's
3221     choice of ways to limit expansion and can set limits for partial terms as
3222     well as for wildcards.  Partial terms now default to the 100 most frequent
3223     matching terms.  (Completes #608, reported by boomboo).
3225   + Deprecate set_max_wildcard_expansion() in favour of set_max_expansion().
3227 * Add support for optional reference counting of FieldProcessor and
3228   ValueRangeProcessor objects.
3230 testsuite:
3232 * If command line option --verbose/-v isn't specified, set the verbosity level
3233   from environmental variable VERBOSE.
3235 * Re-enable replicate3 for glass, as it no longer fails.
3237 * Add more test coverage for get_unique_terms().
3239 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
3241 glass backend:
3243 * When reporting freelist errors during a database check, distinguish between a
3244   block in use and in the freelist, and a block in the freelist more than once.
3246 * Fix compaction and database checking for the change to the format of keys
3247   in the positionlist table which happened in 1.3.2.
3249 * After splitting a block, we always insert the new block in the parent right
3250   after the block it was split from - there's no need to binary chop.
3252 * Avoid infinite recursion when we hit the end of the freelist block we're
3253   reading and the end of the block we're writing at the same time.
3255 * Fix freelist handling to allow for the newly loaded first block of the
3256   freelist being already used up.
3258 chert backend:
3260 * Fix problems with get_unique_terms() on a modified chert database.
3262 * Fix xapian-check on a single chert table, which seg faulted in 1.3.2.
3264 remote backend:
3266 * Avoid dividing zero by zero when calculating the average length for an empty
3267   database.
3269 build system:
3271 * Merge generate-allsnowballheaders script into collate-sbl.
3273 portability:
3275 * A compiler with good support for C++11 is now required to build Xapian.
3276   Most of the actively developed C++ compilers already have decent support,
3277   or are close to having it, and it makes development easier and more
3278   efficient.  Currently known to work: GCC >= 4.7, recent versions of clang
3279   (3.5 works).  Solaris Studio 12.4 compiles the code, but tests currently
3280   fail.  IBM's xlC doesn't support enough of C++11 yet.  HP's aCC hasn't
3281   been tested, but its documentation suggests it also doesn't support enough
3282   of C++11 yet.
3284 * Drop workarounds and special cases for old versions of various compilers
3285   which don't support C++11.
3287 * Use C++11's static_assert() and unique_ptr instead of custom implementations
3288   of equivalent functionality.
3290 * Building on OS/2 with EMX is no longer supported - EMX was last updated in
3291   2001 and comes with GCC 3.2.1, which is much too old to support C++11.
3293 * Building with SGI's and Compaq's C++ compilers is no longer supported -
3294   both seem to have ceased development, and don't support C++11.
3296 * Building with STLport is no longer supported - STLport was last released in
3297   2008, so it's no longer actively developed and won't support C++11.
3299 * Building on IRIX is no longer supported, because IRIX has reached end of
3300   life.
3302 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
3303   compiler, as it fires for functions which end in a "throw" statement.
3304   Genuine instances of missing return values will be caught by compilers with
3305   superior warning machinery.
3307 * Fix warning from GCC 5.1 where template expansion leads to the comparison
3308   (bool_value < 255) which is always true.  Warning introduced by changes in
3309   1.3.2.
3311 * Use getaddrinfo() instead of gethostbyname(), since the latter may not be
3312   thread-safe, and as a step towards IPv6 support (see #374), but currently we
3313   still only look for IPv4 addresses.
3315 * timer_create() seems to always fail on AIX with EAGAIN, so just skip the
3316   matchtimelimit1 testcase there.
3318 * Under __WIN32__, we need to specify Vista as the minimum supported version to
3319   get the AI_ADDRCONFIG flag.  Older versions seem to all be out of support
3320   anyway.
3322 * Change configure probe for log2() to check for a declaration in <cmath>
3323   to get it to fix build on Solaris with Sun C++.  C++11 compilers should all
3324   provide log2(), but let's not rely on that just yet as it's easy to provide a
3325   fallback implementation.
3327 * Use scalbn() instead of ldexp() where possible (which we can in all cases
3328   when FLT_RADIX == 2, as it is on pretty much all current platforms).  On
3329   overflow and underflow ldexp() sets errno, which it seems better to avoid
3330   doing.
3332 * The list of stemmers is now in the same static const struct as the version
3333   info, and Stem::get_available_languages() is just an inlined wrapper which
3334   fetches this structure and returns the appropriate member.  This saves a
3335   relocation, reducing library load time a little.
3337 * Remove "pure" attribute from API functions which could throw an exception.
3338   These functions aren't really pure, and while we're happy for calls to them
3339   to be CSE-ed or eliminated entirely, the compiler might make more assumptions
3340   than that about a pure function - clang seems to assume pure => nothrow and
3341   an exception from such a function can't be caught.
3343 * Remove "pure" attribute from sortable_unserialise(), which can raise floating
3344   point exceptions FE_OVERFLOW and FE_UNDERFLOW.
3346 * Add "nothrow" attribute to more API functions which will never throw an
3347   exception.
3349 * Make sortable_serialise() an inlined wrapper around a function which won't
3350   throw and can be flagged with attribute 'const'.
3352 * Tweak sortable_unserialise() not to compare with a fixed string by
3353   constructing a temporary std::string object (which could throw
3354   std::bad_alloc), and mark it as XAPIAN_NOTHROW.
3356 debug code:
3358 * Only enable assertions in sortable_serialise() and sortable_unserialise() in
3359   the testsuite (since these functions shouldn't throw exceptions), and move
3360   the tests of these functions from queryparsertest to unittest to facilitate
3361   this.
3363 * Add more assertions to the glass backend code.
3365 Xapian-core 1.3.2 (2014-11-24):
3367 This release includes all changes from 1.2.16-1.2.19 which are relevant.
3369 API:
3371 * Update Unicode character database to Unicode 7.0.0.
3373 * New Xapian::Snipper class from Mihai Bivol's GSOC 2012 project.  (mostly
3374   fixes #211)
3376 * Fix all get_description() methods to always return UTF-8 text.  (fixes #620)
3378 * Database::check():
3380   + Alter to take its "out" parameter as a pointer to std::ostream instead of a
3381     reference, and make passing NULL mean "do not produce output", and make
3382     the second and third parameters optional, defaulting to a quiet check.
3384   + Escape invalid UTF-8 data in keys and tags reported by xapian-check, using
3385     the same code we use to clean up strings returned by get_description()
3386     methods.
3388   + Correct failure message which talks above the root block when it's actually
3389     testing a leaf key.
3391   + Rename DBCHECK_SHOW_BITMAP to DBCHECK_SHOW_FREELIST (old name still
3392     provided for now, but flagged as deprecated - DBCHECK_SHOW_BITMAP was new
3393     in 1.3.0, so will likely be removed before 1.4.0).
3395 * Methods and functions which take a string to unserialise now consistently
3396   call that parameter "serialised".
3398 * Weight: Make number of distinct terms indexing each document and the
3399   collection frequency of the term available to subclasses.  Patch from
3400   Gaurav Arora's Language Modelling branch.
3402 * WritableDatabase: Add support for multiple subdatabases, and support opening
3403   a stub database containing multiple subdatabases as a WritableDatabase.
3405 * WritableDatabase can now be constructed from just a pathname (defaulting to
3406   opening the database with DB_CREATE_OR_OPEN).
3408 * WritableDatabase: Add flags which can be bitwise OR-ed into the second
3409   argument when constructing:
3411   + Xapian::DB_NO_SYNC: to disable use of fsync, etc
3413   + Xapian::DB_DANGEROUS: to enable in-place updates
3415   + Xapian::DB_BACKEND_CHERT: if creating, create a chert database
3417   + Xapian::DB_BACKEND_GLASS: if creating, create a glass database
3419   + Xapian::DB_NO_TERMLIST: create a database without a termlist (see #181)
3421   + Xapian::DB_FULL_SYNC flag - if this is set for a database, we use the Mac
3422     OS X F_FULL_SYNC instead of fdatasync()/fsync()/etc on the version file
3423     when committing.
3425 * Database: Add optional flags argument to constructor - the following can be
3426   bitwise OR-ed into it:
3428   + Xapian::DB_BACKEND_CHERT (only open a chert database)
3430   + Xapian::DB_BACKEND_GLASS (only open a glass database)
3432   + Xapian::DB_BACKEND_STUB (only open a stub database)
3434 * Xapian::Auto::open_stub() and Xapian::Chert::open() are now deprecated in
3435   favour of these new flags.
3437 * Add LMWeight class, which implements the Unigram Language Modelling weighting
3438   scheme.  Patch from Gaurav Arora.
3440 * Add implementations of a number of DfR weighting schemes (BB2, DLH, DPH,
3441   IfB2, IneB2, InL2, PL2).  Patches from Aarsh Shah.
3443 * Add support for the Bo1 query expansion scheme.  Patch from Aarsh Shah.
3445 * Add Enquire::set_time_limit() method which sets a timelimit after which
3446   check_at_least will be disabled.
3448 * Database: Trying to perform operations on a database with no subdatabases now
3449   throws InvalidOperationError not DocNotFoundError.
3451 * Query: Implement new OP_MAX query operator, which returns the maximum weight
3452   of any of its subqueries.  (see #360)
3454 * Query: Add methods to allow introspection on Query objects - currently you
3455   can read the leaf type/operator, how many subqueries there are, and get a
3456   particular subquery.  For a query which is a term, Query::get_terms_begin()
3457   allows you to get the term.  (see #159)
3459 * Query: Only simplify OP_SYNONYM with a single subquery if that subquery is a
3460   term or MatchAll.
3462 * Avoid two vector copies when storing term positions in most common cases.
3464 * Reimplement version functions to use a single function in libxapian which
3465   returns a pointer to a static const struct containing the version
3466   information, with inline wrappers in the API header which call this.  This
3467   means we only need one relocation instead of 4, reducing library load time a
3468   little.
3470 * Make TermGenerator flags an anonymous enum, and typedef TermGenerator::flags
3471   to int for backward compatibility with existing user code which uses it.
3473 * Stem: Fix incorrect Unicode codepoints for o-double-acute and u-double-acute
3474   in the Hungarian Snowball stemmer.  Reported by Tom Lane to snowball-discuss.
3476 * Stem: Add an early english stemmer.
3478 * Provide the stopword lists from Snowball plus an Arabic one, installed in
3479   ${prefix}/share/xapian-core/stopwords/.  Patch from Assem Chelli, fixes #269.
3481 * Improve check for direct inclusion of Xapian subheaders in user code to
3482   catch more cases.
3484 * Add simple API to help with creating language-idiomatic iterator wrappers
3485   in <xapian/iterator.h>.
3487 testsuite:
3489 * Extend checkstatsweight1 to check that Weight::get_collection_freq() returns
3490   the same number as Database::get_collection_freq().
3492 * queryparsertest: Add testcase for FieldProcessor on boolean prefix with
3493   quoted contents.
3495 * queryparsertest: Enable some disabled cases which actually work (in some
3496   cases with slightly tweaked expected answers which are equivalent to those
3497   that were shown).
3499 * Make use of the new writable multidatabase feature to simplify the
3500   multi-database handling in the test harness.
3502 * Change querypairwise1_helper to repeat the query build 100 times, as with a
3503   fast modern machine we were sometimes trying with so many subqueries that we
3504   would run out of stack.
3506 * apitest: Use Xapian::Database::check() in cursordelbug1.  (partly addresses
3507   #238)
3509 * apitest: Test Query ops with a single MatchAll subquery.
3511 * apitest: New testcase readonlyparentdir1 to ensure that commit works with a
3512   read-only parent directory.
3514 matcher:
3516 * Streamline collation of statistics for use by weighting schemes - tests show
3517   a 2% or so increase in speed in some cases.
3519 * If a term matches all documents and its weight doesn't depend on its wdf, we
3520   can optimise it to MatchAll (the previous requirement that maxpart == 0 was
3521   unnecessarily strict).
3523 * Fix the check for a term which matches all documents to use the sub-db
3524   termfreq, not the combined db termfreq.
3526 * When we optimise a postlist for a term which matches all documents to use
3527   MatchAll, we still need to set a weight object on it to get percentages
3528   calculated correctly.
3530 glass backend:
3532 * 'brass' backend renamed to 'glass' - we decided to use names in ascending
3533   alphabetical order to make it easier to understand which backend is newest,
3534   and since 'flint' was used recently, we skipped over 'd', 'e' and 'f'.
3536 * Change positionlist keys to be ordered by term first rather than docid first,
3537   which helps phrase searching significantly.  For more efficient indexing,
3538   positionlist changes are now batched up in memory and written out in key
3539   order.
3541 * Use a separate cursor for each position list - now we're ordering the
3542   position B-tree by term first, phrase matching would cause a single cursor
3543   to cycle between disparate areas of the B-tree and reread the same blocks
3544   repeatedly.
3546 * Reference count blocks in the btree cursor, so cursors can cheaply share
3547   blocks.  This can significantly reduce the amount of memory used by cursors
3548   for queries which contain a lot of terms (e.g. wildcards which expand to a
3549   lot of terms).
3551 * Under glass, optimise the turning of a query into a postlist to reuse the
3552   cursor blocks which are the same as the previous term's postlist.  This is
3553   particularly effective for a wildcard query which expands to a lot of terms.
3555 * Keep track of unused blocks in the Btrees using freelists rather than
3556   bitmaps.  (fixes #40)
3558 * Eliminate the base files, and instead store the root block and freelist
3559   pointers in the "iamglass" file.
3561 * When compacting, sync all the tables together at the end.
3563 * In DB_DANGEROUS mode, update the version file in-place.
3565 * Only actually store the document data if it is non-empty.  The table which
3566   holds the document data is now lazily created, so won't exist if you never
3567   set the document data.
3569 chert backend:
3571 * Improve DBCHECK_FIX:
3573   + if fixing a whole database, we now take the revision from the first table
3574     we successfully look at, which should be correct in most cases, and is
3575     definitely better than trying to determine the revision of each broken
3576     table independently.
3578   + handle a zero-sized .DB file.
3580   + After we successfully regenerate baseA, remove any empty baseB file to
3581     prevent it causing problems.  Tracked down with help from Phil Hands.
3583 remote backend:
3585 * Bump remote protocol version to 38.0, due to extra statistics being tracked
3586   for weighting.
3588 * Make Weight::Internal track if any max_part values are set, so we don't need
3589   to serialise them when they've not been set.
3591 build system:
3593 * Fix conditional for enabling replication code - if chert is disabled but
3594   glass isn't, we should still enable it.
3596 * configure: Add hint for which package to install for rst2html
3598 documentation:
3600 * Don't build, ship or install PDF versions of the API docs by default, but
3601   provide an easy way for people to build it for themselves if they want it.
3603 * Convert equations in rst docs to use LaTeX via the math role and directive.
3605 * Actually ship, process and install geospatial.rst.
3607 * postingsource.rst: Use a modern class in postingsource example.  (Noted by
3608   James Aylett)
3610 * Move the protocol docs for the remote and replication protocols into the net/
3611   subdirectory.
3613 * Remove the dir_contents files and all the machinery to handle them.
3615 * HACKING: Note we now use doxygen 1.8.8 for 1.3.x snapshots and releases.
3617 * HACKING: Now using libtool 2.4.3 to bootstrap snapshots and 1.3.x releases.
3619 * HACKING: Now using automake 1.14.1 to bootstrap snapshots and 1.3.x releases.
3621 * HACKING: Drop note about needing git-svn if you're using git - bootstrap now
3622   only uses git-svn if your Xapian tree was checked out using git-svn.
3624 * HACKING: Need sphinx-doc to generate API docs for Python and Python 3 bindings.
3626 * HACKING: Note that MacTeX seems to be the best option if using homebrew.
3628 portability:
3630 * Don't pass an integer argument to log(), to avoid ambiguity errors with xlC
3631   and Sun's C++ compiler.  (fixes #627)
3633 * Fix compilations issues with Sun's C++ compiler (mostly missing library
3634   headers).
3636 * Implement RealTime::now() using clock_gettime() where it's available, since
3637   it can provide nanosecond resolution.
3639 * Implement RealTime::sleep() using nanosleep() where it's available, since it
3640   has a simpler API and a finer resolution than select().
3642 * Use lround() instead of round() in geospatial code, since we want the result
3643   as an int.  GCC 4.4.3 seems to optimise to use lround() anyway, but other
3644   compilers may not.
3646 * Include <math.h> for lround()/round(). (fixes #628)
3648 * Drop code supporting Microsoft Windows 9x which reached EOL in 2006.
3650 * Under C++11, use unique_ptr for AutoPtr.
3652 * Stop using a reference where we may end up passing *NULL, as that's invalid.
3653   Thanks Nick Lewycky and ubsan for helping track this down.
3655 * In DLHWeight and DPHWeight, avoid dividing by zero when the collection size
3656   is 0.
3658 debug code:
3660 * Fix assertion failure when built with --enable-assertions.  The behaviour
3661   when built without assertions happened to be correct.
3663 * Fix assertion in BitReader::decode(), and remove 'Assert(rd);' in two places
3664   where rd is no longer a pointer.
3666 Xapian-core 1.3.1 (2013-05-03):
3668 This release includes all changes from 1.2.10-1.2.15 which are relevant.
3670 API:
3672 * Give an compilation error if user code tries to include API headers other
3673   than xapian.h directly - these other headers are an internal implementation
3674   detail, but experience has shown that some people try to include them
3675   directly.  Please just use '#include <xapian.h>' instead.
3677 * Update Unicode character database to Unicode 6.2.0.
3679 * Add FieldProcessor class (ticket#128) - currently marked as an experimental
3680   API while we sort out how best to sort out exactly how it interacts with
3681   other QueryParser features.
3683 * Add implementation of several TF-IDF weighting schemes via a new TfIdfWeight
3684   class.
3686 * Add ExpandDeciderFilterPrefix class which only return terms with a particular
3687   prefix.  (fixes #467)
3689 * QueryParser: Adjust handling of Unicode opening/closing double quotes - if a
3690   quoted boolean term was started with ASCII double quote, then only ASCII
3691   double quote can end it, as otherwise it's impossible to quote a term
3692   containing Unicode double quotes.
3694 * Database::check(): If the database can't be opened, don't emit a bogus
3695   warning about there being too many documents to cross-check doclens.
3697 * TradWeight,BM25Weight: Throw SerialisationError instead of NetworkError if
3698   unserialise() fails.
3700 * QueryParser: Change the default stemming strategy to STEM_SOME, to eliminate
3701   the API gotcha that setting a stemmer is ignored until you also set a
3702   strategy.
3704 * Deprecate Xapian::ErrorHandler.  (ticket#3)
3706 * Stem: Generate a compact and efficient table to decode language names.  This
3707   is both faster and smaller than the approach we were using, with the added
3708   benefit that the table is auto-generated.
3710 * xapian.h:
3712   + Add check for Qt headers being included before us and defining
3713     'slots' as a macro - if they are, give a clear error advising how to work
3714     around this (previously compilation would fail with a confusing error).
3716   + Add a similar check for Wt headers which also define 'slots' as a macro
3717     by default.
3719 testsuite:
3721 * tests/generate-api_generated: Test that the string returned by a
3722   get_description() method isn't empty.
3724 * Use git commit hash in title of test coverage reports generated from a git
3725   tree.
3727 matcher:
3729 * Drop MatchNothing subqueries in OR-like situations in add_subquery() rather
3730   than adding them and then handling it later.
3732 * Handle the left side of AND_NOT and AND_MAYBE being MatchNothing in
3733   add_subquery() rather than in done().
3735 * Handle QueryAndLike with a MatchNothing subquery in add_subquery() rather
3736   than done().
3738 * Query: Multi-way operators now store their subquery pointers in a custom
3739   class rather than std::vector<Xapian::Query>.  The custom class take the
3740   same amount of space, or often less.  It's particularly efficient when
3741   there are two subqueries, which is very desirable as we no longer flatten a
3742   subtree of the same operator as we build the query.
3744 * Optimise an unweighted query term which matches all the documents in a
3745   subdatabase to use the "MatchAll" postlist.  (ticket#387)
3747 brass backend:
3749 * Iterating positional data now decodes it lazily, which should speed up
3750   phrases which include common words.
3752 * Compress changesets in brass replication. Increments the changeset version.
3753   Ticket #348
3755 * Restore two missing lines in database checking where we report a block with
3756   the wrong level.
3758 * When checking if a block was newly allocated in this revision, just look
3759   at its revision number rather than consulting the base file's bitmap.
3761 chert backend:
3763 * Iterating positional data now decodes it lazily, which should speed up
3764   phrases which include common words.
3766 remote backend:
3768 * Prefix compress list of terms and metadata keys in the remote protocol.
3769   This requires a remote protocol major version bump.
3771 build system:
3773 * Fix the 'libxapian' to be 'libxapian-1.3' and 'xapian.m4' to be
3774   'xapian-1.3.m4' (this was supposed to be the case for 1.3.0, but the
3775   change wasn't made correctly).
3777 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
3778   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
3779   V=1' and 'make V=0' which are broadly equivalent and more standard.
3781 * configure: If we fail to find a function needed for the remote backend, don't
3782   autodisable it - it's more helpful to error out so the use can decide if they
3783   want to pass --disable-backend-remote to disable it, or work out what values
3784   to pass for LIBS, etc to make it work.  This also matches what we do for the
3785   disk based backends.
3787 * automake 1.13.1 is now used to generate snapshots and releases.
3789 * Add check-syntax make target to support editor syntax checks.
3791 * Fix to build when configured with --disable-backend-brass
3792   --disable-backend-chert.  (ticket#586)
3794 * Generate a check for compatible _DEBUG settings if built with MSVC.
3795   (ticket#389)
3797 * If you run "make coverage-check" by hand, the previous default of compressed
3798   HTML is unhelpful, so don't default to passing --html-gzip to genhtml, but
3799   instead add support for GENHTML_ARGS.
3801 * API methods and functions are now marked as 'const', 'pure', or 'nothrow'
3802   allowing compilers which support such annotations to generate more efficient
3803   code.  (tickets #151, #454)
3805 documentation:
3807 * HACKING: Note which MacPorts are needed for development work.
3809 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
3810   message.
3812 tools:
3814 * xapian-check: Add "fix" option, which currently will regenerate iamchert if
3815   it isn't valid, and will regenerate base files from the .DB files (only
3816   really tested on databases which have just been compacted).
3818 portability:
3820 * Fix warning with GCC in build with assertions enabled.
3822 * common/fileutils.cc: Add safeunistd.h for mkdir, required by GCC 4.7
3823   (reported by Gaurav Arora).
3825 * backends/brass/brass_databasereplicator.cc: Use new/delete to avoid variable
3826   length array gcc extension and comply with c++98
3828 * Mark file descriptors as close-on-exec where supported.
3830 * api/queryinternal.cc: Need <functional> for mem_fun().
3832 * Work around Apple's OS X SDK defining a check() macro.
3834 * Add an option to use a flock() based locking implementation for brass and
3835   chert - this is much simpler than using fcntl() due to saner semantics around
3836   releasing locks when closing other descriptors on the same file (at least on
3837   platforms where flock() isn't just a compatibility wrapper around fcntl()).
3838   Sadly we can't simply switch to this without breaking locking compatibility
3839   with previous releases, but it's useful for platforms without fcntl()
3840   locking (it's enabled for DJGPP) and may be useful for custom builds for
3841   special purposes.
3843 packaging:
3845 * xapian-core.spec: Remove xapian-chert-update.
3847 debug code:
3849 * Building with --enable-log works once again.
3851 Xapian-core 1.3.0 (2012-03-14):
3853 API:
3855 * Update Unicode character database to Unicode 6.1.0.  (ticket#497)
3857 * TermIterator returned by Enquire::get_matching_terms_begin(),
3858   Query::get_terms_begin(), Database::synonyms_begin(),
3859   QueryParser::stoplist_begin(), and QueryParser::unstem_begin() now stores the
3860   list of terms to iterate much more compactly.
3862 * QueryParser:
3864   + Allow Unicode curly double quote characters to start and/or end phrases.
3866   + The set_default_op() method will now reject operators which don't make
3867     sense to set.  The operators which are allowed are now explicitly
3868     documented in the API docs.
3870 * Query: The internals have been completely reimplemented (ticket#280).  The
3871   notable changes are:
3873   + Query objects are smaller and should be faster.
3875   + More readable format for Query::get_description().
3877   + More compact serialisation format for Query objects.
3879   + Query operators are no longer flattened as you build up a tree (but the
3880     query optimiser still combines groups of the same operator).  This means
3881     that Query objects are truly immutable, and so we don't need to copy Query
3882     objects when composing them.  This should also fix a few O(n*n) cases when
3883     building up an n-way query pair-wise.  (ticket#273)
3885   + The Query optimiser can do a few extra optimisations.
3887 * There's now explicit support for geospatial search (this API is currently
3888   marked as experimental).  (ticket#481)
3890 * There's now an API (currently experimental) for checking the integrity of
3891   databases (partly addresses ticket#238).
3893 * Database::reopen() now returns true if the database may have been reopened
3894   (previously it returned void).  (ticket#548)
3896 * Deprecate Xapian::timeout in favour of POSIX type useconds_t.
3898 * Deprecate Xapian::percent and use int instead in the API and our own code.
3900 * Deprecate Xapian::weight typedef in favour of just using double and change
3901   all uses in the API and our own code.  (ticket#560)
3903 * Rearrange members of Xapian::Error to reduce its size (from 48 to 40 bytes on
3904   x86-64 Linux).
3906 * Assignment operators for PositionIterator and TermIterator now return *this
3907   rather than void.
3909 * PositionIterator, PostingIterator, TermIterator and ValueIterator now
3910   handle their reference counts in hand-crafted code rather than using
3911   intrusive_ptr/RefCntPtr, which means the compiler can inline the destructor
3912   and default constructor, so a comparison to an end iterator should now
3913   optimise to a simple NULL pointer check, but without the issues which the
3914   ValueIteratorEnd_ proxy class approach had (such as not working in templates
3915   or some cases of overload resolution).
3917 * Enquire:
3919   + Previously, Enquire::get_matching_terms_begin() threw InvalidArgumentError
3920     if the query was empty.  Now we just return an end iterator, which is more
3921     consistent with how empty queries behave elsewhere.
3923   + Remove the deprecated old-style match spy approach of using a MatchDecider.
3925 * Remove deprecated Sorter class and MultiValueSorter subclass.
3927 * Xapian::Stem:
3929   + Add stemmers for Armenian (hy), Basque (eu), and Catalan (ca).
3931   + Stem::operator= now returns a reference to the assigned-to object.
3933 testsuite:
3935 * Make unittest use the test harness, so it gets all the valgrind and fd leak
3936   checks, and other handy features all the other tests have.
3938 * Improve test coverage in several places.
3940 * Compress generated HTML files in coverage report.
3942 flint backend:
3944 * Remove flint backend.
3946 remote backend:
3948 * When propagating exceptions from a remote backend server, the protocol now
3949   sends a numeric code to represent which exception is being propagated, rather
3950   than the name of the type, as a number can be turned back into an exception
3951   with a simple switch statement and is also less data to transfer.
3952   (ticket#471)
3954 * Remote protocol (these changes require a protocol major version bump):
3956   + Unify REPLY_GREETING and REPLY_UPDATE.
3958   + Send (last_docid - doccount) instead of last_docid and (doclen_ubound -
3959     doclen_lbound) instead of doclen_ubound.
3961 * Remove special check which gives a more helpful error message when a modern
3962   client is used against a remote server running Xapian <= 0.9.6.
3964 build system:
3966 * Various changes allow us to now remove XAPIAN_VISIBILITY_DEFAULT from a
3967   number of functions which aren't in the public API (partly addresses
3968   ticket#63).
3970 * configure: For this development series, the library gets a -1.3 suffix and
3971   include files are installed with an extra /xapian-1.3 component to make
3972   parallel installs easier.
3974 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
3975   will then jump to the appropriate column for a compiler error or warning, not
3976   just the appropriate line.
3978 * Snowball compiler now reports "FILE:LINE:" before each error so tools like
3979   vim's quickfix mode can parse this and bring up the line with the error
3980   automatically.
3982 * docs/doxygen_api.conf.in: Don't generate XML from doxygen for the bindings -
3983   the bindings now do this for themselves.  (ticket#262)
3985 documentation:
3987 * INSTALL: Update GCC details - we now recommend 4.3 or newer (was 4.1), and
3988   note that while 3.1 is the hard minimum requirement, the oldest we've tested
3989   with at all recently was 3.3.
3991 * docs/deprecation.rst: Updated.
3993 tools:
3995 * delve:
3997   + Move delve from examples to bin and rename to xapian-delve.
3999   + Send errors to stderr not stdout.
4001 * xapian-check: Now reports useful descriptions rather than cryptic numeric
4002   codes for B-tree errors.
4004 debug code:
4006 * Add assertions that the index is in range when dereferencing MSetIterator and
4007   ESetIterator.
4009 * Fix various errors in debug logging statements.
4011 * Add QUERY category for debug logging.
4013 Xapian-core 1.2.23 (2016-03-28):
4015 API:
4017 * PostingSource: Public member variables are now wrapped by methods (mostly
4018   getters and/or setters, depending on whether they should be readable,
4019   writable or both).  In 1.3.5, the public members variables have been
4020   deprecated - we've added the replacement methods in 1.2.23 as well to make
4021   it easier for people to migrate over.
4023 chert backend:
4025 * xapian-check now performs additional consistency checks for chert. Reported
4026   by Jean-Francois Dockes and Bob Cargill via xapian-discuss.
4028 documentation:
4030 * Update links to Xapian website and trac to use https, which is now supported,
4031   thanks to James Aylett.
4033 portability:
4035 * On older Linux kernels, rename() of a file within a directory on NFS can
4036   sometimes erroneously fail with EXDEV.  This should only happen if you
4037   try to rename a file across filing systems, so workaround this issue by
4038   retrying up to 5 times on EXDEV (which should be plenty to avoid this
4039   bug, and we don't want to risk looping forever).  Fixes #698, reported by
4040   Mark Dufour.
4042 Xapian-core 1.2.22 (2015-12-29):
4044 API:
4046 * Add FLAG_CJK_NGRAM for QueryParser and TermGenerator.  Has the same effect as
4047   setting the environment variable XAPIAN_CJK_NGRAM.  Fixes #180, reported by
4048   Richard Boulton, with contributions from Pavel Strashkin, Mikkel Kamstrup
4049   Erlandsen and Brandon Schaefer.
4051 * Fix bug parsing multiple non-exclusive filter terms - previously this could
4052   result in such filters effectively being ignored.
4054 * Fix Database::get_doclength_lower_bound() over multiple databases when some
4055   are empty or consist only of zero-length documents.  Previously this would
4056   report a lower bound of zero, now it reports the same lowest bound as a
4057   single database containing all the same documents.
4059 * Make Database::get_wdf_upper_bound("") return 0.
4061 * Mark constructors taking a single argument as "explicit" to avoid unwanted
4062   implicit conversions.
4064 testsuite:
4066 * If command line option --verbose/-v isn't specified, set the verbosity level
4067   from environmental variable VERBOSE.
4069 * Skip timed tests if $AUTOMATED_TESTING is set.  Fixes #553, reported by
4070   Dagobert Michelsen.
4072 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
4074 * apitest: Revert disabling of part of adddoc5 for clang - the test failure was
4075   in fact due to a bug in 1.3.x, and 1.2.x was never affected.
4077 * apitest: Tweak bounds checks in dbstats1 testcase - multi backends should
4078   give tight bounds.
4080 brass backend:
4082 * Format limit on docid now correctly imposed when sizeof(int) > 4.
4084 * Avoid potential DB corruption with full-compaction when using 64K blocks.
4086 chert backend:
4088 * Format limit on docid now correctly imposed when sizeof(int) > 4.
4090 * Avoid potential DB corruption with full-compaction when using 64K blocks.
4092 flint backend:
4094 * Format limit on docid now correctly imposed when sizeof(int) > 4.
4096 * Avoid potential DB corruption with full-compaction when using 64K blocks.
4098 remote backend:
4100 * Fix to handle total document length exceeding 34,359,738,368.  (Fixes #678,
4101   reported by matf).
4103 * Avoid dividing by zero when getting the average length for an empty database.
4105 * Stop apparent error from remote server when read-only client disconnects.  A
4106   read-only client just closes the connection when done, but the server
4107   previously reported "Got exception NetworkError: Received EOF", which sounds
4108   like there was a problem.  Now we just say "Connection closed" here, and
4109   "Connection closed unexpectedly" if the client connects in the middle of an
4110   exchange.  Possibly fixes #654, reported by Germán M. Bravo.
4112 * Give a clearer error message when the client and server remote protocol
4113   versions aren't compatible.
4115 * Check length of key in MSG_SETMETADATA.
4117 build system:
4119 * pkg-config: Fix library name in .pc file to say "xapian" not "xapian-core".
4120   Reported by Eric Lindblad to the xapian-devel list.
4122 * Private symbol decode_length() is no longer visible outside the library.
4124 documentation:
4126 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
4127   'git cherry-pick' from working as it should.  The git repo history should be
4128   sufficient for complying with GPLv2 2(a).
4130 * Strip out "quickstart" examples which are out of date and rather redundant
4131   with the "simple" examples.
4133 * Correct documentation of Enquire::get_query().  If no query has been set,
4134   the documentation said Xapian::InvalidArgumentError was thrown, but in
4135   fact we just return a default initialised Query object (i.e. Query()).  This
4136   seems reasonable behaviour and has been the case since Xapian 0.9.0.
4138 * Document xapian-compact --blocksize takes an argument.
4140 * Update snowball website link to snowballstem.org.
4142 tools:
4144 * xapian-replicate: Fix replication for files > 4GB on 32-bit platforms.
4145   Previously replication would fail to copy a file whose size didn't fit in
4146   size_t.  Fixes #685, reported by Josh Elsasser.
4148 * xapian-tcpsrv: Better error if -p/--port not specified
4150 * quest: Support `-f cjk_ngram`.
4152 examples:
4154 * xapian-metadata: Extend "list" subcommand to take optional key prefix.
4156 portability:
4158 * Fix new warnings from recent versions of GCC and clang.
4160 * Add spaces between literal strings and macros which expand to literal strings
4161   for C++11 compatibility in __WIN32__-specific code.
4163 * Need <unistd.h> for unlink() on FreeBSD, reported by Germán M. Bravo via
4164   github PR 72.
4166 * Fix testsuite to build when S_ISSOCK() isn't defined.
4168 * Don't provide our own implementation of sleep() under __WIN32__ if there
4169   already is one - mingw provides one, and in some situations it seems to clash
4170   with ours.  Reported to xapian-discuss by John Alveris.
4172 * Add missing '#include <arpa/inet.h>' to htons().  Seems to be implicitly
4173   included on most platforms, but Interix needs it.  Reported by Eric Lindblad
4174   on xapian-discuss.
4176 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
4177   compiler, as it fires for functions ending in a "throw" statement.  Genuine
4178   instances will be caught by compilers with superior warning machinery.
4180 * Prefer scalbn() to ldexp() where possible, since the former doesn't ever set
4181   errno.
4183 * '#include <config.h>' in the "simple" examples, as when compiling with xlC on
4184   AIX, _LARGE_FILES gets defined by AC_SYS_LARGEFILE to enable large file
4185   support, and defining this changes the ABI of std::string, so it also needs
4186   to be defined when compiling code using Xapian.
4188 * On cygwin, include <arpa/inet.h> instead of winsock headers for htons() and
4189   htonl().
4191 * Include <cygwin/version.h> for CYGWIN_VERSION_API_MAJOR.
4193 * Avoid referencing static members via an object in that object's own
4194   definition, as this doesn't work with all compilers (noted with GCC 3.3), and
4195   is a bit of an odd construct anyway.  Reported by Eric Lindblad on
4196   xapian-discuss.
4198 * GCC < 3.4.2 lacks operator<< overloads for unsigned long long on some
4199   platforms, so simply work around this by using str(), as this isn't
4200   performance sensitive code.  Reported by Eric Lindblad on xapian-discuss.
4202 * Fix delete which should be delete[] in brass backend cursor code.
4204 Xapian-core 1.2.21 (2015-05-20):
4206 API:
4208 * QueryParser: Extend the set of characters allowed in the start of a range to
4209   be anything except for '(' and characters <= ' '.  This better matches what's
4210   accepted for a range end (anything except for ')' and characters <= ' ').
4211   Reported by Jani Nikula.
4213 matcher:
4215 * Reimplement OP_PHRASE for non-exact phrases.  The previous implementation was
4216   buggy, giving both false positives and false negatives in rare cases when
4217   three or more terms were involved.  Fixes #653, reported by Jean-Francois
4218   Dockes.
4220 * Reimplement OP_NEAR - the new implementation consistently requires the terms
4221   to occur at different positions, and fixes some previously missed matches.
4223 * Fix a reversed check for picking the shorter position list for an exact
4224   phrase of two terms.  The difference this makes isn't dramatic, but can be
4225   measured (at least with cachegrind).  Thanks to kbwt for spotting this.
4227 * When matching an exact phrase, if a term doesn't occur where we want, use
4228   its actual position to advance the anchor term, rather than just checking
4229   the next position of the anchor term.
4231 brass backend:
4233 * Fix cursor versioning to consider cancel() and reopen() as events where
4234   the cursor version may need incrementing, and flag the current cursor version
4235   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
4237 * Avoid using file descriptions < 3 for writable database tables, as it risks
4238   corruption if some code in the same process tries to write to stdout or
4239   stderr without realising it is closed.  (Partly addresses #651)
4241 chert backend:
4243 * Fix cursor versioning to consider cancel() and reopen() as events where
4244   the cursor version may need incrementing, and flag the current cursor version
4245   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
4247 * Avoid using file descriptions < 3 for writable database tables, as it risks
4248   corruption if some code in the same process tries to write to stdout or
4249   stderr without realising it is closed.  (Partly addresses #651)
4251 flint backend:
4253 * Fix cursor versioning to consider cancel() and reopen() as events where
4254   the cursor version may need incrementing, and flag the current cursor version
4255   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
4257 remote backend:
4259 * Fix sort by value when multiple databases are in use and one or more are
4260   remote.  This change necessitated a minor version bump in the remote
4261   protocol.  Fixes #674, reported by Dylan Griffith.  If you are upgrading a
4262   live system which uses the remote backend, upgrade the servers before the
4263   clients.
4265 build system:
4267 * The compiler ABI check in the public API headers now issues a warning
4268   (instead of an error) for an ABI mismatch for ABI versions 2 and later
4269   (which means GCC >= 3.4).  The changes in these ABI versions are bug fixes
4270   for corner cases, so there's a good chance of things working - e.g. building
4271   xapian-bindings with GCC 5.1 (which defaults to ABI version 8) against
4272   xapian-core built with GCC 4.9 (which defaults to ABI version 2) seems to
4273   work OK.  A warning is still useful as a clue to what is going on if linking
4274   fails due to a missing symbol.
4276 * xapian-config,xapian-core.pc: When compiling with xlC on AIX, the reported
4277   --cxxflags/--cflags now include -D_LARGE_FILES=1 as this is defined for the
4278   library, and defining it changes the ABI of std::string with this compiler,
4279   so it must also be defined when building code using the Xapian API.
4281 * xapian-core.pc: Include --enable-runtime-pseudo-reloc in --libs output for
4282   mingw and cygwin, like xapian-config does.
4284 * xapian-core.pc: Fix include directory reported by `pkg-config --cflags`.
4285   This bug was harmless if xapian-core was installed to a directory which was
4286   on the default header search path (such as /usr/include).
4288 * xapian-config: Fix typo so cached result of test in is_uninstalled() is
4289   actually used on subsequent calls.  Fixes #676, reported (with patch) by Ryan
4290   Schmidt.
4292 * configure: Changes in 1.2.19 broke the custom macro we use to probe for
4293   supported compiler flags such that the flags never got used.  This release
4294   fixes this problem.
4296 * configure: Set default value for AUTOM4TE before AC_OUTPUT so the default
4297   will actually get used.  Only relevant when building in maintainer mode
4298   (e.g. from git).
4300 * soaktest: Link with libtool's '-no-install' or '-no-fast-install', like we
4301   already do for other test programs, which means that libtool doesn't need to
4302   generate shell script wrappers for them on most platforms.
4304 documentation:
4306 * API documentation: Minor wording tweaks and formatting improvements.
4308 * docs/deprecation.rst: Add deprecation of omindex --preserve-nonduplicates
4309   which happened in 1.2.4.
4311 * HACKING: Update URL.
4313 * HACKING: libtool 2.4.6 is now used for bootstrapping snapshots and releases.
4315 tools:
4317 * xapian-compact: Make sure we open all the tables of input databases at the
4318   same revision.  (Fixes #649)
4320 * xapian-metadata: Add 'list' subcommand to list all the metadata keys.
4322 * xapian-replicate: Fix connection timeout to be 10 seconds rather than 10000
4323   seconds (the incorrect timeout has been the case since 1.2.3).
4325 * xapian-replicate: Set SO_KEEPALIVE for xapian-replicate's connection to the
4326   master, and add command line option to allow setting socket-level timeouts
4327   (SO_RCVTIMEO and SO_SNDTIMEO) on platforms that support them.  Fixes #546,
4328   reported by nkvoll.
4330 * xapian-replicate-server: Avoid potentially reading uninitialised data if a
4331   changeset file is truncated.
4333 portability:
4335 * Add spaces between literal strings and macros which expand to literal strings
4336   for C++11 compatibility.
4338 * ValueCountMatchSpy::top_values_begin(): Fix the comparison function not to
4339   return true for two equal elements, which manifests as incorrect sorting in
4340   some cases when using clang's libc++ (which recent OS X versions do).
4342 * apitest: The adddoc5 testcase fails under clang due to an exception handling
4343   bug, so just #ifdef out the problematic part of the testcase when building
4344   with clang for now.
4346 * Fix clang warnings on OS X.  Reported by Germán M. Bravo.
4348 * Fix examples to build with IBM's xlC compiler on AIX - they were failing due
4349   to _LARGE_FILES being defined for the library build but not for the examples,
4350   and defining this changes the ABI of std::string with this compiler.
4352 * configure: Improve the probe for whether the test harness can use RTTI to
4353   work for IBM's xlC compiler (which defaults to not generating RTTI).
4355 * Fix to build with Sun's C++ compiler.
4357 * Use F_DUPFD where available to dup to a file descriptor which is >= 2, rather
4358   than calling dup() until we get one.
4360 * When unserialising a double, avoid reading one byte past the end of the
4361   serialised value.  In practice this was harmless on most platforms, as
4362   dbl_max_mantissa is 255 for IEEE-754 format doubles, and at least GCC's
4363   std::string keeps the buffer nul-terminated.  Reported by Germán M. Bravo in
4364   github PR#67.
4366 * When unserialising a double, add missing cast to unsigned char when we check
4367   if the value will fit in the double type.  On machines with IEEE-754 doubles
4368   (which is most current platforms) this happened to work OK before.  It would
4369   also have been fine on machines where char is unsigned by default.
4371 * Fix incorrect use of "delete" which should be "delete []".  This is
4372   undefined behaviour in C++, though the type is POD, so in practice this
4373   probably worked OK on many platforms.
4375 debug code:
4377 * Fix some overly strict assertions in flint, which caused apitest's
4378   cursordelbug1 to fail with assertions on.
4380 Xapian-core 1.2.20 (2015-03-04):
4382 chert backend:
4384 * After splitting a block, we always insert the new block in the parent right
4385   after the block it was split from - there's no need to binary chop.
4387 build system:
4389 * Generate and install a file for pkg-config.  (Fixes#540)
4391 * configure: Update link to cygwin FAQ in error message.
4393 documentation:
4395 * include/xapian/weight.h: Document the enum stat_flags values.
4397 * docs/postingsource.rst: Use a modern class in postingsource example.  (Noted
4398   by James Aylett)
4400 * docs/deprecation.rst,docs/replication.rst: Fix typos.
4402 * Update doxygen configuration files to avoid warnings about obsolete tags from
4403   newer doxygen versions.
4405 * HACKING: Update details of building Xapian packages.
4407 tools:
4409 * xapian-check: For chert and brass, cross-check the position and postlist
4410   tables to detect positional data for non-existent documents.
4412 portability:
4414 * When locking a database for writing, use F_OFD_SETLK where available, which
4415   avoids having to fork() a child process to hold the lock.  This currently
4416   requires Linux kernel >= 3.15, but it has been submitted to POSIX so
4417   hopefully will be widely supported eventually.  Thanks to Austin Clements for
4418   pointing out this now exists.
4420 * Fix detection of fdatasync(), which appears to have been broken practically
4421   forever - this means we've probably been using fsync() instead, which
4422   probably isn't a big additional overhead.  Thanks to Vlad Shablinsky for
4423   helping with Mac OS X portability of this fix.
4425 * configure: Define MINGW_HAS_SECURE_API under mingw to get _putenv_s()
4426   declared in stdlib.h.
4428 * Use POSIX O_NONBLOCK in preference to O_NDELAY - the semantics of the latter
4429   differ between BSD and System V.
4431 * According to POSIX, strerror() may not be thread safe, so use alternative
4432   thread-safe ways to translate errno values where possible.
4434 * On Microsoft Windows, avoid defining EADDRINUSE, etc if they're already
4435   defined, and use WSAE* constants un-negated - they start from a high value
4436   so won't collide with E* constants.
4438 debug code:
4440 * Add more assertions to the chert backend code.
4442 Xapian-core 1.2.19 (2014-10-21):
4444 API:
4446 * Xapian::BM25Weight:
4448   + Improve BM25 upper bound in the case when our wdf upper bound > our
4449     document length lower bound.  Thanks to Craig Macdonald for pointing out
4450     this trick.
4452   + Pre-multiply termweight by (param_k1 + 1) rather than doing it for
4453     every weighted term in every document considered.
4455 testsuite:
4457 * Don't report apparent leaks of fds opened on /dev/urandom - at least on
4458   Linux, something in the C library seems to lazily open it, and the report of
4459   a possible leak followed by assurance that it's OK really is just noise we
4460   can do without.
4462 matcher:
4464 * Fix false matches reported for non-exact phrases in some cases.  Fixes the
4465   reduced testcase in #657, reported by Jean-Francois Dockes.
4467 brass backend:
4469 * Only full sync after writing the final base file (only affects Max OS X).
4471 chert backend:
4473 * Only full sync after writing the final base file (only affects Max OS X).
4475 flint backend:
4477 * Only full sync after writing the final base file (only affects Max OS X).
4479 build system:
4481 * For Sun's C++ compiler, pass -library=Crun separately since libtool looks for
4482   " -library=stlport4 " (with the spaces).  (fixes#650)
4484 * Remove .replicatmp (created by the test suite) upon "make clean".
4486 documentation:
4488 * include/xapian/compactor.h: Fix formatting of doxygen comment.
4490 * HACKING: freecode no longer accepts updates, so drop that item from the
4491   release checklist.
4493 * docs/overview.rst: Add missing database path to example of using
4494   xapian-progsrv in a stub database file.
4496 portability:
4498 * Suppress unused typedef warnings from debugging logging macros, which occur
4499   in functions which always exit via throwing an exception when compiling with
4500   recent versions of GCC or clang.
4502 * Fix debug logging code to compile with clang.  (fixes #657, reported by
4503   Germán M. Bravo)
4505 debug code:
4507 * Add missing RETURN() markup for debug logging in a few places, highlighted by
4508   warnings from recent GCC.
4510 * Fix incorrect return types in debug logging annotations so that code compiles
4511   when configured with --enable-log.
4513 Xapian-core 1.2.18 (2014-06-22):
4515 API:
4517 * Document: Fix get_docid() to return the docid for the sub-database (as it
4518   is explicitly documented to) for Document objects passed to functors like
4519   KeyMaker during the match.  (fixes#636, reported by Jeff Rand).
4521 * Document: Don't store the termname in OmDocumentTerm - we were only using it
4522   in get_description() output and an exception message.  Speeds up indexing
4523   etext.txt using simpleindex by 0.4%, and should reduce memory usage a bit
4524   too.  (Change inspired by comments from Vishesh Handa on xapian-devel).
4526 * Database: Iterating the values in a particular slot is now a bit more
4527   efficient for inmemory and remote backends (but still slow compared to
4528   flint, chert and brass).
4530 testsuite:
4532 * apitest: Expand crashrecovery1 to check that the expected base files exist
4533   and ones which shouldn't exist don't.
4535 * queryparsertest: Fix testcase for empty wildcard followed by negation to
4536   enable FLAG_LOVEHATE so the negation is actually parsed.  Fortunately the
4537   fixed testcase passes.
4539 matcher:
4541 * OP_SYNONYM: avoid fetching the doclength if the weighting scheme doesn't
4542   need it and the calculated wdf for the synonym is <= doclength_lower_bound
4543   for the current subdatabase.  (fixes #360)
4545 build system:
4547 * Releases are now bootstrapped with libtool 2.4.2 instead of 2.4, and with
4548   config.guess and config.sub updated to the latest versions.
4550 documentation:
4552 * Add an example of initializing SimpleStopper using a file listing stopwords.
4553   (Patch from Assem Chelli)
4555 * Improve the descriptions of the stem_strategy values in the API docs.
4556   (Reported by "oilap" on #xapian)
4558 * docs/sorting.rst: Fix incorrect parameter types in Xapian::Weight
4559   subclass example.
4561 * docs/glossary.rst: Add definition of "collection frequency".
4563 * HACKING:
4565   + makeindex is now in Debian package texlive-binaries.
4567   + Replace a link to the outdated autotools "goat book" with a link to the
4568     "Portable Shell" chapter of the autoconf manual.
4570 * include/xapian/base.h: Remove very out of date comments talking about atomic
4571   assignment and locking - since 0.5.0 we've adopted a "user locks" policy.
4572   (Reported by Jean-Francois Dockes)
4574 examples:
4576 * delve:
4578   + Add -A <prefix> option to list all terms with a particular prefix.
4580   + Send errors to stderr not stdout.
4582   + If -v is specified more than once, show even more info in some cases.
4583     (NEWS file claimed this was backported in 1.2.15, but it actually wasn't).
4585 * quest:
4587   + Add --default-op option.
4589   + Add --weight option to allow the weighting scheme to be specified.
4591 portability:
4593 * Explicitly '#include <algorithm>' for std::max(), fixing build with VS2013.
4594   (Fixes#641, reported by "boomboo").
4596 * Fix testcase blocksize1 not to try to delete an open database, which isn't
4597   possible under Windows.  (Fixes #643, reported by Chris Olds)
4599 * docs/quickstart.rst: Split --cxxflags and --libs for portability (noted by
4600   "Hurricane Tong" on xapian-devel).
4602 * Fix warnings with clang 5.0.
4604 debug code:
4606 * Add assertions that weighting scheme upper bounds aren't exceeded.
4608 Xapian-core 1.2.17 (2014-01-29):
4610 API:
4612 * Enquire::set_sort_by_relevance_then_value() and
4613   Enquire::set_sort_by_relevance_then_key(): Fix sense of reverse parameter.
4614   Reported by "boomboo" on IRC.
4616 * BM25Weight: Fix case where (k1 == 0 || b == 0) but k2 != 0.  Reported by
4617   "boomboo" on IRC.
4619 * Unicode::tolower(): Fix to give correct results for U+01C5, U+01C8, U+01CB,
4620   and U+01F2 (previously these were left unchanged).
4622 testsuite:
4624 * Automatically probe for and hook in eatmydata to the testsuite using the
4625   wrapper script it now includes.
4627 * Fix apitest to build when brass, chert or flint are disabled.
4629 brass backend:
4631 * Fix handling of invalid block sizes passed to Xapian::Brass::open() - the
4632   size gets fixed as documented, but the uncorrected size was passed to the
4633   base file (and abort() was called if 0 was passed).
4635 * Validate "dir_end" when reading a block.  (fixes #592)
4637 chert backend:
4639 * Fix handling of invalid block sizes passed to Xapian::Chert::open() - the
4640   size gets fixed as documented, but the uncorrected size was passed to the
4641   base file (and abort() was called if 0 was passed).
4643 * Validate "dir_end" when reading a block.  (fixes #592)
4645 flint backend:
4647 * Fix handling of invalid block sizes passed to Xapian::Flint::open() - the
4648   size gets fixed as documented, but the uncorrected size was passed to the
4649   base file (and abort() was called if 0 was passed).
4651 * Validate "dir_end" when reading a block.  (fixes #592)
4653 build system:
4655 * configure: Improve reporting of GCC version.
4657 * Use -no-fast-install on platforms where -no-install causes libtool to emit a
4658   warning.
4660 * docs/Makefile.am: Fix handling of MAINTAINER_NO_DOCS.
4662 * Include UnicodeData.txt and the script to generate the unicode tables from
4663   it.
4665 documentation:
4667 * postingsource.rst: Clarify a couple of points (reported by "vHanda" on IRC).
4669 portability:
4671 * Protect the ValueIterator::check() method against Mac OS X SDK headers
4672   which define a check() macro.
4674 * Fix warning from xlC compiler.
4676 * Avoid use of grep -e in configure, as /usr/bin/grep on Solaris doesn't
4677   support -e.
4679 * Fix check for flags which might be needed for ANSI mode for compilers called
4680   'cxx'.
4682 * configure: Improve handling of Sun's C++ compiler - trick libtool into not
4683   adding -library=Cstd, and prefer -library=stdcxx4 if supported.  Explicitly
4684   add -library=Crun which seems to be required, even though the documentation
4685   suggests otherwise.
4687 Xapian-core 1.2.16 (2013-12-04):
4689 API:
4691 * PositionIterator,PostingIterator,TermIterator,ValueIterator: Don't segfault
4692   if skip_to() or check() is called on an iterator which is already at_end().
4693   Reported by David Bremner.
4695 * ValueCountMatchSpy: get_description() on a default-constructed
4696   ValueCountMatchSpy object no longer fails when xapian-core is built with
4697   --enable-log.
4699 * ValueCountMatchSpy: get_total() on a default-constructed ValueCountMatchSpy
4700   object now returns 0 rather than segfaulting.
4702 testsuite:
4704 * If -v/--verbose is specified more than once to a test program, show the
4705   diagnostic output for passing tests as well as failing/skipped ones.
4707 * queryparsertest: Change qp_scale1 to time 5 repetitions of the large query to
4708   help average out variations.
4710 * queryparsertest: Add test coverage for explicit synonym of a term with a
4711   prefix (e.g. ~foo:search).
4713 * apitest: Remove code from registry* testcases which tries to test the
4714   consequences of throwing an exception from a destructor - it's complex to
4715   ensure we don't leak memory while doing this (it seems GCC doesn't release
4716   the object in this case, but clang does), and it's generally frowned upon,
4717   plus C++11 makes destructors noexcept by default.
4719 * Fix "make check" to actually removed cached databases first, as is
4720   intended.
4722 brass backend:
4724 * When moving a cursor on a read-only table, check if the block we want is in
4725   the internal cursor.  We already do this for a writable table, as it is
4726   necessary for correctness, but it's a cheap check and may avoid asking the
4727   OS for a block we actually already have.
4729 * Correctly report the database as closed rather than 'Bad file descriptor'
4730   in certain cases.
4732 * Reuse a cursor for reading values from valuestreams rather than creating
4733   a new one each time.  This can dramatically reduce the number of blocks
4734   redundantly reread when sorting by value.  The rereads will generally get
4735   served from VM cache, but there's still an overhead to that.
4737 chert backend:
4739 * When moving a cursor on a read-only table, check if the block we want is in
4740   the internal cursor.  We already do this for a writable table, as it is
4741   necessary for correctness, but it's a cheap check and may avoid asking the
4742   OS for a block we actually already have.
4744 * Correctly report the database as closed rather than 'Bad file descriptor'
4745   in certain cases.
4747 * Reuse a cursor for reading values from valuestreams rather than creating
4748   a new one each time.  This can dramatically reduce the number of blocks
4749   redundantly reread when sorting by value.  The rereads will generally get
4750   served from VM cache, but there's still an overhead to that.
4752 flint backend:
4754 * When moving a cursor on a read-only table, check if the block we want is in
4755   the internal cursor.  We already do this for a writable table, as it is
4756   necessary for correctness, but it's a cheap check and may avoid asking the
4757   OS for a block we actually already have.
4759 * Correctly report the database as closed rather than 'Bad file descriptor'
4760   in certain cases.
4762 build system:
4764 * Compress source tarballs with xz instead of gzip.
4766 * Split XAPIAN_LIBS out of XAPIAN_LDFLAGS so that -l flags for libraries
4767   configure detects are needed appear after -L flags specified by the user
4768   that may be needed to find such libraries.  (fixes#626)
4770 * XO_LIB_XAPIAN now handles the user specifying a relative path in
4771   XAPIAN_CONFIG, e.g.: "./configure XAPIAN_CONFIG=../xapian-core/xapian-config"
4773 * Adjust XO_LIB_XAPIAN to strip _gitNNN suffix from snapshot versions.
4775 * configure: Handle git snapshot naming when calculating REVISION.
4777 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
4778   will then jump to the appropriate column for a compiler error or warning, not
4779   just the appropriate line.
4781 * configure: Report GCC version in configure output.
4783 documentation:
4785 * The API documentation shipped with the release is now generated with
4786   doxygen 1.8.5 instead of 1.5.9, which is most evident in the different
4787   HTML styling newer doxygen uses.
4789 * Document how Utf8Iterator handles invalid UTF-8 in API documentation.
4791 * Improve how descriptions of deprecated features appear in the API
4792   documentation.
4794 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
4795   message.
4797 * docs/overview.rst: Correct documentation for how to specify "prog" remote
4798   databases in stub files.
4800 * Direct users to git in preference to SVN - we'll be switching entirely in
4801   the near future.
4803 tools:
4805 * xapian-chert-update: Fix -b to work rather than always segfaulting (reported
4806   in https://bugs.debian.org/716484).
4808 * xapian-chert-update: The documented alias --blocksize for -b has never
4809   actually been supported, so just drop mentions of it from --help and the man
4810   page.
4812 * xapian-check:
4814   + Fix chert database check that first docid in each doclength chunk is more
4815     than the last docid in the previous chunk - previously this didn't actually
4816     work.
4818   + Fix database check not to falsely report "position table: Junk after
4819     position data" whenever there are 7 unused bits (7 is OK, *more* than 7
4820     isn't).
4822   + Fix to report block numbers correctly for links within the B-tree.
4824   + If the METAINFO key is missing, only report it once per table.
4826   + Fix database consistency checking to always open all the tables at the same
4827     revision - not doing this could lead to false errors being reported after a
4828     commit interrupted by the process being killed or the machine crashing.
4829     Reported by Joey Hess in https://bugs.debian.org/724610
4831 examples:
4833 * quest: Add --check-at-least option.
4835 portability:
4837 * configure: clang doesn't support -Wstrict-null-sentinel or -Wlogical-op, so
4838   don't pass it these options.
4840 * Fix build errors and warnings with mingw.
4842 * Suppress "unused local typedef" warnings from GCC 4.8.
4844 * If the compiler supports C++11, use static_assert to implement
4845   CompileTimeAssert.
4847 * tests/zlib-vg.c: Fix two warnings when compiled with clang.
4849 * Fix failure when built with -D_GLIBCXX_DEBUG - we were modifying the top()
4850   element of a heap before calling pop(), such that the heap comparison
4851   operation (which is called when -D_GLIBCXX_DEBUG is on to verify the heap is
4852   valid) would read off the end of the data.  In a normal build, this issue
4853   would likely never manifest.
4855 * configure: When generating ABI compatibility checks in xapian/version.h, pass
4856   $CXXFLAGS and $CPPFLAGS to $CXXCPP as they could contain options which affect
4857   the ABI (such as -fabi-version for GCC).  (Fixes #622)
4859 * Microsoft GUIDs in binary form have reversed byte order in the first three
4860   components compared to standard UUIDs, so the same database would report a
4861   different UUID on Windows to on other platforms.  We now swap the bytes to
4862   match the standard order.  With this fix, the UUIDs of existing databases
4863   will appear to change on Windows (except in rare "palindronic" cases).
4865 * Fix a couple of issues to get Xapian to build and work on AIX.
4867 * common/safeuuid.h: Remove bogus take-address-of from uuid handling code for
4868   NetBSD and OpenBSD.
4870 * Under cygwin, use cygwin_conv_path() if using a new enough cygwin version,
4871   rather than the now deprecated cygwin_conv_to_win32_path().  Reported by
4872   "Haroogan" on the xapian-devel mailing list.
4874 * common/safeuuid.h: Add missing '#include <cstdlib>' and qualify free with std.
4876 * Fix 'unused label' warning when chert backend is disabled.
4878 * xapian.h: Add check for Wt headers being included before us and defining
4879   'slots' as a macro - if they are, give a clear error advising how to work
4880   around this (previously compilation would fail with a confusing error).
4882 debug code:
4884 * Fix assertion failure for when an OrPostList decays to an AndPostList - the
4885   ordering of the subqueries by estimated termfreq may not be the same as it
4886   was when the OrPostList was constructed, as the subqueries may themselves
4887   have decayed.  Reported by Michel Pelletier.
4889 * Fix -Wcast-qual warning from GCC 4.7 when configured with --enable-log.
4891 Xapian-core 1.2.15 (2013-04-16):
4893 API:
4895 * QueryParser/TermGenerator: Don't include CJK codepoints which are
4896   punctuation in N-grams.
4898 * TermGenerator: Fix bug where we failed to generate the first bigram
4899   from the second sequence of N-grammable CJK characters in a piece of text.
4901 brass backend:
4903 * Call fdatasync()/fsync() when creating the "iambrass" file.
4905 chert backend:
4907 * Call fdatasync()/fsync() when creating the "iamchert" file.
4909 flint backend:
4911 * Call fdatasync()/fsync() when creating the "iamflint" file.
4913 build system:
4915 * XO_LIB_XAPIAN now handles the user specifying XAPIAN_CONFIG without a path,
4916   for example: ./configure XAPIAN_CONFIG=xapian-config-1.3
4918 tools:
4920 * delve: If -v is specified more than once, show even more info in some cases.
4922 portability:
4924 * Fix warning due to needlessly casting away const-ness in debug logging.
4926 * Fix pointer truncation bug in lemon parser generator, which probably affects
4927   regenerating the query parser on WIN64.
4929 debug code:
4931 * Fix to build when configured with --enable-log.
4933 Xapian-core 1.2.14 (2013-03-14):
4935 API:
4937 * MSet::get_document(): Don't cache retrieved Document objects unless they
4938   were requested with fetch().  This avoids using a lot of memory when many
4939   MSet entries are retrieved.  (Fixes #604)
4941 testsuite:
4943 * apitest: Improved test coverage.
4945 matcher:
4947 * Check if a candidate document has at least the minimum weight needed
4948   before checking positional information, which speeds up slow phrase
4949   searches (partly addresses #394).
4951 brass backend:
4953 * Fix multipass compaction not to damage document values, and to merge the
4954   database stats correctly.  (fixes #615)
4956 chert backend:
4958 * Fix multipass compaction not to damage document values, and to merge the
4959   database stats correctly.  (fixes #615)
4961 flint backend:
4963 * Fix multipass compaction bug.  (fixes #615)
4965 tools:
4967 * xapian-replicate:
4969   + Fix handling of delays between replication events - the subtraction of the
4970     target time and the current time was reversed, so we wouldn't sleep when
4971     before the deadline, but would sleep after it for the amount we'd missed it
4972     by.
4974   + On Microsoft Windows, we no longer sleep for more than 43 years if the
4975     target time for a replication event had already passed.  (Fixes #472)
4977 portability:
4979 * matcher/queryoptimiser.cc: Need <functional> for mem_fun().
4981 * tests/harness/testsuite.cc: Don't provide explicit template types to
4982   make_pair - it isn't useful, and breaks with C++11.  Fixes build error with
4983   MSVC2012.
4985 * examples/quest.cc: Fix to build with Sun Studio 12 compiler.  (ticket#611)
4987 Xapian-core 1.2.13 (2013-01-09):
4989 API:
4991 * TermGenerator: Add new method TermGenerator::set_max_word_length() to allow
4992   this limit to be adjusted by the user.
4994 * QueryParser: Implicitly close any unclosed brackets at the end of the query
4995   string.  Patch from Sehaj Singh Kalra.
4997 * DateValueRangeProcessor: Add extra constructor overloaded form so that in
4998   DateValueRangeProcessor(1, "date:"), the const char * gets interpreted as
4999   std::string rather than bool.
5001 testsuite:
5003 * apitest: Assorted test coverage improvements.
5005 * When reporting valgrind errors, skip any warnings before the error in the
5006   valgrind log.
5008 matcher:
5010 * Improved fix for #590 - count all matching LeafPostList objects with a Weight
5011   object rather than trying to prune at the MultiAndPostList level based on
5012   max_wt (if wdf is always zero for a term, BM25 gives max_wt of 0, which lead
5013   to us never counting that subquery.
5015 * Fix calculation of 0.0/0.0 in some cases.  This then got used as a minimum
5016   weight, but it seems this gives -nan (at least on x86-64 Linux) so it may
5017   have been harmless in practice.
5019 * We no longer use the highest weighted MSet entry to calculate percentages, so
5020   remove code which finds it.
5022 brass backend:
5024 * Close excess file handles before we get the fcntl lock, which avoids the
5025   lock being released again if one is open on the lock file.  Notably this
5026   avoids a situation where multiple threads in the same process could succeed
5027   in locking a database concurrently.
5029 chert backend:
5031 * Close excess file handles before we get the fcntl lock, which avoids the
5032   lock being released again if one is open on the lock file.  Notably this
5033   avoids a situation where multiple threads in the same process could succeed
5034   in locking a database concurrently.
5036 flint backend:
5038 * Close excess file handles before we get the fcntl lock, which avoids the
5039   lock being released again if one is open on the lock file.  Notably this
5040   avoids a situation where multiple threads in the same process could succeed
5041   in locking a database concurrently.
5043 remote backend:
5045 * Improve the UnimplementedError message for a MatchSpy subclass which doesn't
5046   implement name() so it's clearer that it is this particular subclass which
5047   can't be used remotely, rather than all MatchSpy objects.
5049 build system:
5051 * The build system is now generated with automake 1.11.6 rather than 1.11.1,
5052   which fixes a security issue in "make distcheck" (not something users will
5053   usually run, but it seems worth addressing).
5055 * Use user-specified LIBS for configure tests, which is what you'd expect to
5056   happen, and provides a way for the user to tell configure where to find
5057   library functions which configure can't find for itself.
5059 * INCLUDES is now deprecated in automake, so use AM_CPPFLAGS instead.
5061 * Test coverage rules now assume lcov 1.10 which allows them to be simpler
5062   and not to require a patched version of lcov.
5064 documentation:
5066 * valueranges.html: Update documentation to reflect change in Xapian 1.1.2 -
5067   DateValueRangeProcessor and StringValueRangeProcessor now support a prefix or
5068   suffix.
5070 * Clarify that the "reverse" parameter of set_sort_by_relevance_then_value()
5071   and set_sort_by_relevance_then_key() only affects the ordering of the
5072   value/key part of the sort.
5074 * docs/quickstart.html: Fix seriously outdated statement that Xapian doesn't
5075   create the database directory - that changed in 0.7.2 (released 2003-07-11).
5077 * HACKING: Try to make it clearer we're looking for a dual-licence on submitted
5078   patches.
5080 tools:
5082 * xapian-replicate:
5084   + Add a --full-copy option to force a full copy to be sent.  (ticket#436)
5086   + Add --quiet option, and be a little more verbose by default.
5088   + Allow files > 32G to be be copied by replication.
5090   + Fix "if (fd > 0)" tests in some replication code to be "if (fd >= 0)".
5091     In practice this is unlikely to actually have caused problems since
5092     stdin is typically still open and using fd 0.
5094   + Simplify how we open the .DB file on the replication slave to just call
5095     open() once with O_CREAT, rather than once without, than stat() if that
5096     fails, and then again with O_CREAT|O_TRUNC if stat() doesn't show an
5097     ordinary file exists.
5099 examples:
5101 * quest:
5103   + New --flags command line option to allow setting arbitrary QueryParser
5104     flags.
5106   + Align option descriptions in --help output, and make the initial letter of
5107     such descriptions consistently lowercase.
5109 portability:
5111 * Fix testsuite harness to compile with GCC 4.7.
5113 * On platforms with the F_MAXFD fcntl but without closefrom(), we were failing
5114   to close the highest numbered open fd in our closefrom() replacement.
5116 * Our closefrom() replacement on Linux now works around valgrind not hiding
5117   some extra fds it has open, but then complaining if we try to close them.
5119 + Pass O_BINARY when opening replication related files in some cases where we
5120   weren't before, which will probably help solve ticket #472.
5122 * configure: socketpair() needs -lnetwork on Haiku.
5124 * Micro-optimisation in Unicode handling - GCC doesn't currently optimise the
5125   arithmetic shift right idiom we use, but it documents that signed right shift
5126   does sign extension so we now just use a right shift for GCC.
5128 debug code:
5130 * Preserve errno over debug logging calls, so they can safely be added to code
5131   which expects errno not to change.
5133 Xapian-core 1.2.12 (2012-06-27):
5135 build system:
5137 * 1.2.11 had its library version information incorrectly set.  This resulted in
5138   the shared library having an incorrect SONAME - e.g. on Linux,
5139   libxapian.so.21 instead of libxapian.so.22.  This release has been made to
5140   fix this problem.
5142 documentation:
5144 * AUTHORS: Add the GSoC students.
5146 Xapian-core 1.2.11 (2012-06-26):
5148 API:
5150 * Add new QueryParser::STEM_ALL_Z stemming strategy, which stems all terms and
5151   adds a Z prefix.  (Patch from Sehaj Singh Kalra, fixes ticket#562)
5153 * Add TermGenerator::set_stemming_strategy() method, with strategies which
5154   correspond to those of QueryParser.  Based on patch from Sehaj Singh Kalra,
5155   with some tweaks for adding term positions in more cases.  (Fixes ticket#563)
5157 * Correct "BM25Weight" to "TradWeight" in exception message from TradWeight.
5159 * We were failing to call init() for user-defined Weight objects providing the
5160   term-independent weight.  These now get called with init(0.0).
5162 * Xapian::Auto::open_stub() now throws a Xapian::DatabaseOpeningError exception
5163   if the stub file can't be opened.  Previously we failed to check for this
5164   condition, which resulted in us treating the file as empty.
5166 testsuite:
5168 * When the testsuite is using valgrind, we used to run remote servers under
5169   valgrind too (but with --tool=none) to get consistent behaviour as valgrind's
5170   emulation of x87 excess precision isn't exact.  Now we only do this if x87 FP
5171   instructions are actually in use (which means x86 architecture and configure
5172   run with --disable-sse).
5174 * Make sure XAPIAN_MAX_CHANGESETS gets unset after replication testcases which
5175   set it, so further testcases don't waste time generating changesets.
5177 * Improved test coverage (including more tests for closed databases -
5178   ticket#337).
5180 brass backend:
5182 * After closing the database, methods which try to use the termlist would throw
5183   FeatureUnavailableError with message "Database has no termlist", assuming
5184   that the termlist table not being open meant it wasn't present.  Fix to check
5185   if the postlist_table is open to determine which case we're in.
5187 chert backend:
5189 * After closing the database, methods which try to use the termlist would throw
5190   FeatureUnavailableError with message "Database has no termlist", assuming
5191   that the termlist table not being open meant it wasn't present.  Fix to check
5192   if the postlist_table is open to determine which case we're in.
5194 inmemory backend:
5196 * Check if the database is closed in metadata_keys_begin() for InMemory
5197   Databases.
5199 build system:
5201 * xapian-config: Don't interpret a missing .la file as meaning that we only
5202   have static libraries.
5204 documentation:
5206 * Fix API documentation for Query constructors - both XOR and ELITE_SET can
5207   take any number of subqueries, not only exactly two.
5209 * Backport missing API documentation comments for operator++ and operator*
5210   methods or PositionIterator, PostingIterator and TermGenerator.
5212 * docs/replication.rst: Update documentation - since 1.2.5, the value of
5213   XAPIAN_MAX_CHANGESETS determines how many changesets we keep.
5215 * docs/admin_notes.rst: Correction - we don't "create a lock file", we "lock a
5216   file".
5218 * Fix API documentation for TradWeight constructor - "k1" should be "k".
5220 portability:
5222 * configure: Overhaul handling of compilers which pretend to be GCC.  Clang
5223   is now detected, and we only pass it warning flags it actually understands.
5224   And we now check for symbol visibility support with Intel's compiler.
5226 * configure: Solaris automatically pulls in library dependencies, so set
5227   link_all_deplibs_CXX=no there.
5229 * configure: We now check -Bsymbolic-functions for all compilers.
5231 * configure: Enable -Wdouble-promotion for GCC >= 4.6.
5233 * Pass -ldl last when compiling zlib-vg.so, as that seems to be needed on
5234   Ubuntu 12.04.
5236 * Fix incorrect use of "delete" which should be "delete []".  This is
5237   undefined behaviour in C++, though the type is POD, so in practice this
5238   probably worked OK on many platforms.
5240 * In BM25Weight when k1 or b is zero (not the default), we used to multiply
5241   an uninitialised double by zero, which is undefined behaviour, but in
5242   practice will often give zero, leading to the desired results.
5244 * xapian.h: Add check for Qt headers being included before us and defining
5245   'slots' as a macro - if they are, give a clear error advising how to work
5246   around this (previously compilation would fail with a confusing error).
5248 Xapian-core 1.2.10 (2012-05-09):
5250 testsuite:
5252 * apitest: Extend tradweight1 to test that TradWeight(0) means that wdf and
5253   document length don't affect the weight of a term.
5255 * termgentest: Check that TermGenerator discards words > 64 bytes.
5257 matcher:
5259 * Don't count unweighted subqueries of MultiAndPostList in percentage
5260   calculations, as OP_FILTER maps to MultiAndPostList now.  (ticket#590)
5262 brass backend:
5264 * When compacting, if the output database is empty, don't write out a metainfo
5265   tag.  Take care not to divide by zero when computing the percentage size
5266   change for a table.
5268 chert backend:
5270 * When compacting, if the output database is empty, don't write out a metainfo
5271   tag.  Take care not to divide by zero when computing the percentage size
5272   change for a table.
5274 documentation:
5276 * API documentation:
5278  + Note version when Database::close() was added.
5280  + Fix switched lower and upper in API documentation for Weight methods
5281    get_doclength_lower_bound() and get_doclength_upper_bound().  Correct
5282    maximum to minimum in get_doclength_lower_bound() comment and note that this
5283    excludes zero length documents.  Fix "An lower" to "A lower".
5285 * docs/admin_notes.html: Mention that postlist and termlist tables also hold
5286   value info for chert.  Mention that xapian-chert-update was removed in 1.3.0.
5287   Mention that you need to use copydatabase from 1.2.x to convert flint to
5288   chert.
5290 * HACKING: Update section on patches to mention git (git diff and git
5291   format-patch), and using "-r" with normal diff, and also that ptardiff offers
5292   a nice way to diff against an unpacked tarball.
5294 debug code:
5296 * Fix use of AssertEq() on NULL, which doesn't compile, at least with recent
5297   GCC.
5299 Xapian-core 1.2.9 (2012-03-08):
5301 API:
5303 * QueryParser: Fix FLAG_AUTO_SYNONYMS not to enable auto multi-word synonyms
5304   too (but in a different way to trunk so as to not break the ABI).
5306 matcher:
5308 * Fix issue with running AND, OR and XOR queries against a database with no
5309   documents in it - this was leading to a divide by zero, which led to
5310   MSet::get_matches_estimated() reporting 2147483648 on i386.
5312 build system:
5314 * Remove configure's --with-stlport and --with-stlport-compiler options, as
5315   they don't allow you to actually specify what you need to (at least to use
5316   the Debian STLport package), and instead document what to pass to configure
5317   to enable building with STLport (though it seems to no longer be actively
5318   maintained, and the debug mode (which is probably the most interesting
5319   feature now) doesn't seem to work on Debian stable).
5321 documentation:
5323 * Document that OP_ELITE_SET with non-term subqueries might pick subqueries
5324   which don't match anything.  Closes ticket#49.
5326 * Document that you can define a static operator delete method in your subclass
5327   if deallocation needs to be handled specially.  (Closes ticket#554)
5329 * Assorted minor documentation improvements.
5331 portability:
5333 * Address new warnings from GCC 4.6.
5335 * Fix argument order when linking xapian-check to fix mingw build.
5336   (ticket#567)
5338 * Add some missing explicit header includes to fix build with STLport.
5340 Xapian-core 1.2.8 (2011-12-13):
5342 API:
5344 * Add support to TermGenerator and QueryParser for indexing and searching CJK
5345   text using n-grams.  Currently this is only enabled when the environmental
5346   variable XAPIAN_CJK_NGRAM is set to a non-empty value.
5348 documentation:
5350 * Add link from index page to apidoc.pdf.
5352 * quickstart.html: Correct link which was to quickstartsearch.cc.html but
5353   should be to quickstartindex.cc.html.
5355 * overview.html,quickstart.html: Fix several factual errors.
5357 * API documentation:
5359   + Improve documentation comments for several methods.
5361   + Add documentation for function parameters which didn't have it.
5363   + Remove bogus paragraph in WritableDatabase::replace_document()
5364     documentation comment which had been cut and pasted from delete_document()
5365     documentation comment.  (Fixes ticket#579)
5367   + Explicitly document which value slot numbers are valid.  (Fixes ticket#555)
5369   + Escape < and > in doxygen comments so "<foo>" doesn't get eaten by doxygen.
5371 portability:
5373 + Some fixes for warnings when cross-compiling to mingw.
5375 * tests/soaktest/soaktest.cc: With Sun's compiler, random() and srandom()
5376   aren't in <cstdlib> so we need to use <stdlib.h> instead.
5378 Xapian-core 1.2.7 (2011-08-10):
5380 API:
5382 * Document objects now track whether any document positions have been modified
5383   so that replacing a modified document can completely skip considering
5384   updating positions if none have changed.  Currently the flint, chert, and
5385   brass backends implement this optimisation.  A common case this speeds up is
5386   adding and/or removing boolean filter terms to/from existing documents - for
5387   example this gives an 18% speedup for adding tags in notmuch.
5389 testsuite:
5391 * Make sure that perftest isn't run with libeatmydata preloaded, as making
5392   fsync() a no-op makes performance tests rather bogus.
5394 remote backend:
5396 * Remove unnecessary call to reopen() in the remote servers in a case where
5397   either we had just called it or we are using a writable database and so
5398   reopen() doesn't do anything.
5400 build system:
5402 * configure: -Wshadow gives bogus warnings with 4.0 (at least on Mac OS X), so
5403   disable it for GCC < 4.1 (like the comments already said we did!)
5405 documentation:
5407 * Improve the documentation comment for Database::close().  (ticket#504)
5409 * Fix typo in documentation comment for Enquire constructor which reversed the
5410   intended sense (though the text was fairly obviously wrong before).
5412 * Improve documentation of QueryParser::add_boolean_prefix()'s exclusive
5413   parameter to talk about terms and prefixes rather than values and fields
5414   (which was confusing since "document value" has a particular meaning in
5415   Xapian).
5417 * docs/facets.html: Expand descriptions for indexing and finding facets.
5418   Fix errors in example code.
5420 * docs/index.html: Add links to Omega and bindings documentation.
5422 * docs/remote_protocol.html: Fixed typo which reversed the intended sense.
5424 * xapian-check --help: Document that checking a whole database performs
5425   additional cross-checks between the tables.
5427 * docs/admin_notes.html: Add note about xapian-chert-update.
5429 * docs/deprecation.html: Note here that WritableDatabase::flush() is
5430   deprecated in favour of WritableDatabase::commit().
5432 portability:
5434 * Fix -Wshadow warnings from GCC 4.6.
5436 * Fix warning from GCC 3.3.
5438 debug code:
5440 * Fix some problems with the templates used to implement output of parameters
5441   and return values in debug logging.
5443 Xapian-core 1.2.6 (2011-06-12):
5445 API:
5447 * QueryParser:
5449   + Add new set_max_wildcard_expansion() method to allow limiting the number of
5450     terms a wildcard can expand to.  (ticket#350)
5452   + If default_op is OP_NEAR or OP_PHRASE then disable stemming of the terms,
5453     since we don't index positional information for stemmed terms by default.
5455 * Spelling correction was failing to correctly handle words which had the same
5456   trigram in an even number of times.
5458 testsuite:
5460 * We now actually include the soaktest code in the release tarballs.
5462 matcher:
5464 * Eliminate some vector copies when handling phrase subqueries in the query
5465   optimiser.
5467 brass backend:
5469 * Kill the child process which holds the lock with SIGKILL as that can't be
5470   ignored, whereas SIGHUP can be in some cases.
5472 chert backend:
5474 * Kill the child process which holds the lock with SIGKILL as that can't be
5475   ignored, whereas SIGHUP can be in some cases.
5477 flint backend:
5479 * Kill the child process which holds the lock with SIGKILL as that can't be
5480   ignored, whereas SIGHUP can be in some cases.
5482 documentation:
5484 * The HTML documentation is now maintained in reStructured Text format.
5486 * docs/queryparser.html: Document the precedence order of operators.
5488 * docs/scalability.html: Bring up-to-date.
5490 * docs/overview.html: Document "remote" in stub databases.
5492 * docs/postingsource.html: Add PostingSource example.  (ticket#503)
5494 * include/xapian/database.h: Add @exception InvalidArgumentError for
5495   Database::get_document() (ticket#542).
5497 * Ship ChangeLog.0 in the tarball.
5499 * Assorted minor improvements.
5501 examples:
5503 * examples/delve: Report has_positions().
5505 * examples/simpleindex: Add short description to usage message.
5507 portability:
5509 * Fix to build for mingw.
5511 Xapian-core 1.2.5 (2011-04-04):
5513 API:
5515 * Enquire::get_eset() now accepts a min_wt argument to allow the minimum wanted
5516   weight to be specified.  Default is 0, which gives the previous behaviour.
5518 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
5519   integer the same way at the end of the query as in the middle.
5521 * Replication:
5523   + Only keep $XAPIAN_MAX_CHANGESETS changeset files when generating a new one
5524     (previously this variable only controlled if we generated changesets or
5525     not).  Closes ticket#278.
5527   + $XAPIAN_MAX_CHANGESETS is reread each time, rather than only when the
5528     database is opened.
5530   + If you build Xapian with DANGEROUS mode enabled, changeset files now
5531     actually have the appropriate flag set (the reader will currently throw an
5532     exception, but that's better than quietly handling them incorrectly).
5534 testsuite:
5536 * Compaction tests which generate stub files now close them before performing
5537   the actual compaction, to avoid issues on Microsoft Windows (ticket#525).
5539 * Improve test coverage.
5541 matcher:
5543 * Fix memory leak if an exception is thrown during the match.
5545 brass backend:
5547 * Bumped format version number (we now store the oldest revision for which we
5548   might have a replication changeset).
5550 * Optimise not to read the bitmaps from the base files when opening a database
5551   for reading (cross-port of equivalent change to chert).
5553 * Optimise not to update doclength when it hasn't changed (cross-port of
5554   equivalent change to chert).
5556 * If we try to delete an old base file and it isn't there, just continue rather
5557   than throwing an exception.  We wanted to get rid of it anyway, and it may be
5558   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
5559   was rather a pessimistic assessment.
5561 chert backend:
5563 * Optimise not to read the bitmaps from the base files when opening a database
5564   for reading.
5566 * Optimise not to update doclength when it hasn't changed.
5568 * xapian-chert-update: Fix to handle larger databases, and databases which
5569   have values set.
5571 * If we try to delete an old base file and it isn't there, just continue rather
5572   than throwing an exception.  We wanted to get rid of it anyway, and it may be
5573   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
5574   was rather a pessimistic assessment.
5576 flint backend:
5578 * Optimise not to read the bitmaps from the base files when opening a database
5579   for reading (cross-port of equivalent change to chert).
5581 * Optimise not to update doclength when it hasn't changed (cross-port of
5582   equivalent change to chert).
5584 * If we try to delete an old base file and it isn't there, just continue rather
5585   than throwing an exception.  We wanted to get rid of it anyway, and it may be
5586   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
5587   was rather a pessimistic assessment.
5589 remote backend:
5591 * xapian-tcpsrv: If we can't bind to the specified port because it is a
5592   privileged one, exit with code 77 (EX_NOPERM) to make it easier to
5593   automatically handle failure when starting the server from a script.
5595 build system:
5597 * Snapshots and releases are now bootstrapped with autoconf 2.68 and libtool
5598   2.4.
5600 * configure: -Wstrict-null-sentinel was added in GCC 4.0.1 and so doesn't work
5601   with GCC 4.0.0.  For simplicity, only enable it for GCC >= 4.1.
5603 documentation:
5605 * INSTALL: Note how to build for a non-default arch on a multi-arch platform.
5607 * include/xapian/enquire.h: Fix doxygen markup so alternative overloaded forms
5608   of Enquire::get_mset() appear in the API documentation.
5610 * collapsing.html: Add missing document (written some time ago, but never
5611   actually added to builds).
5613 * replication.html: Update documentation to make it clear that users shouldn't
5614   create the destination directory for replication themselves.
5616 * docs/intro_ir.html: Update link to a paper.  Update text about book "to be
5617   published in 2008".
5619 * docs/deprecation.html:
5621   + PostingSource now offers a replacement for Enquire::set_bias().
5623   + OmegaScript: $set{spelling,true} is now deprecated.
5625   + Add note about botched removal of Enquire.get_matching_terms from Python
5626     bindings (now fully removed).
5628   + Note removal of "if idx in mset" from Python bindings.
5630   + Deprecate MSet.items and ESet.items from Python bindings (ticket#531).
5632 * docs/admin_notes.html: Update for 1.2.5.
5634 * Updates to documentation of internals.
5636 tools:
5638 * xapian-replicate-server: Fix race condition between checking if a file
5639   exists and opening it to replicate it.
5641 * xapian-replicate: Complain unless host name and port number are specified -
5642   previously these defaulted to an empty string and 0, which resulted in
5643   potentially confusing error messages.
5645 * xapian-replicate: If --master isn't specified, default to DATABASE.
5647 examples:
5649 * quest: Report any spelling correction (requires the database contains
5650   spelling data of course).
5652 * copydatabase: Add --no-renumber option.
5654 portability:
5656 * api/compactor.cc: Add missing header <ctime> for time() (ticket#530).
5658 * api/compactor.cc: Use msvc_posix_rename() under __WIN32__ to atomically
5659   update stub file after compaction (ticket#525).
5661 * Fix uninitialised variable warnings with gcc -O3.
5663 * Eliminate std::string member of global static object used when compiled with
5664   --enable-log which was causes problems on Mac OS X.
5666 * Fix some issues highlighted by clang++ warnings.
5668 Xapian-core 1.2.4 (2010-12-19):
5670 API:
5672 * QueryParser:
5674   + Avoid a double free if Query construction throws an exception in a
5675     particular case.  Fixes ticket#515.
5677   + Allow phrase generators between a probabilistic prefix and the term itself
5678     (e.g. path:/usr/local).
5680   + The correct window size wasn't being set in some cases when default_op was
5681     set to OP_PHRASE.
5683 * Enquire::get_mset():
5685   + Avoid pointlessly trying to allocate lots of memory if the first document
5686     requested is larger than the size of the database.
5688   + An empty query now returns an MSet with firstitem set correctly -
5689     previously firstitem was always 0 in this case.
5691 * Document: Initialise docid to 0 when creating a document from
5692   scratch, as documented.
5694 * Compactor:
5696   + Move the database compaction and merging functionality into this new class,
5697     and make xapian-compact a simple wrapper around this class.  (ticket#175)
5699   + Inputs can now be stub database directories or files, in which case the
5700     databases in the stub are used as inputs.
5702   + Add support for compacting to a stub database, which can be one of the
5703     inputs (for atomic update).
5705   + If spellings and/or synonyms were only present in some source databases,
5706     they weren't copied to the output database, but now they are.
5708 testsuite:
5710 * Improve test coverage (particularly for Xapian::Utf8Iterator and
5711   Xapian::Stem).
5713 * Add zlib-vg.c to distribution tarballs.
5715 * tests/runtest: Add XAPIAN_TESTSUITE_LD_PRELOAD hook to allow libeatmydata to
5716   easily be used to speed up testsuite runs.
5718 matcher:
5720 * The matcher wasn't recalculating the max possible weight after a subquery of
5721   XOR reached its end.  This caused an assertion failure in debug builds, and
5722   is a missed optimisation opportunity.
5724 * Implement SelectPostList::check() so that check() on OP_NEAR and OP_PHRASE
5725   subqueries will just check a single document, not a potentially huge numbers
5726   of documents.
5728 * BM25Weight: Fix calculation order to avoid inconsistent weights due to
5729   rounding when certain non-default parameter combinations are used.
5731 * TradWeight: Fix calculation order to avoid inconsistent weights due to
5732   rounding with TradWeight(0).
5734 * Fix regression in speed of OP_OR queries in certain cases due to optimisation
5735   added in 1.0.21/1.2.1.
5737 * In the query optimiser, use value range bounds to detect value ranges which
5738   must be empty.
5740 remote backend:
5742 * Add support for iterating metadata keys with the remote backend.  This change
5743   necessitated an increase in the minor version of the remote protocol.  If you
5744   are upgrading a live system which uses the remote backend, upgrade the
5745   servers before the clients.
5747 build system:
5749 * xapian-config: Add --static option which makes other options report values
5750   for static linking.
5752 * xapian-config is now removed by "make distclean" not "make clean".
5754 * configure: FreeBSD and OpenBSD don't need explicit dependency libraries, so
5755   set link_all_deplibs_CXX=no there.
5757 * This release uses autoconf 2.67 rather than 2.65.
5759 documentation:
5761 * INSTALL: Raise recommended GCC version from 3.3 to 4.1, since that's the
5762   oldest we regularly test with.
5764 * replication.html: Update and improve in various ways.
5766 * Remove lingering "experimental" marker from PostingSource and
5767   ValueCountMatchSpy API documentation.
5769 * index.html: Add links to replication and facets documents, and fix typo in
5770   serialisation document link.
5772 * internals.html: Add link to replication protocol.
5774 * Change the categorisation document to talk about facets, since that's the
5775   terminology that seems to be most widely used these days, and
5776   "categorisation" can also mean automatically assigning categories to
5777   documents.  Also update to reflect the final API.
5779 * deprecation.html: Add guidelines for supporting other software.
5781 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
5782   currently supported.
5784 * PLATFORMS: Move PLATFORMS information to the wiki and replace with a pointer.
5786 tools:
5788 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
5789   This could have caused problems, though we've had no reports of any (the
5790   bug was found with _GLIBCXX_DEBUG).
5792 * xapian-compact: Add --quiet/-q option to suppress progress output.
5793   (ticket#437)
5795 * xapian-replicate: If a full copy was attempted, but was not put live, display
5796   an explanatory message (in verbose mode).
5798 examples:
5800 * examples/quest: Add command line options to allow prefixes to be specified
5801   for the QueryParser.
5803 * examples/delve: Add '-z' option to count zero-length documents.
5805 * examples/simplesearch: Fix cut-and-paste errors in usage message and
5806   --version output.
5808 portability:
5810 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
5811   control of which SSE instructions to use.
5813 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
5815 * configure: Beef up the test for whether -lm is required and add a special
5816   case to force it to be for Sun's C++ compiler - there's some interaction with
5817   libtool and/or shared objects which means that the previous configure test
5818   didn't think -lm is needed here when it is.
5820 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
5822 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
5823   68030 as well as 68000.
5825 * Fix compilation with Sun's C++ compiler.
5827 * Fix testsuite to build on Solaris < 10.
5829 Xapian-core 1.2.3 (2010-08-24):
5831 API:
5833 * Database::get_spelling_suggestion() will now suggest a correction even if the
5834   passed word is in the dictionary, provided the correction has at least the
5835   same frequency.  Partly addresses #225.
5837 * QueryParser:
5839   + Fix handling of groups of terms which are all stopwords - in situations
5840     where this causes a problem we now disable stopword checks for such groups.
5841     (ticket#245)
5843   + Fix to be smarter about handling a boolean filter term containing ".." in
5844     the presence of valuerangeprocessors.
5846 testsuite:
5848 * New "unittest" program for testing low level functions directly.  Currently
5849   this has tests for the internal resolve_relative_path() function.
5850   (ticket#243)
5852 remote backend:
5854 * Retry select() if it fails with EINTR while waiting for connect(), and
5855   discriminate cases with same failure message to aid debugging.
5857 documentation:
5859 * Fix documentation comment for Xapian::timeout type - it holds a time interval
5860   in milliseconds not microseconds (the API docs for the methods which use it
5861   explicitly correctly document that the timeouts are in milliseconds).
5863 * libuuid moved from e2fsprogs to util-linux-ng about a year ago, so update
5864   documentation, comments, and configure error messages to reflect this.
5866 portability:
5868 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
5869   (ticket#492).
5871 * Fix handling of some obscure cases of resolving relative paths on Microsoft
5872   Windows.  (ticket#243).
5874 * Optimise closing of all unwanted file descriptors after forking by using
5875   closefrom() if available, and otherwise providing our own implementation
5876   (optimised to some extent for many platforms).
5878 * Fix test harness to build under Microsoft Windows (ticket#495).
5880 packaging:
5882 * xapian-core.spec: Add xapian-metadata and cmake related files to RPM
5883   packaging.
5885 * xapian-core.spec: Update BuildRequires to specify libuuid-devel instead of
5886   e2fsprogs-devel.
5888 debug code:
5890 * Improve logging of function parameter placeholder strings.
5892 Xapian-core 1.2.2 (2010-06-27):
5894 brass backend:
5896 * Sync changes from each Btree table to disk right after syncing changes to
5897   its base file, which allows more time for the table changes to be written
5898   and may also be more efficient with some Linux kernel versions.
5900 chert backend:
5902 * Sync changes from each Btree table to disk right after syncing changes to
5903   its base file, which allows more time for the table changes to be written
5904   and may also be more efficient with some Linux kernel versions.
5906 tools:
5908 * xapian-check: Don't try to check document lengths are consistent between the
5909   postlist and termlist tables if it would use more than 1GB of memory, and
5910   handle std::bad_alloc or std::length_error when trying to allocate space
5911   for this.  This issue affected sup users, as sup allocates docids such that
5912   they are sparse and large docids can easily occur.
5914 examples:
5916 * delve: Show the database's UUID.
5918 portability:
5920 * Revert 1.2.1 change to visibility of Xapian::Weight's copy constructor as
5921   it making it private broke compilation with GCC 4.1 (which seems to be a
5922   bug in this compiler version).
5924 * tests/harness/testsuite.cc: Need <cstdio> for sprintf().  Fixes compilation
5925   error which was masked if valgrind was installed.  (ticket#489)
5927 packaging:
5929 * xapian-core.spec: Update for 1.2.x - add e2fsprogs-devel to BuildRequires and
5930   add new files to install.
5932 Xapian-core 1.2.1 (2010-06-22):
5934 This release includes all changes from 1.0.21 which are relevant.
5936 API:
5938 * QueryParser: Add support for open-ended ranges (ticket#480).
5940 * Add new optional parameter to QueryParser::add_boolean_prefix() to allow the
5941   user to indicate a prefix isn't "exclusive" and that multiple instances
5942   should be combined with OP_AND rather than OP_OR.  Fixes ticket#402.  This
5943   change should also improve efficiency as it avoids copying the lists of
5944   prefixes and compares them more efficiently.
5946 * You can now specify a custom stemming algorithm by subclassing
5947   Xapian::StemImplementation, mostly based on patch from Evgeny Sizikov in
5948   ticket#448.
5950 * Fix replication bug: when multiple commits were made to the master database
5951   while a client was performing a full copy, the client would only apply the
5952   first changeset and then try to make the database live, but fail due to
5953   trying to set the wrong revision number.
5955 * Replication no longer sleeps between applying changesets to an offline
5956   database.  It's only necessary to sleep for a live database (to allow readers
5957   to complete a search without getting DatabaseModifiedErrror.
5959 * xapian-replicate: Add new "-r" command line option to specify how long
5960   replication sleeps for between applying changesets to a live database.
5962 * If a Btree table doesn't exist when applying a replication changeset, create
5963   it.  This fixes replicating a revision where a lazy table is created.
5964   (ticket#468)
5966 testsuite:
5968 * zlib can produce "uninitialised" output from "initialised" input - the
5969   output does decode to the input, so this is presumably just some unused bits
5970   in the output, so we use an LD_PRELOAD hack to get valgrind to check the
5971   input is initialised and then tell it that the output is initialised.
5973 * Don't pass NULL to closedir(), which fixes test harness failures on platforms
5974   without /proc/self/fd.
5976 * Use safesyswait.h, fixing build failure on "make check" on FreeBSD.
5978 * Check is SA_SIGINFO is defined before using it as it isn't available
5979   everywhere.  Fixes testsuite build failure on GNU Hurd.
5981 * Add a "soaktest" testsuite, intended to contain long-running tests with
5982   random data.  Currently contains a single test which builds and runs random
5983   queries, checking that the results returned are consistent when asking for
5984   different result ranges.
5986 * Test UUID returned by Database::get_uuid() is 36 characters long.
5988 matcher:
5990 * Xapian no longer forces the wdf_max value to be at least one in
5991   BM25Weight::get_maxpart().  We used to do this so that a non-existent term in
5992   the query would cause it not to achieve 100%, but now we calculate
5993   percentages based on the number of matching subqueries, and it is more
5994   natural for a non-existent term to get zero weight (ditto for a term which
5995   always has wdf 0).
5997 * OP_VALUE_RANGE and OP_VALUE_GE now use value streams directly which is much
5998   more efficient for chert (the default backend in 2.2.x).  As an example, a
5999   range query testcase which previously took 29 seconds now takes 0.4 seconds
6000   (70 times faster).  (ticket#432)
6002 * The term statistics from multiple databases are now gathered in a simpler
6003   way which is a bit faster and uses less memory.
6005 build system:
6007 * Install headers under PREFIX/include not PREFIX/include/xapian.  If you used
6008   XO_LIB_XAPIAN or xapian-config in your build system, the headers would still
6009   have been found.
6011 * Releases and snapshots are now generated with libtool 2.2.10 instead of
6012   2.2.6.
6014 * Fix build failures with some combinations of backends disabled (partially
6015   addresses ticket#361 - some combinations still fail).
6017 * Add check to configure that GCC actually supports visibility for the platform
6018   being built for, which fixes compiler warnings with platforms which don't
6019   (such as Mac OS X and mingw).
6021 documentation:
6023 * Update documentation - replication and PostingSource aren't experimental in
6024   1.2.x.
6026 portability:
6028 * Make use of built-in UUID API on FreeBSD and NetBSD.  (ticket#470)
6030 * Fix mingw build.
6032 debug code:
6034 * Add new pretty printer for values reported by calls and returns in debug
6035   logging - in particular, strings are now reported with non-printable
6036   characters escaped.
6038 * Debug logging should have less runtime overhead when built in but not in use.
6040 * Drop support for --enable-log=profile - dedicated profiling tools are likely
6041   to return more useful results.
6043 Xapian-core 1.2.0 (2010-04-28):
6045 This release includes all changes from 1.0.20 which are relevant.
6047 testsuite:
6049 * Fix --abort-on-error to actually work.
6051 * Exit with status 1 not 0 if we caught an exception from the harness itself.
6053 Xapian-core 1.1.5 (2010-04-16):
6055 This release includes all changes from 1.0.19 which are relevant.
6057 API:
6059 * Database replication now handles an exception while applying a changeset
6060   better.
6062 * If environment variable XAPIAN_MAX_CHANGESETS is set on a replication client
6063   then any changesets read are saved so the replicated copy can itself be
6064   replicated.
6066 testsuite:
6068 * Use sigsetjmp() and siglongjmp() where available so that the set of blocked
6069   signals get restored and the test harness can catch a second incidence of a
6070   particular signal in a run.  Use sigaction() instead of signal() where
6071   available, which allows us to report the address associated with SIGSEGV,
6072   SIGFPE, SIGILL, and SIGBUS.
6074 * Add machinery to check for leaked file descriptors.  Currently this requires
6075   /proc/self/fd to work (which is present on Linux and some other platforms).
6076   Remove the crude ulimit in runtest which has caused problems on some Debian
6077   buildds.
6079 * The test harness now explicitly catches const char * exceptions and reports
6080   their contents.
6082 brass backend:
6084 * Ensure that the wdf upper bound is correctly updated when replacing
6085   documents.
6087 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
6089 chert backend:
6091 * Ensure that the wdf upper bound is correctly updated when replacing
6092   documents.
6094 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
6096 * xapian-check: Check that the initial doclen chunk exists.
6098 flint backend:
6100 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
6102 remote backend:
6104 * Add remote backend support for WritableDatabase::add_spelling() and
6105   WritableDatabase::remove_spelling().  This bumps the remote protocol to
6106   version 35.0 (so both client and servers will need updating).  Suggesting
6107   spelling corrections isn't yet supported.  (ticket#178)
6109 build system:
6111 * XO_LIB_XAPIAN: Give a more specific error message for the cases where
6112   XAPIAN_CONFIG isn't found, is a directory, or isn't executable.
6114 examples:
6116 * delve:
6118   + If any documents are specified with "-d<docid>", "-V<slot>" now only show
6119     values for those documents.
6121   + Remove undocumented -k option, which has been a compatibility alias for -V
6122     since 0.9.10.  Just use -V instead.
6124 * xapian-metadata: Add new example program which allows you to get and set
6125   individual user metadata entries.
6127 Xapian-core 1.1.4 (2010-02-15):
6129 This release includes all changes from 1.0.18 which are relevant.
6131 API:
6133 * Xapian::TermGenerator,Xapian::QueryParser,Xapian::Unicode::is_wordchar():
6134   Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories to is_wordchar(),
6135   which is used by TermGenerator and QueryParser.  Also make TermGenerator and
6136   QueryParser ignore several zero-width space characters.  This is a better
6137   but less compatible version of a fix in 1.0.18.
6139 * Implement support for iterating valuestreams for multidatabases.
6141 * Xapian::Stem: Update the german and german2 stemming algorithms to the latest
6142   versions from Snowball.  These add an extra rule for the "-nisse" ending.
6144 * Xapian::ValueCountMatchSpy: Replace get_values() with values_begin() and
6145   values_end().
6147 * Xapian::MatchSpy: Provide an iterator for accessing the top values found
6148   instead of taking a vector by reference to return them in.
6150 * Xapian::NumericRanges: Remove experimental API we aren't happy with yet.
6152 * Xapian::DatabaseReplica, Xapian::DatabaseMaster: Remove experimental
6153   API we aren't happy with.  Replication is still supported via the
6154   command line programs.  (ticket#347)
6156 * Xapian::score_evenness(): Remove as it turns out not to be useful in practice.
6157   (ticket#435)
6159 * Xapian::ValueWeightPostingSource: A ValueWeightPostingSource with no entries
6160   would report -infinity as its upper bound, which could cause no results to be
6161   incorrectly returned for some queries involving such an object.
6163 * Xapian::WritableDatabase::close() fixed to commit() changes (unless a
6164   transaction is in progress).
6166 testsuite:
6168 * apitest: Improve test coverage in various places.
6170 matcher:
6172 * Uses of values during the match (sorting by value or Sorter, MatchSpy,
6173   MatchDecider, and collapsing) now use value stream iteration which is
6174   a lot more efficient for chert and brass (but may be slower for flint).
6176 brass backend:
6178 * New development backend.  Changes over chert:
6180   + Batched posting list changes during indexing use significantly less memory.
6182   + Instead of using complex code to iterate modified posting lists and
6183     documents length lists, brass can flush individual such lists to disk
6184     and then iterates them from there.
6186   + To iterate all terms, chert flushes all pending postlist changes.  In the
6187     case where a prefix is specified, brass only flushes postlist changes for
6188     terms starting with the specified prefix, and doesn't flush document length
6189     changes.
6191 chert backend:
6193 * Promote chert to being the stable backend.
6195 * Change the packing of integers and strings into sortable keys, which reduces
6196   database size by 2.5% in tests.  This means an incompatible change in the
6197   chert format.  You can use the new xapian-chert-update utility to update a
6198   chert database from the old format to the new format.  It works much like
6199   xapian-compact so should take a similar amount of time (and results in a
6200   compact database).
6202 * xapian-compact:
6204   + Prune unused docids off the end of each database when merging multiple
6205     databases with renumbering.
6207   + Extend --no-renumber to support merging databases, but only if they have
6208     disjoint ranges of used document ids.
6210   + Ensure that the resultant database has a fresh UUID (previously chert
6211     copied the UUID from the first input).
6213 * xapian-check:
6215   + Fix checking of the METAINFO key in chert.  For small databases, the
6216     statistics fit in few enough bytes that incorrect check appeared to
6217     succeed and no errors were reported, but for larger databases an
6218     error was incorrectly reported.
6220   + Rework the checking of postlist chunks to use a cleaner approach which
6221     should report errors better.
6223   + Use a type wider than 32 bits to keep count of items in a table.
6224     Previously xapian-check would report the number of entries modulo
6225     4294967296.
6227 * When iterating a value stream, skip_to() now only assigns the value to a
6228   std::string when it reaches its target.  This saves a lot of unnecessary
6229   string copying - in a real-world test it improved the time for 100 queries
6230   from 3.66s to 3.10s.
6232 * When skipping through a chunk of postings to find the one we want, don't
6233   bother to unpack the wdf values we're skipping over.  This should save a
6234   significant amount of time in certain cases where the profile data shows
6235   about a third of the time is spent in the function where this happens.
6237 * Report locking failure due to running out of file descriptors better.
6239 flint backend:
6241 * xapian-compact:
6243   + Prune unused docids off the end of each database when merging multiple
6244     databases with renumbering.
6246   + Ensure that the resultant database has a fresh UUID (previously flint
6247     didn't set a UUID so one would be generated on demand when next requested,
6248     but only if the database was writable).
6250 * Report locking failure due to running out of file descriptors better.
6252 remote backend:
6254 * Add support for WritableDatabase::set_metadata() and Database::get_metadata()
6255   to the remote backend (based largely on patch in #178).
6257 inmemory backend:
6259 * Read the document data and values lazily for the inmemory backend like we do
6260   for other backends.  They're much less costly to fetch than if a disk or
6261   network access is involved, but it avoids copying potentially large data
6262   which may not be needed.  Consistency here also makes things easier to
6263   understand for both users and developers.
6265 build system:
6267 * This release uses autoconf 2.65 rather than 2.64.
6269 documentation:
6271 * docs/replication.html: Add note about not using reopen() with databases being
6272   updated by the replication client.
6274 * docs/admin_notes.html: Update for chert and other recent changes.
6276 * Remove out-of-date reference in the API documentation comment to an
6277   add_slot() method.  This no longer exists - you need to use multiple
6278   ValueCountMatchSpy objects to monitor more than one slot.
6280 examples:
6282 * simpleexpand,simpleindex,simplesearch: Handle --help and --version.
6284 debug code:
6286 * The debug log now reports boolean values as "true" and "false" (instead of
6287   "1" and "0").
6289 Xapian-core 1.1.3 (2009-09-18):
6291 This release includes all changes from 1.0.15-1.0.17 which are relevant.
6293 API:
6295 * Update Unicode character database to Unicode 5.2.  (ticket#351)
6297 * Rename Xapian::Sorter to Xapian::KeyMaker, paving the way for using it to
6298   build collapse keys too.  Xapian::Sorter remains for compatibility (and is
6299   now a subclass of Xapian::KeyMaker) but is deprecated.
6301 * Resolve the inconsistency in MultiValueSorter::add()'s "forward" parameter
6302   versus the "reverse" parameters which the Enquire sorting functions now take
6303   by replacing the class with MultiKeyMaker with a renamed method add_value()
6304   with a "reverse" parameter.  MultiValueSorter remains with the old semantics
6305   for compatibility but is deprecated.  (ticket#359)
6307 * QueryParser: Don't apply spelling correction to wildcarded terms, or to terms
6308   at the end of the query which we expand under FLAG_PARTIAL.
6310 * Add new Error subclass SerialisationError which we throw for serialisation
6311   related errors (which previously mostly threw NetworkError.
6313 * Rename Xapian::SerialisationContext to Xapian::Registry.
6315 * Add DecreasingValueWeightPostingSource class, which reads weights from a
6316   value slot in which a significant range of the values are in decreasing
6317   order.  This functions similarly to ValueWeightPostingSource, but can be much
6318   more efficient.
6320 * Add new Xapian::MatchSpy class:
6322   + This replaces the use of Xapian::MatchDecider as a "matchspy", which is now
6323     deprecated.  The new class only inspects, and can't reject.  It can work
6324     with remote databases, with the results being serialised to return them
6325     across the link.
6327   + Add subclass ValueCountMatchSpy, which counts the occurrences of each value
6328     in a slot in the search results seen (useful for faceted or categorisation
6329     systems).  The results can be grouped into ranges using the NumericRange
6330     and NumericRanges classes, and the score_evenness() function.  This API is
6331     currently experimental.
6333 * Remove default implementation of Weight::clone() which returns NULL.  We
6334   always need clone() to be implemented because it's called for every term
6335   in the query, not just used for the remote backend.
6337 chert backend:
6339 * Rewrite the low level packing and unpacking functions more efficiently.  As
6340   well as being generally faster, the pack functions now take a reference to a
6341   string to append to, which avoids creating a lot of temporary string objects.
6342   Indexing HTML files with omindex is 5-10% faster.  Searching for "The" on
6343   gmane (which results in a lot of unpacking of postings and document lengths)
6344   is about 35% faster.  (ticket#326)
6346 * xapian-compact: Don't report an absent lazy input table as 0 size.
6348 * Fix ChertModifiedPostList to skip added-but-then-deleted-before-flush
6349   documents.  (ticket#392)
6351 * Fix WritableDatabase::get_doclength() to work properly after a call to commit
6352   for the chert backend (ticket#397).
6354 * Fix to work with the metainfo key stored in the latest format of chert
6355   databases.
6357 * Avoid doing pointless work by trying to delete non-existent lists of values
6358   when we're just adding documents.
6360 * Fix code to find the first docid in the next chunk (ticket#399).
6362 * Add support for chert databases without a termlist table (ticket#181).
6363   Currently the only way to create such a database is to create a chert
6364   database and do "rm termlist.*".
6366 flint backend:
6368 * xapian-compact: Don't report an absent lazy input table as 0 size.
6370 remote backend:
6372 * Remote protocol major version has changed to support serialising MatchSpy
6373   objects.
6375 * Fixed not to sometimes read off the end of the returned matches when
6376   searching multiple databases, some of which are remote, and when the primary
6377   ordering is by relevance.
6379 build system:
6381 * This release uses autoconf 2.64 rather than 2.63.  This means configure now
6382   makes use of shell functions, which makes it ~13% smaller, and should also
6383   make it execute faster.
6385 * configure: Send stderr output from ldconfig to config.log.
6387 * Add optional third parameter to XO_LIB_XAPIAN autoconf macro which specifies
6388   the basename for the "xapian-config" script (defaults to "xapian-config" to
6389   give the current behaviour).
6391 * This release uses doxygen 1.5.9 to generate the API documentation.
6393 documentation:
6395 * Minor improvements to the formatting of the collated API documentation.
6397 portability:
6399 * Fix code to compile with Sun's C++ compiler.
6401 * Fix our uuid_unparse_lower() replacement for older libuuid to actually
6402   compile (really fixes ticket#368).
6404 * Fix xapian-config to work with Solaris 10 /bin/sh.  (ticket#405)
6406 debug code:
6408 * Use C++ syntax for NULL with a type in log output.
6410 Xapian-core 1.1.2 (2009-07-23):
6412 This release includes all changes from 1.0.14 which are relevant.
6414 API:
6416 * Move support for a prefix/suffix from NumberValueRangeProcessor to
6417   StringValueRangeProcessor, and change NumberValueRangeProcessor and
6418   DateValueRangeProcessor to inherit from StringValueRangeProcessor so all
6419   three now support a prefix/suffix.  (ticket#220)
6421 * Query: Trim 4 bytes off the internals.  (ticket#280)
6423 * QueryParser: If default_op is OP_NEAR or OP_PHRASE then make the window size
6424   (9 + no_of_terms) to match the default for an explicit NEAR or PHRASE.
6425   (ticket#254)
6427 testsuite:
6429 * Sort out the clash between two different patches to fix leaking file
6430   descriptors when running tests with the remotetcp backend (broken by
6431   changes in 1.1.1).
6433 matcher:
6435 * If the highest weighted document doesn't match all the terms in the query,
6436   its percentage weight is now calculated by simply counting how many weighted
6437   leaf subqueries match it instead of scaling by the proportion of the weight
6438   which matches (which required accessing the termlist for that document).
6439   (ticket#363).
6441 * XOR with a SYNONYM subquery could previously achieve 100% - this has been
6442   fixed.
6444 flint backend:
6446 * Backport the lazy update changes from chert to flint:
6448   WritableDatabase::replace_document() now updates the database lazily in
6449   simple cases - for example, if you just change a document's values and
6450   replace it with the same docid, then the terms and document data aren't
6451   needlessly rewritten.  Caveats: currently we only check if you've looked at
6452   the values/terms/data, not if they've actually been modified, and only keep
6453   track of the last document read.
6455 build system:
6457 * Update to always use C++ forms for ISO C standard headers (ticket#330).
6459 * Fix several places where Xapian::doccount is used instead of
6460   Xapian::termcount, and similar issues.  It's still not possible to make
6461   these types different sizes, but we're now closer to this goal.
6462   (ticket#385).
6464 documentation:
6466 * Note that PostingSource and Weight objects returned by clone() and
6467   unserialise() methods will be deallocated with "delete".
6469 debug code:
6471 * Fix debug logging not to segfault on NULL Query::Internal pointers.
6473 Xapian-core 1.1.1 (2009-06-09):
6475 This release includes all changes from 1.0.13 which are relevant.
6477 API:
6479 * New Query::OP_SYNONYM operator, which matches the same documents as OP_OR,
6480   but attempts to weight as if the all the subqueries were a single term with
6481   their combined wdf, which should give better relevance weights.
6483 * QueryParser's synonym, wildcard, and partial query features now use
6484   the new OP_SYNONYM operator.
6486 * PostingSource: Add new set_maxweight() method to allow subclasses to tell
6487   the matcher that their maximum weight has decreased.  Make get_maxweight()
6488   a non-virtual method of the baseclass which returns the last set maxweight
6489   (which will require updates to most user subclasses. (ticket#340)
6491 * DatabaseReplica: Fix SEGV when calling get_description() on a default
6492   constructed DatabaseReplica.
6494 * Make Query::MatchAll and Query::MatchNothing const since they're immutable.
6495   All the public methods of Query are const, so this should be completely API
6496   compatible.
6498 * Methods returning an end iterator for a ValueIterator now actually return a
6499   proxy object which silently converts to ValueIterator if required.  This
6500   proxy object allows a comparison with an "_end()" method to be optimised
6501   better so that it just ends up comparing the internal member of the iterator
6502   class with NULL (previously a call to ValueIterator's destructor remained).
6503   This should be API compatible, but note that it is definitely now more
6504   efficient just to compare against the return value of the relevant _end()
6505   method than to store the end iterator explicitly.
6507 testsuite:
6509 * Testcase valuestats4 requires transactions, so indicate that and remove the
6510   explicit SKIP for inmemory.
6512 * Testcase changemaxweightsource1 uses ChangeMaxweightPostingSource, which
6513   doesn't work with multi or remote, so mark the test accordingly.
6515 * We've decided that "going back" with skip_to() or check() should have
6516   unspecified behaviour, so stop testing how this case behaves!
6518 matcher:
6520 * Subclass MultiPostList directly from PostList instead of from LeafPostList.
6521   This gets rid of two unused data members per MultiPostList in exchange for
6522   having to define 5 extra "never called" methods, but 4 of these just
6523   tailcall.
6525 * Store termfreqs and reltermfreqs for query terms in a single map rather than
6526   one map for each, which saves is more compact and likely to be faster.
6528 chert backend:
6530 * xapian-check: For chert, check value stats are the correct format and that
6531   the streamed values are consistent with their stats (ticket#277).
6533 * xapian-check: Chert doesn't store termlist entries for documents without
6534   terms, which resulted in us reporting an error when we found document ids in
6535   the doclength "postlist" which were greater than any with an entry in the
6536   termlist.  Instead compare these entries against db.get_last_docid() if we
6537   are checking a whole db and the db can be opened.  If not, suppress this
6538   check.
6540 remote backend:
6542 * When serialising stats, serialise the termfreq and reltermfreq together,
6543   rather than in separate lists.  This gives a smaller serialised form, and
6544   matches these both being stored in the same map now.  This is an incompatible
6545   remote protocol change, so bump the major version to 32.  (ticket#362)
6547 build system:
6549 * Some build failures with --disable-backend-XXX options have been fixed, but
6550   we haven't exhaustively tested all combinations.
6552 * Ship common/win32_uuid.cc and common/win32_uuid.h (ticket#367).
6554 documentation:
6556 * Update PostingSource documentation to describe how init() is called again if
6557   a PostingSource is reused.  Fixes #352.
6559 portability:
6561 * Fixed to build with GCC 4.4.
6563 * Drop support for GCC 2.95.3 and 3.0.x - we now require at least 3.1 as doing
6564   so eliminates some preprocessor conditionals which we aren't able to test
6565   regularly as we don't have easy access to such old GCC versions.  GCC 3.1 is
6566   nearly 7 years old now, and GCC3 didn't get widespread use until later
6567   versions anyway.  If you still need to use GCC < 3.1, Xapian 1.0.x should
6568   build with 2.95.3 or newer.
6570 * Older versions of libuuid don't have uuid_unparse_lower() so probe for it in
6571   configure, and if it isn't present provide an inline version in safeuuid.h
6572   (ticket#368).
6574 * Fixed to build with MSVC (ticket#379).
6576 * Add static_cast<char>() to str(bool) overload to suppress bogus MSVC warning
6577   (ticket#377).
6579 debug code:
6581 * common/debuglog.h: Add missing initialisation of uncaught_exception variable
6582   in a couple of places.
6584 Xapian-core 1.1.0 (2009-04-22):
6586 API:
6588 * All deprecated xapian-core features listed for removal in 1.1.0 have been
6589   removed.  See deprecation.html for details, and suggested updates.
6591 * The Unicode character categorisation functions have been updated from
6592   Unicode 5.0 to 5.1.
6594 * Add NON_SPACING_MARK to is_wordchar() for better tokenisation of languages
6595   which use such marks - for example, Arabic.  This is better than the stop-gap
6596   fix in 1.0 of treating NON_SPACING_MARK as a phrase-generator character
6597   when parsing queries, but it does mean that databases built from data
6598   containing such characters will need to be rebuilt.  (ticket#355)
6600 * The details of how to subclass Xapian::Weight to implement your own
6601   weighting scheme have changed incompatibly to allow user weighting schemes
6602   to have access to the same statistics as built-in schemes (ticket#213)
6603   If you have a existing subclass of Xapian::Weight you'll need to update it.
6605 * New Database methods get_doclength_upper_bound(), get_doclength_lower_bound()
6606   and get_wdf_upper_bound(), primarily intended for allowing weighting schemes
6607   to calculate tighter upper bounds on weights (which BM25Weight and TradWeight
6608   now do) which allows matcher weight-based optimisations to be more effective.
6609   Chert actually tracks doclength bounds and a global (rather than per term)
6610   upper bound on wdf; other backends return much less tight bounds, but these
6611   still lead to better upper bounds on weights.
6613 * Enquire::get_eset() now uses an unmodified of probabilistic formula, and
6614   doesn't return terms which would get a negative weight from it (since that
6615   means they are expected to be harmful not helpful).
6617 * Add Database::close() method, which will release system resources (in
6618   particular, close filehandles) held by a database.  This is particularly
6619   useful when wrapping the API for languages with garbage collection.
6621 * Change Database::positionlist_begin() not to throw exceptions if the term or
6622   document doesn't exist.
6624 * Xapian databases now have a UUID, readable with Database::get_uuid().
6626 * A new Database replication API has been added (currently experimental).
6628 * MSet::get_termfreq() will now fall back to looking up the term frequency in
6629   the database rather than raising an exception if a term wasn't present in
6630   the query.
6632 * Calling RSet:add_document() with argument 0 now throws InvalidArgumentError.
6634 * QueryParser sped up (new version of lemon); queryparsertest runs 2.2% faster.
6636 * Add ValueSetMatchDecider, which is a matchdecider which is intended to be
6637   passed a set of values to look for in documents, and selects documents based
6638   on the presence of those values.
6640 * Add new Xapian::PostingSource class to allow passing custom sources of
6641   postings and weights to the matcher.  Built-in PostingSource subclasses:
6642   FixedWeightPostingSource, ValueMapPostingSource, ValuePostingSource, and
6643   ValueWeightPostingSource.  (Currently experimental).
6645 * Database: Add get_value_freq(), get_value_lower_bound() and
6646   get_value_upper_bound() methods to get statistics about the values stored in
6647   a slot.  Add support for the value statistics methods to chert, inmemory,
6648   multi and remote databases.
6650 * Enquire::get_eset() now faster for large ESet size.
6652 * Xapian::Document objects now have a reduced memory footprint.
6654 * Enquire::set_collapse_key() now allows you to specify a maximum number of
6655   matches with each collapse key to keep (which defaults to 1, giving the
6656   previous behaviour).  Enquire can now report bounds and an estimate of what
6657   the total number of matches would have been if collapsing wasn't in use.
6659 * WritableDatabase::commit() is a new, preferred alias for
6660   WritableDatabase::flush().  (ticket#266)
6662 * Add methods for serialising documents and queries to strings, and
6663   unserialising back from strings.  (ticket#206)
6665 testsuite:
6667 * stemtest: No longer checks environment variables OM_STEMTEST_SKIP_RANDOM,
6668   OM_STEMTEST_LANGUAGES, and OM_STEMTEST_SEED.
6670 * perftest: New performance testsuite.  This is intended to contain intended to
6671   contain potentially time-consuming performance tests, which log output to
6672   an XML file for later analysis.  It's not run by "make check" - use "make
6673   check-perf" to run it.
6675 * apitest: Now runs tests over both flint and chert for multi, remotetcp, and
6676   remoteprog.
6678 * Wait for subprocesses to finish at end of tests with remotetcp backend, to
6679   avoid test failures when the same database is used for the next testcase.
6681 matcher:
6683 * Internally, pass around non-normalised document lengths as Xapian::termcount
6684   (unsigned integer) not Xapian::doclength (double).  This gives a 3% speedup
6685   for 10 term OR queries!
6687 chert backend:
6689 * New development backend.  Use Chert::open() to explicitly create a chert
6690   format database, or set XAPIAN_PREFER_CHERT=1 in the environment to
6691   prefer chert when creating a new database without an explicit type.
6693 * Quartz and Flint stored the document length alongside every posting list
6694   entry.  Chert instead stores a chunked list of all the document lengths
6695   which saves a lot of space, and is a big win for large queries or those
6696   which don't need the document lengths.  This structure is used to
6697   implement much faster iteration (six times faster in a test) over all
6698   document ids (which speeds up queries using unary NOT, e.g. `NOT apples'),
6699   and to test for the existence of documents (instead of checking the record
6700   table for an entry).
6702 * Document values are now stored in a chunked stream for each slot for
6703   efficient access to the same slot in lots of documents.  This makes
6704   operations like sort by value much more efficient.
6706 * WritableDatabase::replace_document() now updates the database lazily in
6707   simple cases - for example, if you just change a document's values and
6708   replace it with the same docid, then the terms and document data aren't
6709   needlessly rewritten.  Caveats: currently we only check if you've looked at
6710   the values/terms/data, not if they've actually been modified, and only keep
6711   track of the last document read.
6713 flint backend:
6715 * If we can't obtain a write lock while trying to create a new database
6716   we now report the lock failure with DatabaseLockError, not
6717   DatabaseOpeningError - it's more useful to know that the lock attempt failed
6718   in this situation.
6720 * Improve reporting of failures to obtain lock due to unexpected errors.
6722 * xapian-check: Don't stop checking a table after an error in certain cases -
6723   instead increment the error counter and try to continue checking from the
6724   next item.
6726 remote backend:
6728 * The remote database protocol major version has been increased, allowing
6729   a significant amount of compatibility code to be removed.  This change means
6730   that new clients won't work with old servers, and old clients won't work
6731   with new servers.  If upgrading a live system, you will need to take this
6732   into account.
6734 * The remote servers now always default to opening a Database and the client
6735   has to send a protocol message to explicitly request write access.  This
6736   allows a single server to support multiple readers and one writer
6737   simultaneously.  (ticket#145)
6739 * Database::get_document() no longer does an unnecessary copy of the document's
6740   values.
6742 * Change serialisation of queries to be more compact and easier to parse.
6744 stub databases:
6746 * Stub databases used to assume that any relative paths were relative to the
6747   current working directory.  They now assume that relative paths are
6748   relative to the directory holding the stub database file.
6750 * Stub database lines which begin with a '#' character are now ignored,
6751   allowing comments in stub database files.
6753 * New "stub directory" database type - this is a directory containing a stub
6754   database file named "XAPIANDB".
6756 * Don't just ignore lines with no spaces in a stub database file.
6758 * Bad lines in a stub file were being ignored after we'd seen a good entry.
6760 * Add new Auto::open_stub() overload which opens a stub database file
6761   containing a single entry as a WritableDatabase.
6763 * Add support for "inmemory" to stub database (which is useful now that stub
6764   databases can be opened for writing).
6766 * A stub database file is now allowed to contain no database entries, which
6767   results in an empty Database object (this avoids user code having to special
6768   case to handle "0 or more" databases).
6770 build system:
6772 * To allow installations of Xapian 1.0 and 1.1 to easily coexist, the library
6773   is now libxapian-1.1; xapian.m4 is now xapian-1.1.m4; headers are now
6774   installed in $prefix/include/xapian-1.1.  If you use XO_LIB_XAPIAN or
6775   xapian-config as we recommend, this should all be transparent.  Also
6776   programs and scripts have a default program suffix to -1.1 unless overridden
6777   using the --program-suffix argument to configure (if you really want no
6778   suffix, "./configure --program-suffix=" will achieve this).
6780 * On Linux and k*bsd-gnu, override libtool's link_all_deplibs_CXX to "no".
6782 * On Linux, override libtool's sys_lib_dlsearch_path_spec to a list generated
6783   in a more reliable way which includes all the default directories.
6785 * configure: --enable-debug and --enable-debug-verbose have been deprecated
6786   since 1.0.0, so remove specific errors pointing to the replacements.
6788 documentation:
6790 * Disable "JAVADOC_AUTOBRIEF" in doxygen configuration since we always try to
6791   write a brief description explicitly, and JAVADOC_AUTOBRIEF causes problems
6792   in some cases.
6794 * docs/deprecation.html: Describe what "experimental" features are, and why
6795   replication and posting sources are currently experimental.
6797 * docs/deprecation.html: Deprecate Stem_get_available_languages() from the
6798   python bindings.
6800 examples:
6802 * Use C++ forms of C headers in examples (ticket#330).
6804 packaging:
6806 * xapian-core.spec: We no longer need to run autoreconf to work around
6807   libtool's incomplete sys_lib_dlsearch_path_spec or to pick up distro-specific
6808   patches for link_all_deplibs.
6810 debug code:
6812 * Report get_description() rather than the pointer value for
6813   Xapian::Query::Internal* parameters to internal functions.
6815 * The debug logging framework has been overhauled.  See HACKING for details
6816   of how it now works.
6818 * Faster integer to string functions inside the library (this is a general
6819   improvement, but will particularly speed up debug logging as that converts a
6820   lot of integers to strings).
6822 Xapian-core 1.0.23 (2011-01-14):
6824 API:
6826 * QueryParser: Avoid a double free if Query construction throws an exception
6827   in a particular case.  Fixes ticket#515.
6829 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
6830   integer the same way at the end of the query as in the middle.
6832 * Enquire::get_mset(): Avoid pointlessly trying to allocate lots of memory
6833   if the first document requested is larger than the size of the database.
6835 * Enquire::get_mset(): An empty query now returns an MSet with firstitem set
6836   correctly - previously firstitem was always 0 in this case.
6838 matcher:
6840 * The matcher wasn't recalculating the max possible weight after a subquery of
6841   XOR reached its end.  This caused an assertion failure in debug builds, and
6842   is a missed optimisation opportunity.
6844 tools:
6846 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
6847   This could have caused problems, though we've had no reports of any (the
6848   bug was found with _GLIBCXX_DEBUG).
6850 Xapian-core 1.0.22 (2010-10-03):
6852 API:
6854 * Xapian::Document: Initialise docid to 0 when creating a document from
6855   scratch, as documented.
6857 * Xapian::QueryParser: Allow phrase generators between a probabilistic prefix
6858   and the term itself (e.g. path:/usr/local).
6860 matcher:
6862 * Back out the OP_OR efficiency improvement made in 1.0.21 since this change
6863   slows down some other common cases.  We'll address this fully in 1.2.4, but
6864   that fix is more invasive than we are comfortable with for 1.0.x at this
6865   point.
6867 build system:
6869 * xapian-config: Add --static option which makes other options report values
6870   for static linking.
6872 documentation:
6874 * deprecation.html: Add guidelines for supporting other software.
6876 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
6877   currently supported.
6879 * Fix documentation for Xapian::timeout type - it holds a time interval in
6880   milliseconds not microseconds (the API docs for the methods which use it
6881   explicitly correctly document that the timeouts are in milliseconds).
6883 portability:
6885 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
6886   (ticket#492).
6888 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
6889   control of which SSE instructions to use.
6891 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
6893 * configure: Beef up the test for whether -lm is required and add a special
6894   case to force it to be for Sun's C++ compiler - there's some interaction with
6895   libtool and/or shared objects which means that the previous configure test
6896   didn't think -lm is needed here when it is.
6898 * Fix test harness to build under Microsoft Windows (ticket#495).
6900 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
6902 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
6903   68030 as well as 68000.
6905 packaging:
6907 * xapian-core.spec: Add cmake related files to RPM packaging.
6909 Xapian-core 1.0.21 (2010-06-18):
6911 API:
6913 * Xapian::Stem now recognises "nb" and "nn" as additional codes for the
6914   Norwegian stemmer.
6916 * Xapian::QueryParser now correctly parses a wildcarded term in between two
6917   other terms (ticket#484).
6919 testsuite:
6921 * Improve test coverage of OP_VALUE_RANGE and MSet::get_percent().
6923 matcher:
6925 * OP_OR could skip a matching document if it decayed to OP_AND or OP_AND_MAYBE
6926   during the match in some cases.  Fixes ticket#476.
6928 * OP_XOR with non-leaf subqueries could skip matching documents in some cases,
6929   and OP_XOR of three or more sub-queries could return incorrect weights.
6930   Fixes ticket#475.
6932 * OP_OR is now more efficient if a subquery is potentially expensive (e.g.
6933   ValueRangePostList, OP_NEAR, OP_PHRASE).  A 10-fold speed-up with
6934   ValueRangePostList has been observed.
6936 flint backend:
6938 * When iterating a table, if the table changes underneath we could end up
6939   returning the same entry twice.  (Debian#579951)
6941 * A cancelled transaction (or a failing operation implicitly cancelling
6942   pending changes) now marks the tables as unmodified, which fixes an exception
6943   trying to read block 0 if one of the tables is empty on disk.
6945 quartz backend:
6947 * When iterating a table, if the table changes underneath we could end up
6948   returning the same entry twice.  (Debian#579951)
6950 remote backend:
6952 * When daemonising, read the max fd to close with sysconf() instead of using
6953   a hardcoded value of 256, and work even if stdin and stdout have been closed.
6955 build system:
6957 * Install files to make Xapian easier to use with cmake.
6959 documentation:
6961 * Update the list of languages that the Xapian::Stem constructor recognises.
6963 * Assorted minor improvements to the collated API documentation.
6965 portability:
6967 * On x86 processors, Xapian now defaults to using SSE2 FP instructions.  This
6968   avoids issues with excess precision and it a bit faster too.  If you need
6969   to support processors without SSE2 (this means pre-Pentium4 for Intel) then
6970   configure with --disable-sse.  (ticket#387)
6972 * Fix warning when compiling for mingw with GCC 4.2.1.
6974 * Remove mutable from a couple of reference class members - mutable doesn't
6975   make sense for a reference and some compilers warn about it.
6977 Xapian-core 1.0.20 (2010-04-27):
6979 API:
6981 * MSet: Fix incorrect values reported by get_matches_estimated(),
6982   get_matches_lower_bound(), and get_matches_upper_bound() in certain cases
6983   when sorting and collapsing (ticket#464).
6985 documentation:
6987 * deprecation.html: Note how to disable deprecation warnings. (ticket#393)
6989 examples:
6991 * delve: Add -a option to list all terms in a database.
6993 * delve: -d and -V command line options now report out of range and invalid
6994   numbers.
6996 portability:
6998 * The getopt warning fix for Cygwin in 1.0.19 caused build failures on Mac OS X
6999   (and probably some other platforms with non-GNU getopt implementations), so
7000   replace with a fix which is only enabled for Cygwin. (ticket#469)
7002 Xapian-core 1.0.19 (2010-04-15):
7004 API:
7006 * QueryParser: Fix leak if Xapian::Database throws an exception during parsing
7007   (ticket#462).
7009 testsuite:
7011 * Explicitly flush after indexing for quartz and flint, so we see any
7012   exceptions from the flush (the implicit flush from the destructor swallows
7013   any exceptions).
7015 * apitest: Add databasemodified1 testcase to provide some test coverage for
7016   DatabaseModifiedError.
7018 flint backend:
7020 * When updating a document, rather than decoding the old positions, comparing
7021   with the new, and then encoding the new if different, we now just encode the
7022   new and then compare the encoded forms.  (ticket#428)
7024 * Avoid trying to delete the document positions when we know there aren't any.
7026 * Fix memory leak if Database::allterms_begin() throws an exception
7027   (ticket#462).
7029 * xapian-check: Report document id for document length mismatch.
7031 * Fix potential issues with iterators over a WritableDatabase which is modified
7032   during iteration.  No problems have actually been observed with flint, only
7033   in 1.1.4 with chert in cases which don't occur in flint, but it seems likely
7034   the issue can manifest for flint in other situations.  Fixes ticket#455.
7036 * Initialise zlib z_stream structure members zalloc, zfree, and opaque with
7037   Z_NULL rather than 0 cast to the appropriate type, as that's what the zlib
7038   documentation says to do.  Add missing initialisation of opaque for the
7039   inflate z_stream which the zlib docs say is needed (reading the zlib code,
7040   this isn't true for current versions, so this improves robustness rather
7041   than fixing an observable bug).
7043 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
7044   undefined behaviour (as a block overlaps itself).
7046 quartz backend:
7048 * Fix potential issues with iterators over a WritableDatabase which is modified
7049   during iteration.  No problems have actually been observed with quartz, only
7050   in 1.1.4 with chert in cases which don't occur in quartz, but it seems likely
7051   the issue can manifest for quartz in other situations.  Fixes ticket#455.
7053 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
7054   undefined behaviour (as a block overlaps itself).
7056 build system:
7058 * Force -fno-strict-aliasing for GCC 4.2 to avoid bad code being generated due
7059   to a bug in that compiler version.  Fixes ticket#449.  This issue hasn't been
7060   observed to affect Xapian 1.0.x, but it seems prudent to backport the fix.
7062 documentation:
7064 * INSTALL: Correct description of --enable-assertions.  It does NOT enable
7065   debugging symbols, and shouldn't control checks on bad data passed to API
7066   calls (if it does anywhere, that's a bug).  Note that Xapian will run more
7067   slowly with assertions on.
7069 * spelling.html:
7071   + Add section on indexing.
7073   + Add a note about removing automatically added spelling dictionary entries.
7075   + Move the "algorithm" section to the end, as it is really just background
7076     information for the curious.
7078 * include/xapian/queryparser.h: Document the possible exception messages from
7079   QueryParser::parse_query().
7081 * include/xapian/termgenerator.h: Note how TermGenerator handles stopwords.
7083 examples:
7085 * delve: Display the lastdocid value when displaying general database
7086   statistics.
7088 * simpleindex: Explicitly call flush() on the database, as that is good
7089   practice (since you see any exceptions).
7091 portability:
7093 * Fix compilation failure in testsuite on OpenBSD, introduced by new regression
7094   test in 1.0.18.  Fixes ticket#458.
7096 * Fix getopt-related warning on Cygwin.
7098 Xapian-core 1.0.18 (2009-02-14):
7100 API:
7102 * Document: Add new add_boolean_term() method, which is an alias for add_term()
7103   with wdfinc=0.
7105 * QueryParser:
7107   + Add support for quoting boolean terms so they can contain arbitrary
7108     characters (partly addresses ticket#128).
7110   + Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories, plus several
7111     zero-width space characters, as phrase generators.  This mirrors a better
7112     fix in 1.1.4, but without losing compatibility with existing databases.
7114   + Fix handling of an explicit AND before a hated term (foo AND -bar).
7115     (ticket#447)
7117 * TermIterator: Only include trailing '+' or '#' on a term if it isn't followed
7118   by a word character (makes more sense and matches QueryParser's behaviour).
7119   (ticket#446)
7121 * Database: Fix many methods to behave better on a database with no
7122   subdatabases, such as is constructed by Database().  Fixes ticket#415.
7124 testsuite:
7126 * Add test coverage for xapian-compact, and improve coverage for
7127   WritableDatabase::replace_document().
7129 * apitest: Rename matchfunctor<n> to matchdecider<n> to match current
7130   terminology.
7132 flint backend:
7134 * When updating documents, don't update posting entries which haven't changed.
7135   Largely fixes ticket #250.
7137 * If the number of entries in the position table happened to be 4294967296 or
7138   an exact multiple, Xapian would ignore positional data for that table when
7139   running queries, and xapian-compact wouldn't copy its contents.
7141 * Iterating all the terms in the database with a prefix is now slightly more
7142   efficient.
7144 * Fix locking code to work if stdin and/or stdout have been closed.
7146 * If a document is replaced with itself unmodified, we no longer increase the
7147   automatic flush counter.
7149 * When iterating a posting list modified since the last flush(), the reported
7150   wdf is now correct (previously it was too high by its old value).
7152 * Replacing a document deleted since the last flush failed to update the
7153   collection frequency and wdf, and caused an assertion failure when assertions
7154   were enabled.
7156 * WritableDatabase::replace_document() didn't always remove old positional
7157   data (the only effect is that the position table was bloated by unwanted
7158   entries).
7160 * xapian-inspect:
7162   + New "until" command which shows entries until a specified key is reached.
7164   + New "open" command which allows easy switching between tables.
7166 * xapian-compact: Fix typos in --help output.
7168 quartz backend:
7170 * Replacing a document deleted since the last flush failed to update the
7171   collection frequency and wdf, and caused an assertion failure when assertions
7172   were enabled.
7174 * WritableDatabase::replace_document() didn't always remove old positional
7175   data (the only effect is that the position table was bloated by unwanted
7176   entries).
7178 remote backend:
7180 * Throw UnimplementedError if a MatchDecider is used with the remote backend.
7181   Previously Xapian returned incorrect results in this case.
7183 build system:
7185 * configure: With --enable-maintainer-mode, enable -Werror for GCC >= 4.1
7186   rather than >= 4.0 as Apple's GCC 4.0 gives bogus uninitialised variable
7187   warnings.
7189 documentation:
7191 * The API documentation now includes Xapian::Error and subclasses, and doesn't
7192   mention Xapian::Query::Internal.
7194 * Make clear in the Xapian::Document API documentation that this class is a
7195   lazy handle and discuss the issues this can cause.
7197 * INSTALL: Improve text about zlib dependency.
7199 * HACKING: Add details of our licensing policy for accepting patches.
7201 examples:
7203 * quest: If no database is specified, still parse the query and report
7204   Query::get_description() to provide an easy way to check how a query parses.
7206 portability:
7208 * Fix GCC 4.2 warning.
7210 xapian-core 1.0.17 (2009-11-18):
7212 API:
7214 * QueryParser:
7216   + Fix handling of a group of two or more terms which are all stopwords which
7217     notably caused issues when default_op was OP_AND, but could probably
7218     manifest in other cases too.  Fixes ticket#406.
7220   + Fix interaction of FLAG_PARTIAL and FLAG_SYNONYM.  (ticket#407)
7222 * Database: A database created via the default constructor no longer causes a
7223   segfault when the methods get_metadata() or metadata_keys_begin() are called.
7225 flint backend:
7227 * Don't try to close the fd one more than the maximum allowable when locking
7228   the database.  Harmless, except it causes a warning when running under
7229   valgrind.  (ticket#408)
7231 remote backend:
7233 * Xapian::Sorter isn't supported with the remote backend so throw
7234   UnimplementedError rather than giving incorrect results.  (ticket#384)
7236 * Fix potential reading off the end of the MSet which is returned internally
7237   by the remote server.
7239 documentation:
7241 * Various documentation comment improvements for the Database class.
7243 examples:
7245 * examples/quest.cc: Tighten up the type of the error we catch to detect an
7246   unknown stemming language.
7248 portability:
7250 * xapian-config: Need to quote ^ for Solaris /bin/sh.
7252 * configure: Actually use any flags we determine are needed to switch the
7253   compiler to proper ANSI C++ mode, when building xapian-core - this stopped
7254   working in 1.0.12, breaking support for HP's aCC, Compaq's cxx, Sun's CC, and
7255   SGI's CC.
7257 Xapian-core 1.0.16 (2009-09-10):
7259 flint backend:
7261 * Fix a typo which stopped this fix in 1.0.12 from working (ticket #398):
7263   If we fail to get the lock after we spawn the child lock process (the common
7264   case is because the database is already open for writing) then we now clean
7265   up the child process properly.
7267 documentation:
7269 * Improve API documentation of QueryParser::set_default_op() and
7270   QueryParser::get_default_op().
7272 portability:
7274 * Fix build failure on Mac OS X 10.6.
7276 Xapian-core 1.0.15 (2009-08-26):
7278 testsuite:
7280 * Fix the test harness not to report heaps of bogus errors when using valgrind
7281   3.5.0.
7283 flint backend:
7285 * Backport the lazy update changes from 1.1.2:
7287   WritableDatabase::replace_document() now updates the database lazily in
7288   simple cases - for example, if you just change a document's values and
7289   replace it with the same docid, then the terms and document data aren't
7290   needlessly rewritten.  Caveats: currently we only check if you've looked at
7291   the values/terms/data, not if they've actually been modified, and only keep
7292   track of the last document read.
7294 * Fix PostingIterator::skip_to() on an unflushed WritableDatabase to skip
7295   documents which were added and deleted since the last flush.  (ticket#392)
7297 documentation:
7299 * Overhaul the doxygen options we use and tweak various documentation comments
7300   to improve the generated API documentation.
7302 * Explicitly document that an empty prefix argument to
7303   QueryParser::add_prefix() means "no prefix".
7305 * Update the documentation comments for Enable::set_sort_by_value(),
7306   set_sort_by_value_then_relevance(), and set_sort_by_relevance_then_value() to
7307   mention sortable_serialise() as a good way to store numeric values for
7308   sorting.
7310 Xapian-core 1.0.14 (2009-07-21):
7312 API:
7314 * When using more than one ValueRangeProcessor, QueryParser didn't reset the
7315   begin and end strings to ignore any changes made by a ValueRangeProcessor
7316   which returned false, so further ValueRangeProcessors would see any changes
7317   it had made.  This is now fixed, and test coverage improved.
7319 testsuite:
7321 * The test harness code which launches xapian-tcpsrv child processes was
7322   failing to close a file descriptor for each one launched due to a bug in
7323   the code which is meant to track them.  This was causing apitest to fail
7324   on OpenBSD (ticket#382).  Also wait between testcases for any spawned
7325   xapian-tcpsrv processes to exit to avoid spurious failures when a database is
7326   reused by the next testcase.
7328 * tests/runtest.in: Use "ulimit -n" where available to limit the number of
7329   available file descriptors to 64 so we catch file descriptor leaks sooner.
7331 * When measuring CPU time used for scalability tests, we no longer try to
7332   include the CPU time used by child processes, as we can only get that for
7333   child processes which have exited and it's hard to ensure that they have
7334   with the current framework.  Although this means we only tests the
7335   client-side scaling for remote tests, the local backend tests cover most of
7336   the work done by the server part of the remote backend.
7338 * apitest: In testcase topercent2, don't expect max_attained or max_possible to
7339   be exact as rounding errors in different ways of calculating can cause small
7340   variations.  On trunk we already have similar code because the new weighting
7341   scheme stuff gives different bounds in the different cases.  This should fix
7342   testsuite failures seen on some of the Debian and Ubuntu buildds.
7344 * The test harness now always reports the full exception message (was
7345   conditional on --verbose), and output for different exception types and
7346   other causes of failure is now more consistent.
7348 * For scalability tests, the test harness now increases the number of
7349   repetitions until the first run takes more than 0.001 seconds, to avoid
7350   trying to base calculations on a length of time we probably can't reliably
7351   measure to start with.
7353 * Add test coverage for Stem::get_description() for each supported language.
7355 * queryparsertest: Reenable tests which require the inmemory backend to be
7356   enabled by fixing typo XAPIAN_HAS_BACKEND_INMEMORY ->
7357   XAPIAN_HAS_INMEMORY_BACKEND.
7359 flint backend:
7361 * Use F_FULLFSYNC where available (Mac OS X currently) to ensure that changes
7362   have been committed to disk.  (ticket#288)
7364 remote backend:
7366 * Fix handling of percentage weights in various cases when we're searching
7367   multiple remote databases or a mix of local and remote databases.
7369 build system:
7371 * configure: -Wshadow produces false positives with GCC 4.0, so only enable it
7372   for >= 4.1 since we enable -Werror for maintainer-mode builds for GCC >= 4.0.
7374 * configure: Check that we can find the valgrind/memcheck.h header as well as
7375   the valgrind binary.
7377 * Change how snowball generates the data used by its among operation - instead
7378   of using pointers to the strings in struct among, store an offset into a
7379   constant pool, as this reduces the number of relocations by about 2300, which
7380   should decrease the time taken by the dynamic linker when loading the
7381   library.  This also reduces the size of the shared library significantly
7382   (on x86-64 Linux, the stripped shared library is 4% smaller).
7384 Xapian-core 1.0.13 (2009-05-23):
7386 API:
7388 * Xapian::Document no longer ever stores empty values explicitly.  This
7389   wasn't intentional behaviour, and how this case was handled wasn't
7390   documented.  The amended behaviour is consistent with how user metadata
7391   is handled.  This change isn't observable using Document::get_value(),
7392   but can be noticed when iterating with Document::values_begin(), using
7393   Document::values_count(), or trying to delete the value with
7394   Document::remove_value().
7396 testsuite:
7398 * Fix testcase scaleweight4 not to fail on x86 when compiled with -O0.  The
7399   problem was in the testcase code, and was caused by excess precision in
7400   intermediate FP values.
7402 * Testcases which check that operations have the expected O(...) behaviour now
7403   check CPU time instead of wallclock time on most platforms, which should
7404   eliminate occasional failures due to load spikes from other processes.
7405   (ticket#308)
7407 * Fix test failures due to SKIP_TEST_FOR_BACKEND("inmemory") not skipping when
7408   it should due to comparing char * strings with == (on trunk the return value
7409   being tested is std::string rather than const char *).
7411 * Improve test coverage in several corner cases.
7413 * Fix testcase consistency2 to actually be run (fortunately it passes).
7415 * In the generated testcases, call get_description() on the default
7416   constructed object of each class to make sure that works (and doesn't try to
7417   dereference NULL, or fail some assertion, etc).  All currently checked
7418   classes are fine - this is to avoid future regressions or such problems with
7419   new classes.
7421 * In the test coverage build, use "--coverage" instead of "-fprofile-arcs
7422   -ftest-coverage".
7424 * The test harness now has the inmemory backend flagged as supporting
7425   user-specified metadata (apart from iteration over metadata keys).
7427 matcher:
7429 * If a query contains a MatchAll subquery, check for it before checking the
7430   other terms so that the loop which checks how many terms match can exit
7431   early if they all match.
7433 * When an OR or ANY_MAYBE decayed to an AND, we were carefully swapping the
7434   children for maximum efficiency, but the condition was reversed so we were
7435   in fact making things worse.  This was noticed because it was resulting in
7436   the same query running faster when more results were asked for!
7438 * Only build the termname to termfreq and weight map for the first subdatabase
7439   instead of rebuilding it for each one.  Also don't copy this map to return
7440   it.  This should speed up searches a little, especially those over multiple
7441   databases.
7443 * If a submatcher fails but ErrorHandler tells us to continue without it, we
7444   just use a NULL pointer to stand in rather than allocating a special dummy
7445   place-holder object.
7447 * Remove AndPostList, in favour of MultiAndPostList.  AndPostList was only used
7448   as a decay product (by AndMaybePostList and OrPostList), and doesn't appear
7449   to be any faster.  Removing it reduces CPU cache pressure, and is less code
7450   to maintain.
7452 * Call check() instead of skip_to() on the optional branch of AND_MAYBE.
7454 flint backend:
7456 * Fix a bug in TermIterator::skip_to() over metadata keys.
7458 remote backend:
7460 * Fix xapian-tcpsrv --interface option to work on MacOS X (ticket#373).
7462 * Fix typo which caused us to return the docid instead of the maximum weight
7463   a document from a remote match could return!  This could have led to wrong
7464   results when searching multiple databases with the remote backend, but
7465   probably usually didn't matter as with BM25 the weights are generally small
7466   (often all < 1) while docids are inevitably >= 1.
7468 inmemory backend:
7470 * The inmemory backend doesn't support iterating over metadata keys.  Trying
7471   to do so used to give an empty iteration, but has now been fixed to throw
7472   UnimplementedError (and this limitation has now been documented).
7474 build system:
7476 * Remove a lot of unused header inclusions and some unused code which should
7477   make the build faster and slightly smaller.
7479 * Fix to compile under --disable-backend-flint, --disable-backend-remote, and
7480   --disable-backend-inmemory.
7482 * Don't remove any built sources in "make clean" even under
7483   --make-maintainer-mode as that breaks switching a tree away from
7484   maintainer-mode with: make distclean;./configure
7486 * configure: Enable more GCC warnings - "-Woverloaded-virtual" for all
7487   versions, "-Wstrict-null-sentinel" for 4.0+, "-Wlogical-op
7488   -Wmissing-declarations" for 4.3+.  Notably "-Wmissing-declarations" caught
7489   that consistency2 wasn't being run.
7491 * Internally, fix the few places where we pass std::string by value to pass
7492   by const reference instead (except where we need a modifiable copy anyway) as
7493   benchmarking shows that const reference is slightly faster and generates
7494   less code with GCC's reference counted std::string implementation - with a
7495   non-reference counted implementation, const reference should be much faster.
7496   (ticket#140)
7498 documentation:
7500 * INSTALL: We no longer regularly test build with GCC 2.95.4 and we're raising
7501   the minimum GCC version required to 3.1 for Xapian 1.1.x.
7503 * Document what passing maxitems=0 to Enquire::get_mset() does.
7505 * docs/queryparser.html: Add examples of using a prefix on a phrase or
7506   subexpression.
7508 * Correct doxygen comments for user metadata functions:
7509   Database::get_metadata() can't throw UnimplementedError but
7510   WritableDatabase::set_metadata() can.
7512 * Document that Database::metadata_keys_begin() returns an end iterator if the
7513   backend doesn't support metadata.
7515 * HACKING: Update the list of Debian/Ubuntu packages needed for a development
7516   environment.
7518 debug code:
7520 * Fix build with --enable-debug.
7522 * Added some more assertions.
7524 Xapian-core 1.0.12 (2009-04-19):
7526 API:
7528 * WritableDatabase::remove_spelling() now works properly.
7530 * The QueryParser now treats NON_SPACING_MARK Unicode characters as phrase
7531   generators, which improves handling of Arabic.  This is a stop-gap solution
7532   for 1.0.x which will work with existing databases without requiring
7533   reindexing - in 1.1.0, NON_SPACING_MARK will be regarded as part of a word.
7534   (ticket#355)
7536 * Fix undefined behaviour in distribution of OP_NEAR and OP_PHRASE over a
7537   non-leaf subquery (indentified by valgrind on testcase nearsubqueries1).
7538   (ticket#349)
7540 * Enhance distribution of OP_NEAR/OP_PHRASE over non-leaf subqueries to work
7541   when there are multiple non-leaf subqueries (ticket#201).
7543 * Enquire::get_mset() no longer needlessly checks if the documents exist.
7545 * PostingIterator::get_description() output improved visually in some cases.
7547 testsuite:
7549 * Add make targets to assist generating a testsuite code coverage report with
7550   lcov.  See HACKING for details.
7552 * Improved test coverage in a number of places and removed some used code as
7553   shown by lcov's coverage report.
7555 flint backend:
7557 * xapian-compact:
7559   + Now handles databases which contains no documents but have user metadata
7560     (ticket#356).
7562   + Fix test for the total document length overflowing.
7564 * Release the database lock if the database is closed due to an unrecoverable
7565   error during modifications. (ticket#354)
7567 * If we fail to get the lock after we spawn the child lock process (the common
7568   case is because the database is already open for writing) then we now clean
7569   up the child process properly.
7571 build system:
7573 * Overriding CXXFLAGS at make-time (e.g. "make CXXFLAGS=-Os") no longer
7574   overrides any flags configure detected to be required to make the compiler
7575   accept ISO C++ (for GCC, no such flags are required, so this doesn't
7576   change anything).
7578 documentation:
7580 * Update documentation and code comments to reflect that 1.1 will be a
7581   development series, and 1.2 the next release series.
7583 * docs/admin_notes.html: Document the child process used for locking which
7584   exec-s "cat" (ticket #258).
7586 * include/xapian/unicode.h: Fix documentation comment typos.
7588 * include/xapian/matchspy.h: Removed currently unused header to stop doxygen
7589   from generating documentation for it.
7591 Xapian-core 1.0.11 (2009-03-15):
7593 API:
7595 * Enquire::get_mset():
7597   + Now throws UnimplementedError if there's a percentage cutoff and sorting is
7598     primarily by value - this has never been correctly supported and it's
7599     better to warn people than give incorrect results.
7601   + No longer needlessly copies the results internally.
7603   + When searching multiple databases, now recalculates the maximum attainable
7604     weight after each database which may allow it to terminate earlier.
7605     (ticket#336).
7607   + Fix inconsistent percentage scores when sorting primarily by value, except
7608     when a MatchDecider is also being used; document this remaining problem
7609     case.  (ticket#216)
7611 * Enquire::set_sort_by_value() (and similar methods): Rename the wrongly named
7612   "ascending" parameter to "reverse", and note that its value should always be
7613   explicitly given since defaulting to "reverse=true" is confusing and the
7614   default will be deprecated in 1.1.0.  (ticket#311)
7616 * Database::allterms_begin(): Fix memory leak when iterating all terms from
7617   more than one database.
7619 * Query::get_terms_begin(): Don't return "" from the TermIterator (happened
7620   when the query contained or was Query::MatchAll).
7622 * Add QueryParser::FLAG_DEFAULT to make it easier to add flags to those set by
7623   default.
7625 testsuite:
7627 * The testsuite now reports problems detected by valgrind with newer valgrind
7628   versions.  Drop support for running the testsuite under valgrind < 3.3.0
7629   (well over a year old) as this greatly simplifies the configure tests.
7631 * Fix usage message for options which take arguments in --help output from test
7632   programs - "-x=foo" doesn't work, the correct syntax is "-x foo".
7634 * If comparing MSet percentages fails, report the differing percentages if in
7635   verbose mode.
7637 * Add test that backends don't truncate total document length to 32 bits.
7639 * Disable lockfileumask1 (regression testcase added in 1.0.10) on Cygwin and on
7640   OS/2.
7642 flint backend:
7644 * The configure test for pread() and pwrite() got accidentally disabled in
7645   0.8.4 and we've always been using llseek() followed by read() or write()
7646   since then.  The configure test is now fixed, and gives a slight speedup
7647   (3% measured for searching).
7649 * The child process used to implement WritableDatabase locking now changes
7650   directory to / so that it doesn't block unmounting of any partitions and
7651   closes any open file descriptors which aren't relating to locking so that
7652   if those files are closed by our parent and deleted the disk space gets
7653   released right away.
7655 * We now reuse the same zlib zstream structures rather than using a fresh
7656   one for each operation.  This doesn't make a measurable difference in
7657   our own tests on Linux but reportedly is measurably faster on some
7658   systems.  (ticket #325)
7660 quartz backend:
7662 * The pread()/pwrite() fix also speeds up quartz.
7664 remote backend:
7666 * Avoid copying Query::Internal objects needlessly when unserialising Query
7667   objects.
7669 inmemory backend:
7671 * Store the (non-normalised) document lengths as Xapian::termcount (unsigned
7672   int) rather than Xapian::doclength (double) which saves 4 bytes per document.
7674 build system:
7676 * configure: The output of g++ --version changed format (again) with GCC 4.3
7677   which meant configure got "g++" for the version.  Instead use the (hopefully)
7678   more robust technique of using g++ -E to pull out __GNUC__ and
7679   __GNUC_MINOR__.
7681 documentation:
7683 * API documentation:
7685   + WritableDatabase::flush() can't throw DatabaseLockError.
7687   + WritableDatabase's constructor can throw at least DatabaseCorruptError or
7688     DatabaseLockError.
7690   + Document how to get all matches from Enquire::get_mset().
7692   + Other minor improvements.
7694 * docs/sorting.html: Clarify meaning.
7696 portability:
7698 * Fix "#line" directives in generated file queryparser/queryparser_internal.cc
7699   to give a relative path - previously they had a full path when generated by a
7700   VPATH build (as release tarballs are), and this confused GCC 2.95 and
7701   depcomp.
7703 * Fix for compiling with Sun's compiler (untested as we no longer have access
7704   to it).
7706 Xapian-core 1.0.10 (2008-12-23):
7708 API:
7710 * Composing an OP_NEAR query with two non-term subqueries now throws
7711   UnimplementedError instead of AssertionError (in a --enable-assertions build)
7712   or leading to unexpected results (otherwise).  This partly addresses bug#201.
7714 * Using a MultiValueSorter with no values set no longer causes a hang or
7715   segmentation fault (but it is still rather pointless!)
7717 matcher:
7719 * If we're using values for sorting and for another purpose, cache the
7720   Document::Internal object created to get the value for sorting, like we do
7721   between other uses.
7723 flint backend:
7725 * If the disk became full while flushing database changes to disk, the
7726   WritableDatabase object would throw a DatabaseError exception but be left in
7727   an inconsistent state such that further use could lead to the database on
7728   disk ending up in a "corrupt" state (theoretically fixable, but no tool
7729   to fix such a database exists).  Now we try to ensure that the object is
7730   left in a consistent state, but if doing so throws a further exception, we
7731   put the WritableDatabase object in a "closed" state such that further
7732   attempts to use it throw an exception.
7734 * Create the lockfile "flintlock" with permissions 0666 so that the umask is
7735   honoured just like we do for the other files (previously we used 0600).
7736   Previously it wasn't possible to lock a database for update if it was
7737   owned by another user, even if you otherwise had sufficient permissions via
7738   "group" or "other".
7740 * Fix garbled exception message when a base file can't be reread.
7742 quartz backend:
7744 * Fix garbled exception message when a base file can't be reread.
7746 remote backend:
7748 * xapian-tcpsrv and xapian-progsrv now accept -w as a short form of --writable,
7749   as was always intended.
7751 build system:
7753 * This release now uses newer versions of the autotools (autoconf 2.62 ->
7754   2.63; automake 1.10.1 -> 1.10.2).
7756 documentation:
7758 * INSTALL: Add new paragraphs about HP's aCC and IRIX (adapted from footnotes
7759   in PLATFORMS).
7761 * PLATFORMS: HP testdrive has been shut down, so all mark all those machines as
7762   "no longer available".  Update atreus' build report to 1.0.10.
7764 * docs/queryparser.html: Add link to valueranges.html.
7766 examples:
7768 * delve: Add missing "and" to --help output.  Report termfreq and collection
7769   freq for each term we're asked about.
7771 portability:
7773 * Fix to build with GCC 4.4 snapshot.
7775 Xapian-core 1.0.9 (2008-10-31):
7777 API:
7779 * Database::get_spelling_suggestion() is now faster (15% speed up for parsing
7780   queries with FLAG_SPELLING_CORRECTION set in a test on real world data).
7782 * Fix OP_ELITE_SET segmentation fault due to excess floating point precision
7783   on x86 Linux (and possibly other platforms).
7785 * Database::allterms_begin() over multiple databases now gives a TermIterator
7786   with operations O(log(n)) rather than potentially O(n) in the number of
7787   databases.
7789 * Add new Database methods metadata_keys_begin() and metadata_keys_end() to
7790   allow the complete list of metadata in a database to be retrieved (this
7791   API addition is needed so that copydatabase can copy database metadata).
7793 testsuite:
7795 * Remove the cached test databases before running the testsuite.
7797 * apitest: Fix cursordelbug1 to work on Microsoft Windows (bug#301).
7799 * apitest,queryparsertest: Skip tests which fail because the timer granularity
7800   is too coarse to measure how long the test took.  In practice, this is only
7801   an issue on Microsoft Windows (bug#300 and bug#308).
7803 matcher:
7805 * Adjust percent cutoff calculations in the matcher in a way which corresponds
7806   to the change to percentage calculations made in 1.0.7 to allow for excess
7807   precision.
7809 * Query::MatchAll no longer gives match results ranked by increasing document
7810   length.
7812 flint backend:
7814 * xapian-compact: Fix crash while compacting spelling table for a single
7815   database when built with MSVC, and probably other platforms, though Linux
7816   got lucky and happened to work (bug#305).
7818 build system:
7820 * configure: Disable -Wconversion for now - it's not useful for older GCC and
7821   is buggy in GCC 4.3.
7823 * configure: Set -Wstrict-overflow to 1 instead of 5, to avoid unreasonable
7824   warnings under GCC 4.3.
7826 documentation:
7828 * Minor improvements to API documentation, including documenting the
7829   XAPIAN_FLUSH_THRESHOLD environmental variable in WriteableDatabase::flush()
7830   (bug#306).
7832 * valueranges.html: Fix typos in example code, and drop superfluous empty
7833   destructor from ValueRangeProcessor subclass.
7835 * HACKING: Several improvements.
7837 examples:
7839 * copydatabase: Also copy user metadata.
7841 Xapian-core 1.0.8 (2008-09-04):
7843 API:
7845 * Fix output of RSet::get_description
7847 testsuite:
7849 * Report subtotals per backend, rather than per testgroup per backend to make
7850   the output easier to read.
7852 flint backend:
7854 * Fix WritableDatabase::add_document() and replace_document() not to be O(n*n)
7855   in the number of values in the new document.
7857 * Fix handling of a table created lazily after the database has had commits,
7858   and which is then cursored while still in sequential mode.
7860 * Fix failure to remove all the Btree entries in some cases when all the
7861   postings for a term are removed.  (bug#287)
7863 * xapian-inspect: Show the help message on start-up.  Correct the documented
7864   alias for next from ' ' to ''.  Avoid reading outside of input string when it
7865   is empty.  (bug#286)
7867 quartz backend:
7869 * Backport fix from flint for WritableDatabase::add_document() and
7870   replace_document() not to be O(n*n) in the number of values in the new
7871   document.
7873 build system:
7875 * configure: Report bug report URL in --help output.
7877 * xapian-config: Report bug report URL in --help output.
7879 * configure: Fix deprecation error for --enable-debug=full to say to instead
7880   use '--enable-assertions --enable-log' not '--enable-debug --enable-log'.
7882 documentation:
7884 * valueranges.html: Expand on some sections.
7886 examples:
7888 * quest: Fix to catch QueryParserError instead of const char * which
7889   QueryParser threw in Xapian < 1.0.0.
7891 * copydatabase: Use C++ forms of C headers.  Only treat '\' as a directory
7892   separator on platforms where it is.  Update counter every 13 counting up to
7893   the end so that the digits all "rotate" and the counter ends up on the exact
7894   total.
7896 portability:
7898 * Eliminate literal top-bit-set characters in testsuite source code.
7900 Xapian-core 1.0.7 (2008-07-15):
7902 API:
7904 * OP_VALUE_RANGE, OP_VALUE_GE, and OP_VALUE_LE:
7906   + If there were gaps in the document id numbering, these operators could
7907     return document ids which weren't present in the database.  This has been
7908     fixed.
7910   + These operators are now more efficient when there are a lot of "missing"
7911     document ids (bug#270).
7913   + Optimise Query(OP_VALUE_GE, <n>, "") to Query::MatchAll.
7915 * Xapian::QueryParser:
7917   + QueryParser now stops parsing immediately when it hits a syntax error.
7918     This doesn't change behaviour, but does mean failing to parse queries is
7919     now more efficient.
7921   + Cases of O(N*N) behaviour have been fixed.
7923 * Xapian::Stem now recognises "nl" as an alias for "dutch" (debian bug 484458).
7925 * Setting sort by value was being ignored by a Xapian::Enquire object which had
7926   previously had a Xapian::Sorter set (bug#256).
7928 testsuite:
7930 * Improved test coverage in a few places.
7932 matcher:
7934 * When using a MatchDecider, we weren't reducing matches_lower_bound unless
7935   all the potential results were retrieved, which led to the lower bound
7936   being too high in some such cases.
7938 * We now track how many documents were tested by a MatchDecider and how many
7939   of those it rejected, and set matches_estimated based on this rate.  Also,
7940   matches_upper_bound is reduced by the number of rejected documents.
7942 * Fixed matches_upper_bound in some cases when collapsing and using a
7943   MatchDecider.
7945 * Fixed matches_lower_bound when collapsing and using a percentage cutoff.
7947 * When using two or more of a MatchDecider, collapsing, or a percentage
7948   cutoff, we now only round the scaled estimate once, and we also round it to
7949   the nearest rather than always rounding down.  Hopefully this should
7950   improve the estimate a little in such cases.
7952 * Fix problem on x86 with the top match getting 99% rather than 100% (caused
7953   by excess precision in an intermediate value).
7955 flint backend:
7957 * If Database::reopen() is called and the database revision on disk hasn't
7958   changed, then do as little work as possible.  Even if it has changed, don't
7959   bother to recheck the version file (bug#261).
7961 * xapian-compact:
7963   + Fix check for user metadata key to not match other key types we may add in
7964     the future.  When compacting, we can't assume how we should handle them.
7966   + If the same user metadata key is present in more than one source database
7967     with different tag values, issue a warning and copy an arbitrary tag value.
7969   + Fix potential SEGV when compacting database(s) with user metadata but no
7970     postings.
7972   + In error message, refer to "iamflint" as the "version file", not the
7973     "meta file".
7975 * xapian-inspect:
7977   + Print top-bit-set characters as escaped hex forms as they often won't be
7978     valid UTF-8 sequences.
7980   + If we're passed a database directory rather than a single table, issue a
7981     special error message since this is an obvious mistake for users to make.
7983 * Fix cursor handling for a modified table which has previously only had
7984   sequential updates which usually manifested as zlib errors (bug#259).
7986 quartz backend:
7988 * Fix cursor handling for a modified table which has previously only had
7989   sequential updates which usually manifested as incorrect data being returned
7990   (bug#259).
7992 * Calling skip_to() as the first operation on an all-documents PostingIterator
7993   now works correctly.
7995 remote backend:
7997 * Improve performance of matches with multiple databases at least one of which
7998   is remote, and when the top hit is from a remote database (bug#279).
8000 * When remote protocol version doesn't match, the error message displayed
8001   now shows the minor version number supplied by the server correctly.
8003 * We now wait for the connection to close after sending MSG_SHUTDOWN for a
8004   WritableDatabase, which ensures that changes have been written to disk
8005   and the lock released before the WritableDatabase destructor returns
8006   (as is the case with a local database).
8008 * We no longer ever send MSG_SHUTDOWN for a read-only Database - just closing
8009   the connection is enough (and is protocol compatible).
8011 inmemory backend:
8013 * Fix bug which resulted in the values not being stored correctly when
8014   replacing an existing document, or if there are gaps in the document id
8015   numbering.
8017 build system:
8019 * This release now uses newer versions of the autotools (autoconf 2.61 ->
8020   2.62; automake 1.10 -> 1.10.1; libtool 1.5.24 -> 1.5.26).  The newer
8021   autoconf reportedly results in a faster configure script, and warns about
8022   use of unrecognised configure options.
8024 * Fix configure to recognise --enable-log=profile and fix build problems when
8025   this is enabled.
8027 * "make up" in the "tests" subdirectory now does "make" in the top-level.
8029 * Fix "make distcheck" by using dist-hook to install generated files from
8030   either srcdir or builddir, with the appropriate dependency to generate them
8031   automatically in maintainer mode builds.
8033 documentation:
8035 * intro_ir.html: Improve wording a bit.
8037 * The documentation now links to trac instead of bugzilla.  For links to the
8038   main website, we now prefer xapian.org to www.xapian.org.
8040 * Doxygen-generated API documentation:
8042   + Improved documentation in several places.
8044   + The helper macro XAPIAN_VISIBILITY_DEFAULT no longer appears in the output.
8046   + Header and directory relationship graphs are no longer generated as they
8047     aren't actually informative here.
8049 * HACKING: Numerous updates and improvements.
8051 examples:
8053 * quest: Output get_description() of the parsed query.
8055 portability:
8057 * Fix build with GCC 2.95.3.
8059 * Fix build with GCC 4.3.
8061 * Newer libtool features improved support for Mac OS X Leopard and added
8062   support for AIX 6.1.
8064 debug code:
8066 * Database::get_spelling_suggestion() now debug logs with category APICALL
8067   rather than SPELLING, for consistency with all other API methods.
8069 * Added APICALL logging to a few Database methods which didn't have it.
8071 * Remove debug log tracing from get_description() methods since logging for
8072   other methods calls get_description() methods on parameters, so logging these
8073   calls just makes for more confusing debug logs.  A get_description() method
8074   should have no side-effects so it's not very interesting even when explicitly
8075   called by the user.
8077 Xapian-core 1.0.6 (2008-03-17):
8079 API:
8081 * Add new query operators OP_VALUE_LE and OP_VALUE_GE which perform "single
8082   ended" range checks, and a corresponding new Query constructor.
8084 * Add Unicode::toupper() to complement Unicode::tolower().
8086 * Xapian::Stem has been further optimised - stemtest now runs ~2.5% faster.
8088 testsuite:
8090 * tests/runtest: Fixed to handle test programs with a ".exe" extension.
8092 * tests/queryparsertest: Add a couple more testcases which already work to
8093   improve test coverage.
8095 * tests/apitest: Add caseconvert1 testcase to test Unicode::tolower() and
8096   Unicode::toupper().
8098 flint backend:
8100 * xapian-check: Fix not to report an error for a database containing no
8101   postings but some user metadata.
8103 * Update the base files atomically to avoid problems with reading processes
8104   finding partially written ones.
8106 * Create lazy tables with the correct revision to avoid producing a database
8107   which we later report as "corrupt" (bug#232).
8109 * xapian-compact: Fix compaction for databases which contain user metadata
8110   keys.
8112 quartz backend:
8114 * Update the base files atomically to avoid problems with reading processes
8115   finding partially written ones.
8117 remote backend:
8119 * The addition of OP_VALUE_LE and OP_VALUE_GE required an update to the Query
8120   serialisation, which required a minor remote protocol version bump.
8122 * Fix to actually set the writing half as the connection as non-blocking when
8123   a timeout is specified.  This would have prevented timeouts from operating
8124   correctly in some situations.
8126 build system:
8128 * configure: GCC warning flag overhaul:  Stop passing "-Wno-multichar" since
8129   any multi-character character literal is bound to be a typo (I believe we
8130   were only passing it after misinterpreting its sense!)  Pass
8131   "-Wformat-security", and "-Wconversion" for all GCC versions.  Add
8132   "-Winit-self" and "-Wstrict-overflow=5" for GCC >= 4.2.  The latter might
8133   prove too aggressive, but seems reasonable so far.  Fix some minor niggles
8134   revealed by "-Wconversion" and "-Wstrict-overflow=5".
8136 * Add XAPIAN_NORETURN() annotations to functions and non-virtual methods which
8137   don't return.
8139 documentation:
8141 * docs/intro_ir.html: Briefly mention how pure boolean retrieval is supported.
8143 * docs/valueranges.html: Fix example of using multiple VRPs to come out as a
8144   "program listing".
8146 * include/xapian/queryparser.h: Fix incorrect example in doccomment.
8148 * docs/quickstart.html: Remove information covered by INSTALL since
8149   there's no good reason to repeat it and two copies just risks one
8150   getting out of date (as has happened here!)
8152 * docs/quickstart.html: Fix very out of date reference to MSet::items
8153   (bug#237).
8155 * PLATFORMS: Remove reports for 0.8.x as they're too old to be interesting.
8156   Separate out 0.9.x reports.  Add Solaris 9 and 10 success reports from James
8157   Aylett.  Update from Debian buildd logs.
8159 portability:
8161 * Now builds on OS/2, thanks to a patch by Yuri Dario.
8163 * Fix testsuite to build on mingw (broken by changes in 1.0.5).
8165 debug code:
8167 * Fix --enable-assertions build, broken by changes in 1.0.5.
8169 Xapian-core 1.0.5 (2007-12-21):
8171 API:
8173 * More sophisticated sorting of results is now possible by defining a
8174   functor subclassing Xapian::Sorter (bug#100).
8176 * Xapian::Enquire now provides a public copy constructor and assignment
8177   operator (bug#219).
8179 * Xapian::Document::values_begin() didn't ensure that values had been read
8180   when working on a Document read from a database.  However, values_end() did
8181   (and so did values_count()) so this wasn't generally a problem in practice.
8183 * Xapian::PostingIterator::skip_to() now works correctly when running over
8184   multiple databases.
8186 * Xapian::Database::postlist_begin() no longer adds a "MultiPostList" wrapper
8187   for the common case when there's only one subdatabase.
8189 * Xapian::TradWeight now avoids division by zero in the (rare) situation of the
8190   average document length being zero (which can only happen if all documents
8191   are empty or only have terms with wdf 0).
8193 * Calling Xapian::WritableDatabase methods when we don't have exactly one
8194   subdatabase now throws InvalidOperationError.
8196 testsuite:
8198 * apitest:
8200   + Testcases now describe the conditions they need to run, and are
8201     automatically collated by a Perl script.  This makes it significantly
8202     easier to add a new testcase.
8204   + The test harness's "BackendManager" has been overhauled to allow
8205     cleaner implementations of testcases which are currently hard to
8206     write cleanly, and to make it easier to add new backend settings.
8208   + Add a "multi" backend setting which runs suitable tests over two
8209     subdatabases combined.  There's a corresponding new make target
8210     "check-multi".
8212   + Add more feature tests of document values.
8214   + sortrel1 now runs for inmemory too.
8216   + Add simple feature test for TradWeight being used to run a query.
8218   + Fix spell3 to work on Microsoft Windows (bug#177).
8220   + API classes are now tested to check they have copy constructors and
8221     assignment operators, and also that most have a default constructor.
8223   + quartztest testcases adddoc2 and adddoc3 have been reworked as apitest
8224     testcases adddoc5 and adddoc6, which run for other backends.
8226   + stubdb1 now explicitly creates the database it needs - generally this
8227     bug didn't manifest because an earlier test has already created it.
8229 * queryparsertest: Add feature tests to check that ':' is being inserted
8230   between prefix and term when it should be.
8232 * Fix extracting of valgrind error messages in the test harness.
8234 * tests/valgrind.supp: Add more variants of the zlib suppressions.
8236 matcher:
8238 * Xapian::Enquire: When the "first" parameter to get_mset() is non-zero, avoid
8239   copying all the wanted items after performing the match.
8241 * Fix bug in handling a pure boolean match over more than one database under
8242   set_docid_order(ASCENDING) - we used to exit early which isn't correct.
8244 * When collapsing on a value, give a better lower bound on the number of
8245   matches by keeping track of the number of empty collapse values seen.
8247 * Xapian::BM25Weight: Fix bug when k2 is non-zero: a non-initialised value
8248   influenced the weight calculations.  By default k2 is zero, so this bug
8249   probably won't have affected most users.
8251 * The mechanism used to collate term statistics across multiple databases has
8252   been greatly simplified (bug#45).
8254 flint backend:
8256 * xapian-check:
8258   + Update to handle flint databases produced by Xapian 1.0.3 and later.
8260   + Fix not to go into an infinite loop if certain checks fail.
8262 quartz backend:
8264 * quartzcompact: Fix equality testing of C strings to use strcmp() rather than
8265   '=='!  In practice, using '==' often gives the desired effect due to pooling
8266   of constant strings, but this may have resulted in a bug on some platforms.
8268 remote backend:
8270 * If we're doing a match with only one database which is remote then just
8271   return the unserialised MSet from the remote match.  This requires an
8272   update to the MSet serialisation, which requires a minor remote protocol
8273   version bump.
8275 build system:
8277 * XO_LIB_XAPIAN now hooks LT_INIT as well as AC_PROG_LIBTOOL and
8278   AM_PROG_LIBTOOL.
8280 * Distribute preautoreconf, dir_contents, docs/dir_contents and
8281   tests/dir_contents.
8283 * Fix preautoreconf to correctly handle all the sources passed to doxygen to
8284   create the collated internal source documentation, and to work in a VPATH
8285   build.
8287 documentation:
8289 * sorting.html: New document on the topic of sorting match results.
8291 * HACKING,admin_notes.html,bm25.html,glossary.html,intro_ir.html,overview.html,
8292   quickstart.html,scalability.html,termgenerator,html,synonyms.html: Assorted
8293   minor improvements.
8295 * valueranges.html: State explicitly that Xapian::sortable_serialise() is used
8296   to encode values at index time, and give an example of how it is called.
8298 * API documentation:
8300  + Clarify get_wdf() versus get_termfreq().
8302  + We now use pngcrush to reduce the size of PNG files in the HTML version.
8304  + The HTML version no longer includes various intermediate files which doxygen
8305    generates.
8307  + Hide the v102 namespace from Doxygen as it isn't user visible.
8309  + Stop describing get_description() as an "Introspection method", as this
8310    doesn't help to explain what it does, and get_description() doesn't really
8311    fall under common formal definitions of "introspection".
8313 * index.html: Add a list of documents on particular topics and include links to
8314   previously unlinked-to documents.  Weed down the top navigation bar which had
8315   grown to unwieldy length.
8317 * PLATFORMS: Update for Debian buildds.
8319 * Improve documentation comment for Document::termlist_count().
8321 * admin_notes.html: Note that this document is up-to-date for 1.0.5.
8323 * INSTALL: zlib 1.2.0 apparently fixes a memory leak in deflateInit2(), which
8324   we use, so that's another reason to prefer 1.2.x.
8326 portability:
8328 * Add explicit includes of C headers needed to build with the latest snapshots
8329   of GCC 4.3.  Fix new warnings.
8331 * xapian-config: On platforms which we know don't need explicit dependencies,
8332   --ltlibs now gives the same output as --libs.
8334 * The minimum supported GCC version is now 2.95.3 (rather than 2.95) as 2.95.3
8335   added support for '#include <sstream>' which means we no longer need to
8336   maintain our own version.
8338 * Fix build with SGI's compiler on IRIX.
8340 * Fix or suppress some MSVC warnings.
8342 debug code:
8344 * Remove incorrect assertion in MultiAndPostList (bug#209).
8346 * Fix build when configured with "--enable-log --disable-assertions".
8348 Xapian-core 1.0.4 (2007-10-30):
8350 API:
8352 * Query:
8354   + Add OP_SCALE_WEIGHT operator (and a corresponding constructor which
8355     takes a single subquery and a parameter of type "double").  This
8356     multiplies the weights from the subquery by the parameter, allowing
8357     adjustment of the importance of parts of the query tree.
8359   + Deprecate the essentially useless constructor Query(Query::op, Query).
8361 * QueryParser:
8363   + A field prefix can now be set to expand to more than one term prefix.
8364     Similarly, multiple term prefixes can now be applied by default.  This is
8365     done by calling QueryParser::add_boolean_prefix() or
8366     QueryParser::add_prefix() more than once with the same field name but a
8367     different term prefix (previously subsequent calls with the same field name
8368     had no effect).
8370   + Trying to set the same field as probabilistic and boolean now throws
8371     InvalidOperationError.
8373   + Fix parsing of `term1 site:example.org term2', broken by changes in 1.0.2.
8375   + Drop special treatment for unmatched ')' at the start of the query, as it
8376     seems rather arbitrary and not particularly useful and was causing us to
8377     parse `(site:example.org) -term' incorrectly.
8379   + The QueryParser now generates pure boolean Query objects for strings such
8380     as `site:example.org' by applying OP_SCALE_WEIGHT with a factor of 0.0.
8382   + Fix handling of `"quoted phrase" +term' and `"quoted phrase" -term'.
8384   + Fix handling of `site:example.org -term'.
8386   + Fix problem with spelling correction of hyphenated terms (or other terms
8387     joined with phrase generators): the position of the start of the term
8388     wasn't being reset for the second term in the generated phrase, resulting
8389     in out of bounds errors when substituting the new value in the corrected
8390     query string.
8392   + The parser stack is now a std::vector<> rather than a fixed size, so it
8393     will typically use less memory, and can't hit the fixed limit.
8395   + Fix handling of STEM_ALL and update the documentation comment for
8396     QueryParser::set_stemming_strategy() to explain how it works clearly.
8398 * PostingIterator: positionlist_begin() and get_wdf() should now always
8399   throw InvalidOperationError where they aren't meaningful (before in some
8400   cases UnimplementedError was thrown).
8402 testsuite:
8404 * Add tests for new features.
8406 * Add another valgrind suppression for a slightly different error from zlib
8407   in Ubuntu gutsy.
8409 * Remove quartztest's test_postlist1 and test_postlist2, replacing the coverage
8410   lost by extending and adding tests which work with other backends as well.
8412 * If a test throws a subclass of std::exception, the test harness now
8413   reports the class name and the extra information returned by std::exception's
8414   what() method.
8416 matcher:
8418 * Several performance improvements have been made, mainly to the handling
8419   of OP_AND and related operations (OP_FILTER, OP_NEAR, and OP_PHRASE).
8420   In combination, these are likely to speed up searching significantly
8421   for most users - in tests on real world data we've seen savings of 15-55%
8422   in search times).  These improvements are:
8424   + OP_AND of 3 or more sub-queries is now processed more efficiently.
8426   + Sub-queries from adjacent OP_AND, OP_FILTER, OP_NEAR, and OP_PHRASE are now
8427     combined into a single multi-way OP_AND operation, and the filters which
8428     implement the near/phrase restrictions are hoisted above this so they need
8429     to check fewer documents (bug#23).
8431   + If an OP_OR or OP_AND_MAYBE decays to OP_AND, we now ensure that the less
8432     frequent sub-query is on the left, which OP_AND is optimised to expect.
8434 * When the Enquire::get_mset() parameter checkatleast is set, and we're sorting
8435   by relevance with forward ordering by docid, and the query is pure boolean,
8436   the matcher was deciding it was done before the checkatleast requirement was
8437   satisfied.  Then the adjustments made to the estimated and max statistics
8438   based on checkatleast meant the results claimed there were exactly msize
8439   results.  This bug has now been fixed.
8441 * Queries involving an OP_VALUE_RANGE filter now run around 3.5 times faster
8442   (bug#164).
8444 * The calculations behind MSet::get_matches_estimated() were always rounding
8445   down fractions, but now round to the nearest integer.  Due to cumulative
8446   rounding, this could mean that the estimate is now a few documents higher in
8447   some cases (and hopefully a better estimate).
8449 * Implement explicit swap() methods for internal classes MSetItem and ESetItem
8450   which should make the final sort of the MSet and ESet a little more
8451   efficient.
8453 flint backend:
8455 * Fixed a bug introduced in 1.0.3 - trying to open a flint database for reading
8456   no longer fails if it isn't writable.
8458 * We no longer use member function pointers in the Btree implementation which
8459   seems to speed up searching a little.
8461 remote backend:
8463 * The remote protocol minor version has been increased (to accommodate
8464   OP_SCALE_WEIGHT).  If you are upgrading a live system which uses the
8465   remote backend, upgrade the servers before the clients.
8467 build system:
8469 * Added macro machinery to allow branch prediction hints to be specified and
8470   used by compilers which support this (current GCC and Intel C++).
8472 * In a developer build, look for rst2html.py if rst2html isn't found as some
8473   Linux distros have it installed under with an extension.
8475 documentation:
8477 * In the API documentation, explicitly note that Database::get_metadata()
8478   returns an empty string when the backend doesn't support user-specified
8479   metadata, and that WritableDatabase::set_metadata() throws UnimplementedError
8480   in this case.  Also describe the current behaviour with multidatabases.
8482 * README: Remove the ancient history lesson - this material is better left to
8483   the history page on the website.
8485 * deprecation.html:
8487   + Deprecate the non-pythonic iterators in favour of the pythonic ones.
8489   + Move "Stem::stem_word(word)" in the bindings to the right section (it was
8490     done in 1.0.0, as already indicated).
8492   + Improve formatting.
8494 * When running rst2html, using "--verbose" was causing "info" messages to be
8495   included in the HTML output, so drop this option and really fix this issue
8496   (which was thought to have been fixed by changes in 1.0.3).
8498 * install.html: Reworked - this document now concentrates on giving
8499   a brief overview of building which should be suitable for most common cases,
8500   and defers to the INSTALL document in each tarball for more details.
8502 * PLATFORMS: Update from tinderbox and buildbot.
8504 * remote.html: xapian-tcpsrv has been able to handle concurrent read
8505   access since 0.3.1 (7 years ago) so update the very out-of-date information
8506   here.  Also, note that some newer features aren't supported by the remote
8507   backend yet.
8509 * HACKING: Note specifically that std::list::size() is O(n) for GCC.
8511 * intro_ir.html: Add link to the forthcoming book "Introduction to
8512   Information Retrieval", which can be read online.
8514 * scalability.html: Update size of gmane.
8516 * quartzdesign.html: Note that Quartz is now deprecated.
8518 debug code:
8520 * The debug assertion code has been rewritten from scratch to be cleaner and
8521   pull in fewer other headers.
8523 Xapian-core 1.0.3 (2007-09-28):
8525 API:
8527 * Add support for user specified metadata (bug#143).  Currently supported by
8528   the flint and inmemory backends.
8530 * Deprecate Enquire::register_match_decider() which has always been a no-op.
8532 * Improve the lower bound on the number of matching documents for an AND query
8533   - if the sum of the lower bounds for the two sides is greater than the
8534   number of documents in the database, then some of them must have both terms.
8536 * Spelling correction: Fix off-by-one error in loop bounds when initialising
8537   (bug#194).
8539 * If the check_at_least parameter to Enquire::get_mset() is used, but there
8540   aren't that many results, then MSet::get_matches_lower_bound() and
8541   MSet::get_matches_upper_bound() weren't always reported as equal - this
8542   bug is now fixed.
8544 * When sorting by value, and using the check_at_least parameter to
8545   Enquire::get_mset(), some potential matches weren't being counted.
8547 * Failing to create a flint or quartz database because we couldn't create the
8548   directory for it now throws DatabaseCreateError not DatabaseOpeningError.
8550 testsuite:
8552 * Fix display of valgrind output when a test fails because valgrind detected
8553   a problem.
8555 * Add another version of valgrind suppression for the zlib end condition check
8556   as this gives a different backtrace for zlib in Ubuntu gutsy.
8558 flint backend:
8560 * The Flint database format has been extended to support user metadata, and
8561   each termlist entry is now a byte shorter (before compression).  As a
8562   result, Xapian 1.0.2 and earlier won't be able to read Xapian 1.0.3
8563   databases.  However, Xapian 1.0.3 can read older databases.  If you open an
8564   older flint database for writing with Xapian 1.0.3, it will be upgraded
8565   such that it cannot then be read by Xapian 1.0.2 and earlier.
8567 * Zlib compression wasn't being used for the spelling or synonym tables (due
8568   to a typo - Z_DEFAULT_COMPRESSION where it should be Z_DEFAULT_STRATEGY).
8570 * xapian-check: Allow "db/record." and "db/record.DB" as arguments.
8572 * Fix "key too long" exception message by substituting FLINT_BTREE_MAX_KEY_LEN
8573   with its numeric value.
8575 * Assorted minor efficiency improvements.
8577 * If we reach the flush threshold during a transaction, we now write out the
8578   postlist changes, but don't actually commit them.
8580 * Check length of new terms is at most 245 bytes for flint in add_document()
8581   and replace_document() so that the API user gets an error there rather
8582   than when flush() is called (explicitly or implicitly).  Fixes bug#44.
8584 * Flint used to read the value of the environmental variable
8585   XAPIAN_FLUSH_THRESHOLD when the first WritableDatabase was opened and would
8586   then cache this value.  However the program using Xapian may have changed
8587   it, so we now reread it each time a WritableDatabase is opened.
8589 * Implement TermIterator::positionlist_count() for the flint backend.
8591 remote backend:
8593 * Fix the result of MSet::get_matches_lower_bound() when using the
8594   check_at_least parameter to get_mset().
8596 inmemory backend:
8598 * Implement TermIterator::positionlist_count() for the inmemory backend.
8600 build system:
8602 * xapian-config: We always need to include dependency_libs in the output of
8603   `xapian-config --libs` if shared libraries are disabled.
8605 * Distribution tarballs are now in the POSIX "ustar" format.  This supports
8606   pathnames longer than 99 characters (which we now have a few instances of
8607   in the doxygen generated documentation) and also results in a distribution
8608   tarball that is about half the size!  This format should be readable by any
8609   tar program in current use - if your tar program doesn't support it, we'd
8610   like to know (but note that the GNU tar tarball is smaller than the size
8611   reduction in the xapian-core tarball...)
8613 * configure no longer generates msvc/version.h - this is now entirely handled
8614   by the MSVC-specific makefiles.
8616 documentation:
8618 * Add a glossary.
8620 * docs/stemming.html: Reorder the initial paragraphs so we actually answer the
8621   question "What is a stemming algorithm?" up front.
8623 * When running rst2html, use "--exit-status=warning" rather than "--strict".
8624   The former actually gives a non-zero exit status for a warning or worse,
8625   while the former doesn't, but does include any "info" messages in the output
8626   HTML.
8628 * docs/deprecation.rst: Add "Database::positionlist_begin() throwing
8629   RangeError and DocNotFoundError".
8631 * valueranges.rst: Correct out-of-date reference to float_to_string.
8633 * HACKING: Document a few more "coding standards".
8635 * PLATFORMS: Updated.
8637 * docs/overview.html: Restore HTML header accidentally deleted in November
8638   2006.
8640 * Fix several typos.
8642 portability:
8644 * Add missing instances of "#include <string.h>" to fix compilation with recent
8645   GCC 4.3 snapshots.
8647 * Fix some warnings for various compilers and platforms.
8649 Xapian-core 1.0.2 (2007-07-05):
8651 API:
8653 * Xapian now offers spelling correction, based on a dynamically maintained
8654   list of spelling "target" words.  This is currently supported by the
8655   flint backend, and works when searching multiple databases.
8657 * Xapian now offers search-time synonym expansion, based on an externally
8658   provided synonym dictionary.  This is currently supported by the flint
8659   backend, and works when searching multiple databases.
8661 * TermGenerator: now offers support for generating spelling correction
8662   data.
8664 * QueryParser:
8666   + New flag FLAG_SPELLING_CORRECTION to enable spelling correction, and a new
8667     method, "get_corrected_query_string()" to get the spelling corrected
8668     query string.
8670   + New flags have been added to allow the new synonym expansion feature to be
8671     enabled and controlled.  Synonym expansion can either be automatic, or only
8672     for terms explicitly indicated in the query string by the new "~" operator.
8674   + The precedence of the boolean operators has been adjusted to match their
8675     usual precedence in mathematics and programming languages.  "NOT" now binds
8676     as tightly as "AND" (previously "AND NOT" would bind like "AND", but just
8677     "NOT" would bind like "OR"!)  Also "XOR" now binds more tightly than "OR",
8678     but less tightly than "AND" (previously it bound just like "OR").
8680   + '+' and '-' have been fixed to work on bracketed subexpressions as
8681     documented.
8683   + If the stemmer is "none", no longer put a Z prefix on terms; this now
8684     matches the output of TermGenerator.
8686 * Add new Xapian::sortable_serialise() and Xapian::sortable_unserialise()
8687   functions which serialise and unserialise numbers (currently only
8688   doubles) to a string representation which sorts in numeric order.  Small
8689   integers have a short representation.
8691 * NumberValueRangeProcessor has been changed to work usefully.  Previously
8692   the numbers had to be the same length; now numbers are serialised to
8693   strings such that a string sort on the string orders the numbers correctly.
8694   Negative and floating point numbers are also supported now.  The old
8695   NumberValueRangeProcessor is still present in the library to preserve
8696   ABI compatibility, but code linking against 1.0.2 or later will pick
8697   up the new implementation, which really lives in a sub-namespace.
8699 * Documents now have a get_docid() method, to get the document ID from the
8700   database they came from.
8702 * Add support for a new type of match decider, called a "matchspy".  Unlike
8703   the old deciders, this will reliably be tested on every candidate
8704   document, so can be used to tally statistics on them.
8706 * Fixed a segfault when getting a description for a MatchNothing query
8707   joined with AND_NOT (bug #176).
8709 * Header files have been tidied up to remove some unnecessary includes.
8710   Applications using "#include <xapian.h>" will not be affected.  We don't
8711   intend to support direct inclusion of individual header files from the xapian
8712   directory, but if you do that, you may have to update you code.
8714 testsuite:
8716 * Feature tests added for all new features.
8718 * Improved test coverage in queryparsertest.  Some tests in queryparsertest
8719   now use flint databases, so the test now ensures that the .flint
8720   subdirectory exists.
8722 * The test harness no longer creates <dbdir>/log for flint (flint doesn't
8723   create a log like quartz does).
8725 * apitest: "-bremote" must now be "-bremoteprog" (to better match
8726   "-bremotetcp"); "-bvoid" must now be "-bnone" (to better describe not
8727   using a database backend).
8729 * To complement "make check-flint", "make check-quartz", and "make
8730   check-remote", you can now run tests for the remotetcp backend with
8731   "make check-remotetcp", for the remoteprog backend with "make
8732   check-remoteprog", for the inmemory backend with "make check-inmemory", and
8733   tests not requiring a backend with "make check-none".
8735 * Several extra tests of the check_at_least parameter supplied to
8736   get_mset() were added.
8738 * Fix memory leak and fd leak in remotetcp handling, so apitest now passes
8739   under valgrind.
8741 * quartztest: no longer test QuartzPostList::get_collection_freq(), which
8742   has been removed.
8744 * Add regression test emptyquery2 for bug #176.
8746 * Add regression test matchall1 for bug with MatchAll queries.
8748 * Enhanced test coverage of match functor, to check that it returns all
8749   matching documents.
8751 matcher:
8753 * Fix bug when check_at_least was supplied - the matches after the
8754   requested MSet size were being returned to the user.  The parameter is
8755   also now handled in a more efficient way - no extra memory is required
8756   (previously, extra memory proportional to the value of check_at_least was
8757   required).
8759 * Fix bug which used incorrect statistics, and caused assertion failures,
8760   when performing a search using a MatchAll query.
8762 * Optimisation for single term queries: we don't need to look at the top
8763   document's termlist to determine that it matches all the query terms.
8765 flint backend:
8767 * The value and position tables are now only created if there is anything to
8768   add to them.  So if you never use document values, there's no value.DB,
8769   value.baseA, or value.baseB.  This means the table doesn't need to be opened
8770   for searching (saving a file handle and a number of syscalls) and when
8771   flushing changes, we don't need to update baseA/baseB just to keep the
8772   revisions in step.  The flint database version has been increased, but the
8773   new code will happily open and read/update flint databases from Xapian 1.0.0
8774   and 1.0.1.  Xapian 1.0.2 flint databases can't be read by Xapian 1.0.1 or
8775   earlier though.
8777 * Two new optional tables are now supported: "spelling", which is used to
8778   store information for spelling correction, and "synonym", which is used
8779   to store synonym information.
8781 * xapian-compact: Now compacts and merges spelling and synonym tables.
8782   Also has a new option "--no-renumber" to preserve document ids from
8783   source databases.
8785 * xapian-check: Now checks the spelling and synonym tables (only the Btree
8786   structure is currently checked, not the information inside).
8788 * Database::term_exists(), Database::get_termfreq(), and
8789   Database::get_collection_freq() are now slightly more efficient for flint
8790   databases.
8792 * New utility 'xapian-inspect' which allowing interactive inspection of key/tag
8793   pairs in a flint Btree.  Useful for development and debugging, and an
8794   approximate equivalent to quartzdump.
8796 * WritableDatabase::delete_document() no longer cancels pending changes if the
8797   document doesn't exist.
8799 * Fix handling of exceptions during commit - previously, this could result
8800   in tables getting out-of-sync, perhaps even resulting in a corrupt database.
8802 * Optimise iteration of all documents in the case where all the document
8803   IDs up to lastdocid are used; in this case, we no longer need to access disk
8804   to get the document IDs.
8806 quartz backend:
8808 * WritableDatabase::delete_document() no longer cancels pending changes if the
8809   document doesn't exist.
8811 * We no longer create a postlist just to find the termfreq or collection
8812   frequency.
8814 remote backend:
8816 * Calling WritableDatabase::delete_document() on a non-existent document now
8817   correctly propagates DocNotFoundError.
8819 * The minor remote protocol version has increased (to fix the previous issue).
8820   You should be able to cleanly upgrade a live system by upgrading servers
8821   first and then clients.
8823 * progclient: Reopen stderr on the child process to /dev/null rather than
8824   closing it.  This fixes apitest with the remoteprog backend to pass when run
8825   under valgrind (it failed in this case in 1.0.0 and 1.0.1).  It probably
8826   has no effect otherwise.
8828 * check_at_least is now passed to the remote server to reduce the work
8829   needed to produce the match, and the serialised size of the returned MSet.
8831 inmemory backend:
8833 * Bug fix: using replace_document() to add a document with a specific
8834   document id above the highest currently used would create empty documents
8835   for all document ids in between.
8837 build system:
8839 * Work around an apparent bug in automake which causes the entries in .libs
8840   subdirectories generated for targets of bin_PROGRAMS not to be removed on
8841   make clean.  This was causing make distcheck to fail.
8843 * Snapshots and releases are now bootstrapped with automake 1.10, and
8844   libtool 1.5.24.
8846 * HTML documentation generated from RST files is now installed.
8848 documentation:
8850 * The API documentation is now generated with Doxygen 1.5.2, which fixes the
8851   missing docs for Xapian::Query.
8853 * Ship and install internals.html.
8855 * Generating the doxygen-collated documentation of the library internals (with
8856   "make doxygen_source_docs") now only tries to generate an HTML version.  The
8857   PDF version kept exceeding TeX limits, and HTML is a more useful format for
8858   this anyway.
8860 * API docs for Xapian::QueryParser now make it clear that the default value for
8861   the stemming strategy is STEM_NONE.
8863 * API docs now describe the NumberValueRangeProcessor more clearly.
8865 * Several typo fixes and assorted wording improvements.
8867 * queryparser.html: Mention "AND NOT" as an alternative way to write "NOT",
8868   and document synonym expansion.
8870 * admin_notes.html: Updated for changes in this release, and corrected a
8871   few minor errors.
8873 * spelling.rst: New file, documenting the spelling correction feature.
8875 * synonyms.rst: New file, documenting the synonyms expansion feature.
8877 * valueranges.rst: The NumberValueRangeProcessor is now documented.
8879 * HACKING: Mention new libtool, and more details about preferring
8880   pre-increment.  Also add a note about 2 space indentation of protection
8881   level declarations in classes.
8883 * INSTALL: note that zlib must be installed before you can build.
8885 examples:
8887 * copydatabase: Now copies synonym and spelling data.  Also, fix a cosmetic
8888   bug with progress output when a specified database directory has a trailing
8889   slash.
8891 portability:
8893 * Fix to build on with OpenBSD's zlib (xapian-core 1.0.0 and 1.0.1 didn't).
8895 * Fixed to build with older zlib such as zlib 1.1.5 which Solaris apparently
8896   uses (xapian-core 1.0.0 and 1.0.1 didn't).  However, we recommend using zlib
8897   1.2.x as decompressing is apparently about 20% faster.
8899 * msvc/version.h.in: Generated version.h for MSVC build no longer has the
8900   remote backend marked as disabled.
8902 * Fix warnings from Intel's C++ compiler.
8904 * Fixes for compilation with gcc-2.95 and GCC 4.3 snapshots.
8906 packaging:
8908 * RPMs:
8910   + Rename xapian.spec to xapian-core.spec to match tarball name.
8912   + Append the user name to BuildRoot.
8914 debug code:
8916 * Better debug logging from the queryparser internals.
8918 Xapian-core 1.0.1 (2007-06-11):
8920 API:
8922 * Xapian::Error:
8924   + Make Error::error_string member std::string rather than char * to avoid
8925     problems with double free() with copied Error objects.  Unfortunately
8926     this mean an incompatible ABI change which we had hoped to avoid until
8927     1.1.0, but in this case there didn't seem to be a sane way to fix the
8928     problem without an ABI change.
8930   + Error::get_description() now converts my_errno to error_string if it hasn't
8931     been already rather than not including any error description in this case.
8933   + Add new method "get_description()" to get a string describing the error
8934     object.  This is used in various examples and scripts, improving their
8935     error reporting.
8937 * Xapian::Database: Add new form of allterms_begin() and allterms_end()
8938   which allow iterating of all terms with a particular prefix.  This
8939   is easier to use than checking the end condition yourself, and is
8940   more efficiently implemented for the remote backend (fixes bug#153).
8942 * Xapian::Enquire: Passing an uninitialised Database object to Enquire will
8943   now cause InvalidArgumentError to be thrown, rather than causing a segfault
8944   when you call Enquire::get_mset().  If you really want an empty database,
8945   you can use Xapian::InMemory::open() to create one.
8947 * Xapian::QueryParser: Multiple boolean prefixed terms with the same term
8948   prefix are now combined with OR before such groups are combined with AND
8949   (bug#157).  Multiple value ranges on the same value are handled similarly.
8951 * Xapian::Query OP_VALUE_RANGE: Avoid calling db->get_lastdocid() repeatedly
8952   as we know the answer won't change - this reduces the run time of a
8953   particular test case by 25%.
8955 testsuite:
8957 * Add test for serialisation of error strings.
8959 * Improved output in various situations:
8961   + Quote strings in TEST_STRINGS_EQUAL().
8963   + queryparsertest: Use TEST_STRINGS_EQUAL when comparing query descriptions
8964     against their expected output, since this makes it much easier to see the
8965     differences.
8967   + Report whole message for exceptions, rather than a truncated version, in
8968     verbose mode.
8970   + Make use of Xapian::Error::get_description(), giving better error
8971     reports.
8973 * queryparsertest: New test of custom ValueRangeProcessor subclass
8974   (qp_value_customrange1).
8976 * apitest: flintdatabaseformaterror1 and flintdatabaseformaterror2 now use a
8977   genuine Xapian 0.9.9 flint database for their tests, and more cases are
8978   tested.  The two tests have also been split into 3 now.
8980 * Fix test harness not to invoke undefined behaviour in cases where a paragraph
8981   of test data contains two or fewer characters.
8983 * Implement a better fix for the MSVC ifstream issue which was fixed in 1.0.0.
8984   This fixes an unintentional side-effect of the previous fix which meant that
8985   apitest's consistency1 wasn't working as intended (it now has a regression
8986   test to make sure it is testing what we intend).
8988 flint backend:
8990 * xapian-compact: Don't uncompress and recompress tags when compacting a
8991   database.  This speeds up xapian-compact rather a lot (by more than 50% in a
8992   quick test).
8994 * If the docid counter wraps, Flint now throws DatabaseError (fixes bug#152).
8996 * Remove the special case error message for pre-0.6 databases since they'll
8997   be quartz format (the check is only in flint because this code was taken from
8998   quartz).
9000 quartz backend:
9002 * If the docid counter wraps, Quartz now throws DatabaseError (fixes bug#152).
9004 remote backend:
9006 * The remote protocol now has a minor version number.  If the major
9007   version number is the same, a client can work with any server with
9008   the same or higher minor version number, which makes upgrading live
9009   systems easier for most remote protocol changes - just upgrade the servers
9010   first.
9012 * When a read-only remote database is closed, the client no longer sends a
9013   (totally bogus) MSG_FLUSH to the server, and the reply is also eliminated.
9014   This reduces the time taken to close a remote database a little (fixes
9015   bug#149).
9017 inmemory backend:
9019 * skip_to() on an allterms TermIterator from an InMemory Database can no longer
9020   move backwards.
9022 * An allterms TermIterator now initialises lazily, which can save some work if
9023   the first operation is a skip_to() (as it often will be).
9025 build system:
9027 * Fix VPATH compilation in maintainer mode with gcc-2.95.
9029 * Fix multiple target rule for generating the queryparser source files in
9030   parallel builds.
9032 * Distribute missing stub Makefiles for "bin", "examples", and
9033   "include/xapian".
9035 documentation:
9037 * Document the design flaw with NumberValueRangeProcessor and why it shouldn't
9038   be used.
9040 * ValueRangeProcessor and subclasses now have API documentation and an overview
9041   document.
9043 * Expand documentation of value range Query constructor.
9045 * Improved API documentation for the TermGenerator class.
9047 * docs/deprecation.rst:
9049   + Fix copy and paste error - set_sort_forward() should be changed to
9050     set_docid_order().
9052   + Improve entry for QueryParserError.
9054 * PLATFORMS: Updated from tinderbox.
9056 examples:
9058 * copydatabase: Rewritten to use the ability to iterate over all the documents
9059   in a database.  Should be much more efficient for databases with sparsely
9060   distributed document IDs.
9062 * simpleindex: Rewritten to use the TermGenerator class, which eliminates a
9063   lot of non-Xapian related code and is more typical of what a user is likely
9064   to want to do.
9066 * simplesearch,simpleexpand: Rewritten to use the QueryParser class, which
9067   is more typical of what a user is likely to want to do.
9069 portability:
9071 * xapian-config: Add special case check for host_os matching linux* or
9072   k*bsd-gnu since vanilla libtool doesn't correctly probe link_all_deplibs=no
9073   for them.
9075 packaging:
9077 * RPMs: Add "# norootforbuild" comment which SuSE's build scripts look for.
9078   Rename "Source0:" to "Source:" as there's only one tarball now.  Add gcc-c++
9079   and zlib-devel to "Build-Requires:".
9081 * The required automake version has been lowered to 1.8.3, so RPMs can now be
9082   built on RHEL 4 and SLES 9.
9084 Xapian-core 1.0.0 (2007-05-17):
9086 API:
9088 * Xapian::Database:
9090   + The Database(const std::string &) constructor has been marked as "explicit".
9091     Hopefully this won't affect real code, but it's possible.  Instead of
9092     passing a std::string where a Xapian::Database is expected, you'll now
9093     have to explicitly write `Xapian::Database(path)' instead of `path'.
9095   + Fixed problem when calling skip_to() on an allterms iterator over multiple
9096     databases which could cause a debug assertion in debug builds, and possible
9097     misbehaviour in normal builds.
9099 * Xapian::Error:
9101   + The constructors of Error subclasses which take a `const std::string &'
9102     parameter are now explicit.  This is very unlikely to affect any real code
9103     but if it does, just write `Xapian::Error(msg)' instead of `msg'.
9105   + Xapian::Error::get_type() now returns const char* rather than std::string.
9106     Generally existing code will just work (only one change was required in
9107     Xapian itself) - the simplest change is to write `std::string(e.get_type())'
9108     instead of `e.get_type()'.
9110   + Previously, the errno value was lost when an error was propagated from
9111     a remote server to the client, because errno values aren't portable
9112     between platforms.  To fix this, Error::get_errno() is now deprecated and
9113     you should use Error::get_error_string() instead, which returns a string
9114     expanded from the errno value (or other system error code).
9116 * Xapian::QueryParser:
9118   + Now assumes input text is encoded as UTF-8.
9120   + We've made several changes to term generation strategy.  Most notably:
9121     Unicode support has been added; '_' now counts as a word character; numbers
9122     and version numbers are now parsed as a single term; single apostrophes are
9123     now included in a term; we now store unstemmed forms of all terms; and we
9124     no longer try to "normalise" accents.
9126   + parse_query() now throws the new Xapian::Error subclass QueryParserError
9127     instead of throwing const char * (bug#101).
9129   + Pure NOT queries are now supported (for example, `NOT apples' will match
9130     all documents not indexed by the stemmed form of `apples').  You need
9131     to enable this feature by passing QueryParser::FLAG_PURE_NOT in flags
9132     to QueryParser::parse_query().
9134   + We now clear the stoplist when we parse a new query.
9136   + Queries such as `+foo* bar', where no terms in the database match the
9137     wildcard `foo*', now match no documents, even if `bar' exists.  Handling
9138     of `-foo*' has also been fixed.
9140   + Now supports wildcarding the last term of a query to provide better support
9141     for incremental searching.  Enabled by QueryParser::FLAG_PARTIAL.
9143   + The default prefix can now be specified to parse_query() to allow parsing
9144     of text entry boxes for particular fields.
9146   + QueryParser::set_stemming_options() has been deprecated since 0.9.0 and
9147     has now been removed.
9149 * Xapian::Stem:
9151   + Now assumes input text is encoded as UTF-8.
9153   + We've updated to the latest version of the Snowball stemmers.  This means
9154     that a small number of words produce different (and generally better)
9155     stems and that some new stemmers are supported: german2 (like german but
9156     normalises umlauts), hungarian, kraaij_pohlmann (a different Dutch
9157     stemmer), romanian, and turkish.
9159 * Xapian::TermGenerator:
9161   + New class which generates terms from a piece of text.
9163 * Xapian::Enquire:
9165   + The Enquire(const Database &) constructor has been marked as "explicit".
9166     This probably won't affect real code - certainly no Xapian API methods
9167     or functions take an Enquire object as a parameter - but calls to user
9168     methods or functions taking an Enquire object could be affected.  In
9169     such cases, you'll now have to explicitly write `Xapian::Enquire(db)'
9170     instead of `db'.
9172   + Enquire::get_eset() now produces better results when used with multiple
9173     databases - without USE_EXACT_TERMFREQ they should be much more similar to
9174     results from an equivalent single database; with USE_EXACT_TERMFREQ they
9175     should be identical.
9177   + Track the minimum weight required to be considered for the MSet separately
9178     from the minimum item which could be considered.  Trying to combine the two
9179     caused several subtle bugs (bug#86).
9181   + Enquire::get_query() is now `const'.  Should have no effect on user code.
9183   + Enquire::get_mset() now handles the common case of an "exact" phrase search
9184     (where the window size is equal to the number of terms) specially.
9186   + Enquire::include_query_terms and Enquire::use_exact_termfreq are now
9187     deprecated in favour of capitalised versions Enquire::INCLUDE_QUERY_TERMS
9188     and Enquire::USE_EXACT_TERMFREQ (for consistency with our other manifest
9189     constants, and general C/C++ conventions).
9191 * Xapian::RSet:
9193   + RSet::contains(MSetIterator) is now `const'.  Should have no effect on user
9194     code.
9196 * Xapian::SimpleStopper::add() now takes `const std::string &' not `const
9197   std::string'.  Should have no effect on user code.
9199 * Xapian::Query:
9201   + We now only perform internal validation on a Query object when it's either
9202     constructed or changed, to avoid O(n^2) behaviour in some cases.
9204   + Xapian::Query::MatchAll (an alias for Query("")) matches all terms in the
9205     document (useful for "pure NOT" queries) and Xapian::Query:MatchNothing
9206     is now a more memorable alias for Query().
9208 * Instead of explicitly checking that a term exists before opening its
9209   postlist, we now do both in one operation, which is more efficient.
9211 * MatchDecider::operator() now returns `bool' not `int'.
9213 * ExpandDecider::operator() now returns `bool' not `int'.
9215 * Xapian::TermIterator::get_termfreq() now throws InvalidOperationError
9216   if called on a TermIterator from a freshly created Document (since
9217   there's no meaningful term frequency as there's no Database for
9218   context).
9220 * <xapian/output.h> is no longer available as an externally visible header.
9221   It's not been included by <xapian.h> since 0.7.0.  Instead of using
9222   `cout << obj;' use `cout << obj.get_description();'.
9224 * New constant Xapian::BAD_VALUENO which is -1 cast to Xapian::valueno.
9226 * New Xapian::ValueRangeProcessor hierarchy: DateValueRangeProcessor,
9227   NumberValueRangeProcessor, and StringValueRangeProcessor.  In
9228   conjunction with the new QueryParser::add_valuerangeprocessor()
9229   method and the new Query::OP_VALUE_RANGE op these allow you to
9230   implement ranges in the query parser, such as `$50..100',
9231   `10..20kg', `01/02/2007..03/04/2007'.
9233 testsuite:
9235 * Many new and improved testcases in various areas.
9237 * If a test throws an unknown exception, say so in the test failure message.
9238   If it throws std::string, report the first 40 characters (or first line if
9239   less than 40 characters) of the string even in non-verbose mode.
9241 * Use of valgrind improved:
9243   + The test harness now only hooks into valgrind if environment variable
9244     XAPIAN_TESTSUITE_VALGRIND is set, which makes it easy to run test programs
9245     under valgrind in the normal way.  The runtest script sets this
9246     automatically.
9248   + runtest now passes "--leak-resolution=high" to valgrind to prevent
9249     unrelated leak reports related to STL classes from being combined.
9251   + configure tests for valgrind improved and streamlined.
9253   + New runsrv script to run xapian-tcpsrv and xapian-progsrv.  We need to
9254     run these under valgrind to avoid issues with excess numerical precision
9255     in valgrind's FP handling, but we can use "--tool=none" which is a lot
9256     faster than running them under valgrind's default memcheck tool.
9258 * The test harness now starts xapian-tcpsrv in a more reliable way - it will
9259   try sequentially higher port numbers, rather than failing because a
9260   xapian-tcpsrv (or something else) is already using the default port.
9261   It also no longer leaks file descriptors (which was causing later tests
9262   to fail on some platforms), and if xapian-tcpsrv fails to start, the error
9263   message is now reported.
9265 * remotetest has been removed and its testcases have either been added to
9266   apitest or just removed if redundant with tests already in apitest.
9268 * termgentest is a new test program which tests the Xapian::TermGenerator
9269   class.
9271 * TEST_EQUAL_DOUBLE() now uses a slightly less stringent threshold -
9272   DBL_EPSILON is too strict for calculations which include multiple
9273   steps.  Also, we now use it instead of doubles_are_equal_enough() and
9274   weights_are_equal_enough() which try to perform the same job.
9276 * New macro TEST_STRINGS_EQUAL() which displays the strings on separate lines
9277   so the differences can be clearly seen.
9279 * Test programs are now linked with '-no-install' which means that libtool
9280   doesn't need to generate shell script wrappers for them on most platforms.
9282 * runtest: Now turns on MALLOC_CHECK_ and MALLOC_PERTURB_ for glibc if
9283   valgrind isn't being used.
9285 * Better support for Microsoft Windows:
9287   + test_emptyterm2 no longer tries to delete a database from disk while a
9288     WritableDatabase object still exists for it, since this isn't supported
9289     under Microsoft Windows.
9291   + Fallback handling when srcdir isn't specified how takes into account .exe
9292     extensions and different path separators.
9294 flint backend:
9296 * Flint is now the default backend.
9298 * xapian-check: New program which performs consistency checks on a flint
9299   database or table.
9301 * xapian-compact: Now prunes unused docids off the start of each source
9302   database's range of docids.
9304 * Positional information is now encoded using a highly optimised fls()
9305   implementation, which is much faster than the FP code 0.9.x used.
9306   Unfortunately the old encoding could occasionally add extra bits
9307   on some architectures, which was harmless except the databases
9308   wouldn't be portable.  Because of this, the flint format has had to
9309   be changed incompatibly.
9311 * The lock file is now called "flintlock" rather than "flicklock" (which
9312   was a typo!)
9314 * Flint now releases its lock correctly if there's an error in
9315   WritableDatabase's constructor.  Previously the lock would remain until
9316   the process exited.
9318 * Flint now throws new Xapian::Error subclass DatabaseVersionError instead of
9319   DatabaseOpeningError when it fails to open a database because it has an
9320   unsupported version.  DatabaseVersionError is a subclass of
9321   DatabaseOpeningError so existing code should continue to work, but it's
9322   now much easier to determine if the problem is that a database needs
9323   rebuilding.
9325 * If you try to open a flint database with an older or newer version than
9326   flint understands, the exception message now gives the version understood,
9327   rather than "I only understand FLINT_VERSION" (literally).
9329 * If we fail to obtain the lock, report why in the exception message.
9331 * Flint now compresses tags in the record and termlist tables using zlib.
9333 * More robust code to handle the flint locking child process, in case of
9334   unexpected errors.
9336 * If a document was replaced more than once between flushes, the document
9337   length wouldn't be updated after the first change.
9339 quartz backend:
9341 * Quartz is still supported, but use in new projects is deprecated (use Flint
9342   instead).  Quartz will be removed eventually.
9344 * quartzcheck: Test if this is a quartz database by looking at "meta" not
9345   "record_DB".  If "record_DB" is >= 2GB and we don't have a LFS aware stat
9346   function then stat can fail even though the file is there.  Also open the
9347   database explicitly as a Quartz database for extra robustness.
9349 * If a document was replaced more than once between flushes, the document
9350   length wouldn't be updated after the first change.
9352 remote backend:
9354 * The remote backend is now supported under Microsoft Windows.
9356 * Open a fresh copy of the database(s) on each connection to a xapian-tcpsrv
9357   rather than relying on being able to share a database across fork() or
9358   between threads (which we don't promise will work).
9360 * xapian-tcpsrv: New "--interface" option allows the hostname or address of the
9361   interface to listen on to be specified (the default is the previous behaviour
9362   of listening on all interfaces).
9364 * If name lookup fails, report the h_errno code from gethostbyname() rather
9365   than whatever value errno happens to currently have!
9367 * Fix bugs in query unserialisation.
9369 * The remote backend now supports all operations (get_lastdocid(), and
9370   postlist_begin() have now been implemented).
9372 * Currently a read-only server can be opened as a WritableDatabase (which is
9373   a minor bug we plan to fix).  In this case, operations which write will fail
9374   and the exception is now InvalidOperationError not NetworkError.
9376 * If a remote server catches NetworkTimeoutError then it will now only
9377   propagate it if we can send it right away (since the connection is
9378   probably unhappy).  After that (and for any other NetworkError) we now
9379   just rethrow it locally to close the connection and let it be logged if
9380   required.
9382 * The timeout parameter to RemoteDatabase wasn't being used, instead the
9383   client would wait indefinitely for the server to respond.
9385 * A timeout of zero to the remote backend now means "never timeout".  This
9386   is now the default idle timeout for WritableDatabase (the connection
9387   timeout default is now 10 seconds, rather than defaulting to the idle
9388   timeout).
9390 * Fix handling of the document length in remote termlists.
9392 * The remote backend now checks when decoding serialised string that the
9393   length isn't more than the amount of data available (bug#117).
9395 * The remote backend now handles the unique term variants of delete_document
9396   and replace_document on the server side.
9398 * The RSet serialisation now encodes deltas between docids (rather than the
9399   docids themselves) which greatly reduces the size of the encoding of a
9400   sparse RSet for a large database.
9402 * We now encode deltas between term positions when sending data after calling
9403   positionlist_begin() on a remote database.
9405 * When using a MatchDecider with remote database(s), don't rerun the
9406   MatchDecider on documents which a remote server has already checked.
9408 * Apply the "decreasing weights with remote database" optimisation which we use
9409   in the sort_by_relevance case in the sort_by_relevance_then_value case too.
9411 * We now throw NetworkError rather than InternalError for invalid data received
9412   over the remote protocol.
9414 * We now close stderr of the spawned backend program when using the "prog" form
9415   of the remote backend.  Previously stderr output would go to the client
9416   application's stderr.
9418 muscat36 backend:
9420 * Support for the old Muscat 3.6 backends has been completely removed.  It's
9421   still possible to convert Muscat 3.6 databases to Xapian databases by
9422   building 0.9.10 and using copydatabase to create a quartz database, which can
9423   then be read by 1.0.0 (and converted to a flint database using copydatabase
9424   again).
9426 build system:
9428 * We've added GCC visibility annotations to the library, which when using GCC
9429   version 4.0 or later reduce the size and load time of the library and
9430   increase the runtime speed a little.  Under x86_64, the stripped library is
9431   6.4% smaller (1.5% smaller with debug information).
9433 * configure: If using GCC, use -Bsymbolic-functions if it is supported
9434   (it requires a very recent version of ld currently).  This option reduces the
9435   size and load time of the shared library by resolving references within the
9436   library when it's created.
9438 * We automatically define _FORTIFY_SOURCE in config.h if GCC is in use
9439   and it's not already set (you can override this as documented in INSTALL).
9440   This adds some checking (mostly at compile time) that important return
9441   values aren't ignored and that array bounds aren't exceeded.
9443 * `./configure --enable-quiet' already allows you to specify at configure time
9444   to pass `--quiet' to libtool.  Now you can override this at make-time by
9445   using `make QUIET=' (to turn off `--quiet') or `make QUIET=y' (to turn on
9446   `--quiet').
9448 * In non-maintainer mode, we don't need the tools required to rebuild some of
9449   the documentation, so speed up configure by not even probing for them in
9450   this common case.
9452 * The makefiles now use non-recursive make in all directories except "docs" and
9453   "tests".  For users, this means that the build is faster and requires less
9454   disk space (bug#97).
9456 * configure: Add proper detection for SGI's C++ (check stderr output of
9457   "CC -v") and automatically pass -ptused in CXXFLAGS for xapian-core and any
9458   applications using xapian-config --cxxflags since it seems to be required to
9459   avoid template linking errors.
9461 * XO_LIB_XAPIAN now checks for the case where XAPIAN_CONFIG wasn't specified
9462   and xapian-config wasn't found, but the library appears to be installed -
9463   this almost certainly means that the user has installed xapian-core from
9464   a package, but hasn't installed the -dev or -devel package, so include
9465   that advice in the error message.
9467 * `./configure --with-stlport-compiler' now requires a compiler name as an
9468   argument.
9470 * configure: Disable probes for f77, gcj, and rc completely by preventing
9471   the probe code from even appearing in configure - this reduces the size of
9472   configure by 209KB (~25%) and should speed it up significantly.
9474 * configure: Suppress more unhelpful warnings and "remarks" for HP's aCC, and
9475   turn on "+wlint", which seems useful.
9477 * A number of cases of unnecessary header inclusions have been addressed,
9478   which should speed up compilation (fewer headers to parse when compiling
9479   many source files).  This also reduces dependencies within the source code,
9480   and thus the number of files which need to be rebuilt when a header is
9481   changed.
9483 * configure: Cache the results of some of our custom tests.
9485 documentation:
9487 * The documentation has all been updated for changes in Xapian 1.0.0.
9489 * Many of the documentation comments in the API headers (which are collated
9490   using doxygen to generated the API reference) have been improved, and some
9491   missing ones added.  Also, internal classes, members, and methods are now all
9492   marked as such so that none should appear in the generated documentation.  In
9493   particular, the class inheritance graphs should be a lot clearer.  A few other
9494   problems have also been addressed.
9496 * docs/internals.html: New separate index page for the "internal"
9497   documentation.
9499 * docs/deprecated.html: New document describing deprecation policy.  This
9500   includes lists of features which have been removed, or which are deprecated
9501   and scheduled for removal, along with suggested replacements.
9503 * docs/admin_notes.html: New document introducing Xapian for sysadmins.
9505 * docs/termgenerator.html: New document describing the new term generation
9506   strategy implemented by the Term::Generator class.
9508 * docs/bm25.html,docs/intro_ir.html: These have been overhauled to make them
9509   fit better with the rest of the documentation, and with Xapian itself.
9511 * docs/overview.html: Fixed links to error classes in generated API
9512   documentation.
9514 * HACKING,INSTALL: Many updates and improvements.
9516 * xapian-config: Improve --version output so that help2man produces a better
9517   man page.
9519 * PLATFORMS: Remove reports for 0.7.* and demote reports for 0.8.* to "older
9520   reports" status.  All SF compilefarm machines are now "no longer available",
9521   so update the symbols and key to reflect this.  Update with recent success
9522   reports from the tinderbox and other sources.
9524 * AUTHORS: Thanks several bug reporters I missed before, as well as recent
9525   contributors.
9527 * docs/code_structure.html now looks nicer and includes links to
9528   svn.xapian.org.
9530 * docs/remote_protocol.html: Fixed several typos and other errors, and document
9531   all the new messages.
9533 * We no longer include docs/apidoc/latex/* in the xapian-core tarballs since
9534   it's just useless bloat.
9536 examples:
9538 * delve:
9540   + Report the exception error string if open a database fails.
9542   + Rename "-k" to "-V" since "keys" were renamed to "values" long ago.  Keep
9543     "-k" as an alias for now, but don't advertise it.  Add handling so "-V3"
9544     shows value #3 for every document in the database.
9546   + No longer stems terms by default.  Add "-s/--stemmer" option to allow a
9547     stemmer to be specified.
9549 * quest: Add "--stemmer" option to allow stemming language to be set, or
9550   stemming to be disabled.
9552 portability:
9554 * Fix compilation with GCC 4.3 snapshot.
9556 * Always use pid_t not int for holding a process id, and use AC_TYPE_PID_T to
9557   `#define pid_t int' if <sys/types.h> doesn't provide pid_t.
9559 * Pass the 4th parameter of setsockopt() as char* which works whether the
9560   function actually takes char* or void* (since C++ allows implicit conversion
9561   from char* to void*).
9563 * Most warnings in the MSVC build have been fixed.
9565 * Refactored most portability workarounds into safeXXXX.h headers.
9567 * Building for mingw in a cygwin environment should work better now.
9569 packaging:
9571 * RPM spec file:
9573   + Updated for the changes in this release.
9575   + ChangeLog.examples is now packaged.
9577 debug code:
9579 * Rename --enable-debug* configure options - conflating the options to "turn on
9580   assertions" and "turn on logging" is confusing. `--enable-debug[=partial]'
9581   becomes `--enable-assertions'; `--enable-debug-verbose' becomes
9582   `--enable-log' and `--enable-debug=full' becomes `--enable-assertions
9583   --enable-log'.  For now the old options give an error telling you the new
9584   equivalent.
9586 * Debug logging from expand is now all of type EXPAND (some was of types
9587   MATCHER and WTCALC before).
9589 * Hook the debug tracing in the lemon generated parser into Xapian's debug
9590   logging framework.
9592 * New assertion types: AssertEqParanoid() and AssertNeParanoid().
9594 * Retry write() if it fails when writing a debug log entry to ensure to avoid
9595   the risk of a partial write.
9597 Xapian-core 0.9.10 (2007-03-04):
9599 API:
9601 * Fix WritableDatabase::replace_document() not to lose positional information
9602   for a document if it is replaced with itself with unmodified postings.
9604 * QueryParser: Add entries to the "unstem" map for prefixed boolean filters
9605   (e.g. type:html).
9607 * Fix inconsistent ordering of documents between pages with
9608   Enquire::set_sort_by_value_then_relevance (fixes bug#110).
9610 testsuite:
9612 * Workaround apparent bug in MSVC's ifstream class.
9614 flint and quartz backends:
9616 * Fix possible double-free after a transaction fails.
9618 * Fix code for recovering from failing to open a table for reading
9619   mid-modification.  If modifications are so frequent that opening for reading
9620   fails 100 times in a row, throw DatabaseModifiedError not
9621   DatabaseOpeningError.
9623 * Don't call std::string::append(ptr, 0) when ptr may be uninitialised
9624   or NULL (rather suspect, and reported to cause SEGV-like behaviour with
9625   MSVC).
9627 * Ensure both_bases is set to false if we don't have both bases when
9628   opening a table using an existing object.
9630 * Use MS Windows API calls to delete files and open files we might want to
9631   delete while they are still open (i.e. the flint and quartz btree base
9632   files).  This fixes a problem when a writer can't discard an old revision at
9633   the exact moment a reader is opening it (bug #108).
9635 remote backend:
9637 * Fix WritableDatabase::has_positions() to refetch the cached value if it
9638   might be out of date.
9640 * Fix incorrect serialisation of a query with non-default termpositions.
9642 inmemory backend:
9644 * If replace_document is used to set the docid of a newly added document which
9645   has previously existed, ensure we mark that document as valid.
9647 documentation:
9649 * Assorted improvements to API documentation.
9651 * docs/Makefile.am: The larger pool_size we set in 0.9.9 for building
9652   sourcedoc.pdf was a bit marginal, so increase it further.
9654 * docs/stemming.html,docs/install.html: Correct 2 references to "CVS" to say
9655   "SVN" instead.
9657 * HACKING: Update the release checklist.
9659 portability:
9661 * Fix flint and quartz to allow 2GB+ B-tree tables when compiling with MSVC.
9663 packaging:
9665 * RPMs: Remove "." from end of "Summary:".  Package the new man page for
9666   xapian-progsrv.
9668 Xapian-core 0.9.9 (2006-11-09):
9670 testsuite:
9672 * Use popen() to run xapian-tcpsrv and wait for "Listening..." before returning
9673   rather than just sleeping for 1 second and hoping that's enough.
9675 * If we can't start xapian-tcpsrv because the port is in use, try higher
9676   numbered ports.
9678 remote backend:
9680 * xapian-tcpsrv: If the port requested is in use, exit with code 69
9681   (EX_UNAVAILABLE) which is useful if you're trying to automate launching of
9682   xapian-tcpsrv instances.
9684 * xapian-tcpsrv: Output "Listening..." once the socket is open and read for
9685   connections (this allows the testsuite to wait until xapian-tcpsrv is ready
9686   before connecting to it).
9688 * xapian-progsrv: Now supports --help, --version, and has a man page.  Fixes
9689   Bug #98.
9691 * Turn on TCP_NODELAY for the TCP variant of the remote backend which
9692   dramatically improves the latency of operations on the database.
9694 build system:
9696 * internaltest: Disable serialiselength1 and serialisedoc1 when the remote
9697   backend is disabled to fix build error in this case.
9699 * Move libbtreecheck.la from testsuite/ to backends/quartz/.
9701 * Move the testsuite harness from testsuite/ to tests/harness/.
9703 documentation:
9705 * Ship our custom INSTALL file rather than the generic one from autoconf which
9706   we've accidentally been shipping instead since 0.9.5.
9708 * docs/Makefile.am: Building sourcedoc.pdf needs a larger pool_size now we're
9709   using pdflatex.
9711 * HACKING: Update debian packaging checklist.
9713 * PLATFORMS: Updated with results from tinderbox.
9715 portability:
9717 * Create "safefcntl.h" as a replacement for <fcntl.h> instead of using
9718   "utils.h" for this purpose, since "utils.h" pulls in many other things we
9719   often don't need.
9721 packaging:
9723 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
9725 Xapian-core 0.9.8 (2006-11-02):
9727 API:
9729 * QueryParser: Don't require a prefixed boolean term to start with an
9730   alphanumeric - allow the same set of characters as we do for the second
9731   and subsequent characters.
9733 flint backend:
9735 * Only force a flush on WritableDatabase::allterms_begin() if there are
9736   actually pending changes.
9738 quartz backend:
9740 * Only force a flush on WritableDatabase::allterms_begin() if there are
9741   actually pending changes.
9743 * quartzcheck: Avoid dying because of an unhandled exception if the Btree
9744   checking code finds an error in the low-level Btree structure.  Add a
9745   catch for any other unknown exceptions.
9747 build system:
9749 * When building with GCC, turn on warning flag -Wshadow even when not in
9750   maintainer mode (provided it is supported by the GCC version being used).
9752 * testsuite/backendmanager.cc: Fix compilation when valgrind is detected by
9753   configure.
9755 * If generating apidoc.pdf fails, display the logfile pdflatex generates since
9756   that is likely to show what failed.
9758 documentation:
9760 * Produce a PDF for apidoc rather than PostScript, since the PDF is smaller,
9761   plus at least as easy to print and easier to view for most users.  Use
9762   pdflatex to generate the PDF directly rather than going via a DVI file which
9763   apparently produces a better result and also avoids problems on some Linux
9764   distros where latex is a symlink to pdfelatex (bug#81, bug#95).
9766 * HACKING: Mention automake 1.10 is out but we've not tested it yet.
9768 * HACKING: Add entries to release checklist: make sure new API methods
9769   are wrapped by the bindings, and that bug submitters are thanked.
9771 * HACKING: Note that on Debian, tetex-extra is needed for
9772   fancyhdr.sty.
9774 * HACKING: Note that dch can be used to update debian/changelog.
9776 * docs/code_structure.html: Document backends/remote.
9778 * PLATFORMS: Update from tinderbox.
9780 portability:
9782 * configure: When checking if we need -lm, don't use a constant argument to
9783   log() as the compiler might simply evaluate the whole expression at compile
9784   time.
9786 * configure: Redhat's GCC 2.96 doesn't support -Wundef even though real GCC
9787   version before and after it do!
9789 * configure: Avoid use of double quotes in double-quoted backticks since
9790   it causes problems on some platforms.
9792 * backends/flint/flint_io.cc: Fix compilation on windows (needs to
9793   #include "safewindows.h" to get definition of SSIZE_T).
9795 * Fix our implementation of om_ostringstream to compile so that the build
9796   works once more on older compilers without <sstream> (regression probably
9797   introduced in 0.9.7).
9799 packaging:
9801 * xapian.spec: Package xapian-progsrv.
9803 Xapian-core 0.9.7 (2006-10-10):
9805 API:
9807 * QueryParser:
9809   + Allow a distance to be optionally specified for NEAR - e.g.
9810     "cats NEAR/3 dogs" (bug#92).
9812   + Implement "ADJ" operator - like "NEAR" except the terms must
9813     appear in matching documents in the same order as in the query.
9815   + Fix bug in how we handle prefixed quoted phrases and prefixed brackets.
9817   + Fix parsing of loved and hated prefixed phrases and bracketted expressions.
9819   + Fix handling of stopwords in boolean expressions.
9821   + Don't ignore a stopword if it's the only query term.
9823 * Document::add_value() failed to replace an existing value with the same
9824   number, contrary to what the documentation says (bug #82).
9826 * Enquire::set_sort_by_value(): Don't fetch the document data when fetching
9827   the value to sort on.  Simple benchmarking showed this to speed up sort by
9828   value by a factor of between 3 and 9!
9830 * Implement transactions for flint and quartz.  Also supported are "unflushed"
9831   transactions, which provided an efficient way to atomically group a number
9832   of database modifications.
9834 * The Xapian::Error and Xapian::ErrorHandler classes have been reimplemented.
9835   The new versions have better, clearer documentation comments and are cleaner
9836   internally.
9838 * Change how doubles are serialised by TradWeight, BM25Weight, and in the
9839   remote backend protocol.  The new encoding allows us to transfer any double
9840   value which can be represented by both machines precisely and compactly.
9842 testsuite:
9844 * Add targets "check-flint", "check-quartz", and "check-remote" in tests and at
9845   the top level which run the subset of tests which test the respective backend.
9847 * apitest: Run tests on flint if flint is enabled, rather than if quartz is
9848   enabled!
9850 * apitest: Speed up deldoc4 when run in verbose mode - some stringstream
9851   implementations are very inefficient when the string grows long.
9853 * Turn on GLIBCXX_FORCE_NEW when running tests under valgrind to stop the GNU
9854   C++ STL from using a pooling allocator.  This helps make velgrind's leak
9855   tracking more reliable.
9857 * Probe for required valgrind logging options at configure time rather than
9858   when running the test program.  This saves about 2 seconds per test program
9859   invocation.
9861 * Fix testsuite harness to show valgrind output when a test fails (when running
9862   under valgrind in verbose mode).  This had stopped working, probably due to
9863   changes in valgrind 3.
9865 * internaltest: Check that the destructor on a temporary object gets called
9866   at the correct time (Sun C++ deliberately gets this wrong by default, and it
9867   would be good to catch any other compilers which do the same).
9869 * apitest: When running tests on the remote backend and running under valgrind,
9870   run xapian-tcpsrv and xapian-progsrv under valgrind too to avoid issues
9871   with the precision of doubles (bug#94).
9873 flint backend:
9875 * Retry on EINTR from fcntl or waitpid when creating or releasing the flint
9876   lock file.
9878 * xapian-compact: Add --blocksize option to allow the blocksize to be set
9879   (default is 8K as before.)
9881 * WritableDatabase::replace_document(did, doc) was double-incrementing the
9882   "changes" counter when document did didn't exist so it would flush twice
9883   as often - fixed.
9885 * WritableDatabase::postlist_begin(): Remove forced flush when iterating the
9886   posting list of a term which has modified postings pending.
9888 quartz backend:
9890 * quartzcompact: Add --blocksize option to allow the blocksize to be set
9891   (default is 8K as before.)
9893 * WritableDatabase::replace_document(did, doc) was double-incrementing the
9894   "changes" counter when document did didn't exist so it would flush twice
9895   as often - fixed.
9897 remote backend:
9899 * Most of the remote backend has been rewritten.  It now supports most
9900   operations which a local database does (including writing!), the protocol
9901   used is more compact, and a number of layers of classes have been eliminated
9902   and the sequences of method calls simplified, so the code should be easier to
9903   understand and maintain despite doing more.  A number of bugs have been fixed
9904   in the process.
9906 * xapian-tcpsrv: Report errno if we catch a Xapian::Error which has it set.
9908 * xapian-tcpsrv: Fix memory leak in query unserialisation.
9910 build system:
9912 * Now using autoconf 2.60 for snapshots and releases.  Also now using a
9913   libtool patch which improves support for Sun C++'s -library=stlport4 option.
9915 * configure: Fix generation of version.h to work with Solaris sed.
9917 * automake adds suitable rules for rebuilding doxygen_api_conf and
9918   doxygen_source_conf, so remove our less accurate versions.  Also fix
9919   dependencies for regenerating the doxygen documentation, and make the
9920   documentation build work with parallel make.
9922 * Make use of the dist_ prefix to avoid having to list files in EXTRA_DIST as
9923   well as in *_DATA and man_MANS.
9925 * Removed a few unused #include-s.
9927 * include/xapian/error.h: Add hook to allow SWIG bindings to be built using
9928   GCC's visibility support.
9930 * configure: Turn on automake's -Wportability to help ensure our Makefile.am's
9931   are written in a portable way.
9933 * configure: Disable probing and short-cut tests for a FORTRAN compiler.  We
9934   don't use one, but current libtool versions always check for it regardless.
9936 * xapian-config: Prune -L/usr/lib from output of `xapian-config --libs'.
9938 documentation:
9940 * docs/scalability.html: quartzcompact and xapian-compact now allow you to set
9941   the blocksize, so there's no need to use copydatabase if you want to migrate
9942   a database to a larger blocksize.  Mention gmane.  Other minor tweaks.
9944 * Eliminate "XAPIAN_DEPRECATED" from generated documentation.
9946 * PLATFORMS: Added success report for Nexenta (alpha 5), MSVC, and sparc linux.
9947   Updated other results from tinderbox.
9949 * Add links to the wiki from README and the documentation index.
9951 * docs/overview.html: Add discussion of uses of terms vs values.
9953 * docs/overview.html: Rewrite the section on Xapian::Document to remove some
9954   very out-of-date information and make it clearer.
9956 * include/xapian/database.h: Note that automatically allocated document IDs
9957   don't reuse IDs from deleted documents.
9959 * include/xapian/enquire.h: Note that "set_sort_by_relevance" is the default
9960   setting.
9962 * docs/queryparser.html,include/xapian/queryparser.h: Add note that
9963   FLAG_WILDCARD requires you to call set_database.
9965 * HACKING: Add some advice regarding debugging using -D_GLIBCXX_DEBUG,
9966   valgrind, and gdb.
9968 * HACKING: Give URL to Alexandre Duret-Lutz's autotools tutorial, which is much
9969   more up-to-date than the "goat book".
9971 * HACKING: Update and expand the information about the debian packaging.
9973 * Add missing dir_contents files.
9975 portability:
9977 * xapian/version.h: Add a check that _GLIBCXX_DEBUG is set compatibly if we're
9978   compiling with GNU C++ 3.4 or newer.
9980 * Add configure check to see if "-lm" is needed to get maths functions since
9981   newer versions of Sun's C++ compiler seem to require this.
9983 * Automatically put Sun's C++ compiler into "ANSI C++ compliant library" mode
9984   (using -library=stlport4).  This allows us to remove most of the special
9985   case bits of code we've accumulated for just this compiler, which improves
9986   maintainability.
9988 * Sun's C++ compiler implements non-standards-conforming lifetimes for
9989   temporary objects by default.  This means database locks don't get released
9990   when they should, so we now always pass "-features=tmplife" for Sun C++
9991   which selects the behaviour specified by the C++ standard.
9993 Xapian-core 0.9.6 (2006-05-15):
9995 API:
9997 * Rename Xapian::xapian_version_string() and companions to
9998   Xapian::version_string(), etc.  Keep the old functions as aliases which are
9999   marked as deprecated.
10001 * QueryParser: Add rules to handle a boolean filter with a "+" in front (such
10002   as +site:xapian.org).
10004 testsuite:
10006 * queryparsertest: Add another prefix testcase to improve coverage.
10008 build system:
10010 * configure: Simpler check for VALGRIND being set to empty value.
10012 * include/Makefile.am: Add xapian/version.h.timestamp as a dependency on
10013   all-local so that xapian/version.h actually gets regenerated when required.
10015 * Eliminate XAPIAN_BUILD_BACKEND_* from config.h and just use
10016   XAPIAN_HAS_*_BACKEND from xapian/version.h instead.
10018 documentation:
10020 * remote_protocol.html: Document keep-alive messages.
10022 * xapian/enquire.h: Remove bogus documentation for a parameter which doesn't
10023   exist.
10025 * PLATFORMS: Added a summary.  Updated and pruned old entries for which we
10026   have a newer close match.
10028 * HACKING: Expand on details of what's required when changing Xapian (discuss
10029   documentation requirements, and more on why feature tests are vital).
10031 * HACKING: Update section on building debian packages.
10033 portability:
10035 * The tarball is generated with a patched version of libtool 1.5.22 which
10036   fixes libtool bugs on HP-UX and some BSD platforms.
10038 * configure: Fix problems with test for snprintf which affected cygwin, and
10039   possibly some other platforms.
10041 * configure: Tweak version.h generation to cope with CXXCPP putting carriage
10042   returns into its output as can happen on cygwin.
10044 * Fix renaming of "iamflint.tmp" for MS Windows where you can't rename an open
10045   file.
10047 * Fixed MSVC7 warnings.
10049 * Added workaround for newlib header bug.
10051 Xapian-core 0.9.5 (2006-04-08):
10053 API:
10055 * QueryParser:
10057   + Fix FLAG_BOOLEAN_ANY_CASE to really allow any case combination - previously
10058     it only allowed all uppercase or all lowercase.
10060   + Fix QueryParser's handling of terms with trailing "#", "+", or "-" when
10061     set_database has been called and the term doesn't exist in the database
10062     with the suffix.
10064 * Add mechanism to allow xapian-bindings to override deprecation warnings so
10065   we can continue to wrap deprecated methods without lots of warnings.
10067 * Move Enquire::get_matching_terms_end() and Document::termlist_end() inline in
10068   header.
10070 * Database::termlist_begin(): Eliminate the MultiTermList wrapper in the common
10071   case where we're only dealing with a single database.
10073 * Fix TermIterator::positionlist_begin() to work on TermIterator from
10074   Database::termlist_begin().  Make TermList::positionlist_begin() pure
10075   virtual and put dummy implementations in BranchTermList and other
10076   subclasses which can't (or don't) implement it.  This makes it hard to
10077   accidentally fail to implement it in a backend's TermList subclass.
10079 * TermIterator::positionlist_begin() with the remote backend now throws
10080   UnimplementedError instead of InvalidOperationError.
10082 * Implement Enquire::set_sort_by_relevance_then_value().
10084 testsuite:
10086 * Added missing feature test for QueryParser::FLAG_BOOLEAN_ANY_CASE.
10088 * remotetest: Check mset size in tcpmatch1.
10090 flint backend:
10092 * xapian-compact: Fixed segfault from passing an unknown option (e.g.
10093   "xapian-compact --foo").
10095 quartz backend:
10097 * quartzdump,quartzcompact: Fixed segfault from passing an unknown option
10098   (e.g.  "quartzdump --foo").
10100 remote backend:
10102 * xapian-tcpsrv: Don't perform a name lookup on the IP address which an
10103   incoming connection is from as that could easily slow down the search
10104   response - instead just print the IP address itself if output is verbose.
10106 * xapian-tcpsrv: Allow up to 5 connections in the listen queue instead of just
10107   one.
10109 build system:
10111 * Removed unused code from the matcher and the remote, quartz, and flint
10112   backends.
10114 documentation:
10116 * All installed binaries now support --help and --version and have a man page
10117   (which is generated using help2man).
10119 * docs/overview.html: Bring up to date.
10121 * docs/remote_protocol.html: Document messages for requesting and sending a
10122   termlist and a document.
10124 * PLATFORMS, AUTHORS: Updated.
10126 * INSTALL: Improve wording.
10128 * HACKING: Note that we now use a lightly patched version of libtool 1.5.22.
10130 * HACKING: aclocal is part of automake, not autoconf.
10132 portability:
10134 * Added some tweaks to help support compilation with MSVC.
10136 packaging:
10138 * RPMs: package the new man pages.
10140 debug code:
10142 * Add missing spaces in some debug output.
10144 Xapian-core 0.9.4 (2006-02-21):
10146 API:
10148 * Flag deprecated methods such that the compiler gives a warning, for compilers
10149   which support such a feature (most notably GCC >= 3.1).
10151 * Correct typo in name of definition of function xapian_revision().
10153 testsuite:
10155 * Updated uses of deprecated methods in the testsuite.
10157 build system:
10159 * xapian-config: Set exec_prefix and prefix at top of script so that
10160   xapian-config works after xapian-core is installed.
10162 documentation:
10164 * Add documentation comment for Enquire::set_sort_by_value_then_relevance().
10166 * README: Add pointer to HACKING.  Change "CVS access" to "SVN access".
10168 * PLATFORMS: Updated from tinderbox.
10170 * COPYING: Update second occurrence of old FSF address.
10172 Xapian-core 0.9.3 (2006-02-16):
10174 API:
10176 * Added 4 functions to report version information for the library version being
10177   used (which may not be the same as that compiled against if shared libraries
10178   are in use):  xapian_version_string(), xapian_major_version(),
10179   xapian_minor_version(), xapian_revision().
10181 * Xapian::QueryParser:
10183   + Fix handling of "+" terms in a query when the default query operator is
10184     AND.  Added regression test for this.
10186   + Added "AND NOT" as a synonym for "NOT".  Added feature tests for this.
10188 * Fix prototype for ESet::operator[] to take parameter of type termcount
10189   instead of doccount (doccount and termcount are both typedefs to the same
10190   type so this really just makes the prototype more consistent).
10192 * Xapian::Stem: Check for malloc and calloc failing to allocate memory and
10193   throw an exception.  Richard has fixed this upstream in snowball, so this is
10194   a temporary fix until we import a new version of snowball.
10196 * Xapian::Database: Trying to open a database for reading which doesn't exist
10197   now fails with DatabaseOpeningError instead of FeatureUnavailableError.
10198   Added regression test for this.
10200 * Add Stopper::get_description() and SimpleStopper::get_description().
10202 testsuite:
10204 * Fixed testsuite harness to work with valgrind on 64 bit platforms.
10206 * Merged the "running tests" section of docs/tests.html into the similar
10207   section in HACKING, and make docs/tests.html refer the reader to HACKING for
10208   more information.
10210 * Tidied and enhanced environmental variables which the test suite harness
10211   recongnises:
10213   + OM_TEST_BACKEND: Removed support since the "-b" switch to apitest allows
10214     you control which backend is used, making OM_TEST_BACKEND pretty much
10215     redundant.
10217   + XAPIAN_SIG_DFL: Renamed to XAPIAN_TESTSUITE_SIG_DFL.
10219   + XAPIAN_TESTSUITE_OUTPUT: New environmental variable to control use of
10220     ANSI colour escape sequences in test output (set to "plain" to disable
10221     them, unset, empty, or "auto" to check if stdout is a tty, or anything
10222     else to force colour).
10224 flint backend:
10226 * xapian-compact: Added "--multipass" option to merge postlists in pairs or
10227   triples until all are merged.  Generally this is faster than an N-way merge,
10228   but it does require more disk space for temporary files so it's not the
10229   default.
10231 quartz backend:
10233 * quartzcheck: If the database is too broken to open, emit a warning message
10234   and bump the error count.
10236 build system:
10238 * Now generate snapshots and releases with automake 1.9.6 (was 1.9.5) and
10239   libtool 1.5.22 (was 1.5.18).
10241 * configure: If not cross-compiling, try to actually run a test program built
10242   with the C++ compiler, not just link one.
10244 * configure: Fix to actually skip the check for valgrind if VALGRIND is set to
10245   an empty value.
10247 * configure: Add sanity check for MS Windows that "find" is Unix-like find, not
10248   MSDOS-like.
10250 * Fix conditional compilation of flint backend - it was being disabled when
10251   quartz was, not when flint was supposed to be.
10253 documentation:
10255 * INSTALL,README: Updated.
10257 * Give pointer to replacements for the deprecated Enquire sorting methods
10258   in the doxygen collated documentation.
10260 * PLATFORMS: Added success reports for ppc64 linux and Fedora Core 4.  Updated
10261   from the tinderbox.
10263 * HACKING: Note platforms valgrind now has solid support for; Improve
10264   phrasing in a few places.
10266 * Upgrade to using doxygen 1.4.6 for generating API documentation.
10268 * Change title of the "full source" documentation to "Internal Source
10269   Documentation" rather than "Full source documentation" to make it
10270   clearer it's only useful if you want to modify Xapian itself.
10272 * Fix documentation comments for the values of QueryParser::feature_flag so
10273   doxygen actually pulls out the documentation for them.  Add documentation for
10274   the parameters of QueryParser::parse_query().
10276 * queryparser.html: Document wildcards.
10278 portability:
10280 * Fix compilation with GCC 4.0.1 and later (need to forward declare class
10281   InMemoryDatabase) (bug #69).
10283 * Fix compilation under cygwin (broken in 0.9.2).
10285 * Don't pass NULL for the second parameter of execl() - the Linux man page
10286   says execl takes "one or more pointers to null-terminated strings".  Also
10287   cast the NULL to (void*) to avoid "missing sentinel" warning from GCC4.
10289 * Use snprintf instead of sprintf where available (we were attempting to
10290   do this in some places before, but the configure test was broken so
10291   sprintf was always being used).
10293 * Enable more warnings under aCC and fix minor issues highlighted.  Suppress
10294   "Entire translation unit was empty" warning which isn't useful to us.
10296 * Write top-bit set characters in the source using \xXX notation to avoid
10297   warnings from Intel's C++ compiler.
10299 * configure: TYPE_SOCKLEN_T fails hard, so only run it if we've successfully
10300   run other socket tests.
10302 * queryparser/accentnormalisingitor.h: #include <limits.h> for CHAR_BIT.
10304 * bin/xapian-compact.cc: Fix printf type mismatch on 64 bit platforms.
10306 * Replace pair<bool, string> with a simple class BoolAndString - the pair
10307   results in a 4328 byte symbol on HP-UX which gets truncated (to 4000 bytes).
10308   Most likely this is harmless, but it causes a warning.
10310 * configure: Disable flint backend by default if building for djgpp or msdos.
10312 * xapian-config: Previously when linking without libtool we've always thrown
10313   in dependency_libs, even though only some platforms need it (because it's
10314   generally pretty harmless).  However some Linux distros have an unhelpful
10315   policy of not packaging .la files, so libxapian.la isn't available to
10316   extract dependency_libs from.  Linux is a platform which doesn't require
10317   dependency_libs to be explicitly linked, so extend xapian-config to not
10318   pull in dependency_libs if libtool's link_all_deplibs_CXX=no.
10320 * xapian-config: If the current platform needs dependency_libs and
10321   libxapian.la's dependency_libs contains another .la file, transform it into a
10322   pair of -L and -l options, and recursively expand its dependency_libs (if
10323   any).
10325 * Don't pass functions with C++ linkage to places wanting pointers to functions
10326   with C linkage.  So far this has worked for us, but it causes warnings with
10327   some compilers, and may not be portable.
10329 * Compaq C++ 7.1 doesn't suffer from the problem which previously prevented
10330   it from building Xapian.  This release includes workarounds for some
10331   oddities with errno.h support in this compiler, but currently the build
10332   fails when trying to link a binary with the library.
10334 packaging:
10336 * RPM: Invoke %setup correctly in xapian.spec.
10338 debug code:
10340 * Add missing '#include <iostream>' when TIMING_PATCH is defined.
10342 Xapian-core 0.9.2 (2005-07-15):
10344 API:
10346 * QueryParser:
10348   + Added optional "flags" argument to parse_query method.
10350   + Add flag FLAG_BOOLEAN_ANY_CASE which tells the QueryParser that boolean
10351     operators such as "AND", "OR", and "NEAR" should be recognised even if
10352     they aren't fully capitalised (so "and", "And", "aNd", etc will work too).
10354   + Add flag FLAG_WILDCARD which tells the QueryParser to allow right
10355     truncation e.g. "xap*".
10357   + Fixed to handle "-site:microsoft.com" where site is a boolean prefix.
10358     Added testcases for this.
10360 testsuite:
10362 * The test harness was incorrectly creating a quartz database when a flint one
10363   was requested, which meant tests weren't being run against flint and so it
10364   had bugs rendering it pretty much unusable.
10366 * Added regression test longpositionlist1 (to check encoding/decoding a long
10367   position list, which flint had problems with).
10369 flint backend:
10371 * Bumped format version number.
10373 * Added new "xapian-compact" program which can compact and merge flint
10374   databases in a similar way to how quartzcompact does for quartz databases.
10376 * Fixed to auto-detect database type when opening an existing Flint database
10377   as a WritableDatabase.
10379 * The code to encode the position list size, first entry, and last entry
10380   didn't match the code to decode them!  Reworked both to match, using a
10381   slightly more compact encoding.
10383 * We were failing to append "DB" to the path when opening a table for reading.
10385 * Rewrite of FlintAllTermsList with several fewer member variables.  The
10386   rewrite fixes a bug too - the old version wasn't ignoring the metainfo
10387   entry which is now in the postlist table.
10389 * It seems we need to explicitly kill the child process used for locking.
10390   Otherwise when we have two databases locked just closing the connection
10391   doesn't cause the child to die.  I don't understand why it's needed, but this
10392   fix is at least clean.
10394 quartz backend:
10396 * quartzcompact: Fix mis-repacking of keys in positionlist table when merging
10397   several databases.
10399 * Disable assertion in allterms iteration which is incorrect in a corner case.
10400   This is only a problem if a termname contains zero bytes and you're using a
10401   debug build.  Add regression test test_specialterms2.
10403 remote backend:
10405 * Implement sorting on a value with the remote backend.
10407 build system:
10409 * Pass automake options to AM_INIT_AUTOMAKE rather than specifying them in
10410   Makefile.am.  This way, the version requirements for autoconf and automake
10411   are stated close together.
10413 * configure: -Wshadow causes false positives with GCC 3.0.4, so only enable it
10414   for 3.1 and up.
10416 * configure: Eliminate use of "ln -s" when generating include/xapian/version.h
10417   since it seems to cause problems on Solaris in some setups and isn't really
10418   necessary.
10420 * Add dependency mechanism so version.h gets regenerated when the template is
10421   changed.
10423 * configure: Check for spaces in build directory, source directory, or install
10424   prefix and die with a helpful message.
10426 * Add dependency to generate queryparser_token.h.
10428 * Eliminated TOP_SRCDIR and TOP_BUILDDIR - it's better to just use top_srcdir
10429   and top_builddir directly.
10431 * configure: Generate the list of source files to feed to doxygen by inspecting
10432   all the Makefile.am files prior to running autoreconf rather than by using
10433   "find" when the user runs ./configure.  This speeds up configure, avoids
10434   generating docs for random .cc and .h files which aren't part of xapian-core,
10435   and avoids problems with picking up FIND.EXE on MS Windows.
10437 documentation:
10439 * Expanded explanation of the "descending docid with boolean weighting" trick
10440   for fast date ordered searching in Enquire::set_docid_order() API docs.
10442 * docs/intro_ir.html: Citeseer has moved, so update link.
10444 * testsuite/testsuite.cc: Update URL for valgrind FAQ in comment.
10446 * COPYING: Update FSF address.
10448 * HACKING: Minor updates to release checklist.
10450 portability:
10452 * Assorted tweaks towards allowing compilation with MSVC.
10454 packaging:
10456 * xapian.spec.in: Package xapian-compact.
10458 Xapian-core 0.9.1 (2005-06-06):
10460 API:
10462 * Fix SEGV on get_terms_begin() on an empty Query object.  This was causing
10463   a SEGV in Omega with an empty query.
10465 * Put Query::get_terms_end() inline in header.
10467 flint backend:
10469 * Added the new "flint" backend, which starts out as a copy of the quartz
10470   backend plus some modifications and replacements.  When creating a database
10471   without a specified backend, quartz is still used unless the environmental
10472   variable XAPIAN_PREFER_FLINT is set to a non-empty value.
10474 * apitest now runs tests on flint as well as the other backends.
10476 * Removed undocumented (and hence the little used) quartz "log" feature.
10478 * Implement new fork+fcntl+exec based locking (for Unix) and CreateFile based
10479   locking (for Windows - currently untested).
10481 * Move the special key/tag pair holding the total document length and doc id
10482   high water mark from the record table to the postlist table.  This means that
10483   when appending documents, the insertion point will now always be at the end
10484   of the record table which is more efficient.  We need to jump around the
10485   postlist table to merge postings in anyway.
10487 * Changed metafile magic to be different from quartz, and make the metafile
10488   version a datestamp which we'll change each time the format changes.
10490 * Check the return value of close() when writing the metafile.
10492 * Flint position list table now stores entries using interpolative coding
10493   (which is significantly more compact).
10495 quartz backend:
10497 * quartzcheck: Fixed corner case where you couldn't check a single Btree table
10498   which was just the DB and baseA/baseB files in a directory (Xapian doesn't
10499   produce anything like this, but btreetest does while unit testing the
10500   Btree code).
10502 build system:
10504 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
10506 * configure: Pass more -W flags to g++ (including -Wundef which caught the
10507   getopt problem fixed in this release).  Fixed new GCC warnings from these new
10508   flags.
10510 * Fixed a lingering DOXYGEN_HAVE_DOT reference.
10512 * Fixed accidentally pruned #define which meant that getopt code was being
10513   included even on systems which use glibc (on such systems, we should use
10514   the glibc copy of the code instead).
10516 * queryparser/queryparser.lemony: Add missing '#include <config.h>'.
10518 documentation:
10520 * Added missing documentation comments for a QueryParser methods added in
10521   0.9.0.
10523 * docs/quartzdesign.html: Removed warning that quartz is still in development.
10525 * PLATFORMS: Updated from tinderbox.
10527 * configure: Describe CC_FOR_BUILD in configure --help output.
10529 * HACKING: Updated release instructions to refer to SVN, and note that release
10530   tarballs are now built specially rather than being copies of snapshots.
10531   Update information about the SVN tag name to use for debian files.
10533 * HACKING: Add "email Fabrice" to the release checklist so that RPM
10534   spec files don't lag behind.
10536 * Fixed a few spelling mistakes.
10538 packaging:
10540 * xapian.spec: Remove bogus %setup line left over from when we packaged
10541   xapian-core and xapian-examples together from separate tarballs.
10543 debug code:
10545 * api/omqueryinternal.cc: Fixed compilation with --enable-debug.
10547 * common/omdebug.h: Replace C style cast with static_cast<> which reveals that
10548   we were discarding const (harmlessly though).
10550 Xapian-core 0.9.0 (2005-05-13):
10552 API:
10554 * Query objects really need to be immutable after construction (otherwise we
10555   need a copy-on-write mechanism).  To achieve this the following API changes
10556   were required:
10558   + Remove Query::set_length() in favour of an optional length
10559     parameter to Enquire::set_query().
10561   + Eliminated Query::set_elite_set_size() in favour of optional parameter
10562     to constructor.
10564   + Eliminated Query::set_window() in favour of an optional parameter to the
10565     constructor.
10567 * Removed OP_WEIGHT_CUTOFF, since it doesn't actually seem to add useful
10568   functionality over using Enquire::set_cutoff().
10570 * MSet::max_size() (which only exists so that MSet is an STL container) now
10571   returns MSet::size() and is inlined from the header.
10573 * Added ESet::max_size() (for STL compatibility).
10575 * Fixed Xapian::RSet to have the same "it's a handle" copy semantics as most of
10576   the other classes.
10578 * Rewritten QueryParser class:
10580   + Uses Lemon instead of Bison to generate the parser, which enables us to
10581     stop using static data, so this class is at last reentrant.
10583   + QueryParser now uses a PIMPL style with reference counted internals like
10584     most of the other Xapian classes.
10586   + Direct access to member variables has gone, which unfortunately forces an
10587     API change (but this fixes bug #39).  Instead of accessing
10588     QueryParser::termlist member variable, iterate over terms using
10589     Query::get_terms_begin() and get_terms_end() on the returned Query object.
10590     Direct access to stoplist is replaced by QueryParser::get_stoplist_begin()
10591     and get_stoplist_end(); and to unstem by get_unstem_begin() and
10592     get_unstem_end().
10594   + The rewrite parses many real world examples better than the old version.
10596   + Now allow searches for C#, etc.  If a database has been set, for this and +
10597     and - suffixes, check if the term actually exists, and if not, ignore the
10598     suffix if the unsuffixed term exists.
10600   + Added QueryParser::get_description() method (not very descriptive yet!)
10602   + Added backward compatibility wrapper for old version of
10603     QueryParser::set_stemming_options().
10605   + xapian.h now automatically includes xapian/queryparser.h.  Directly
10606     including xapian/queryparser.h will continue to work for now, but is
10607     deprecated.
10609   + QueryParser::parse_query() was failing to clear termlist and unstem
10610     - the rewrite fixes this.
10612   + New QueryParser parses "term prefix:(term2 term3)" correctly.
10614 * Added Xapian::SimpleStopper which just stops terms specified by a pair of
10615   iterators.  This should be sufficient for the majority of uses.
10617 * Tidied up the Enquire sorting API and added ability to reverse sort on a
10618   value.  Removed sort_bands support.
10620 * Enquire::get_description() improved.
10622 * Methods which return an end iterator where the internals are just NULL are
10623   now inline in the header for efficiency.  Should we ever need to change an
10624   implementation, we can easily move methods back into the library and bump the
10625   library version suitably.
10627 * Added Stem::operator() as preferred alternative to Stem::stem_word().
10629 * Simplified Stem internal design by restructuring to eliminate a few internal
10630   methods.
10632 * BM25Weight: Avoid fetching document length if we're simply going to multiply
10633   it by zero!
10635 testsuite:
10637 * Fixed TEST_EQUAL_DOUBLE to use DBL_EPSILON correctly.
10639 * Rewrite of index_utils test harness code, removing unused and unusual
10640   features.  Data files for tests are now easier to write.  These changes
10641   also fix the bug that ^x didn't actually decode hex values correctly.
10643 * tests/testdata/etext.txt: Stripped carriage returns.
10645 * apitest: Extended stemlang1 to check that trying to create
10646   a stemmer for a non-existent language throws InvalidArgumentError.
10648 * queryparsertest:
10650   + Moved into tests/ subdirectory.
10652   + Reworked to use the standard testsuite harness.
10654   + Added tests for new features in the rewritten QueryParser.
10656 quartz backend:
10658 * quartzcheck: Now checks the structure of all the tables, not
10659   just the postlist table, and cross-checks doclen values between
10660   termlist and postlist tables.  Recognises "--help" option.  Should
10661   now continue after an error (typically it would crash before), and
10662   counts the number of errors found.  Now exits with non-zero status
10663   if any errors were found.  More readable output.
10665 * quartzcompact: Extended to allow merging several quartz
10666   databases to produce a single compact quartz database.  This
10667   allows for faster building - simple index in chunks, then merge
10668   the chunks.
10670 * quartzcompact: Made full compaction a tiny bit more compact.
10672 * quartzcompact: Added "fuller compaction" mode, which ignores the usual "at
10673   least 4 items per block" rule.  This achieves slightly tighter compaction,
10674   though it's probably not advisable to use this option if you plan to update
10675   the compacted database.
10677 * Improved compaction by a few % in non-full case.  Tighter bound on amount of
10678   memory to reserve to read the tag into.
10680 * Fix skip_to on an allterms TermIterator to set the current term when the
10681   skip_to-ed term is in the database.  Add regression test for this
10682   (allterms5).
10684 * Values are stored in sorted order so we can stop unpacking the list once we
10685   get to one after the one we're looking for (in the case where the one we're
10686   looking for doesn't exist).
10688 build system:
10690 * configure: Check that the C++ compiler can actually link a program.
10691   AC_LANG_CXX doesn't, and if it can't find a C++ compiler it'll just return
10692   "g++" which just leads to a later configure test failing in a confusing way.
10694 * configure: corrected configure output of "none known for yes" or "none known
10695   for no" to "none known for g++-3.2" or similar.
10697 * include/xapian/version.h: Define XAPIAN_HAS_xxx_BACKEND for each backend
10698   which is enabled.  The bindings need this, and user code might find it useful
10699   too.
10701 * include/xapian/database.h: Don't declare the backend factory functions if the
10702   corresponding backend has been disabled.  This means that trying to use a
10703   disabled backend will be caught at compile time rather than link time.
10705 * configure: Enhanced valgrind test to (a) see if --tool=memcheck
10706   is needed and (b) see if valgrind actually works (we don't want to
10707   try to use an x86 valgrind on an x86_64 box).
10709 * configure: Suppress 2 Intel C++ warnings which we can't easily code around,
10710   and enable -Werror automatically with --enable-maintainer-mode.
10712 * Clearer make rules for building Postscript doxygen docs.
10714 * Removed some no longer used code.
10716 * Moved a number of method definitions out of headers because they are virtual,
10717   or too large to be sensible candidates for inlining.
10719 * Eliminated the extra library for the queryparser - it's tiny compared to the
10720   main library and having it around just complicates things.
10722 * configure: We no longer need Bison, but we do need CC_FOR_BUILD to compile
10723   Lemon with.
10725 * Snapshot generator now appends _svn6789 or similar to the version string.
10726   Adjusted configure and XO_LIB_XAPIAN macro to take this into account.
10728 * configure: If any tools needed for documentation are missing
10729   and we're in maintainer mode, die with a suitable error in
10730   configure rather than with strange errors when building the
10731   documentation.
10733 * docs/Makefile.am: Explicitly set the pool_size for latex, because we
10734   now seem to overflow the default setting on some systems.
10736 * docs/Makefile.am: Use $(MAKE) instead of make.
10738 documentation:
10740 * Numerous improvements to documentation comments.  Added documentation
10741   comments for QueryParser class.
10743 * HACKING: Added better description of how reference-counted API
10744   classes are structured.
10746 * HACKING: Note that '#include <limits>' isn't supported by GCC 2.95,
10747   and other assorted minor tweaks.
10749 * HACKING: Note how to disable use of VALGRIND on the make check
10750   command line, or when using runtest directly.
10752 * Updated all documentation mentions of CVS to talk about Subversion
10753   instead.
10755 * PLATFORMS: Updated from tinderbox and other sources.
10757 * PLATFORMS: Added minimal testcase which fails to compile with
10758   Compaq's C++ compiler (cxx).
10760 * INSTALL,README: Updated.
10762 * docs/queryparser.html: Note that + and - work on phrases and
10763   bracketed expressions.
10765 * docs/intro_ir.html: Corrected two errors.
10767 * docs/stemming.html: Stemming appears to be applicable to Japanese
10768   so don't say it isn't!
10770 examples:
10772 * Moved xapian-examples module to examples subdirectory of xapian-core.
10774 * quest: Added stopword handling.
10776 portability:
10778 * configure: autoconf identifies Intel's C++ compiler as GCC, so probe for
10779   which we actually have.
10781 * Xapian will now compile cleanly with Intel C++ 8.1 on ia64 Linux and
10782   on x86 Linux.
10784 * backends/quartz/btree.cc: Fixed GCC compilation warning.
10786 * tests/api_db.cc: Fixed warning from Sun's C++ compiler.
10788 * configure: Automatically enable ANSI C++ mode for SGI's compiler
10789   with '-LANG:std'; check that any automatically determined flags
10790   for ANSI C++ mode actually allow us to compile a trivial program
10791   - if they don't it probably means the compiler isn't the one we
10792   were expecting, but one installed with the same name, so we now
10793   drop the flags in this case.
10795 * The compile on IRIX with SGI compiler is now warning free, apart from two
10796   "unused variable" warnings in Snowball generated code.
10798 * On WIN32, don't define NOMINMAX if it is already defined.
10800 packaging:
10802 * xapian.spec: Don't say "%makeinstall" in a comment since rpm
10803   tries to expand it and explodes.
10805 * xapian.spec: '/usr/share' -> '%{_datadir}'.
10807 * xapian.spec: Put the .so in the -devel package (it's only useful
10808   for linking to - the .so.* files are all that's needed at runtime).
10810 debug code:
10812 * net/socketserver.cc: Fixed typo in debug code.
10814 Xapian-core 0.8.5 (2004-12-23):
10816 quartz backend:
10818 * quartzcompact: When full_compaction is enabled, don't fill the last few bytes
10819   of a block if that would mean we needed an extra item and the overhead for
10820   that item would use up more of the next block than we save.  This reduces the
10821   table size after full compaction by up to 0.2% in my tests!
10823 * quartzcompact: Tables sizes will always be a whole number of Kbytes, since
10824   the blocksize is, so report the size in K.  Also report the change in size as
10825   well as the before and after sizes.
10827 * quartzcompact: Added missing '#include <config.h>' so that largefile support
10828   is enabled when we call stat() and we report compression statistics for
10829   tables > 2G.
10831 * quartzcompact: Added --no-full / -n option to disable full compaction.  This
10832   may be useful if you want to update the database after compacting it (need to
10833   test to see if this option is actually useful).
10835 * Renamed Btree::compress() to Btree::compact() for consistency with
10836   "full_compaction" and "quartzcompact".  Also, "compress" is confusing since
10837   we use that term in the zlib patch.
10839 build system:
10841 * xapian-config: Fixed --libs output to not include libxapian.la.
10843 * Added missing '#include <config.h>' to various .cc files (the omissions were
10844   probably harmless, but config.h should be included as the first thing any
10845   source file does).
10847 documentation:
10849 * Minor updates.
10851 packaging:
10853 * RPM spec file: %makeinstall puts the wrong paths in the .la files so use
10854   "make DESTDIR=... install" instead.
10856 debug code:
10858 * Fixed to build with AssertParanoid enabled.
10860 Xapian-core 0.8.4 (2004-12-08):
10862 API:
10864 * Added constructors to Database and WritableDatabase which fulfil the role
10865   that the Auto::open() factory functions currently do.  Auto::open() is
10866   now deprecated.
10868 * Removed the ability to write a Xapian object to an ostream directly, as
10869   it's little used and potentially dangerous ('cout << mset[i];' will
10870   compile, but you almost certainly meant 'cout << *mset[i];').  You can
10871   get the old effect by writing 'cout << obj->get_description();' instead
10872   of 'cout << obj;'.  Note that including xapian.h no longer pulls in
10873   fstream, which code may have been implicitly relying on - if this is
10874   a problem add '#include <fstream>' after '#include <xapian.h>'.
10876 * QueryParser: Be smarter about when to add a ':' when adding a term prefix.
10878 * BoolWeight::unserialise() now returns BoolWeight*, and similarly for
10879   TradWeight and BM25Weight.  BoolWeight::clone() now returns BoolWeight *.
10881 * If a database contains no positional information, change NEAR and PHRASE
10882   queries into AND queries (as otherwise they'd return no matches at all)
10883   (bug #56).  Added feature test phraseorneartoand1.
10885 * Renamed BM25 parameters to match standard naming in papers and elsewhere
10886   (A->k3, B->k1, C->k2, D->b), eliminated the extra factor of 2 which our C
10887   had, and reordered the parameters to k1, k2, k3.  This is an incompatible API
10888   change for BM25Weight(), so if you are using custom parameters for BM25
10889   you'll need to update your code.
10891 * During query expansion, if we estimate the term frequency, ensure it has a
10892   sane value (>= r and <= N - R + r) rather than bodging around the problem
10893   later on.
10895 * TradWeight, BM25Weight: termfreq is always exact for matching (we only
10896   approximate it for query expansion) so replace code to work around bad
10897   approximations with Assert() to make sure this never happens.
10899 testsuite:
10901 * runtest: Enhanced to allow it to run test programs under valgrind and other
10902   tools (gdb was already supported).
10904 * runtest: now works with valgrind 2.1.2 and later (valgrind's --logfile-fd
10905   option was renamed to --log-fd).
10907 * runtest: Allow VALGRIND environmental variable to override the value we got
10908   from configure.
10910 * Added a dependency so "make check" regenerates runtest if necessary.
10912 * The test programs now point the user to the runtest script if srcdir can't
10913   be guessed.  And they no longer look for the test program in the tests
10914   subdirectory of the current directory.
10916 * btreetest: Fixed memory leaks in test_cursor1 (the testcase itself was
10917   causing the leak, not the library).
10919 * apitest: Fixed mset_range_is_same() and mset_range_is_same_weights() helper
10920   functions which were only comparing the first item in the range.  Thankfully
10921   the tests still all pass so this wasn't hiding any bugs.
10923 * apitest: A modified version of changequery1 fails - the bug is obscure and
10924   subtle, and the fix is tricky so set the modified test to SKIP for now.
10926 * apitest: Added test_weight1 which tests the built-in Xapian::Weight
10927   subclasses and test_userweight1 which tests user defined weighting schemes
10928   (bug#8).
10930 * quartztest: Test with DB_CREATE_OR_OPEN in writelock1.
10932 quartz backend:
10934 * An interrupted update could cause any further updates to fail with "New
10935   revision too low" because the new revision was being calculated incorrectly -
10936   fixed (bug#55).
10938 * Fixed Bcursor::del() which didn't always leave the cursor on the next item
10939   like it should.  This may have been causing problems when trying to remove
10940   the last references to a particular term.
10942 * Fixed ultra-obscure bug in the code which finds a key suitable to
10943   discriminating between two blocks in a B-tree branch (discovered by reading
10944   the code).  Comparing the keys didn't consider the length of the second, so
10945   it is possible the code would miscompare.  But in reality this is extremely
10946   unlikely to happen, and even then would probably just mean that the
10947   discriminating key wouldn't be as short as it could be (wasting a few bytes
10948   but otherwise harmless).
10950 * If we're removing a posting list entirely, often there will only be one
10951   chunk, so avoid creating a Bcursor in this case.
10953 * Simplified Btree::compare_keys() by removing the last case which was dead
10954   code as it was covered by an earlier case.
10956 * Check that any user specified block size is a power of 2.  If the block
10957   size passed is invalid, use the default of 8192 rather than throwing an
10958   exception.
10960 * Started to refactor the Btree manager by introducing Item and Key classes
10961   which take care of handling the on-disk format, and eliminated duplicated
10962   tag reading code in Btree and Bcursor.  These changes will pave the way for
10963   improvements to the on disk format.
10965 * Applied the Quartz "DANGEROUS" patch, but disabled for now.  This way it
10966   won't keep being broken by changes to the code.
10968 * quartzcompact: Added --help and --version; Check that the source path and
10969   desitination path aren't the same; Report each table name when we start
10970   compacting it, and some simple stats on the compaction achieved when we
10971   finish.
10973 muscat36 backend:
10975 * Removed a default parameter value from one variant of
10976   Xapian::Muscat36::open_db() so that there's only one candidate for
10977   open_db(string).
10979 build system:
10981 * xapian-config: If flags are needed to select ANSI mode with the current
10982   compiler, then make xapian-config --cxxflags include them so that Xapian
10983   users don't have to jump through the same hoops we do.
10985 * xapian-config: Added --swigflags option for use with SWIG.
10987 * XO_LIB_XAPIAN now passes ac_top_srcdir to xapian-config which uses it
10988   (if provided) to say "configure.ac" or "configure.in" rather than
10989   "configure.in (or configure.ac)" in the "Add AC_PROG_LIBTOOL"
10990   error message.
10992 * Cleaned up the build system in a few places.
10994 * Removed a few totally unneeded header includes.
10996 * Moved a number of functions and methods out of headers because they're not
10997   good inlining candidates (too big or virtual methods).
10999 * Changed C style casts to C++ style.  The syntax is ugly, but they do make the
11000   intent clearer which is a good thing.  Note this as a coding style guideline
11001   in HACKING.
11003 * configure.ac: Automatically add -Werror to CFLAGS and CXXFLAGS if
11004   maintainer mode is enabled and we're using GCC3 or newer.  Don't do
11005   this for older GCCs as GCC 2.95 issues spurious warnings.
11007 * Reworked how include/xapian/version.h is generated so that it works
11008   better with compilers other than GCC, and with HP-UX sed.
11010 * XAPIAN_VERSION is now a string (e.g. "0.8.4").
11012 * Added new #define XAPIAN_REVISION (which is 4 for version 0.8.4).
11014 documentation:
11016 * docs/bm25.html,docs/intro_ir.html: Reworked to talk about Xapian
11017   rather than Muscat.  Also improved the appearance of the formulae.
11019 * HACKING: Valgrind now supports x86 FreeBSD and PowerPC Linux.
11021 * Documented parameters of Enquire::register_match_decider().
11023 * We now use doxygen 1.3.8 to build documentation for snapshots and releases.
11025 * PLATFORMS: Updated from the tinderbox (which now runs builds on machines
11026   available in HP's testdrive scheme) and other assorted reports.
11028 * PLATFORMS: Removed reports from versions prior to 0.7.0.  So much
11029   has changed that these are of little value.
11031 * docs/scalability.html: Added note warning about benchmarking from cold.
11033 * Assorted other minor documentation improvements.
11035 portability:
11037 * configure.ac: Improved snprintf configure test to actually
11038   check that it works (older implementations may have different
11039   semantics for the return value, and at least one ignores the length
11040   restriction entirely!)
11042 * Reworked the GNU getopt source we use so that the header is clean and
11043   suitable for use from a reasonably ISO-conforming C++ compiler instead of
11044   being full of cruft for working around quirky C compilers which C++ compilers
11045   tend to stumble over.
11047 * Use SOCKLEN_T for the type we need to pass to various socket calls, since
11048   HPUX defines socklen_t yet wants int in those calls.  Reworked the
11049   TYPE_SOCKLEN_T test we use.
11051 * On Windows, we want winsock2.h instead of sys/socket.h.  Mingw doesn't seem
11052   to even have the latter, so I think previously we've been compiling by
11053   picking one up from somewhere random!
11055 * Change the small number of C sources we have to be C++ so we can compile
11056   everything with the C++ compiler.  This way we don't need to worry about
11057   configure choosing a mismatching pair of compilers, or about whether
11058   configure tests with the C compiler don't apply to the C++ compiler, or vice
11059   versa.
11061 * Compiles and passes testsuite with HP's aCC (we have to compile in
11062   ANSI mode, so we automatically add -AA to CXXFLAGS).
11064 * If the link test detects pread and pwrite are present, get configure to try
11065   out prototypes for pread and pwrite.  This is much cleaner than trying to
11066   find the right combination of preprocessor defines to get each platform's
11067   system headers to provide prototypes.
11069 * configure: Disable probing for pread/pwrite on HP-UX as they're present but
11070   don't work when LFS (Large File Support) is enabled, and we definitely want
11071   LFS.
11073 * Fixed some warnings from Sun's C++ compiler.
11075 * Provide our own C_isalpha(), etc replacements for isalpha(), etc
11076   which always work in the C locale and avoid signed char problems.
11078 * For mingw/cygwin, pass -no-undefined when linking libxapianqueryparser.la
11079   so libtool builds a shared library.  Also pass the magic linker flag
11080   -Wl,--enable-runtime-pseudo-reloc if configure has determined it is needed.
11082 * For cygwin, use the underlying MoveFile API call for locking, as link()
11083   doesn't work on FAT partitions.  And don't rely on HAVE_LINK to control
11084   whether we use link() otherwise - if the configure test somehow misfires, a
11085   compilation error is better than using rename() on Unix as that would cause a
11086   second writer to smash the lock of the first.
11088 * Closer to building with Compaq C++ - add "-std strict_ansi" to CXXFLAGS, and
11089   tweaked the code in several places.  It currently dies trying to compile
11090   the PIMPL smart pointer template code which looks hard to fix.
11092 debug code:
11094 * HACKING: Document that %% in XAPIAN_DEBUG_LOG is substituted with
11095   the process-id, and that setting XAPIAN_DEBUG_FLAGS to -1 enables
11096   all debug messages.
11098 * Removed compatibility code for checking environment variables OM_DEBUG_FILE
11099   and OM_DEBUG_TYPES.
11101 Xapian-core 0.8.3 (2004-09-20):
11103 API:
11105 * Fixed bug which caused a segmentation fault or odd "Document not found"
11106   exceptions when new check_at_least parameter to Enquire::get_mset() was used
11107   and there weren't many matches (regression test checkatleast1).
11109 remote backend:
11111 * Renamed omtcpsrv to xapian-tcpsrv and omprogsrv to xapian-progsrv.
11113 packaging:
11115 * RPM packaging now has a separate package for the runtime libraries to
11116   allow 32 and 64 bit versions to be installed concurrently.
11118 * RPM for xapian-core now includes binaries from xapian-examples.
11120 debug code:
11122 * Fixed to compile with debug tracing enabled.
11124 Xapian-core 0.8.2 (2004-09-13):
11126 API:
11128 * Removed the compatibility layer which allowed programs written against the
11129   pre-0.7.0 API to be compiled.
11131 * Added new ESet methods swap(), back() and operator[].
11133 * Xapian::WritableDatabase::replace_document can now be used
11134   to add a document with a specific docid (to allow keeping docids
11135   in sync with numeric UIDs from another system).
11137 * Added Xapian::WritableDatabase::replace_document and
11138   delete_document variants which take a unique id term name rather
11139   than a document id.
11141 * Enquire::get_mset(): If a matchdecider is specified and no matches
11142   are requested, the lower bound on the number of matches must be 0
11143   (since the matchdecider could reject all the matches).
11145 * Renamed Query::is_empty() to Query::empty() for consistency.  Keep
11146   Query::is_empty() for now as a deprecated alias.
11148 * Enquire::set_sorting() now takes an optional third parameter which allows
11149   you to specify a sort by value, then relevance, then docid instead of
11150   by value then docid.
11152 * Enquire::get_mset() now takes an optional "check_at_least" parameter
11153   which allows Omega's MIN_HITS functionality to be implemented in the matcher
11154   (where it can be done a bit more efficiently).
11156 testsuite:
11158 * Reworked quartztest's positionlist1 into a generic api test as apitest's
11159   poslist3.
11161 * apitest: Reenabled allterms2, but with the iterator copying parts removed -
11162   TermIterator is an input_iterator so that part was invalid.
11164 * Overhauled btreetest and quartztest - tests at the Btree level are now all
11165   in btreetest.  Those at the QuartzDatabase level are in quartztest.
11167 * Split api_db.cc into 3 files as it has grown rather large.
11169 * tests/runtest: Added support for easily running gdb on a test program,
11170   automatically sorting out srcdir and libtool.
11172 quartz backend:
11174 * Refactored the quartz backend code to reduce the number of layered classes
11175   and eliminate unnecessary buffering, reducing memory usage so that more
11176   posting list changes can be batched together (see next change) and database
11177   building can be done several times faster.
11179 * Added tunable flush threshold - set XAPIAN_FLUSH_THRESHOLD=50000 to flush
11180   every 50000 documents.  The default is now every 10000 documents (was
11181   every 1000 documents previously).  The optimum value will most likely
11182   depend on your data and hardware.
11184 * WritableDatabase::get_document() no longer forces pending changes to be
11185   flushed.  The document will read things lazily from the database, and that
11186   reading may trigger a forced flush).
11188 * WritableDatabase::get_avlength() no longer forces pending changes to be
11189   flushed.  This means you can now search a modified WritableDatabase without
11190   causing a flush unless the search includes a term whose postlist has pending
11191   modifications.
11193 * Reduced quartz postlist chunk threshold from "2048 or a few bytes more" to
11194   "2000 or a few bytes more" so that full size chunks won't get split by the
11195   Btree.
11197 * Improved the "Db block overwritten" message.  The DatabaseCorruptError
11198   version now suggests multiple writers may be the cause, while the
11199   DatabaseModifiedError version uses less alarming wording and says to call
11200   Database::reopen().
11202 * QuartzWritableDatabase now stores the total document length and the last
11203   docid itself rather than tallying added and removed document length and
11204   writing the last docid back every time a document is added.  This gives
11205   cleaner code and a small performance win.
11207 * Make the first key null for blocks more than 1 away from the leaves.
11208   It saves disk space for a tiny CPU and RAM cost so is bound to be
11209   a win overall.
11211 * matcher/localmatch.cc: Fixed problems handling termweights in queries with
11212   the same term repeated (bug #37) and added regression test (qterminfo2).
11214 * Sped up iteration over all the terms in a database (QuartzCursor now only
11215   reads the tag from the Btree if asked to).
11217 * Cancelling an operation is now implemented more efficiently.
11219 inmemory backend:
11221 * Fixed bugs with deleting a document while a PostingIterator over it is
11222   active.
11224 muscat36 backend:
11226 * Fixed to compile now that internal_end_session() has gone (broken in 0.8.1).
11228 build system:
11230 * Fixed to compile when configured with --disable-inmemory (bug #33).
11232 * XO_LIB_XAPIAN now AC_SUBSTs XAPIAN_VERSION so your application's build
11233   system can easily check for a particular version of Xapian.
11235 * When compiling with GCC, we check that the compiler used to compile the
11236   library and the compiler used to compile the application have compatible
11237   C++ ABI versions.  Unfortunately GCC 3.1 incorrectly reports the same
11238   ABI version as GCC 3.0, so we now special case that test.
11240 * Bumped the versions of the autotools we require for bootstrapping, and
11241   updated the documentation of these in the HACKING document.
11243 * Quote macro names to fix warnings from newer aclocal.
11245 documentation:
11247 * Improved API documentation for Xapian::WritableDatabase::replace_document and
11248   delete_document.
11250 * Added documentation comments for MSet methods size(), empty(), swap(),
11251   begin(), end(), back().
11253 * Removed bogus documentation comments saying that some Enquire methods can
11254   throw DatabaseOpeningError.
11256 * Updated quartz design docs to reflect recent changes.  Also pulled
11257   out the Btree and Bcursor API docs and slotted them in as doxygen
11258   documentation comments - this way they're much more likely to
11259   be kept up-to-date.
11261 * Corrected multiple occurrences of "an Xapian::XXX" to "a Xapian::XXX"
11262   (presumably these all resulted from replacing "Om" with "Xapian::").
11264 * Various minor updates and improvements.
11266 portability:
11268 * Reworked how we cope with fcntl.h #define-ing open on Solaris.  This change
11269   finally allows Sun's C++ compiler to produce a working Xapian build on
11270   sparc Solaris!
11272 * configure.ac: Don't define DATADIR - we no longer use it and clashes
11273   with more recent mingw headers.
11275 * matcher/andpostlist.cc: Initialise lmax and rmax to 0.  This cures
11276   the SIGFPE on apitest's qterminfo2 on alpha linux.
11278 Xapian-core 0.8.1 (2004-06-30):
11280 API:
11282 * New method Xapian::Database::get_lastdocid which returns the highest used
11283   document id for a database (useful for re-synchronizing an indexer which
11284   was interrupted).  Implemented for quartz and inmemory.
11286 * Xapian::MSet::get_matches_*() methods now take collapsing into account, and
11287   the documentation has been clarified to state explicitly that collapsing and
11288   cutoffs are taken into account (bug#31).
11290 * Xapian::MSet: Need to adjust index by firstitem when indexing into items
11291   (bug#28).
11293 * MSetIterator and ESetIterator are now bidirectional iterators (rather than
11294   just input iterators)
11296 * Fixed post-increment forms of PostingIterator, TermIterator,
11297   PositionIterator, and ValueIterator so that *i++ works (as it must for them
11298   to be true input iterators).
11300 * Xapian::QueryParser: If we fail to parse a query, try stripping out
11301   non-alphanumerics (except '.') and reparsing.
11303 * Fixed memory leaked upon Xapian::QueryParser destruction.
11305 * Removed several unused Xapian::Error subclasses (these were used by the
11306   indexer framework which we decided was a failed experiment).
11308 testsuite:
11310 * queryparsertest: Pruned near-duplicate queryparsertest testcases.
11312 * queryparsertest: Added test case for `term NOT "a phrase'.
11314 * remotetest: Use 127.0.0.1 instead of localhost so that tcpmatch1 doesn't fail
11315   just because the network setup is broken.
11317 * apitest: Make emptyquery1 check that Query("") causes an InvalidArgumentError
11318   exception.
11320 quartz backend:
11322 * Fixed bug which meant we sometimes failed to remove a posting when deleting
11323   or replacing a document.
11325 * Fixed PostlistChunkReader to take a copy of the postlist data being read to
11326   avoid problems with reading data from a string that's been deleted.
11328 * Fixed bug in postlist merging which could occasionally extend a postlist
11329   chunk to overlap the docid range of the next chunk.
11331 * Eliminated the split cursor in each Btree object - we only actually need a
11332   single block buffer to handle splitting blocks.  This reduces the memory
11333   overhead of each Bcursor (and hence each QuartzPostList).
11335 * Changed 2 calls to abort() to throw Xapian::DatabaseCorruptError instead,
11337 * If Btree is writable, throw DatabaseCorruptError if we detect overwritten.
11339 * Check the return value of fdatasync()/fsync()/_commit() and raise an error.
11340   If they fail, we really want to know as it could cause data corruption.
11342 * Assorted clean ups, improved comments, debug tracing, assertions.
11344 * When merging in postlist changes, removed an unneeded call to
11345   QuartzBufferedTable::get_or_make_tag() in a case when we're using a cursor
11346   which has already fetched the tag.
11348 * Added SON_OF_QUARTZ define to disable incompatible changes to database
11349   formats by default, and use it to control the docid encoding for keys such
11350   that we're always inserting at the end of the table when added new documents.
11352 * Reopening the readonly version of a writable Btree is now more efficient
11353   (we used to close and reopen all the files and destroy and recreate a lot
11354   of objects and buffers).
11356 * Share file descriptors between the read and write Btree objects so that a
11357   quartz WritableDatabase now uses 5 fds rather than 10.
11359 * Added configure test for glibc, because otherwise we need to include a header
11360   before we can check for glibc in order to define something we should be
11361   defining before we include any headers!  Defining _XOPEN_SOURCE on OpenBSD
11362   seems to do the opposite to Linux and *disable* pread and pwrite!
11364 backends:
11366 * Stripped out the session machinery - all that is actually required is to
11367   ensure that any unflushed changes are flushed when the destructor runs.
11369 * A few other backend interface cleanups.
11371 build system:
11373 * Unified the shlib version numbers (the small benefit of tracking them
11374   individually makes it hard to justify the extra work required, and having one
11375   version simplifies debian packaging too).
11377 * configure.in: Fix typo (STLPORT_CXXLAGS -> STLPORT_CXXFLAGS)
11379 * Removed trivial m4/Makefile.am and autoconf/Makefile.am and do the work
11380   from the top level Makefile.am instead.  It's easier to see the structure
11381   this way, and it also removes a couple of recursive make invocations which
11382   will speed up builds a little.
11384 documentation:
11386 * HACKING: Added a list of subtasks when doing a release.
11387   Currently it's always me that does this, but it may not always be
11388   and anyhow it'll help me to have a list to run through.
11390 * include/xapian/database.h: Remove references to sessions in doxygen
11391   comments.
11393 * docs/quickstart.html: Corrected lingering reference to "om.h" and
11394   note that we need <iostream>.
11396 * docs/quickstartindex.cc.html,docs/quickstartexpand.cc.html,
11397   docs/quickstartsearch.cc.html: Add <iostream>.
11399 * PLATFORMS,AUTHORS: Updated.
11401 * docs/quartzdesign.html: Corrected various pieces of out of date
11402   information, and improved wording in a couple of places.
11404 * docs/scalability.html: Removed the reference to the Quartz update bottleneck
11405   "currently being addressed for Xapian 0.8" as it's now been addressed!  Also
11406   reworded to remove use of first person (it was originally a message sent to
11407   the mailing list).
11409 Xapian-core 0.8.0 (2004-04-19):
11411 * Omega, xapian-examples and xapian-bindings now have their own NEWS files.
11413 API:
11415 * Throw an exception when an empty query is used to build in the binary
11416   operator Query constructor (previously this caused a segfault.  Added
11417   regression test.
11419 * Made the TradWeight constructor explicit.  This is technically an API change
11420   as before you could pass a double where a Xapian::Weight was required - now
11421   you must pass Xapian::TradWeight(2.0) instead of 2.0.  That seems desirable,
11422   and it's unlikely any existing code will be affected.
11424 * Added "explicit" qualifier to constructors for internal use which take a
11425   single parameter.
11427 * Renamed Xapian::Document::add_term_nopos to Xapian::Document::add_term
11428   (with forwarding wrapper method for compatibility with existing code).
11430 * The reference counting mechanism used by most API classes now handles
11431   creating a new object slightly more efficiently.
11433 * Xapian::QueryParser: Don't use a raw term for a term which starts with a
11434   digit.
11436 testsuite:
11438 * apitest, quartztest: Added a couple of tests, and commented out some test
11439   lines which fail in debug builds.
11441 * quartztest: cause a test to fail if there's still a directory after a call
11442   to rmdir(), or if there isn't a directory after calling mkdir().
11444 * apitest: Check returned docids are the expected values in a couple more
11445   cases.  Improved wording of a comment.
11447 quartz backend:
11449 * We now merge a batch of changes into a posting list in a single pass which
11450   relieves an update bottleneck in previous versions.
11452 * When storing the termlist, pack the wdf into the same byte as the reuse
11453   length when possible - doing so typically makes the termlist 14% smaller!
11454   This change is backward compatible (0.7 database will work with 0.8, but
11455   databases built or updated with 0.8 won't work with 0.7).
11457 * quartzcheck: Check the structure within the postlist Btree as well as
11458   the Btree structures themselves.
11460 * Reduced code duplication in the btree manager and btreechecking code.
11462 * quartzdump: Backslash escape space and backslash in output rather than hex
11463   encoding them; renamed start-term and end-term to start-key and end-key;
11464   removed rather pointless "Calling next" message; if there's an error, write
11465   it to stderr not stdout, and exit with return code 1.
11467 * Corrected a number of comments in the source.
11469 * Removed several needless inclusions of quartz_table_entries.h.
11471 * Removed OLD_TERMLIST_FORMAT code - it has been disabled for since 0.6.0.
11473 * Removed all the quartz lexicon code and docs.  It's been disabled for ages,
11474   and we've not missed it.
11476 build system:
11478 * XO_LIB_XAPIAN autoconf macro can now be called without arguments in the
11479   common case where you want the test to fail if Xapian isn't found.
11481 * Fixed the configure test for valgrind - it wasn't working correctly when
11482   valgrind was installed but was too a version to support VALGRIND_COUNT_ERRORS
11483   and VALGRIND_COUNT_LEAKS.
11485 * GCC 2.95 supported -Wno-long-long and is our minimum recommended version, so
11486   unconditionally use -Wno-long-long with GCC, and don't test for it on other
11487   compilers (the old test incorrectly decided to use it with SGI's compiler
11488   resulting in a warning for every file compiled).
11490 documentation:
11492 * Updated the quickstart tutorial and removed the warning that "this
11493   document isn't up to date".
11495 * docs/intro_ir.html: Added a link to "Information Retrieval" by Keith van
11496   Rijsbergen which can be downloaded from his website!
11498 * docs/quartzdesign.html: Some minor improvements.
11500 * docs/matcherdesign.html: Merged in more details from a message sent to the
11501   mailing list.
11503 * docs/queryparser.html: Grammar fixes.
11505 * Doxygen wasn't picking up the documentation for PostingIterator and
11506   PositionListIterator - fixed.  Added doxygen comments for Xapian::Stopper
11507   and Xapian::QueryParser.
11509 * PLATFORMS: Updated with many results from tinderbox and from users.
11511 * AUTHORS: Updated the list of contributors.
11513 * HACKING: XAPIAN_DEBUG_TYPES should be XAPIAN_DEBUG_FLAGS.
11515 * HACKING: Updated to mention that building from CVS requires
11516   `./configure --enable-maintainer-mode' (or use bootstrap).
11518 * HACKING: Added notes about using "using", and pointers to a couple of useful
11519   C++ web resources.
11521 portability:
11523 * Solaris: Code tweaks for compiling with Sun's C++ compiler.
11525 * IRIX: Code tweaks for compiling with SGI's C++ compiler.
11527 * NetBSD mkdir() doesn't cope with a trailing / on the path - fixed our code to
11528   cope with this.
11530 * mingw/cygwin: Only use O_SYNC (on the debug log) if the headers define it.
11532 * backends/quartz/quartz_table_manager.cc: Fix for building on mingw.
11534 * mingw: Added configure test for link() to avoid infinite loop in our C++
11535   wrapper for link.
11537 * mingw and cygwin both need -Wl,--enable-runtime-pseudo-reloc passing when
11538   linking.  Arrange for xapian-config to include this, and check that the ld
11539   installed is a new enough version (or at least that it was at configure
11540   time).  Also pass to programs linked as part of the xapian-core build.
11542 * cygwin: Close a QuartzDatabase or QuartzWritableDatabase before trying to
11543   overwrite it - cygwin doesn't allow use to delete open/locked files...
11545 * backends/quartz/quartz_termlist.cc: Use Xapian::doccount instead of
11546   unsigned int in set_entries().
11548 * Database::Internal::Internal::keep_alive() should be
11549   Database::Internal::keep_alive().
11551 * Make Xapian::Weight::Weight() protected rather than private as we want to be
11552   able to call it from derived classes (GCC 3.4 flags this, other compilers
11553   seem to miss it).
11555 debug code:
11557 * Open debug log with flag O_WRONLY so that we can actually write to it!
11559 * backends/quartz/quartz_values.cc: Fixed problem with dereferencing
11560   a pointer to the end of a string in debug output.
11562 Xapian 0.7.5 (2003-11-26):
11564 API:
11566 * Xapian::QueryParser now supports prefixes on phrases and expressions (e.g.
11567   author:(twain OR poe) subject:"space flight").
11569 * Added missing default constructors for TermIterator, PostingIterator, and
11570   PositionIterator classes.
11572 * Fixed PositionIterator assignment operator.
11574 testsuite:
11576 * queryparsertest: Added testcase for new phrase and expression prefix support.
11578 * apitest: Added regression tests for API fixes.
11580 backends:
11582 * quartzcompact: Fix the name that the meta file gets copied to (was
11583   /path/to/dbdirmeta rather than /path/to/dbdir/meta).
11585 build system:
11587 * Changed to using AM_MAINTAINER_MODE.  If you're doing development work on
11588   Xapian itself, you should configure with "--enable-maintainer-mode" and
11589   ideally use GNU make.
11591 * Fixed configure test for fdatasync to work (I suspect a change in a recent
11592   autoconf broke it as it relied on autoconf internal naming).
11594 * Fully updated to reflect move of libbtreecheck.la from backends/quartz
11595   to testsuite.  btreetest and quartzcheck should build correctly now.
11597 documentation:
11599 * Added first cut of documentation for Xapian::QueryParser query syntax.
11601 * Fixed incorrectly formatted doxygen documentation comments which resulted in
11602   some missing text in the collated API and internal classes documentation.
11604 * Documented --enable-maintainer-mode and problems with BSD make in HACKING.
11606 * Fixed typo in docs/scalability.html.
11608 * PLATFORMS: Updated from the tinderbox.
11610 omega:
11612 * omega: Parsing of the probabilistic query is now delayed until we need some
11613   information from it.  This means that we can now use options set by the
11614   omegascript template to control the behaviour of the query parser.
11615   $set{stemmer,...} now controls the stemming language (e.g. $set{stemmer,fr})
11616   and $setmap{prefix,...} now sets the QueryParser prefix map (e.g.
11617   $setmap{prefix,subject,XT,abstract,XA}).
11619 * omega: Fixed $setmap not to add bogus entries.
11621 * docs/omegascript.txt: Expanded documentation of $set and $setmap to list
11622   values which Omega itself makes use of.
11624 * omega: Cleaned up the start up code quite a bit.
11626 * omega: Removed the unfinished code for caching omegascript command
11627   expansions.  Added code to cache $dbsize.  The only other value correctly
11628   marked for caching is already being cached!
11630 Xapian 0.7.4 (2003-10-02):
11632 API:
11634 * Fixed small memory leak if Xapian::Enquire::set_query() is called more than
11635   once.
11637 * Xapian::ESet now has reference counted internals (library interface version
11638   bumped because of this).
11640 * Removed unused OmDocumentTerm::termfreq member variable.
11642 * OmDocumentTerm ctor now takes wdf, and replaced set_wdf() with inc_wdf() and
11643   dec_wdf().
11645 * Removed unused open_document() method from SubMatch and derived classes.
11647 * Calls made by the matcher to Document::Internal::open_document() now use the
11648   lazy flag provided for precisely this purpose, but apparently never used -
11649   this should give quite a speed boost to any matcher options which use values
11650   (e.g. sort, collapse).
11652 testsuite:
11654 * Finished off support for running tests under valgrind to check for memory
11655   leaks and access to uninitialised variables.
11657 * apitest: Sped up deldoc4.
11659 * btreetest: Removed superfluous `/'s from constructed paths.
11661 * quartztest: adddoc2 now checks that there weren't any extra values created.
11663 backends:
11665 * quartz: don't start the document's TermIterator from scratch on every
11666   iteration in replace_document().  Should be a small performance win.
11668 * quartz: Pass 0 for the lexicon/postlist table when creating a termlist just
11669   to find the doc length.
11671 * quartz: quartz_table_entries.cc: Removed rather unnecessary use of
11672   const_cast.
11674 * quartz: quartz_table.cc: Removed unused variable.
11676 * quartz: Improved encapsulation of class Btree.
11678 build system:
11680 * libbtreecheck.la now has an explicit dependency on libxapian.la.
11682 * We now set the dependencies for libxapian correctly so that linking
11683   applications will pull in other required libraries.
11685 * matcher/Makefile.am: Ship networkmatch.cc even if "make dist" is run from a
11686   tree with the remote backend disabled.
11688 * configure.in: Sorted out tests for gethostbyname and gethostbyaddr using
11689   standard autoconf macros.
11691 * configure.in: If fork is found, but socketpair isn't, automatically disable
11692   the remote backend rather than configure dying with an error.
11694 * autoconf/: Removed various unused autoconf macros.
11696 portability:
11698 * xapian-config.in: Link with libxapianqueryparser before libxapian, since
11699   that's the dependency order.
11701 * Removed or replaced uses of <iostream> and <iosfwd> in the library sources
11702   - we don't need or want the library to pull in cin and friends.
11704 * extra/queryparser.yy: Fixed to build with Sun's C++ compiler.
11706 * Make the dummy source file C++ rather than C so that automake tells libtool
11707   that this is a C++ library - vital for correct linking on some platforms.
11709 * Makefile.am: Pass -no-undefined to libtool so that we can build build a DLL
11710   on MS Windows.
11712 * configure.in: Fixed check for socketpair - we were automatically disabling
11713   the remote backend on platforms where socketpair is in libsocket
11714   (such as Solaris).
11716 * Use O_BINARY for binary I/O if it exists.
11718 * common/utils.h: mkdir() only takes one argument on mingw.
11720 * common/utils.h,testsuite/backendmanager.cc: Touch file using open() rather
11721   than system().
11723 * common/utils.cc: Fixed to compile if snprintf isn't available.
11725 documentation:
11727 * docs/scalability.html: Fixed slip (32GB should be 32TB);  Added note about
11728   Linux 2.4 and ext2 filesize limits.
11730 * PLATFORMS: Updated.
11732 * NEWS: Fixed a few typos.
11734 bindings:
11736 * xapian.i: using namespace std in SWIG parsed segment to sort out typemaps.
11738 packaging:
11740 * Updated RPM packaging.
11742 omega:
11744 * omega: $topdoc now ensures the match has been run; $date no longer ensures
11745   the match has been run.
11747 * omega: Fixed to build with Sun's C++ compiler.
11749 Xapian 0.7.3 (2003-08-08):
11751 API:
11753 * MSetIterator: Fixed MSetIterator::get_document() to work when get_mset() was
11754   called with first != 0 (regression test msetiterator3).
11756 testsuite:
11758 * internaltest: Changed test exception1 to actually test something (hopefully
11759   what was originally intended!)
11761 * Added long option support to the testsuite programs (and quartzdump).
11763 * Testsuite now builds on platforms for which we use our own stringstream
11764   implementation.
11766 * Only use \r in test output if the output is a tty.
11768 * Increased default timeout used by tests running on the remote backend from 10
11769   seconds to 5 minutes to avoid tests failing just because the machine running
11770   them is slow and/or busy.
11772 * Fixed check for broken exception handling - we were getting "Xapian::"
11773   prefixed to one version and not on the other.
11775 * tests/runtest: Set srcdir if it isn't already to make it easy to manually run
11776   test programs from a VPATH build.
11778 * apitest: Check termfreq in allterms4.
11780 backends:
11782 * quartz: Fixed allterms TermIterator to not give duplicate terms when a
11783   posting list is chunked; added regression test (allterms4).
11785 * quartz: Check for EINTR when reading or writing blocks and retry the
11786   operation.  This should mean quartz won't fail falsely if a signal is
11787   received (e.g. if alarm() is used).
11789 build system:
11791 * Renamed libomqueryparser to libxapianqueryparser - for backward compatibility
11792   we still provide a library with the old name for now.
11794 * xapian.m4: Added XO_LIB_XAPIAN to replace OM_PATH_XAPIAN.  XO_LIB_XAPIAN will
11795   automagically enable use of "xapian-config --ltlibs" if A[CM]_PROG_LIBTOOL is
11796   used in configure.in.
11798 * xapian-config: Now supports linking with libtool - using libtool means that
11799   the run-time library path is set and that you can now link with an
11800   uninstalled libxapian.  Also xapian-config will now work once xapian-core's
11801   configure has been run, rather than only after "make all".
11803 * xapian-config: Now automatically tries to link libxapianqueryparser too.
11805 * bootstrap: Removed bootstrap scripts in favour of top-level bootstrap which
11806   creates a top-level configure you can optionally use to configure all checked
11807   out Xapian modules with one command, and which creates a top level Makefile
11808   to build all checked out Xapian modules with one command.
11810 * Added versioning information to libxapian and libxapianqueryparser.
11812 * xapian-example/omega: Use libtool and XO_LIB_XAPIAN so we can link with an
11813   uninstalled Xapian, and so the run time load path gets built into the
11814   binaries (no need to set LD_LIBRARY_PATH just because you install Xapian with
11815   a non-standard prefix).
11817 * configure: Stop the API documentation from being regenerated when
11818   include/xapian/version.h changes (since it's generated by configure).
11820 * Fixed "make dist" in VPATH builds.
11822 portability:
11824 * common/getopt.h: #include <stdlib.h>, <stdio.h>, and <unistd.h> before
11825   defining getopt as a macro - this avoids problems with clobbering prototypes
11826   of getopt() in system headers.
11828 * bin/quartzcompact.cc: Need stdio.h for rename().
11830 * languages/Makefile.am: Fixed compilation for compilers other than GCC.
11832 * Moved rset serialisation into a method of RSet::Internal, so
11833   omrset_to_string() is now just glue code.  This eliminates the need for it to
11834   be a friend of RSet::Internal which Sun's C++ compiler didn't seem to be able
11835   to cope with.
11837 documentation:
11839 * Fix incorrect documentation comment for Enquire::set_set_forward().  (Looked
11840   like a cut&paste error)
11842 * COPYING: Updated FSF address, and reinstated missing section: "How to Apply
11843   These Terms to Your New Programs"
11845 * PLATFORMS: Updated some linux results: RH7.3 on x86, and Debian on alpha and
11846   arm; Updated FreeBSD success report; Updated with results from the tinderbox.
11848 * docs/mkdoc.pl: Don't choke on a comment at the end of the DIST_SUBDIRS line
11849   in a Makefile.am.
11851 * HACKING: Improved note about why libtool 1.5 is needed.
11853 * HACKING: Added note about additional tools needed for building a
11854   distribution.
11856 bindings:
11858 * Fixed VPATH builds.
11860 * python: Fixed to link with libomqueryparser.
11862 * guile,tcl8: Updated typemaps to SWIG 1.3 style.
11864 omega:
11866 * omindex.cc: Added missing `#include <errno.h>'.
11868 * omindex/scriptindex: Fixed signed character issue in accent normalisation.
11870 * omindex: fixed memory and file descriptor leak on indexing a zero-sized file.
11872 * omindex: Fixed sense of test for unreadable files.
11874 * omindex: Improved log messages to distinguish re-indexed/added.
11876 * omindex,omega,scriptindex: Fixed to compile with mingw.
11878 * omindex: Fixed to compile with GNU getopt so we can build on non-glibc
11879   platforms.
11881 examples:
11883 * msearch: Quick fix to get mingw building going.
11885 * getopt: Copied over our fixes for better C++ compatibility.
11887 * simplesearch: Stem search terms.
11889 * simpleindex: Fixed not to run words together between lines.
11891 * simpleindex: Create database if it doesn't exist.
11893 Xapian 0.7.2 (2003-07-11):
11895 testsuite:
11897 * Fixed NULL pointer dereference when a test threw an unexpected exception.
11899 backends:
11901 * Quartz: When asked to create a quartz database, try to create the directory
11902   if it doesn't already exist.  Then we don't have to do it in every single
11903   Xapian program which wants to create a database...
11905 portability:
11907 * common/getopt.h: Fixed to work better with C++ compilers on non-glibc
11908   platforms.
11910 * common/utils.h: missing #include <ctype.h>
11912 * Quartz: Defined _XOPEN_SOURCE=500 for GLIBC so we get pread() and pwrite().
11914 * common/utils.h: Improved mingw implementation of rmdir().
11916 documentation:
11918 * PLATFORMS: Added MacOS X 10.2 success report.
11920 * Improvements to doxygen-generated documentation.
11922 bindings:
11924 * Moved to separate xapian-bindings module.
11926 * Added configure check for SWIG version (require at least 1.3.14).
11928 * bindings/swig/xapian.i: Fixed over-enthusiastic automatic conversion of
11929   termname to std::string.
11931 * PHP4 bindings much closer to working once again; updated guile and tcl8
11932   somewhat.
11934 omega:
11936 * omega: If the same database is listed more than once, only search the first
11937   occurrence.
11939 * omega: use snprintf to help guard against buffer overflows.
11941 Xapian 0.7.1 (2003-07-08):
11943 testsuite:
11945 * Fixed testsuite programs to not try to use "rm -rf" under mingw.
11947 backends:
11949 * Quartz: Use pread() and pwrite() on platforms which support them.  Doing so
11950   avoids one syscall per block read/write.
11952 * Quartz block count is now unsigned, which should nearly double the size of
11953   database for a given block size.  Not tested this yet.
11955 omega:
11957 * omindex: Fixed compilation problem in 0.7.0.
11959 documentation:
11961 * Added new document discussing scalability issues.
11963 * PLATFORMS: Updated.
11965 Xapian 0.7.0 (2003-07-03):
11967 API:
11969 * Moved everything into a Xapian namespace, which the main header now being
11970   xapian.h (rather than om/om.h).
11972 * Three classes have been renamed for better naming consistency:
11973   OmOpeningError is now Xapian::DatabaseOpeningError, OmPostListIterator is
11974   now Xapian::PostingIterator, and OmPositionListIterator is now
11975   Xapian::PositionIterator.
11977 * xapian.h includes <iosfwd> rather than <iostream> - if you were relying on
11978   the implicit inclusion, you'll need to add an explicit "#include <iostream>".
11980 * Replaced om_termname with explicit use of std::string - om_termname was just
11981   a typedef for std::string and the typedef doesn't really buy us anything.
11983 * Older code can be compiled by continuing to use om/om.h which uses #define
11984   and other tricks to map the old names onto the new ones.
11986 * Define XAPIAN_VERSION (e.g. 0.7.0), XAPIAN_MAJOR_VERSION (e.g. 0), and
11987   XAPIAN_MINOR_VERSION (e.g. 7).
11989 * Updated omega and xapian-examples to use Xapian namespace.
11991 queryparser:
11993 * Xapian::QueryParser: Accent normalisation added; Improved error reporting;
11994   Fixed to handle the most common examples found in the wild which used to give
11995   "parse error".
11997 bindings:
11999 * Python bindings brought up to date - use ./configure --enable-bindings to
12000   build them.  Requires Python >= 2.0 - may require Python >= 2.1.
12002 * Enabled optional building of bindings as part of normal build process.  Old
12003   Perl and Java bindings dropped; for Perl, use Search::Xapian from CPAN; Java
12004   JNI bindings will be replaced with a SWIG-based implmentation.
12006 internal implementation changes:
12008 * Removed one wrapper layer from the internal implementation of most API
12009   classes.
12011 * Xapian::Stem now uses reference counted internals.
12013 * Internally a lot of cases of unnecessary header inclusion have been removed
12014   or replaced with forward declarations of classes.  This should speed up
12015   compilation and recompilation of the Xapian library.
12017 * Suppress warnings in Snowball generated C code.
12019 * Reworked query serialisation in the remote backend so that the code is now
12020   all in one place.  The serialisation is now rather more compact and no longer
12021   relies on flex for parsing.
12023 testsuite:
12025 * Moved all the core library tests to tests subdirectory.
12027 * apitest now allows backend to be specified with "-b" rather than having to
12028   mess with environmental variables.
12030 * Testsuite programs can now hook into valgrind for leak checking, undefined
12031   variable checking, etc.
12033 backends:
12035 * Fixed parsing of port number in remote stub databases.
12037 * Quartz: Improved error message when asked to open a pre-0.6 Quartz database.
12039 * Quartz backend: Workaround for shared_level problem turns out to
12040   be arguably the better approach, so made it permanent and tidied up
12041   code.
12043 build system:
12045 * Build system fixed to never leave partial files in place of the expected
12046   output if a build is interrupted.
12048 * quartzcheck, quartzdump, and quartzcompact are now built by "make" rather
12049   than only by "make check".
12051 * xapian-config: Removed --prefix and --exec-prefix - you can't reliably
12052   install Xapian with a different prefix to the one it was configured with,
12053   yet these options give the impression you can.
12055 miscellaneous:
12057 * Fixed sending debug output to a file with XAPIAN_DEBUG_LOG with a value which
12058   didn't contain "%%" (%% expands to the current PID).
12060 * Fixed Xapian::MSetIterator::get_collapse_count() to work as intended.
12062 omega:
12064 * omindex,scriptindex: Normalise accents in probabilistic terms.
12066 * omindex: Read output from pstotext and pdftotext via pipes rather
12067   than temporary files to side-step the whole problem of secure temporary file
12068   creation; Use pdfinfo to get the title and keywords from when indexing a PDF;
12069   Safe filename escaping tweaked to not escape common safe punctuation.
12071 * omindex: Implement an upper limit on the length of URL terms - this is a
12072   slightly conservative 240 characters.  If the URL term would be longer than
12073   this, its last few bytes are replaced by a hash of the tail of the URL.  This
12074   means that (apart from hopefully very rare collisions) urlterms should still
12075   be unique ids for documents.  This is forward and backward compatible for
12076   URLs less than 240 characters.
12078 * omindex: Clean up processing of HTML documents:
12079   - Ignore the contents of <script> and <style> tags in HTML.
12080   - Strip initial whitespace in each tag in an HTML document.
12081   - Try not to split words in half when truncating title and summary.
12083 * query.cc: Set STEM_LANGUAGE near the start of the file so it's easy
12084   for users to change until we get better configurability.
12086 * omega: Replaced half-hearted logging support with flexible OmegaScript-based
12087   approach with new $log command.  Also added $now to allow the current
12088   date/time to be logged.
12090 * templates/xml: added collapse info to xml template.
12092 documentation:
12094 * Assorted minor documentation improvements.
12096 * PLATFORMS: Updated.
12098 rpms:
12100 * Improved RPM packaging of xapian-core and omega.
12102 Xapian 0.6.5 (2003-04-10):
12104 * OmEnquire: optimised the handling when sort_bands == 1 and fixed incorrect
12105   results in this and some other sorting cases; added some sorting testcases.
12107 * OmMSetIterator: added get_collapse_count() which returns a lower bound on
12108   the number of items which were removed by collapsing onto the current item.
12110 * OmStem: added default OmStem constructor and "none" language.  Both of these
12111   give a stemmer object which leaves terms unchanged which should allow for
12112   simpler logic in programs using Xapian.  The default constructor also removes
12113   the need to mess with pointers in some cases.
12115 * Automatically disable the remote backend if we don't have fork() since the
12116   remote backend requires it in several places.
12118 * Fixed to build with debug enabled.
12120 * testsuite: fixed to still build when some backends are disabled.
12122 * extra/parsequerytest.cc: Fixed to build with GCC 2.95.
12124 * Testsuite: Added regression test for Quartz bug which caused problems with
12125   long terms on machines with signed chars.
12127 * testsuite/index_utils.cc: Handling of ^x was just downright wrong due to a
12128   typo.
12130 * Improved portability: Fix for 64 bit machines.  Fixed btreetest to build with
12131   older compilers lacking <sstream>.  Xapian is now much closer to building
12132   with Sun's CFront-based Sun Pro C++ compiler, and with a Linux to mingw
12133   cross-compiler.
12135 * PLATFORMS: Updated with the results of many test builds.
12137 * Improved RPM packaging of xapian-core and omega.
12139 * Documentation: Use http://www.doxygen.org/ as URL for doxygen; Fixed bad link
12140   to our own website in overview.html; code_structure.html now only includes
12141   directories in the build system.
12143 * HACKING: updated.
12145 * Removed bugs/todo.xml, TODO, TODO.release, docs/todo.html, and
12146   docs/todo-release.html from the distribution.  Bugs and todo items will be
12147   tracked in Bugzilla instead.
12149 * Install docs in /usr/share/doc/xapian-core instead of /usr/share/xapian-core.
12151 * omega: If xP and P are both empty, there may be a boolean query, so don't
12152   force first page of hits.
12154 * omega: Fixed off-by-one error in rounding down topdoc - it was possible to
12155   get to an empty page of hits if there were exactly a multiple of HITSPERPAGE
12156   matches and the matcher over-estimated the number of matches and Omega
12157   displayed page links.
12159 * omega: Fixed handling of multiple DB parameters to be as documented.
12161 * omega: Added $collapsed to report get_collapse_count() for the current hit.
12163 * omega: Added $transform{} which does regexp manipulation (currently disabled
12164   until configure tests for regexp library are added)
12166 * omega: Added $uniq{} to eliminate duplicates from a sorted list.
12168 * omega: Don't force page 1 for a query with repeated terms!
12170 * omega: removed duplicates from terms listed in term frequencies.
12172 * omega: Added cgi parameter COLLAPSE to collapse on key values
12174 * omega: Added $value{key[,docid]} support to omegascript
12176 * omega: Renamed DATE1, DATE2, and DAYSMINUS to the more meaningful START, END,
12177   and SPAN (NB SPAN is days before END, or after START, or before today -
12178   whereas SPAN was before *DATE1* or before today).  The old parameters names
12179   are supported (with the original semantics) for now.
12181 * omega: Actually install documentation!
12183 * templates/query: propagate B boolean filters
12185 * templates/godmode: removed link to EuroFerret image
12187 * templates/godmode: added value dumping, for values from 0-255
12189 * omindex: Report correct version number (was hard-wired to 1.0!)
12191 * scriptindex: Allow '_' in fieldnames.  Diagnose bad characters in fieldnames
12192   better.
12194 * dbi2omega: Added DBUSER and DBPASSWD environmental variable support so that
12195   password protected DBs can easily be used
12197 * scriptindex.cc: added missing "#include <stdio.h>" which caused builds
12198   to fail for some platforms.
12200 Xapian 0.6.4 (2002-12-24):
12202 * Quartz backend: Fixed double setting of position list when updating a
12203   document with term position information (overall result was correct, just
12204   inefficient); when deleting a position_list, don't check if it's empty,
12205   just ask the layer below to delete it and let it handle the case when
12206   there's nothing to delete; Fixed unpacking of termlist on platforms where
12207   char is signed.
12209 * OmQueryParser: Added support for searching probabilistic fields (using
12210   <field>:<term>); the unstem multimap now includes "." on the end of a
12211   term if it was there in the query.
12213 * Don't include "om.h" as a dependency for the api docs since it's generated
12214   a configure time and the dependency was forcing users to regenerate the
12215   documentation, which requires doxygen to be installed.
12217 * Bindings: Python bindings updated to work with the updated API (still
12218   disabled by default).
12220 * Muscat 3.6 backend: Fixed to build with the new database factory functions;
12221   fixed compilation warnings; Muscat 3.6 DA and DB databases don't support
12222   positional information.  Instead of throwing an exception when we try to
12223   access it, return an empty position list (like a quartz database with no
12224   position information would).  This allows copydatabase to be used to convert
12225   a Muscat 3.6 database to a quartz one.
12227 * Documentation: quartzdesign and todo list updated.
12229 * quartzcheck: default mode changed to "v" rather than "+", since "+" is too
12230   verbose for a btree of any size; if you pass a quartz database directory,
12231   quartzcheck will now check all the tables which make up a quartz database.
12233 * quartzcompact: new tool which makes a copy of a quartz database with full
12234   compaction turned on - this results in a smaller database which is faster
12235   to search.  The next update will result in a lot of block splitting though
12236   (since all blocks are as full as possible).
12238 * omega: Added $unstem to map a stemmed term to the form(s) used in the query;
12239   $queryterms now only includes the first occurrence of each stemmed form;
12240   $prettyterm makes use of the unstem map; prefer MINHITS to MIN_HITS and
12241   RAWSEARCH to RAW_SEARCH since none of the other CGI parameter names have
12242   _ separating words (continue to support old names for now); fixed default
12243   template to not generate topterms twice, and fixed topterms to not stick
12244   outside the green box; corrected omegascript docs - it's $setrelevant
12245   not $set_relevant.
12247 * scriptindex: index=nopos with new indexnopos action; index and indexnopos now
12248   take an optional prefix argument; index=nopos is handled specially for
12249   backwards compatibility; added new data action to generate terms for date
12250   range searching.
12252 Xapian 0.6.3 (2002-12-14):
12254 * Updated PLATFORMS and todo list.  Noted in HACKING that Bison 1.50 seems to
12255   work with Xapian.
12257 * OmQueryParser now creates an "unstem" multimap to allow probabilistic
12258   query terms to be converted back to the form the user originally typed.
12260 * Updated documentation for remote protocol description and the quickstart
12261   tutorial which were both very out of date.
12263 * No longer use OmSettings to pass matcher parameters.  This completes the
12264   removal of OmSettings.
12266 * Added workaround for problem with cursors sharing levels in the btree.
12267   This should fix sporadic problems with large databases (small databases
12268   have fewer btree levels so aren't affected).
12270 * Stub databases now work again, though with a different format.  The new
12271   format allows multiple databases to be specified in the stub file.
12273 * OmEnquire::get_eset() now takes a flags argument of bit constants |-ed
12274   together instead of 2 bools.
12276 * Applied Martin Porter's better fix for the btree sequential addition bug
12277   which Richard fixed a few months ago.  Richard's fix resulted in a correct
12278   btree, but didn't always utilise space as efficiently as possible.
12280 * Fixed the remote backend to handle weighting schemes after the OmSettings
12281   changes.  You can now even implement your own weighting scheme and use it
12282   with the remote backend provided you register it with SocketServer at
12283   runtime (this feature has been on the todo list for ages).
12285 Xapian 0.6.2 (2002-12-07):
12287 * Set env var XAPIAN_SIG_DFL to stop the testsuite installing its
12288   signal handler (may be useful with some debugging tools).
12290 * backends/quartz/btree.cc: max_item_size wasn't being set due to
12291   some over-zealous code pruning.  It was defaulting to 0, and
12292   was causing the code to write off the end of allocated memory
12293   blocks.
12295 * matcher/localmatch.cc: fixed handling of wtscheme() - we were
12296   trying to use it for the extra weights, and then double
12297   deleting it!
12299 * common/omdebug.cc,common/omdebug.h: Fixed permissions on newly
12300   created log file (was getting 000!); Simplified class internals;
12301   Renamed env vars: OM_DEBUG_FILE is now XAPIAN_DEBUG_LOG,
12302   OM_DEBUG_TYPES is now XAPIAN_DEBUG_FLAGS (old versions still work
12303   for now).
12305 * testsuite/testsuite.cc: Fixed so running "gdb .libs/apitest"
12306   finds srcdir (for an in-tree build at least).
12308 * Fixed to compile with --enable-debug=full.
12310 * docs/remote.html: Updated from OmSettings to factory functions.
12312 * PLATFORMS: ixion is actually Linux 2.2.
12314 * OmWritableDatabase now has a default constructor.
12316 * Weighting scheme now specified by passing OmWeight object to OmEnquire.
12317   This also allows user weighting schemes (just subclass OmWeight and
12318   pass in an instance of this new class).  [This doesn't currently work
12319   with the remote backend.]
12321 * No longer use OmSettings to specify parameters for constructing databases.
12322   Instead there's a factory function for each database type - temporary naming
12323   scheme is OmXxx__open(), mostly because it's easy to grep for later.
12324   Instead of create and overwrite flags, we pass in a value - a new possible
12325   opening mode is "create or open".  [At present stub databases and the
12326   machinery in InMemory to allow the multierrhandler1 test aren't working.
12327   Everything else should be.]
12329 * OmEnquire::get_eset() takes parameters instead of an OmSettings object.
12331 * Fixed reversed sense of use_query_terms (and fixed reversed sense test in
12332   apitest which meant this wasn't spotted).
12334 * Documentation: Link to annotated class lists in doxygen generated
12335   documentation instead of the rather empty index pages; added doxygen
12336   markup so that apidoc now documents header files; updated todo list.
12338 * Documentation: intro doc thing was very out of date in places - fixed.
12340 * Omega: index .php files as HTML, with the PHP code stripped out; omindex
12341   return non-zero return code if an unexpected exception is caught; fixed
12342   HTML parser to not read one character past the end of the document in
12343   some cases; updated in line with OmSettings related changes to the API;
12344   Fixed $dbname to return "default" for the default database instead of "";
12345   templates/query: Removed now unused xDEFAULTOP hidden field, and superfluous
12346   "}"; dbi2omega now more efficient and can be restricted to listed fields.
12348 Xapian 0.6.1 (2002-11-28):
12350 * Fixed to compile with GCC 3.0.
12352 * PLATFORMS: Updated.
12354 Xapian 0.6.0 (2002-11-27):
12356 * Quartz database backend: lexicon disabled (./configure CXXFLAGS=-DUSE_LEXICON
12357   to reenable it), and encoding schemes simplified and made more compact;
12358   extended and added test cases; minimum block size is now 2048 bytes (as
12359   documented before, but now we actually enforce this); btree checking code
12360   split off and only linked in when required; tidied up btreetest's output.
12362 * Replaced our stemmers with those from Snowball.  These give better results,
12363   and are actively maintained by Martin Porter (who wrote the original Xapian
12364   stemmers too).  It also means that Xapian now has stemmers for Finnish,
12365   and Russian, and an implementation of Lovins' English stemmer.
12367 * Assorted improvements to the documentation, especially the documentation
12368   of the internals of the Quartz backend.
12370 * Removed the three uses of RTTI (typeid() and dynamic_cast<>) - one was
12371   totally superfluous, and the other two easily avoided.
12373 * Omega and simpleindex example: limit probabilistic term length to 64
12374   characters to stop the index filling up with junk terms which nobody will
12375   ever search for.
12377 * Omega: Added dbi2omega perl script to dump any database which perl DBI can
12378   access into the dump format expected by scriptindex.
12380 Xapian 0.5.5 (2002-12-04):
12382 * Fixed compilation with --enable-debug.
12384 * Minor documentation updates.
12386 * Omega: Fixed paging on default database; removed xDEFAULTOP from the query
12387   template as it's no longer used; removed bogus unmatched '}' from query
12388   template; added dbi2omega perl script to dump any database which perl DBI
12389   can access into the dump format expected by scriptindex; limit length of
12390   probabilistic terms generated to 64 characters.
12392 Xapian 0.5.4 (2002-10-16):
12394 * Fixed a compilation error with "make check" when using GCC 3.2.
12396 * PLATFORMS: checked 0.5.3 works on OpenBSD and Solaris 7.
12398 Xapian 0.5.3 (2002-10-12):
12400 Notable changes: Improvements to the test suite, and internal code cleanups:
12402 * Internal code cleanups on Quartz Btree implementation.
12404 * Minor documentation updates (TODO and PLATFORMS updated; Martin Porter's
12405   stemming paper removed - see the Snowball site for background stemmer
12406   info).
12408 * Implemented QuartzAllTermsList::get_approx_size().
12410 * Removed a couple of occurrences of "using std::XXX;" from externally
12411   visible headers.
12413 * With GCC, add warning flags "-Wall -W" rather than "-Wall -Wunused" (-Wall
12414   implies -Wunused anyway).  Fixed all the warnings this throws up, except in
12415   languages/ (that code is to be replaced with Snowball soon).
12417 * Test suite: Disable colour test output if stdout isn't a terminal and
12418   reworked check for broken exception handling as the previous  version never
12419   seemed to fire.  Other assorted minor improvements.
12421 * include/om/om.h is now removed on "make distclean" rather than "make clean".
12423 Xapian 0.5.2 (2002-10-06):
12425 Further improvements to documentation and portability:
12427 * docs/: converted all text docs to HTML (except omsettings which will
12428   has odd markup (LaTeX?) and will probably soon be obsolete anyway).
12430 * remote backend: Fixed handling of timeouts which are now in the past - fixes
12431   test failures with redhat/x86.
12433 * quartz backend: now works on 64 bit platforms.
12435 * test suite: try to spot mishandled exceptions and stop them causing bogus
12436   OMEXCEPT failures.
12438 Xapian 0.5.1 (2002-10-02):
12440 This release fixes features improved documentation and some build system
12441 portability fixes.
12443 * PLATFORMS: updated with more test results.
12445 * docs/: tidied up layout of HTML documentation; converted the notes about
12446   BM25 into HTML; updated stemmer docs to reflect intention to use Snowball
12447   instead; included HTML versions of quickstart*.cc.
12449 * automake 1.6.3 and autoconf 2.54 are now required for those working
12450   from CVS to fix a problem with the generated Makefiles and Solaris
12451   make.
12453 * net/Makefile.am: Fixed building of readquery.cc from readquery.ll.
12455 * buildall script is now deprecated - use the new streamlined bootstrap script
12456   in preference.
12458 Xapian 0.5.0 (2002-09-20):
12460 The last release of the software that is now known as Xapian was Open Muscat
12461 0.4.1 on November 24th 2000, not far from 2 years ago.
12463 There's been a significant amount of development in this time, so we've
12464 summarised the most notable changes and improvements:
12466   * The project is now called "Xapian". We've renamed the modules in the light
12467     of this change:
12469       + "om" is now "xapian-core"
12470       + "om-examples" is now "xapian-examples", and now contains small,
12471         instructive examples which demonstrate how to use Xapian to implement
12472         particularly features.
12473       + Added "xapian-applications" which contains larger sample applications
12475   * Much improved build system - should now build "out of the box" on many Unix
12476     platforms. Can now VPATH build with vendor tools on most platforms. Builds
12477     as cleanly as we can achieve with GCC 2.95.* (some bogus warnings due to
12478     compiler bugs). Should build without warnings on GCC 3.0, 3.1, and 3.2.
12480   * If using GCC, om/om.h now contains a check that the compiler used to build
12481     Xapian and the compiler used to build the application have compatible C++
12482     ABIs. So you get a clear error message early from the first attempt to
12483     compile a file rather than a confusing error from the linker near the end
12484     of the build.
12486   * RPM packages are now available. We intend to prepare Debian packages in the
12487     near future too.
12489   * xapian-config no longer support "--uninst". It's hard to make this work
12490     reliably and portably, and the effort is better expended elsewhere.
12491     Configure with a prefix and install to a temporary directory instead.
12493   * Xapian can now work with files > 2Gb on OSes which support them.
12495   * Restructured and reworked documentation.
12497   * Removed thread locks. We intend to be "thread-friendly" so different
12498     threads can access different objects without problems. In the rare event
12499     that you want to concurrently call methods on the same object from
12500     different threads you need to create a mutex and lock it. Thus the thread
12501     lock overhead is only incurred when it's necessary.
12503   * Indexgraph removed from core library. It will reappear as an add-on library
12504     at some point.
12506   * Omega's query parser has now been reworked as a separate library.
12508   * Terminology change - "keys" are now known as "values" to avoid confusion,
12509     since they're not like keys in a relational database. The exception is when
12510     a value is used as a key in some operation, e.g. "match_collapse_key".
12512   * Database backends:
12514       + Auto backend: can now be used to create a new database.
12515       + Auto backend: added support for "stub" databases - a text file
12516         specifying the settings for the database to be opened (particularly
12517         useful for allowing easy access to specific remote databases).
12518       + Quartz backend: many fixes and improvements, and the code has been
12519         cleaned up a lot. Implemented deleting of items from postlists.
12520       + Remote backend: implemented term_exists() and get_termfreq();
12521       + Multi-backend: the document length is now fetched from the sub-postlist
12522         rather than the database, which provides a huge speed-up in some cases.
12523       + Sleepycat backend: this experimental backend has been removed.
12524       + Muscat 3.6 backends: now disabled by default.
12526   * Tests:
12528       + Test cases added for most bug fixes and new features.
12529       + stemtest: rewritten in C++ rather than part C++, part perl. Now 15%
12530         faster.
12531       + includetest: removed - it's no longer useful now the code has matured.
12532       + Removed problematic leak checking from testsuite. We plan to use
12533         valgrind instead soon.
12535   * Matcher:
12537       + Fixed several matcher bugs which could cause incorrect results in some
12538         situations.
12539       + Fix bug in expander due to nth_element being called on the wrong
12540         element.
12541       + Added sorting within relevance bands to the matcher.
12542       + Matcher now calculates percentages differently, such that 100%
12543         relevance is actually achievable.
12544       + Matcher now uses a min-heap rather than nth-element to maintain the
12545         proto-mset. This is cleaner and more efficient.
12546       + New operator OP_ELITE_SET replaces match_max_or_terms option.
12547       + Implemented multiple XOR queries.
12548       + Add a new query operator, OP_WEIGHT_CUTOFF, which returns only those
12549         documents from a query which have a weight greater than a specified
12550         cutoff value.
12551       + Removed OmBatchEnquire from system: it may return at a later date, but
12552         for now it is simply out of date and a maintenance liability, and
12553         gives no significant advantage.
12554       + Added experimental match bias functors.
12556   * The API has been cleaned up in various places:
12558       + OmDocumentContents and OmIndexDoc merged to become OmDocument
12559       + OmQuery interface cleaned up
12560       + OmData and OmKey removed - methods which used them now just pass a
12561         string instead
12562       + OmESetItem replaced by OmESetIterator; OmMSetItem by OmMSetIterator;
12563         om_termname_list by OmTermIterator
12564       + OmDocumentTerm and OmDocumentParams removed
12565       + OmMSet::mbound replaced by OmMSet::matches_
12566         {lower_bound,estimated,upper_bound}, giving more information
12567       + Xapian iterators now have default constructors
12568       + Most API classes now have reference counted internals, so assignment
12569         and copying are cheap
12570       + OmStem now has copy constructor and assignment operator
12571       + and more...