Use O_NOINHERIT for O_CLOEXEC on Windows
[xapian.git] / xapian-core / NEWS
blob821a260b04693f9e1fd321e80e2ad923f6ca2eca
1 Xapian-core 1.4.7 (2018-07-19):
3 API:
5 * Database::check(): Fix bogus error reports for documents with length zero
6   due to a new check added in 1.4.6 that the doclength was between the stored
7   upper and lower bounds, which failed to allow for the lower bound ignoring
8   documents with length zero (since documents indexed only by boolean terms
9   aren't involved in weighted searches).  Reported by David Bremner.
11 * Query: Use of Query::MatchAll in multithreaded code causes problems because
12   the reference counting gets messed up by concurrent updates.  Document that
13   Query(string()) should be used instead of MatchAll in multithreaded code, and
14   avoid using it in library code.  Reported by Germán M. Bravo.
16 * Stem:
18   + Stemming algorithms added for Irish, Lithuanian, Nepali and Tamil.
20   + Merge Snowball compiler changes which improve code generation.
22   + Merge optimisations to the Arabic and Turkish stemmers.
24 testsuite:
26   + Fix duplicate test in apitest closedb10 testcase.  Patch from Guruprasad
27     Hegde.
29 glass backend:
31 * A long-lived cursor on a table in a WritableDatabase could get into
32   an invalid state, which typically resulted in a DatabaseCorruptError
33   being thrown with the message:
35       Db block overwritten - are there multiple writers?
37   But in fact the on-disk database is not corrupted - it's just that
38   the cursor in memory has got into an inconsistent state.  It looks
39   like we'll always detect the inconsistency before it can cause on-disk
40   corruption but it's hard to be completely certain.
42   The bug is in code to rebuild the cursor when the underlying table
43   changes in ways which require that, which is a fairly rare occurrence
44   to start with, and only triggers when a block in the cursor has been
45   released, reallocated, and we tried to load it in the cursor at the
46   same level - the cursor wrongly assumes it has the current version
47   of the block.
49   Reported with a reproducer by Sylvain Taverne.  Confirmed by David
50   Bremner as also fixing a problem in notmuch for which he hadn't managed
51   to find a reduced reproducer.
53 documentation:
55 * INSTALL: Document need to have MSVC command line tools on PATH.
57 portability:
59 * Cygwin: Work around oddity where unlink() sometimes seems to indicate failure
60   with errno set to ECHILD.
62 Xapian-core 1.4.6 (2018-07-02):
64 API:
66 * API classes now support C++11 move semantics when using a compiler which
67   we are confident supports them (currently compilers which define
68   __cplusplus >= 201103 plus a special check for MSVC 2015 or later).
69   C++11 move semantics provide a clean and efficient way for threaded code to
70   hand-off Xapian objects to worker threads, but in this case it's very
71   unhelpful for availability of these semantics to vary by compiler as it
72   quietly leads to a build with non-threadsafe behaviour.  To address this,
73   user code can #define XAPIAN_MOVE_SEMANTICS before #include <xapian.h> to
74   force this on, and will then get a compilation failure if the compiler lacks
75   suitable support.
77 * MSet::snippet():
79   + We were only escaping output for HTML/XML in some cases, which would
80     potentially allow HTML to be injected into output (this has been assigned
81     CVE-2018-0499).
83   + Include certain leading non-word characters in snippets.  Previously we
84     started the snippet at the start of the first actual word, but there are
85     various cases where including non-word characters in front of the actual
86     word adds useful context or otherwise aids comprehension.  Reported by
87     Robert Stepanek in https://github.com/xapian/xapian/pull/180
89 * Add MSetIterator::get_sort_key() method.  The sort key has always been
90   available internally, but wasn't exposed via the public API before, which
91   seems like an oversight as the collapse key has long been available.
92   Reported by 张少华 on xapian-discuss.
94 * Database::compact():
96   + Allow Compactor::resolve_duplicate_metadata() implementations to delete
97     entries.  Previously if an implementation returned an empty string this
98     would result in a user meta-data entry with an empty value, which isn't
99     normally achievable (empty meta-data values aren't stored), and so will
100     cause odd behaviour.  We now handle an empty returned value by interpreting
101     it in the natural way - it means that the merged result is to not set a
102     value for that key in the output database.
104   + Since 1.3.5 compacting a WritableDatabase with uncommitted changes throws
105     Xapian::InvalidOperationError when compacting to a single-file glass
106     database.  This release adds similar checks for chert and when compacting
107     to a multiple-file glass database.
109   + In the unlikely event that the total number of documents or the total
110     length of all documents overflow when trying to compact a multi-database,
111     we throw an exception.  This is now a DatabaseError exception instead of a
112     const char* exception (a hang-over from before this code was turned into a
113     public API in the library).
115 * Document::remove_term(): Handle removing term at current TermIterator
116   position - previously the underlying iterator was invalidated, leading to
117   undefined behaviour (typically a segmentation fault).  Reported by Gaurav
118   Arora.
120 * TermIterator::get_termfreq() now always returns an exact answer.  Previously
121   for multi-databases we approximated the result, which is probably either a
122   hang-over from when this method was used during Enquire::get_eset(), or else
123   due to a thinking that this method would be used in that situation (it
124   certainly is not now).  If the user creates a TermIterator object and asks it
125   for term frequencies then we really should give them the correct answer - it
126   isn't hugely costly and the documentation doesn't warn that it might be
127   approximated.
129 * QueryParser::parse_query():
131   + Now adds a colon after the prefix when prefixing a boolean term which
132     starts with a colon.  This means the mapping is reversible, and matches
133     what omega actually does in this case when it tries to reverse the mapping.
134     Thanks to Andy Chilton for pointing out this corner case.
136   + The parser now makes use of newer features in the lemon parser generator to
137     make parsing faster and use less memory.
139 * Enquire::get_mset(): Fix bug with get_mset(0, 0, X) when X > 0 which was
140   causing an attempt to access an element in an empty vector.  Reported by
141   sielicki in #xapian.
143 * Stem:
145   + Add Indonesian stemming algorithm.
147   + Small optimisations to almost all stemming algorithms.
149 * Stopper:
151   + Add Indonesian stopword list.
153   + The installed version of the Finnish stopword list now has one word per
154     line.  Previously it had several space-separated words on some lines, which
155     works with C++'s std::istream_iterator but may be inconvenient for use from
156     some other languages.
158   + The installed versions of stopword lists are now sorted in byte order
159     rather than whatever collation order is specified by LC_COLLATE or similar
160     at build time.  This makes the build more reproducible, and also may be
161     more efficient for loading into some data structures.
163 * WritableDatabase::replace_document(term, doc): Check for last_docid wrapping
164   when used on a sharded database.
166 * Database::locked(): Consistently throw FeatureUnavailableError on platforms
167   where we can't test for a database lock without trying to take it.
168   Previously GNU Hurd threw DatabaseLockError while platforms where we don't
169   use fcntl() locking at all threw UnimplementedError.
171 * Database and WritableDatabase constructors: Fix handling of entries for
172   disabled backends in stub database files to throw FeatureUnavailableError
173   instead of DatabaseError.
175 * Database::get_value_lower_bound() now works correctly for sharded databases.
176   Previously it returned the empty string if any shard had no values in the
177   specified slot.
179 * PostingIterator was failing to keep an internal reference to the parent
180   Database object for sharded databases.
182 * ValueIterator::skip_to() and check() had an off-by-one error in their docid
183   calculations in some cases with sharded databases.
185 testsuite:
187 * apitest:
189   + Enable testcases flagged metadata, synonym and/or writable to run on
190     sharded databases.
192   + Enable testcases flagged writable to run on sharded databases.  Writing to
193     a sharded WritableDatabase has been supported since 1.3.2, but the test
194     harness wasn't running many of the tests that could be with a sharded
195     WritableDatabase.  This uncovered three bugs which are fixed in this
196     release.
198   + Support "generated" testcases for the inmemory backend, which uncovered a
199     bug which is fixed in this release.
201   + Skip testcase testlock1 on platforms that don't allow us to implement
202     Database::locked() (which notably include GNU Hurd and Microsoft Windows).
204   + Disable testlock2 on sharded databases as it fails for platforms which
205     don't actually support testing the lock.
207   + Extend tests of behaviour after database close.  Patch from Guruprasad
208     Hegde.  Fixes https://trac.xapian.org/ticket/337
210   + Enable testcase closedb5 for remote backends.  This testcase failed for
211     remote backends when it was added and the cause wasn't clear, but it turns
212     out it was actually a bug in the disk based backends, which was fixed way
213     back in 2010.  Reported by Guruprasad Hegde.
215   + Check for select() failing in retrylock1 testcase.  Retry on EINTR or
216     EAGAIN, and report other errors rather than trying the read() anyway.
217     Previously the read() would likely fail for the same reason the select()
218     did, but at best this is liable to make what's going on less clear if the
219     testcase fails.
221 * Report bool values as true/false not 1/0.
223 * Assorted minor testcase improvements.
225 * The test harness now supports testcases which are expected to fail (XFAIL).
226   Based on patch from Richard Boulton in https://trac.xapian.org/ticket/156.
228 * Fix demangling of std::exception subclass names which wasn't happening due
229   to a typo in the preprocessor check for the required header.  This was broken
230   by changes in 1.4.2.
232 * Make TEST_EQUAL() arguments side-effect free.  The TEST_EQUAL() macro
233   evaluates its arguments a second time if the test fails in order to report
234   their values.  This isn't ideal and really ought to be addressed, but for now
235   fix uses where the argument has side-effect (e.g. *i++) such that the
236   reported value should match the tested value.
238 * runtest: Show usage if first option starts '-'.  Previously we ended up
239   passing such options to libtool, so putting -v on runtest instead of apitest
240   would run the tests but -v would effectively do nothing (it would make
241   libtool verbose, but that doesn't make any difference in this case):
242   ./runtest -v ./apitest
244 * Suppress output from xcopy on MS Windows.
246 * The test harness machinery for detecting file descriptor leaks should now
247   work on any platform which has /dev/fd.
249 * Implement recursive delete of a database directory in the test harness
250   using nftw() if available (and not buggy like mingw64's seems to be), rather
251   than running "rm -rf" as an external command.  This avoids the overhead of
252   starting a new process each time we clean up a test database, which happens a
253   lot during a test run.
255 * Speed up generated test databases a little by adding a stat() check to avoid
256   throwing and catching an exception when the database doesn't yet exist.
258 * Skip timed tests when configured with --enable-log.  The logging can easily
259   turn O(1) operations into O(n), and that's hard to avoid.  Fixes
260   https://trac.xapian.org/ticket/757, reported by Guruprasad Hegde.
262 matcher:
264 * OP_VALUE_*: When a value slot's lower and upper bound are equal, we know
265   that exactly how many documents the subquery can match (either 0 or those
266   bounds).  This also avoids a division by zero which previously happened
267   when trying to calculate the estimate.
269 * Speed up sorting by keys.  Use string::compare() to avoid having to call
270   operator< if operator> returns false.
272 * Fix clamping of maxitems argument to get_mset() - it was being clamped
273   to db.get_doccount(), now it's clamped to db.get_doccount() - first.  In
274   practice this doesn't actually seem to cause any issues.
276 * If a match time limit is in effect, when it expires we now clamp
277   check_at_least to first + maxitems instead of to maxitems.  In practice this
278   also doesn't seem to actually cause any issues (at least we've failed to
279   construct a testcase where it actually makes an observable difference).
281 * Fix percentages when only some shards have positions.  If the final shard
282   didn't have positions this would lead to under-counting the total number leaf
283   of subqueries which would lead to incorrect positional calculations (and a
284   division by zero if the top level of the query was positional.  This bug was
285   introduced in 1.4.3.
287 * OP_NEAR: Fix "phantom positions", where OP_NEAR would think a term without
288   positional information occurred at position 1 if it had the lowest term
289   frequency amongst the OP_NEAR's subqueries.
291 * Fix termfreq used in weight calculations for a term occurring more than once
292   in the query.  Previously the termfreq for such terms was multiplied by the
293   number of different query positions they appeared at.
295 * OP_SYNONYM: We use the doclength upper bound for the wdf upper bound of a
296   synonym - now we avoid fetching it twice when the doclength upper bound is
297   explicitly needed.
299 * Short-cut init() when factor is 0 in most Weight subclasses.  This indicates
300   the object is for the term-independent weight contribution, which is always 0
301   for most schemes, so there's no point fetching any stats or doing any
302   calculations.  This fixes a divide by zero for TfIdfWeight, detected by
303   UBSan.
305 * OP_OR: Fix bug which caused orcheck1 to fail once hooked up to run with the
306   inmemory backend.
308 glass backend:
310 * Fix glass freelist bug when changes to a new database which didn't modify the
311   termlist table were committed.  In this corner case, a block which had been
312   allocated to be the root block in the termlist table was leaked.  This was
313   largely harmless, except that it was detected by Database::check() and caused
314   it to report an error.  Reported by Antoine Beaupré and David Bremner.
316 * Fix glass freelist bug with cancel_transaction().  The freelist wasn't
317   reset to how it was before the transaction, resulting in leaked blocks.
318   This was largely harmless, except that it was detected by Database::check()
319   and caused it to report an error.
321 * Improve the per-term wdf upper bound.  Previously we used min(cf(term),
322   wdf_upper_bound(db)) which is tight for any terms which attain that
323   upper bound, and also for terms with termfreq == 1 (the latter are common
324   in the database (e.g. 66% for a database of wikipedia), but probably
325   much less common in searches).  When termfreq > 1 we now use
326   max(first_wdf(term), cf(term) - first_wdf(term)), which means terms with
327   termfreq == 2 will also attain their bound (another 11% for the same
328   database) while terms with higher termfreq but below the global bound will
329   get a tighter bound.
331 * Fix Database::locked() on single-file glass db to just return false (such
332   databases can't be opened as a WritableDatabase so there can't be a write
333   lock).  Previously this failed with: "DatabaseLockError: Unable to get write
334   lock on /flintlock: Testing lock"
336 * Fix compaction when both the input and output are specified as a file
337   descriptor.  Previously this threw an exception due to an overeager check
338   that destination != source.
340 * Use O_TRUNC when compacting to single file.  If the output already exists but
341   is larger than our output we don't want to just overwrite the start of it.
342   This case also used to result in confusing compaction percentages.
344 * Enable glass's "open_nearby_postlist" optimisation (which especially helps
345   large wildcard queries) for writable databases without any uncommitted
346   changes as well.
348 * Make get_unique_terms() more efficient for glass.  We approximate
349   get_unique_terms() by the length of the termlist (which counts boolean terms
350   too) but clamp this to be no larger than the document length.  Since we need
351   to open the termlist to get its length, it makes more sense to get the
352   document length from that termlist for no extra cost rather than looking it
353   up in the postlist table.
355 * Database::check() now checks document lengths against the stored document
356   length lower and upper bounds.  Patch from Uppinder Chugh.  Fixes
357   https://trac.xapian.org/ticket/617.
359 * Fix bogus handling of most-recently-read value slot statistics.  It seems
360   that we get lucky and this can't actually cause a problem in practice due
361   to another layer of caching above, but if nothing else it's a bug waiting to
362   happen.
364 * If we fail to create the directory for a new database because the path
365   already exists, the exception now reports EEXIST as the errno value rather
366   than whatever errno value happened to be set from an earlier library call.
368 remote backend:
370 * xapian-tcpsrv --one-shot no longer forks.  We need fork to handle multiple
371   concurrent connections, but when handling a single connection forking just
372   adds overhead and potentially complicates process management for our caller.
373   This aligns with the behaviour under __WIN32__ where we use threads instead
374   of forking, and service the connection from the main thread with --one-shot.
376 * Fix repeat call to ValueIterator::check() on the same docid to not always
377   set valid to true for remote backend.
379 inmemory backend:
381 * Fix repeat call to ValueIterator::check() on the same docid to not always
382   set valid to true for inmemory backend.
384 build system:
386 * configure: Fix potentially confusing messages suggesting snprintf was added
387   in C90 - it was actually standardised in C99.
389 * Eliminate configure probes related to off_t by using C++11 features.
391 * The installed xapian-config script is now cleaned up by removing code to
392   handle use before installation.  This extra code contained build paths
393   which meant the build wasn't bit-for-bit reproducible unless the same
394   build directory name was used.  This change also eliminates use of
395   automake's $(transform) (which seems to be intended an internal mechanism)
396   and fixes "make uninstall" to remove xapian-config when a program-prefix or
397   -suffix is in use (e.g. there's a default -1.5 suffix for git master
398   currently).
400 * Directory separator knowledge is now factored out into configure, based on
401   $host_os and __WIN32__ (it seems hard to probe for this in a way which works
402   when cross-compiling).
404 * Fix build with --disable-backend-remote.
406 * In an out-of-tree build configured with --enable-maintainer-mode
407   and --disable-dependency-tracking we would fail to create the
408   "tests/soaktest" and "unicode" directories in the build directory.
409   Patch from Gaurav Arora.
411 * Improve handling of multitarget rule stamp files.  Clean them on "make
412   maintainer-clean" and ship them so that --enable-maintainer-mode when
413   building from a tarball doesn't needlessly rerun the multitarget rules.
415 * Split out allsnowballheaders.h again to avoid include path issues with
416   unittest in out-of-tree maintainer-mode builds.
418 * xapian-core.pc: Both the Name and Description were too long compared to
419   pkg-config norms, and the Description was trying to be multi-line which it
420   seems pkg-config doesn't support.  Fixes
421   https://github.com/xapian/xapian/pull/203, reported by orbea.
423 documentation:
425 * Stop describing Xapian as "Probabilistic" - we've also had non-probabilistic
426   weighting schemes since 1.3.2.
428 * Improve API docs for MSet::snippet().
430 * Correct some class names in doxygen file documentation comments.
432 * Mark up shell command as code-block:: sh.
434 tools:
436 * xapian-delve:
438   + Document values can contain binary data, so escape them by default for
439     output.  Other options now supported are to decode as a packed integer
440     (like omindex uses for last modified), decode using
441     Xapian::sortable_unserialise(), and to show the raw form (which was the
442     previous behaviour).
444   + Report current database revision.
446 * xapian-inspect:
448   + Report entry count when opening table
450   + Support inspecting single file DBs via a new --table option (which can also
451     be used with a non-single-file DB instead of specifying the path to the
452     table).
454   + Add "first" and "last" commands which jump to the first/last entry in the
455     current table respectively.
457   + "until" now counts and reports the number of entries advanced by.
459   + Document "until" with no arguments - this advances to the end of the table,
460     but wasn't mentioned in the help.
462   + Commands "goto" and "until" which take a key as an argument now expect the
463     key in the same escaped form that's used for display.  This makes it much
464     simpler to interact with tables with binary keys.
466   + Fix to expect .glass not .DB extension of glass tables.
468 portability:
470 * Sort out building using MSVC with the standard build system, and fix assorted
471   problems.  MSVC 2015 or later is required for decent C++11 support.  Both 32-
472   and 64-bit builds are now supported.
474 * Remove code specific to old MSVC nmake build system.  The latter has been
475   removed already.
477 * Don't use WIN32 API to parse/unparse UUIDs.  So much glue code is needed that
478   it's simpler to just do the parsing and unparsing ourselves, and we already
479   have an implementation which is used when generating UUIDs using /proc on
480   Linux.  We still use UuidCreate() to generate a new UUID.
482 * Improve compiler visibility attribute detection to check that using the
483   attributes doesn't result in a warning - previously we'd enable them even on
484   platforms which don't support them, which would result in a compiler warning
485   for every file compiled.  We now probe for -fvisibility=hidden and
486   -fvisibility-inlines-hidden together as it seems all compilers implement both
487   or neither, and it's faster to do one probe instead of two.
489 * Don't pass the same FDSET twice in same select() - this appears not to be
490   allowed by current POSIX, and causes warnings with GCC8.
492 * Fix compacttofd testcases to specify O_BINARY so they pass on platforms
493   where O_BINARY matters.
495 * configure: Probe for declaration of _putenv_s.  It seems that the symbol is
496   always present in the MSVCRT DLL, but older mingw may not provide a
497   declaration for it.
499 * Fix "may be used uninitialised" warning with GCC 4.9.2 and -Os.
501 * Suppress mingw32 deprecation warning for useconds_t.  We've already switched
502   away from useconds_t on git master, but it's not easy to do for 1.4.x without
503   ABI breakage.
505 * Fix signed vs unsigned warnings with assertions on.
507 * Use $(SED) instead of hard-coding "sed".  The rules concerned are all ones
508   that only maintainers currently need to run, but we're likely to enable
509   maintainer-mode by default at some point and then portability here will
510   matter more.
512 * Add missing explicit <algorithm> for std::max()/std::min().
514 * Check for EAGAIN as well as EINTR from select().  The Linux select(2) man
515   page says: "Portable programs may wish to check for EAGAIN and loop, just as
516   with EINTR" and that seems to be necessary for Cygwin at least.
518 * Probe for exp10() declaration as Cygwin seems to have the symbol but lacks a
519   declaration in the headers.  Just ignoring it is simplest and we'll use GCC's
520   __builtin_exp10() instead.
522 * Fix warnings when building Snowball compiler with recent GCC.
524 * Fix Perl script used during maintainer builds to work with Perl < 5.10.  Such
525   old perl versions shouldn't really be relevant for maintainer builds at this
526   point, but appveyor's mingw install has such a Perl version.
528 * Remove unused macro STATIC_ASSERT_TYPE_DOMINATES (unused, except by
529   internaltest unit test for it, since the flint backend was removed in 2011)
530   and replace uses of STATIC_ASSERT_UNSIGNED_TYPE with C++11 features
531   static_assert and std::is_unsigned instead.
533 * Don't retry on (errno == EINTR) when read() or pread() indicates end-of-file.
534   This could potentially have put us into an infinite loop if we encountered
535   this situation and errno happened to be EINTR from a previous library call.
537 * Make read-only data arrays consistently static and const.
539 * Avoid casting invalid value to enum reply_type if an invalid reply code is
540   received from a remote server.  This is technically undefined behaviour,
541   though in practice probably not a problem.
543 * Eliminate an array of function pointers and some char* array members in
544   library, reducing the number of relocations needed at shared library load
545   time, which reduces the total time to load the library.
547 packaging:
549 * Use https for tarball URLs in .spec files.  This provides protection against
550   MITM attacks on people building packages using these spec files, and is also
551   slightly more efficient as the http: URLs redirect to the https: versions
552   anyway.
554 debug code:
556 * Fix build when configured with --enable-log due to bugs in debug logging
557   annotations.  Patch from Uppinder Chugh.
559 * Fix assertion for value range on empty slot.
561 * Use AssertEq() rather than Assert with ==, the former reports the two
562   values if the assertion fails.
564 Xapian-core 1.4.5 (2017-10-16):
566 API:
568 * Add Database::get_total_length() method.  Previously you had to calculate
569   this from get_avlength() and get_doccount(), taking into account rounding
570   issues.  But even then you couldn't reliably get the exact value when total
571   length is large since a double's mantissa has more limited precision than an
572   unsigned long long.
574 * Add Xapian::iterator_rewound() for bidirectional iterators, to test if the
575   iterator is at the start (useful for testing whether we're done when
576   iterating backwards).
578 * DatabaseOpeningError exceptions now provide errno via get_error_string()
579   rather than turning it into a string and including it in the exception
580   message.
582 * WritableDatabase::replace_document(): when passed a Document object which
583   came from a database and has unmodified values, we used to always read
584   those values into a memory structure.  Now we only do this if the document
585   is being replaced to the same document ID which it came from, which should
586   make other cases a bit more efficient.
588 * Enquire::get_eset(): When approximating term frequencies we now round to the
589   nearest integer - previously we always rounded down.
591 testsuite:
593 * Improve Xapian::Document test coverage.
595 * Pass --child-silent-after-fork=yes to valgrind which stops us creating a
596   .valgrind.log.* file for every remote testcase run.  This option was added in
597   valgrind 3.3.0 which is already the minimum version we support.
599 * Open and unlink valgrind log before option parsing so we no longer leave a
600   log file behind if there's an error parsing options or for options like
601   --help which report and exit.
603 * Delete .valgrind.log.* on "make clean" - if tests are run under valgrind and
604   the test is killed at just the wrong moment then a log file may be left
605   behind.
607 * Fix the NetworkError with ECHILD check added in 1.4.4 - this will no longer
608   segfault if the test harness catches a NetworkError without an error string.
610 matcher:
612 * Iterating of positions has been sped up, which means phrase matching is now
613   faster (by a little over 5% in some simple tests).
615 * Fix use after free of QueryOptimiser hint in certain cases involving
616   multiple databases only some of which have positional information.
617   This bug was introduced by changes in xapian-core 1.4.3.  Fixes #752,
618   reported and analysed by Robert Stepanek.
620 * An unweighted OP_AND_MAYBE is now optimised to just its left branch - the
621   other branch or branches only contribute weight, so can be completely ignored
622   when the operator is unweighted.
624 inmemory backend:
626 * Use binary chop instead of linear search in all places where we're searching
627   for a term or document - we weren't taking advantage of the sorted order
628   everywhere.
630 build system:
632 * xapian-core.pc: Specify Libs.private in pkgconfig file, which is needed for
633   static linking, and probably also for shared libraries on platforms without
634   DT_NEEDED or something equivalent.  Fixes #751, reported by Matthieu Gautier.
636 documentation:
638 * Document that QueryParser::set_default_op() supports OP_MAX - this
639   has been the case since OP_MAX was added, but the API docs for
640   set_default_op() weren't updated to reflect this.
642 * Document OP_MAX and OP_WILDCARD.
644 * Fix documentation of TermGenerator stop_strategy values STOP_ALL and
645   STOP_STEMMED.  Reported by Matthieu Gautier in #750.  Thanks to Gaurav Arora
646   for additional investigation.
648 * net/remote_protocol.rst: Update the current version of the remote protocol
649   version (39 not 38).  The differences between the two are only in the Query
650   and MSet serialisations which aren't documented in detail here.
652 * Link get_unique_terms_begin() and get_terms_begin() API documentation -
653   the cross-referencing is useful in itself, but also helps to highlight
654   the difference between the two.
656 * Fix "IPv5" -> "IPv6" comment typo.  Noted by James Clarke
658 * deprecation.html:
660   + Add deprecated Enquire::get_eset() overload - this was marked as deprecated
661     in the header file, but hadn't been added here.
663   + Move deprecated typedefs to the "to be removed" list - they'd been
664     accidentally added to the "removed" list.
666   + Improve descriptions of several deprecated features.
668 * QueryParser::set_max_expansion() is now discussed in the API documentation
669   instead of the deprecated set_max_wildcard_expansion().
671 * Clarify PostList::check() API documentation:  If valid is set to false, then
672   NULL must be returned (pruning in this situation doesn't make sense) and
673   at_end() shouldn't be called (because it implicitly depends on the current
674   position being valid).
676 * HACKING:
678   + Update re -Wold-style-cast which we enabled and then had to disable again.
680   + Update links to C++ FAQ and libstdc++'s debug mode.
682   + Update several URLs to use https.
684   + The 1.2 release branch has now been retired, so remove 1.2-specific
685     backporting tips.
687 portability:
689 * Also check <errno.h> for sys_nerr and sys_errlist.  This is probably a more
690   common location for them than Linux's <stdio.h> (even on Linux the man page
691   says they're in <errno.h> but that doesn't match reality).
693 * Use $(CC) not $(CC_FOR_BUILD) to build zlib-vg.so.  The test for whether we
694   need it is based on the host OS, so it makes more sense to use the host
695   compiler to build it when cross compiling.
697 * On Hurd F_GETLK currently always fails with errno set to ENOSYS - treat this
698   the same way as ENOLCK.  This fixes the testsuite on GNU Hurd, broken since
699   the addition on Database::locked() in 1.4.3.
701 * Add missing #include "safesyssocket.h", needed on at least FreeBSD to get
702   AF_INET and SOCK_STREAM defined.  Fixes
703   https://github.com/xapian/xapian/pull/154, reported by Po-Chuan Hsieh
704   (alternative fix applied was suggested by James Aylett).
706 * configure: Fixed the probe for whether the test harness can use RTTI with
707   IBM's xlC compiler (which defaults to not generating RTTI).  Previously the
708   probe would always think RTTI was available.
710 debug code:
712 * Fix some incorrect class/method names in debug logging.
714 * Stop disabling ccache for coverage builds as ccache 3.2.2 now supports
715   caching compilations with --coverage, and they work as far back as ccache 3.0
716   (caching is automatically disabled by these older versions).
718 * Drop --enable-quiet from in COVERAGE_CONFIGURE - this option no longer does
719   anything since 1.3.1.
721 Xapian-core 1.4.4 (2017-04-19):
723 API:
725 * Database::check():
727   + Fix checking a single table - changes in 1.4.2 broke such checks unless you
728     specified the table without any extension.
730   + Errors from failing to find the file specified are now thrown as
731     DatabaseOpeningError (was DatabaseError, of which DatabaseOpeningError is
732     a subclass so existing code should continue to work).  Also improved the
733     error message when the file doesn't exist is better.
735 * Drop OP_SCALE_WEIGHT over OP_VALUE_RANGE, OP_VALUE_GE and OP_VALUE_LE in the
736   Query constructor.  These operators always return weight 0 so OP_SCALE_WEIGHT
737   over them has no effect.  Eliminating it at query construction time is cheap
738   (we only need to check the type of the subquery), eliminates the confusing
739   "0 * " from the query description, and means the OP_SCALE_WEIGHT Query object
740   can be released sooner.  Inspired by Shivanshu Chauhan asking about the query
741   description on IRC.
743 * Drop OP_SCALE_WEIGHT on the right side of OP_AND_NOT in the Query
744   constructor.  OP_AND_NOT takes no weight from the right so OP_SCALE_WEIGHT
745   has no effect there.  Eliminating it at query construction time is cheap
746   (just need to check the subquery's type), eliminates the confusing "0 * "
747   from the query description, and means the OP_SCALE_WEIGHT object can be
748   released sooner.
750 testsuite:
752 * Add more tests of Database::check().  Fixes #238, reported by Richard
753   Boulton.
755 * Make apitest testcase nosuchdb1 fail if we manage to open the DB.
757 * Skip testcases which throw NetworkError with errno value ECHILD - this
758   indicates system resource starvation rather than a Xapian bug.  Such failures
759   are seen on Debian buildds from time to time, see:
760   https://bugs.debian.org/681941
762 matcher:
764 * Fix incorrect results due to uninitialised memory.  The array holding max
765   weight values in MultiAndPostList is never initialised if the operator is
766   unweighted, but the values are still used to calculate the max weight to pass
767   to subqueries, leading to incorrect results.  This can be observed with an OR
768   under an unweighted AND (e.g. OR under AND on the right side of AND_NOT).
769   The fix applied is to simply default initialise this array, which should lead
770   to a max weight of 0.0 being passed on to subqueries.  Bug reported in
771   notmuch by Kirill A. Shutemov, and forwarded by David Bremner.
773 documentation:
775 * Correct "Query::feature_flag" -> "QueryParser::feature_flag".  Fixes #747,
776   reported by James Aylett.
778 * Rename set_metadata() `value` parameter to `metadata`.  This change is
779   particularly motivated by making it easier to map this case specially in SWIG
780   bindings, but the new name is also clearer and better documents its purpose.
782 * Rename value range parameters.  The new names (`range_limit` instead of
783   `limit`, `range_lower` instead of `begin` and `range_upper` instead of `end`)
784   are particularly motivated by making it easier to map them specially in SWIG
785   bindings, but they're also clearer names which better document their
786   purposes.
788 * Change "(key, tag)" to "(key, value)" in user metadata docs.  The user
789   metadata is essentially what's often called a "key-value store" so users
790   are likely to be familiar with that terminology.
792 * Consistently name parameter of Weight::unserialise() overridden forms.
793   In xapian/weight.h it was almost always named `serialised`, but LMWeight
794   named it `s` and CoordWeight omitted the name.
796 * Fix various minor documentation comment typos.
798 portability:
800 * Fix configure probe for __builtin_exp10() to work around bug on mingw - there
801   GCC generates a call to exp10() for __builtin_exp10() but there is no exp10()
802   function in the C library, so we get a link failure.  Use a full link test
803   instead to avoid this issue.  Reported by Mario Emmenlauer on xapian-devel.
805 * Fix configure probe for log2() which was failing on at least some platforms
806   due to ambiguity between overloaded forms of log2().  Make the probe
807   explicitly check for log2(double) to avoid this problem.
809 * Workaround the unhelpful semantics of AI_ADDRCONFIG on platforms which follow
810   the old RFC instead of POSIX (such as Linux) - if only loopback networking is
811   configured, localhost won't resolve by name or IP address, which causes
812   testsuites using the remote backend over localhost to fail in auto-build
813   environments which deliberately disable networking during builds.  The
814   workaround implemented is to check if the hostname is "::1", "127.0.0.1" or
815   "localhost" and disable AI_ADDRCONFIG for these.  This doesn't catch all
816   possible ways to specify localhost, but should catch all the ways these might
817   be specified in a testsuite.  Fixes https://bugs.debian.org/853107, reported
818   by Daniel Schepler and the root cause uncovered by James Clarke.
820 debug code:
822 * Adjust assertion in InMemoryPostList.  Calling skip_to() is fine when the
823   postlist hasn't been started yet (but the assertion was failing for a term
824   not in the database).  Latent bug, triggered by testcases complexphrase1 and
825   complexnear1 as updated for addition of support for OP_OR subqueries of
826   OP_PHRASE/OP_NEAR.
828 Xapian-core 1.4.3 (2017-01-25):
830 API:
832 * MSet::snippet(): Favour candidate snippets which contain more of a diversity
833   of matching terms by discounting the relevance of repeated terms using an
834   exponential decay.  A snippet which contains more terms from the query is
835   likely to be better than one which contains the same term or terms multiple
836   times, but a repeated term is still interesting, just less with each
837   additional appearance.  Diversity issue highlighted by Robert Stepanek's
838   patch in https://github.com/xapian/xapian/pull/117 - testcases taken from his
839   patch.
841 * MSet::snippet(): New flag SNIPPET_EMPTY_WITHOUT_MATCH to get an empty snippet
842   if there are no matches in the text passed in.  Implemented by Robert
843   Stepanek.
845 * Round MSet::get_matches_estimated() to an appropriate number of significant
846   figures.  The algorithm used looks at the lower and upper bound and where the
847   estimate sits between them, and then picks an appropriate number of
848   significant figures.  Thanks to Sébastien Le Callonnec for help sorting out a
849   portability issue on OS X.
851 * Add Database::locked() method - where possible this non-invasively checks if
852   the database is currently open for writing, which can be useful for
853   dashboards and other status reporting tools.
855 testsuite:
857 * Use terms that exist in the database for most snippet tests.  It's good to
858   test that snippet highlighting works for terms that aren't in the database,
859   but it's not good for all our snippet tests to feature such terms - it's
860   not the common usage.
862 matcher:
864 * Improve value range upper bound and estimated matches.  The value slot
865   frequency provides a tighter upper bound than Database::get_doccount().
866   The estimate is now calculated by working out the proportion of possible
867   values between the slot lower and upper bounds which the range covers
868   (assuming a uniform distribution).  This seems to work fairly well in
869   practice, and is certainly better than the crude estimate we were using:
870   Database::get_doccount() / 2
872 * Handle arbitrary combinations of OP_OR under OP_NEAR/OP_PHRASE, partly
873   addressing #508.  Thanks to Jean-Francois Dockes for motivation and testing.
875 * Only convert OP_PHRASE to OP_AND if full DB has no positions.  Until now the
876   conversion was done independently for each sub-database, but being consistent
877   with the results from a database containing all the same documents seems more
878   useful.
880 * Avoid double get_wdf() call for first subquery of OP_NEAR and OP_PHRASE,
881   which will speed them up by a small amount.
883 documentation:
885 * INSTALL: Update section about -Bsymbolic-functions which is not a new
886   GNU ld feature at this point.
888 tools:
890 * xapian-delve: Uses new Database::locked() method to report if the database
891   is currently locked.
893 portability:
895 * Fix build failure cross-compiling for android due to not pulling in header
896   for errno.
898 * Fix compiler warnings.
900 Xapian-core 1.4.2 (2016-12-26):
902 API:
904 * Add XAPIAN_AT_LEAST(A,B,C) macro.
906 * MSet::snippet(): Optimise snippet generation - it's now ~46% faster in a
907   simple test.
909 * Add Xapian::DOC_ASSUME_VALID flag which tells Database::get_document() that
910   it doesn't need to check that the passed docid is valid.  Fixes #739,
911   reported by Germán M. Bravo.
913 * TfIdfWeight: Add support for the L wdf normalisation.  Patch from Vivek Pal.
915 * BB2Weight: Fix weights when database has just one document.  Our existing
916   attempt to clamp N to be at least 2 was ineffective due to computing
917   N - 2 < 0 in an unsigned type.
919 * DPHWeight: Fix reversed sign in quadratic formula, making the upper bound a
920   tiny amount higher.
922 * DLHWeight: Correct upper bound which was a bit too low, due to flawed logic
923   in its derivation.  The new bound is slightly less tight (by a few percent).
925 * DLHWeight,DPHWeight: Avoid calculating log(0) when wdf is equal to the
926   document length.
928 * TermGenerator: Handle stemmer returning empty string - the Arabic stemmer
929   can currently do this (e.g. for a single tatweel) and user stemmers can too.
930   Fixes #741, reported by Emmanuel Engelhart.
932 * Database::check(): Fix check that the first docid in each doclength chunk is
933   more than the last docid in the previous chunk - this code was in the wrong
934   place so didn't actually work.
936 * Database::get_unique_terms(): Clamp returned value to be <= document length.
937   Ideally get_unique_terms() ought to only count terms with wdf > 0, but that's
938   expensive to calculate on demand.
940 glass backend:
942 * When compacting we now only write the iamglass file out once, and we write it
943   before we sync the tables but sync it after, which is more I/O friendly.
945 * Database::check(): Fix in SEGV when out == NULL and opts != 0.
947 * Fix potential SEGV with corrupt value stats.
949 chert backend:
951 * Fix potential SEGV with corrupt value stats.
953 build system:
955 * Add XO_REQUIRE autoconf macro to provide an easy way to handle version checks
956   in user configure scripts.
958 tools:
960 * quest: Support BM25+, LM and PL2+ weighting schemes.
962 * xapian-check: Fix when ellipses are shown in 't' mode.  They were being shown
963   when there were exactly 6 entries, but we only start omitting entries when
964   there are *more* than 6.  Fix applies to both glass and chert.
966 portability:
968 * Avoid using opendir()/readdir() in our closefrom() implementation as these
969   functions can call malloc(), which isn't safe to do between fork() and exec()
970   in a multi-threaded program, but after fork() is exactly where we want to
971   use closefrom().  Instead we now use getdirentries() on Linux and
972   getdirentriesattr() on OS X (OS X support bugs shaken out with help from
973   Germán M. Bravo).
975 * Support reading UUIDs from /proc/sys/kernel/random/uuid which is especially
976   useful when building for Android, as it avoids having to cross-build a UUID
977   library.
979 * Disable volatile workaround for excess precision SEGV for SSE - previously it
980   was only being disabled for SSE2.
982 * When building for x86 using a compiler where we don't know how to disable
983   use of 387 FP instructions, we now run remote servers for the testsuite under
984   valgrind --tool=none, like we do when --disable-sse is explicitly specified.
986 * Add alignment_cast<T> which has the same effect as reinterpret_cast<T> but
987   avoids warnings about alignment issues.
989 * Suppress warnings about unused private members.  DLHWeight and DPHWeight
990   have an unused lower_bound member, which clang warns about, but we need to
991   keep them there in 1.4.x to preserve ABI compatibility.
993 * Remove workaround for g++ 2.95 bug as we require at least 4.7 now.
995 * configure: Probe for <cxxabi.h>.  GCC added this header in GCC 3.1, which
996   is much older than we support, so we've just assumed it was available if
997   __GNUC__ was defined.  However, clang lies and defines __GNUC__ yet doesn't
998   seem to reliably provide <cxxabi.h>, so we need to probe for it.
1000 * Fix "unused assignment" warning.
1002 * configure: Probe for __builtin_* functions.  Previously we just checked for
1003   __GNUC__ being defined, but it's cleaner to probe for them properly -
1004   compilers other than GCC and those that pretend to be GCC might provide these
1005   too.
1007 * Use __builtin_clz() with compilers which support it to speed up encoding
1008   and especially decoding of positional data.  This speeds up phrase searching
1009   by ~0.5% in a simple test.
1011 * Check signed right shift behaviour at compile time - we can use a test on a
1012   constant expression which should optimise away to just the required version
1013   of the code, which means that on platforms which perform sign-extension
1014   (pretty much everything current it seems) we don't have to rely on the
1015   compiler optimising a portable idiom down to the appropriate right shift
1016   instruction.
1018 * Improve configure check for log2().  We include <cmath> so the check really
1019   should succeed if only std::log2() is declared.
1021 * Enable win32-dll option to LT_INIT.
1023 debug code:
1025 * xapian-inspect:
1027   + Support glass instead of chert.
1029   + Allow control of showing keys/tags.
1031   + Use more mnemonic letters than X for command arguments in help.
1033 Xapian-core 1.4.1 (2016-10-21):
1035 API:
1037 * Constructing a Query for a non-reference counted PostingSource object will
1038   now try to clone the PostingSource object (as happened in 1.3.4 and
1039   earlier).  This clone code was removed as part of the changes in 1.3.5 to
1040   support optional reference counting of PostingSource objects, but that breaks
1041   the case when the PostingSource object is on the stack and goes out of scope
1042   before the Query object is used.  Issue reported by Till Schäfer and analysed
1043   by Daniel Vrátil in a bug report against Akonadi:
1044   https://bugs.kde.org/show_bug.cgi?id=363741
1046 * Add BM25PlusWeight class implementing the BM25+ weighting scheme, implemented
1047   by Vivek Pal (https://github.com/xapian/xapian/pull/104).
1049 * Add PL2PlusWeight class implementing the PL2+ weighting scheme, implemented
1050   by Vivek Pal (https://github.com/xapian/xapian/pull/108).
1052 * LMWeight: Implement Dir+ weighting scheme as DIRICHLET_PLUS_SMOOTHING.
1053   Patch from Vivek Pal.
1055 * Add CoordWeight class implementing coordinate matching.  This can be useful
1056   for specialised uses - e.g. to implement sorting by the number of matching
1057   filters.
1059 * DLHWeight,DPHWeight,PL2Weight: With these weighting schemes, the formulae
1060   can give a negative weight contribution for a term in extreme cases.  We
1061   used to try to handle this by calculating a per-term lower bound on the
1062   contribution and subtracting this from the contribution, but this idea
1063   is fundamentally flawed as the total offset it adds to a document depends on
1064   what combination of terms that document matches, meaning in general the
1065   offset isn't the same for every matching document.  So instead we now clamp
1066   each term's weight contribution to be >= 0.
1068 * TfIdfWeight: Always scale term weight by wqf - this seems the logical
1069   approach as it matches the weighting we'd get if we weighted every non-unique
1070   term in the query, as well as being explicit in the Piv+ formula.
1072 * Fix OP_SCALE_WEIGHT to work with all weighting schemes - previously it was
1073   ignored when using PL2Weight and LMWeight.
1075 * PL2Weight: Greatly improve upper bound on weight:
1076   + Split the weight equation into two parts and maximise each separately as
1077     that gives an easily solvable problem, and in common cases the maximum is
1078     at the same value of wdfn for both parts.  In a simple test, the upper
1079     bounds are now just over double the highest weight actually achieved -
1080     previously they were several hundred times.  This approach was suggested by
1081     Aarsh Shah in: https://github.com/xapian/xapian/pull/48
1082   + Improve upper bound on normalised wdf (wdfn) - when wdf_upper_bound >
1083     doclength_lower_bound, we get a tighter bound by evaluating at
1084     wdf=wdf_upper_bound.  In a simple test, this reduces the upper bound on
1085     wdfn by 36-64%, and the upper bound on the weight by 9-33%.
1087 * PL2Weight: Fix calculation of upper_bound when P2>0.  P2 is typically
1088   negative, but for a very common term it can be positive and then we should
1089   use wdfn_lower not wdfn_upper to adjust P_max.
1091 * Weight::unserialise(): Check serialised form is empty when unserialising
1092   parameter-free schemes BoolWeight, DLHWeight and DPHWeight.
1094 * TermGenerator::set_stopper_strategy(): New method to control how the Stopper
1095   object is used.  Patch from Arnav Jain.
1097 * QueryParser: Fix handling of CJK query over multiple prefixes.  Previously
1098   all the n-gram terms were AND-ed together - now we AND together for each
1099   prefix, then OR the results.  Fixes #719, reported by Aaron Li.
1101 * Add Database::get_revision() method which provides access to the database
1102   revision number for chert and glass, intended for use by xapiand.  Marked
1103   as experimental, so we don't have to go through the usual deprecation cycle
1104   if this proves not to be the approach we want to take.  Fixes #709,
1105   reported by Germán M. Bravo.
1107 * Mark RangeProcessor constructor as `explicit`.
1109 testsuite:
1111 * OP_SCALE_WEIGHT: Check top weight is non-zero - if it is zero, tests which
1112   try to check that OP_SCALE_WEIGHT works will always pass.
1114 * testsuite: Check SerialisationError descriptions from Xapian::Weight
1115   subclasses mention the weighting scheme name.
1117 matcher:
1119 * Fix stats passed to Weight with OP_SYNONYM.  Previously the number of
1120   unique terms was never calculated, and a term which matched all documents
1121   would be optimised to an all-docs postlist, which fails to supply the
1122   correct wdf info.
1124 * Use floating point calculation for OR synonym freq estimates.  The division
1125   was being done as an integer division, which means the result was always
1126   getting rounded down rather than rounded to the nearest integer.
1128 glass backend:
1130 * Fix allterms with prefix on glass with uncommitted changes.  Glass aims to
1131   flush just the relevant postlist changes in this case but the end of the
1132   range to flush was wrong, so we'd only actually flush changes for a term
1133   exactly matching the prefix.  Fixes #721.
1135 remote backend:
1137 * Improve handling of invalid remote stub entries: Entries without a colon now
1138   give an error rather than being quietly skipped; IPv6 isn't yet supported,
1139   but entries with IPv6 addresses now result in saner errors (previously the
1140   colons confused the code which looks for a port number).
1142 build system:
1144 * XO_LIB_XAPIAN: Check for user trying to specify configure for XAPIAN_CONFIG
1145   and give a more helpful error.
1147 * Fix XO_LIB_XAPIAN to work without libtool.  Modern versions of GNU m4 error
1148   out when defn is used on an undefined macro.  Uncovered by Amanda Jayanetti.
1150 * Clean build paths out of installed xapian-config, mostly in the interests of
1151   facilitating reproducible builds, but it is also a little more robust as the
1152   "uninstalled tree" case can't then accidentally be triggered.
1154 * Drop compiler options that are no longer useful:
1155   + -fshow-column is the default in all GCC versions we now support
1156     (checked as GCC 4.6).
1157   + -Wno-long-long is no longer necessary now that we require C++11 where
1158     "long long" is a standard type.
1160 documentation:
1162 * Add API documentation comments for all classes, methods, constants, etc which
1163   were lacking them, and improve the content of some existing comments.
1165 * Stop hiding undocumented classes and members.  Hiding them silences doxygen's
1166   warnings about them, so it's hard to see what is missing, and the stub
1167   documentation produced is perhaps better than not documenting at all.
1168   Fixes #736, reported by James Aylett.
1170 * xapian-check: Make command line syntax consistent with other tools.
1172 * Note when MSet::snippet() was added.
1174 * deprecation.rst: Recommend unsigned over useconds_t for timeout values (but
1175   leave the API using useconds_t for 1.4.x for ABI compatibility.  The type
1176   useconds_t is now obsolete and anyway was intended to represent a time in
1177   microseconds (confusing when Xapian's timeouts are in milliseconds).  The
1178   Linux usleep man page notes: "Programs will be more portable if they never
1179   mention this type explicitly."
1181 portability:
1183 * Suppress compiler warnings about pointer alignment on some architectures.
1184   We know the data is aligned in these cases.
1186 * Fix replicate7 under Cygwin.
1188 debug code:
1190 * Add missing forward declaration needed by --enable-log build.
1192 Xapian-core 1.4.0 (2016-06-24):
1194 API:
1196 * Update to Unicode 9.0.0.
1198 portability:
1200 * Fix build on big-endian architectures.  The new unaligned word access
1201   functions expect WORDS_BIGENDIAN to be set, but configure.ac wasn't invoking
1202   AC_C_BIGENDIAN to arrange for this to be set.
1204 * Suppress compiler warnings about pointer alignment.  We know the data is
1205   suitably aligned, because the whole point of these functions is to allow
1206   reading an aligned word.
1208 Xapian-core 1.3.7 (2016-06-01):
1210 API:
1212 * Reimplement ESet and ESetIterator as we did for MSet and MSetIterator in
1213   1.3.5.  ESetIterator internally now counts down to the end of the ESet, so
1214   the end test is now against 0, rather than against eset.size().  And more of
1215   the trivial methods are now inlined, which reduces the number of relocations
1216   needed to load the library, and should give faster code which is a very
1217   similar size to before.
1219 * MSetIterator and ESetIterator are now STL-compatible random_access_iterators
1220   (previously they were only bidirectional_iterators).
1222 testsuite:
1224 * Merge queryparsertest and termgentest into apitest.  Their testcases now use
1225   the backend manager machinery in the testharness, so we don't have to
1226   hard-code use of inmemory and chert backends, but instead run them under all
1227   backends which support the required features.  This fixes some test failures
1228   when both chert and glass are disabled due to trying to run spelling tests
1229   with the inmemory backend.
1231 * Avoid overflowing collection frequency in totaldoclen1.  We're trying to test
1232   total document length doesn't wrap, so avoid collection freq overflowing in
1233   the process, as that triggers errors when running the testsuite under ubsan.
1234   We should handle collection frequency overflow better, but that's a separate
1235   issue.
1237 * Add some test coverage for ESet::get_ebound().
1239 matcher:
1241 * Fix upper bound on matches for OP_XOR.  Due to a reversed conditional, the
1242   estimate could be one too low in some cases where the XOR matched all the
1243   documents in the database.
1245 * Improve lower bound on matches for OP_XOR.  Previously the lower bound was
1246   always set to 0, which is valid, but we can often do better.
1248 glass backend:
1250 * Fix Database::check() parsing of glass changes file header.  In practice this
1251   was unlikely to actually cause problems.
1253 build system:
1255 * --disable-backend-remote now disables replication too which makes it
1256   actually usable (currently replication and the remote backend share most of
1257   their network code, so disabling them together probably makes sense anyway).
1259 * Improve builds with various combinations of backends disabled (see #361).
1261 portability:
1263 * Revert change to handle a self-initialised PIMPL object (e.g. Xapian::Query
1264   q(q);), added in 1.3.6.  It seems this case is actually undefined behaviour,
1265   so there's not much point trying to do anything about it.  Clang warns about
1266   the testcase for it (tested with 3.5), but sadly current GCC doesn't (tested
1267   with 6.1).
1269 * Use <cstdint> for integer types of known widths now we require C++11.
1271 * Replace unaligned word access functions with optimised versions which use
1272   memcpy() and (on little-endian platforms) a byte-swap (via compiler builtins
1273   where available).  Access revision numbers in database blocks with an aligned
1274   load, since we know they are suitably aligned.
1276 * Simplify handling of platforms where timer_create() exists but isn't
1277   suitable for our needs - AIX and GNU Hurd both have timer_create() but it
1278   always seems to fail (on Hurd this is because there's a dummy implementation
1279   in glibc which always fails with ENOSYS).  Trying a call at runtime which
1280   will never succeed is a waste of time, so we want to avoid defining
1281   HAVE_TIMER_CREATE in such cases.  Probing for this properly in configure
1282   would need us to compile and run a test program, which is unhelpful when
1283   cross-compiling, so for now just test against a blacklist of platforms we
1284   know don't provide a suitable timer_create() function.
1286 * Check _POSIX_MONOTONIC_CLOCK and if it's not defined, use CLOCK_REALTIME
1287   instead of CLOCK_MONOTONIC.  The existing hard-coded platform checks still
1288   seem to be needed, as on these platforms CLOCK_MONOTONIC is available for
1289   some functions, but doesn't work with timer_create() for one reason or
1290   another.  But the new check should avoid failures on platforms without any
1291   monotonic clock support.
1293 * Make opt_intrusive_base symbols visible to avoid UBSAN warnings.
1295 * Avoid potential set-but-unused warning - with both chert and glass disabled,
1296   last_docid's final set value isn't used, which GCC doesn't warn about, but
1297   other compilers might.
1299 * Avoid explicit recursive return of void - we've had warnings for such cases
1300   from some compilers in the past, and it's an odd thing to do outside of a
1301   template.
1303 Xapian-core 1.3.6 (2016-05-09):
1305 API:
1307 * TfIdfWeight: Support freq and squared IDF normalisations.  Patch from Vivek
1308   Pal.
1310 * New Xapian::Query::OP_INVALID to provide an "invalid" query object.
1312 * Reject OP_NEAR/OP_PHRASE with non-leaf subqueries early to avoid a
1313   potential segmentation fault if the non-leaf subquery decayed at
1314   just the wrong moment.  See #508.
1316 * Reduce positional queries with a MatchAll or PostingSource subquery to
1317   MatchNothing (since these subqueries have no positional information, so
1318   the query can't match).
1320 * Deprecate ValueRangeProcessor and introduce new RangeProcessor class as
1321   a replacement.  RangeProcessor()::operator()() method returns Xapian::Query,
1322   so a range can expand to any query.  OP_INVALID is used to signal that
1323   a range is not recognised.  Fixes #663.
1325 * Combining of ranges over the same quantity with OP_OR is now handled by
1326   an explicit "grouping" parameter, with a sensible default which works
1327   for value range queries.  Boolean term prefixes and FieldProcessor now
1328   support "grouping" too, so ranges and other filters can now be grouped
1329   together.
1331 * Formally deprecate WritableDatabase::flush().  The replacement commit()
1332   method was added in 1.1.0, so code can be switched to use this and still
1333   work with 1.2.x.
1335 * Fix handling of a self-initialised PIMPL object (e.g. Xapian::Query q(q);).
1336   Previously the uninitialised pointer was copied to itself, resulting in
1337   undefined behaviour when the object was used.  This isn't something you'd see
1338   in normal code, but it's a cheap check which can probably be optimised away
1339   by the compiler (GCC 6 does).
1341 testsuite:
1343 * Fix testcase notermlist1 to check correct table extension - ".glass" not
1344   ".DB" (chert doesn't support DB_NO_TERMLIST).
1346 build system:
1348 * Bootstrap with autoconf 2.69.  This requires GNU m4 >= 4.6, but that should
1349   no longer be an issue on developer machines.
1351 * Fix build with --enable-log.  Debug logging was trying to log
1352   compress_strategy parameter which was removed recently.  Reported by Ankit
1353   Paliwal on xapian-devel.
1355 documentation:
1357 * Fix misfiled deprecation notes.  Various things marked as deprecated and
1358   removed in 1.3.x have in fact been deprecated but not removed (they were just
1359   added to the wrong list).  One instance queried by David Bremner on #xapian,
1360   and a review found several more.
1362 * Improve docs for lcov makefile targets - say that these are targets in the
1363   xapian-core directory (noted by poe_ on #xapian), document
1364   coverage-reconfigure-maintainer-mode target, and clarify what the example of
1365   how to use GENHTML_ARGS actually does.
1367 * Note that Java bindings use xapian/iterator.h.
1369 * Update release checklist.  The script to build the release tarballs now
1370   automates some of the changes needed in trac.
1372 portability:
1374 * Fix build with Android NDK which declares sys_errlist and sys_nerr in the
1375   C library headers, but doesn't actually define them in the library itself.
1376   The configure test now tries to link a trivial program which uses these
1377   symbols.  Patch from Tejas Jogi.
1379 Xapian-core 1.3.5 (2016-04-01):
1381 This release includes all changes from 1.2.23 which are relevant.
1383 API:
1385 * The Snipper class has been replaced with a new MSet::snippet() method.
1386   The implementation has also been redone - the existing implementation was
1387   slower than ideal, and didn't directly consider the query so would sometimes
1388   selects a snippet which doesn't contain any of the query terms (which users
1389   quite reasonably found surprising).  The new implementation is faster, will
1390   always prefer snippets containing query terms, and also understands exact
1391   phrases and wildcards.  Fixes #211.
1393 * Add optional reference counting support for ErrorHandler, ExpandDecider,
1394   KeyMaker, PostingSource, Stopper and TermGenerator.  Fixes #186, reported
1395   by Richard Boulton.  (ErrorHandler's reference counting isn't actually used
1396   anywhere in xapian-core currently, but means we can hook it up in 1.4.x if
1397   ticket #3 gets addressed).
1399 * Deprecate public member variables of PostingSource.  The new getters and/or
1400   setters added in 1.2.23 and 1.3.5 are preferred.  Fixes #499, reported by
1401   Joost Cassee.
1403 * Reimplement MSet and MSetIterator.  MSetIterator internally now counts down
1404   to the end of the MSet, so the end test is now against 0, rather than against
1405   mset.size().  And more of the trivial methods are now inlined, which reduces
1406   the number of relocations needed to load the library, and should give faster
1407   code which is a very similar size to before.
1409 * Only issue prefetch hints for documents if MSet::fetch() is called.  It's not
1410   useful to send the prefetch hint right before the actual read, which was
1411   happening since the implementation of prefetch hints in 1.3.4.  Fixes #671,
1412   reported by Will Greenberg.
1414 * Fix OP_ELITE_SET selection in multi-database case - we were selecting
1415   different sets for each subdatabase, but removing the special case check for
1416   termfreq_max == 0 solves that.
1418 * Remove "experimental" marker from FieldProcessor, since we're happy with the
1419   API as-is.  Reported by David Bremner on xapian-discuss.
1421 * Remove "experimental" marker from Database::check().  We've not had any
1422   negative feedback on the current API.
1424 * Databse::check() now checks that doccount <= last_docid.
1426 * Database::compact() on a WritableDatabase with uncommitted changes could
1427   produce a corrupted output.  We now throw Xapian::InvalidOperationError in
1428   this case, with a message suggesting you either commit() or open the database
1429   from disk to compact from.  Reported by Will Greenberg on #xapian-discuss
1431 * Add Arabic stemmer.  Patch from Assem Chelli in
1432   https://github.com/xapian/xapian/pull/45
1434 * Improve the Arabic stopword list.  Patch from Assem Chelli.
1436 * Make functions defined in xapian/iterator.h 'inline'.
1438 * Don't force the user to specify the metric in the geospatial API -
1439   GreatCircleMetric is probably what most users will want, so a sensible
1440   default.
1442 * Xapian::DBCHECK_SHOW_BITMAP: This was added in 1.3.0 (so has never been in
1443   a stable release) and was superseded by Xapian::DBCHECK_SHOW_FREELIST in
1444   1.3.2, so just remove it.
1446 * Make setting an ErrorHandler a no-op - this feature is deprecated and we're
1447   not aware of anyone using it.  We're hoping to rework ErrorHandler in 1.4.x,
1448   which will be simpler without having to support the current behaviour as well
1449   as the new.  See #3.
1451 testsuite:
1453 * unittest: We can't use Assert() to unit test noexcept code as it throws an
1454   exception if it fails.  Instead set up macros to set a variable and return if
1455   an assertion fails in a unittest testcase, and check that variable in the
1456   harness.
1458 glass backend:
1460 * Make glass the default backend.  The format should now be stable, except
1461   perhaps in the unlikely event that a bug emerges which requires a format
1462   change to address.
1464 * Don't explicitly store the 2 byte "component_of" counter for the first
1465   component of every Btree entry in leaf blocks - instead use one of the upper
1466   bits of the length to store a "first component" flag.  This directly saves 2
1467   bytes per entry in the Btree, plus additional space due to fewer blocks and
1468   fewer levels being needed as a result.  This particularly helps the position
1469   table, which has a lot of entries, many of them very small.  The saving would
1470   be expected to be a little less than the saving from the change which shaved
1471   2 bytes of every Btree item in 1.3.4 (since that saved 2 bytes multiple times
1472   for large entries which get split into multiple items).  A simple test
1473   suggests a saving of several percent in total DB size, which fits that.  This
1474   change reduces the maximum component size to 8194, which affects tables
1475   with a 64KB blocksize in normal use and tables with >= 16KB blocksize with
1476   full compaction.
1478 * Refactor glass backend key comparison - == and < operations are replaced by
1479   a compare() function returns negative, 0 or positive (like strcmp(), memcmp()
1480   and std::string::compare()).  This allows us to avoid a final compare to
1481   check for equality when binary chopping, and to terminate early if the binary
1482   chop hits the exact entry.
1484 * If a cursor is moved to an entry which doesn't exist, we need to step back to
1485   the first component of previous entry before we can read its tag.  However we
1486   often don't actually read its tag (e.g. if we only wanted the key), so make
1487   this stepping back lazy so we can avoid doing it when we don't want to read
1488   the tag.
1490 * Avoid creating std::string objects to hold data when compressing and
1491   decompressing tags with zlib.
1493 * Store minimum compression length per table in the version file, with 0
1494   meaning "don't compress".  Currently you can only change this setting with a
1495   hex editor on the file, but now it is there we can later make use of it
1496   without needing a database format change.
1498 * Database::check() now performs additional consistency checks for glass.
1499   Reported by Jean-Francois Dockes and Bob Cargill via xapian-discuss.
1501 * Database::check(): check docids don't exceed db_last_docid when checking
1502   a single glass table.
1504 * We now throw DatabaseCorruptError in a few cases where it's appropriate
1505   but we didn't previously, in particular in the case where all the files in a
1506   DB have been truncated to zero size (which makes handling of this case
1507   consistent with chert).
1509 * Fix compaction to a single file which already exists.  This was hanging.
1510   Noted by Will Greenberg on #xapian.
1512 chert backend:
1514 * When using 64-bit Xapian::docid, consistently use the actual maximum valid
1515   docid value rather instead of the maximum value the type can hold.
1517 build system:
1519 * Default to only building shared libraries.  Building both shared and static
1520   means having to compile the files which make up the library twice on most
1521   platforms.  Shared libraries are the better option for most users, and if
1522   anyone really wants static libraries they can configure with --enable-static
1523   (or --enable-static=xapian-core if configuring a combined tree with the
1524   bindings).
1526 * Fix XAPIAN_TEST_LINKER_FLAG macro to actually test if it's possible to link
1527   with the option in LDFLAGS - previously we attempted to guess based on
1528   whether the error message from $CXX $flag contained the option name, which
1529   doesn't actually work very well.
1531 documentation:
1533 * Document that OP_WILDCARD expansion limits currently work per sub-db.
1535 * Remove reference to ChangeLog files, as we are no longer updating them.
1537 * Remove link to apidoc.pdf which we no longer generate this by default.
1539 * Clarify LatLongCoord::operator< purpose in API documentation.
1541 * Fix documentation comment typo - LatLongDistancePostingSource is a posting
1542   source, not a match decider!
1544 * HACKING: Recommend lcov 1.11 as it uses much less memory
1546 tools:
1548 * xapian-replicate: Obviously corrupt replicas now self-heal.  If a replica
1549   database fails to open with DatabaseCorruptError then a full copy is now
1550   forced.
1552 portability:
1554 * Eliminate arrays of C strings, which result in relocations at library load
1555   time, slowing startup and making pages containing them unsharable.
1557 * Refactor MSet::fetch() to reduce load time relocations.
1559 debug code:
1561 * Fix to build when configured with --enable-assertions.
1563 * Fix to build when configured with --enable-log.  Reported by Tim McNamara
1564   on #xapian-discuss.
1566 Xapian-core 1.3.4 (2016-01-01):
1568 This release includes all changes from 1.2.22 which are relevant.
1570 API:
1572 * Update to Unicode 8.0.0.  Fixes #680.
1574 * Overhaul database compaction API.  Add a Xapian::Database::compact() method,
1575   with the Database object specifying the source database(s).
1576   Xapian::Compactor is now just a functor to use if you want to control
1577   progress reporting and/or the merging of user metadata.  The existing API
1578   has been reimplemented using the new one, but is marked as deprecated.
1580 * Add support for a default value when sorting.  Fixes #452, patch from
1581   Richard Boulton.
1583 * Make all functor objects non-copyable.  Previously some were, some weren't,
1584   but it's hard to correctly make use of this ability.  Fixes #681.
1586 * Fix use after free with WILDCARD_LIMIT_MOST_FREQUENT.  If we tried to open a
1587   postlist after processing such a wildcard, the postlist hint could be
1588   pointing to a PostList object which had been deleted.  Fixes #696, reported
1589   by coventry.
1591 * Add support for optional reference counting of MatchSpy objects.
1593 * Improve Document::get_description() - the output is now always valid UTF-8,
1594   doesn't contain implementation details like "Document::Internal", and more
1595   clearly reports if the document is linked to a database.
1597 * Remove XAPIAN_CONST_FUNCTION marker from sortable_serialise_() helper, as it
1598   writes to the passed in buffer, so it isn't const or pure.  Fixes
1599   decvalwtsource2 testcase failure when compiled with clang.
1601 * Make PostingSource::set_maxweight() public - it's hard to wrap for the
1602   bindings as a protected method.  Fixes #498, reported by Richard Boulton.
1604 testsuite:
1606 * Add unit test for internal C_isupper(), etc functions.
1608 matcher:
1610 * Optimise value range which is a superset of the bounds.  If the value
1611   frequency is equal to the doccount, such a range is equivalent to MatchAll,
1612   and we now avoid having to read the valuestream at all.
1614 * Optimise OP_VALUE_RANGE when the upper bound can't be exceeded.  In this
1615   case, we now use ValueGePostList instead of ValueRangePostList.
1617 glass backend:
1619 * Shave 2 bytes of every Btree item (which will probably typically reduce
1620   database size by several percent).
1622 * More compact item format for branch blocks - 2 bytes per item smaller.  This
1623   means each branch block can branch more ways, reducing the number of Btree
1624   levels needed, which is especially helpful for cold-cache search times.
1626 * Track an upper bound on spelling word frequency.  This isn't currently used,
1627   but will be useful for improving the spelling algorithm, and we want to
1628   stabilise the glass backend format.  See #225, reported by Philip Neustrom.
1630 * Support 64-bit docids in the glass backend on-disk format.  This changes the
1631   encoding used by pack_uint_preserving_sort() to one which supports 64 bit
1632   values, and is a byte smaller for values 16384-32767, and the same size for
1633   all other 32 bit values.  Fixes #686, from original report by James Aylett.
1635 * Use memcpy() not memmove() when no risk of overlap.
1637 * Store length of just the key data itself, allowing keys to be up to 255 bytes
1638   long - the previous limit was 252.
1640 * Change glass to store DB stats in the version file.  Previously we stored
1641   them in a special item in the postlist table, but putting them in the version
1642   file reduces the number of block reads required to open the database, is
1643   simpler to deal with, and means we can potentially recalculate tight upper
1644   and lower bounds for an existing database without having to commit a new
1645   revision.
1647 * Add support for a single-file variant for glass.  Currently such databases
1648   can only be opened for reading - to create one you need to use
1649   xapian-compact (or its API equivalent).  You can embed such databases within
1650   another file, and open them by passing in a file descriptor open on that file
1651   and positioned at the offset the database starts at).  Database::check() also
1652   supports them.  Fixes #666, reported by Will Greenberg (and previously
1653   suggested on xapian-discuss by Emmanuel Engelhart).
1655 * Avoid potential DB corruption with full-compaction when using 64K blocks.
1657 * Where posix_fadvise() is available, use it to prefetch postlist Btree blocks
1658   from the level below the root block which will be needed for postlists of
1659   terms in the query, and similarly for the docdata table when MSet::fetch() is
1660   called.  Based on patch by Will Greenberg in #671.
1662 chert backend:
1664 * Where posix_fadvise() is available, use it to prefetch postlist Btree blocks
1665   from the level below the root block which will be needed for postlists of
1666   terms in the query, and similarly for the record table when MSet::fetch() is
1667   called.  Based on patch by Will Greenberg in #671.
1669 remote backend:
1671 * Fix hook for remote support of user weighting schemes.  The commented-out
1672   code used entirely the wrong class - now we use the server object we have
1673   access to, and forward the method to the class which needs it.
1675 build system:
1677 * New configure options --enable-64bit-docid and --enable-64bit-termcount,
1678   which control the size of these types.  Because these types are used in
1679   the API, libraries built with different combinations of them won't be ABI
1680   compatible.  Based heavily on patch from James Aylett and Dylan Griffith.
1681   Fixes #385.
1683 * Sort out hiding most of the internal symbols which had public visibility
1684   for various reason.  Mostly addresses #63.
1686 tools:
1688 * xapian-inspect: We no longer install this - it's really an aid to Xapian
1689   development rather than a user tool.
1691 portability:
1693 * Minimum supported GCC version is now documented as GCC 4.7, for C++11
1694   support.  Previously we documented 4.7 as the oldest known to work.
1696 * Use CLOCK_REALTIME with timer_create() on Cygwin.
1698 * Don't include winsock headers on Cygwin.  Instead include <arpa/inet.h> for
1699   htons() and htonl().
1701 * Handle AI_ADDRCONFIG not being defined by some mingw versions.
1703 * Fix to handle mingw now providing a nanosleep() function.
1705 * Use WSAAddressToString instead of inet_ntop under __WIN32__ - at least under
1706   mingw we don't seem to have inet_ntop().
1708 * Fix testsuite to compile when S_ISSOCK() isn't defined.
1710 debug code:
1712 * Add missing parameters to debug logging for a few methods.
1714 Xapian-core 1.3.3 (2015-06-01):
1716 This release includes all changes from 1.2.20-1.2.21 which are relevant.
1718 API:
1720 * Database:
1722   + Add new flag Xapian::DB_RETRY_LOCK which allows opening a database for
1723     writing to wait until it can get a write lock.  (Fixes #275, reported by
1724     Richard Boulton).
1726   + Fix Database::get_doclength_lower_bound() over multiple databases when some
1727     are empty or consist only of zero-length documents.  Previously this would
1728     report a lower bound of zero, now it reports the same lowest bound as a
1729     single database containing all the same documents.
1731   + Database::check(): When checking a single table, handle the ".glass"
1732     extension on glass database tables, and use the extension to guide the
1733     decision of which backend the table is from.
1735 * Query:
1737   + Add new OP_WILDCARD query operator, which expands wildcards lazily, so now
1738     we create the PostList tree for a wildcard directly, rather than creating
1739     an intermediate Query tree.  OP_WILDCARD offers a choice of ways to limit
1740     wildcard expansion (no limit, throw an exception, use the first N by term
1741     name, or use the most frequent N).  (See tickets #48 and #608).
1743 * QueryParser:
1745   + Add new set_max_expansion() method which provides access to OP_WILDCARD's
1746     choice of ways to limit expansion and can set limits for partial terms as
1747     well as for wildcards.  Partial terms now default to the 100 most frequent
1748     matching terms.  (Completes #608, reported by boomboo).
1750   + Deprecate set_max_wildcard_expansion() in favour of set_max_expansion().
1752 * Add support for optional reference counting of FieldProcessor and
1753   ValueRangeProcessor objects.
1755 testsuite:
1757 * If command line option --verbose/-v isn't specified, set the verbosity level
1758   from environmental variable VERBOSE.
1760 * Re-enable replicate3 for glass, as it no longer fails.
1762 * Add more test coverage for get_unique_terms().
1764 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
1766 glass backend:
1768 * When reporting freelist errors during a database check, distinguish between a
1769   block in use and in the freelist, and a block in the freelist more than once.
1771 * Fix compaction and database checking for the change to the format of keys
1772   in the positionlist table which happened in 1.3.2.
1774 * After splitting a block, we always insert the new block in the parent right
1775   after the block it was split from - there's no need to binary chop.
1777 * Avoid infinite recursion when we hit the end of the freelist block we're
1778   reading and the end of the block we're writing at the same time.
1780 * Fix freelist handling to allow for the newly loaded first block of the
1781   freelist being already used up.
1783 chert backend:
1785 * Fix problems with get_unique_terms() on a modified chert database.
1787 * Fix xapian-check on a single chert table, which seg faulted in 1.3.2.
1789 remote backend:
1791 * Avoid dividing zero by zero when calculating the average length for an empty
1792   database.
1794 build system:
1796 * Merge generate-allsnowballheaders script into collate-sbl.
1798 portability:
1800 * A compiler with good support for C++11 is now required to build Xapian.
1801   Most of the actively developed C++ compilers already have decent support,
1802   or are close to having it, and it makes development easier and more
1803   efficient.  Currently known to work: GCC >= 4.7, recent versions of clang
1804   (3.5 works).  Solaris Studio 12.4 compiles the code, but tests currently
1805   fail.  IBM's xlC doesn't support enough of C++11 yet.  HP's aCC hasn't
1806   been tested, but its documentation suggests it also doesn't support enough
1807   of C++11 yet.
1809 * Drop workarounds and special cases for old versions of various compilers
1810   which don't support C++11.
1812 * Use C++11's static_assert() and unique_ptr instead of custom implementations
1813   of equivalent functionality.
1815 * Building on OS/2 with EMX is no longer supported - EMX was last updated in
1816   2001 and comes with GCC 3.2.1, which is much too old to support C++11.
1818 * Building with SGI's and Compaq's C++ compilers is no longer supported -
1819   both seem to have ceased development, and don't support C++11.
1821 * Building with STLport is no longer supported - STLport was last released in
1822   2008, so it's no longer actively developed and won't support C++11.
1824 * Building on IRIX is no longer supported, because IRIX has reached end of
1825   life.
1827 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
1828   compiler, as it fires for functions which end in a "throw" statement.
1829   Genuine instances of missing return values will be caught by compilers with
1830   superior warning machinery.
1832 * Fix warning from GCC 5.1 where template expansion leads to the comparison
1833   (bool_value < 255) which is always true.  Warning introduced by changes in
1834   1.3.2.
1836 * Use getaddrinfo() instead of gethostbyname(), since the latter may not be
1837   thread-safe, and as a step towards IPv6 support (see #374), but currently we
1838   still only look for IPv4 addresses.
1840 * timer_create() seems to always fail on AIX with EAGAIN, so just skip the
1841   matchtimelimit1 testcase there.
1843 * Under __WIN32__, we need to specify Vista as the minimum supported version to
1844   get the AI_ADDRCONFIG flag.  Older versions seem to all be out of support
1845   anyway.
1847 * Change configure probe for log2() to check for a declaration in <cmath>
1848   to get it to fix build on Solaris with Sun C++.  C++11 compilers should all
1849   provide log2(), but let's not rely on that just yet as it's easy to provide a
1850   fallback implementation.
1852 * Use scalbn() instead of ldexp() where possible (which we can in all cases
1853   when FLT_RADIX == 2, as it is on pretty much all current platforms).  On
1854   overflow and underflow ldexp() sets errno, which it seems better to avoid
1855   doing.
1857 * The list of stemmers is now in the same static const struct as the version
1858   info, and Stem::get_available_languages() is just an inlined wrapper which
1859   fetches this structure and returns the appropriate member.  This saves a
1860   relocation, reducing library load time a little.
1862 * Remove "pure" attribute from API functions which could throw an exception.
1863   These functions aren't really pure, and while we're happy for calls to them
1864   to be CSE-ed or eliminated entirely, the compiler might make more assumptions
1865   than that about a pure function - clang seems to assume pure => nothrow and
1866   an exception from such a function can't be caught.
1868 * Remove "pure" attribute from sortable_unserialise(), which can raise floating
1869   point exceptions FE_OVERFLOW and FE_UNDERFLOW.
1871 * Add "nothrow" attribute to more API functions which will never throw an
1872   exception.
1874 * Make sortable_serialise() an inlined wrapper around a function which won't
1875   throw and can be flagged with attribute 'const'.
1877 * Tweak sortable_unserialise() not to compare with a fixed string by
1878   constructing a temporary std::string object (which could throw
1879   std::bad_alloc), and mark it as XAPIAN_NOTHROW.
1881 debug code:
1883 * Only enable assertions in sortable_serialise() and sortable_unserialise() in
1884   the testsuite (since these functions shouldn't throw exceptions), and move
1885   the tests of these functions from queryparsertest to unittest to facilitate
1886   this.
1888 * Add more assertions to the glass backend code.
1890 Xapian-core 1.3.2 (2014-11-24):
1892 This release includes all changes from 1.2.16-1.2.19 which are relevant.
1894 API:
1896 * Update Unicode character database to Unicode 7.0.0.
1898 * New Xapian::Snipper class from Mihai Bivol's GSOC 2012 project.  (mostly
1899   fixes #211)
1901 * Fix all get_description() methods to always return UTF-8 text.  (fixes #620)
1903 * Database::check():
1905   + Alter to take its "out" parameter as a pointer to std::ostream instead of a
1906     reference, and make passing NULL mean "do not produce output", and make
1907     the second and third parameters optional, defaulting to a quiet check.
1909   + Escape invalid UTF-8 data in keys and tags reported by xapian-check, using
1910     the same code we use to clean up strings returned by get_description()
1911     methods.
1913   + Correct failure message which talks above the root block when it's actually
1914     testing a leaf key.
1916   + Rename DBCHECK_SHOW_BITMAP to DBCHECK_SHOW_FREELIST (old name still
1917     provided for now, but flagged as deprecated - DBCHECK_SHOW_BITMAP was new
1918     in 1.3.0, so will likely be removed before 1.4.0).
1920 * Methods and functions which take a string to unserialise now consistently
1921   call that parameter "serialised".
1923 * Weight: Make number of distinct terms indexing each document and the
1924   collection frequency of the term available to subclasses.  Patch from
1925   Gaurav Arora's Language Modelling branch.
1927 * WritableDatabase: Add support for multiple subdatabases, and support opening
1928   a stub database containing multiple subdatabases as a WritableDatabase.
1930 * WritableDatabase can now be constructed from just a pathname (defaulting to
1931   opening the database with DB_CREATE_OR_OPEN).
1933 * WritableDatabase: Add flags which can be bitwise OR-ed into the second
1934   argument when constructing:
1936   + Xapian::DB_NO_SYNC: to disable use of fsync, etc
1938   + Xapian::DB_DANGEROUS: to enable in-place updates
1940   + Xapian::DB_BACKEND_CHERT: if creating, create a chert database
1942   + Xapian::DB_BACKEND_GLASS: if creating, create a glass database
1944   + Xapian::DB_NO_TERMLIST: create a database without a termlist (see #181)
1946   + Xapian::DB_FULL_SYNC flag - if this is set for a database, we use the Mac
1947     OS X F_FULL_SYNC instead of fdatasync()/fsync()/etc on the version file
1948     when committing.
1950 * Database: Add optional flags argument to constructor - the following can be
1951   bitwise OR-ed into it:
1953   + Xapian::DB_BACKEND_CHERT (only open a chert database)
1955   + Xapian::DB_BACKEND_GLASS (only open a glass database)
1957   + Xapian::DB_BACKEND_STUB (only open a stub database)
1959 * Xapian::Auto::open_stub() and Xapian::Chert::open() are now deprecated in
1960   favour of these new flags.
1962 * Add LMWeight class, which implements the Unigram Language Modelling weighting
1963   scheme.  Patch from Gaurav Arora.
1965 * Add implementations of a number of DfR weighting schemes (BB2, DLH, DPH,
1966   IfB2, IneB2, InL2, PL2).  Patches from Aarsh Shah.
1968 * Add support for the Bo1 query expansion scheme.  Patch from Aarsh Shah.
1970 * Add Enquire::set_time_limit() method which sets a timelimit after which
1971   check_at_least will be disabled.
1973 * Database: Trying to perform operations on a database with no subdatabases now
1974   throws InvalidOperationError not DocNotFoundError.
1976 * Query: Implement new OP_MAX query operator, which returns the maximum weight
1977   of any of its subqueries.  (see #360)
1979 * Query: Add methods to allow introspection on Query objects - currently you
1980   can read the leaf type/operator, how many subqueries there are, and get a
1981   particular subquery.  For a query which is a term, Query::get_terms_begin()
1982   allows you to get the term.  (see #159)
1984 * Query: Only simplify OP_SYNONYM with a single subquery if that subquery is a
1985   term or MatchAll.
1987 * Avoid two vector copies when storing term positions in most common cases.
1989 * Reimplement version functions to use a single function in libxapian which
1990   returns a pointer to a static const struct containing the version
1991   information, with inline wrappers in the API header which call this.  This
1992   means we only need one relocation instead of 4, reducing library load time a
1993   little.
1995 * Make TermGenerator flags an anonymous enum, and typedef TermGenerator::flags
1996   to int for backward compatibility with existing user code which uses it.
1998 * Stem: Fix incorrect Unicode codepoints for o-double-acute and u-double-acute
1999   in the Hungarian Snowball stemmer.  Reported by Tom Lane to snowball-discuss.
2001 * Stem: Add an early english stemmer.
2003 * Provide the stopword lists from Snowball plus an Arabic one, installed in
2004   ${prefix}/share/xapian-core/stopwords/.  Patch from Assem Chelli, fixes #269.
2006 * Improve check for direct inclusion of Xapian subheaders in user code to
2007   catch more cases.
2009 * Add simple API to help with creating language-idiomatic iterator wrappers
2010   in <xapian/iterator.h>.
2012 testsuite:
2014 * Extend checkstatsweight1 to check that Weight::get_collection_freq() returns
2015   the same number as Database::get_collection_freq().
2017 * queryparsertest: Add testcase for FieldProcessor on boolean prefix with
2018   quoted contents.
2020 * queryparsertest: Enable some disabled cases which actually work (in some
2021   cases with slightly tweaked expected answers which are equivalent to those
2022   that were shown).
2024 * Make use of the new writable multidatabase feature to simplify the
2025   multi-database handling in the test harness.
2027 * Change querypairwise1_helper to repeat the query build 100 times, as with a
2028   fast modern machine we were sometimes trying with so many subqueries that we
2029   would run out of stack.
2031 * apitest: Use Xapian::Database::check() in cursordelbug1.  (partly addresses
2032   #238)
2034 * apitest: Test Query ops with a single MatchAll subquery.
2036 * apitest: New testcase readonlyparentdir1 to ensure that commit works with a
2037   read-only parent directory.
2039 matcher:
2041 * Streamline collation of statistics for use by weighting schemes - tests show
2042   a 2% or so increase in speed in some cases.
2044 * If a term matches all documents and its weight doesn't depend on its wdf, we
2045   can optimise it to MatchAll (the previous requirement that maxpart == 0 was
2046   unnecessarily strict).
2048 * Fix the check for a term which matches all documents to use the sub-db
2049   termfreq, not the combined db termfreq.
2051 * When we optimise a postlist for a term which matches all documents to use
2052   MatchAll, we still need to set a weight object on it to get percentages
2053   calculated correctly.
2055 glass backend:
2057 * 'brass' backend renamed to 'glass' - we decided to use names in ascending
2058   alphabetical order to make it easier to understand which backend is newest,
2059   and since 'flint' was used recently, we skipped over 'd', 'e' and 'f'.
2061 * Change positionlist keys to be ordered by term first rather than docid first,
2062   which helps phrase searching significantly.  For more efficient indexing,
2063   positionlist changes are now batched up in memory and written out in key
2064   order.
2066 * Use a separate cursor for each position list - now we're ordering the
2067   position B-tree by term first, phrase matching would cause a single cursor
2068   to cycle between disparate areas of the B-tree and reread the same blocks
2069   repeatedly.
2071 * Reference count blocks in the btree cursor, so cursors can cheaply share
2072   blocks.  This can significantly reduce the amount of memory used by cursors
2073   for queries which contain a lot of terms (e.g. wildcards which expand to a
2074   lot of terms).
2076 * Under glass, optimise the turning of a query into a postlist to reuse the
2077   cursor blocks which are the same as the previous term's postlist.  This is
2078   particularly effective for a wildcard query which expands to a lot of terms.
2080 * Keep track of unused blocks in the Btrees using freelists rather than
2081   bitmaps.  (fixes #40)
2083 * Eliminate the base files, and instead store the root block and freelist
2084   pointers in the "iamglass" file.
2086 * When compacting, sync all the tables together at the end.
2088 * In DB_DANGEROUS mode, update the version file in-place.
2090 * Only actually store the document data if it is non-empty.  The table which
2091   holds the document data is now lazily created, so won't exist if you never
2092   set the document data.
2094 chert backend:
2096 * Improve DBCHECK_FIX:
2098   + if fixing a whole database, we now take the revision from the first table
2099     we successfully look at, which should be correct in most cases, and is
2100     definitely better than trying to determine the revision of each broken
2101     table independently.
2103   + handle a zero-sized .DB file.
2105   + After we successfully regenerate baseA, remove any empty baseB file to
2106     prevent it causing problems.  Tracked down with help from Phil Hands.
2108 remote backend:
2110 * Bump remote protocol version to 38.0, due to extra statistics being tracked
2111   for weighting.
2113 * Make Weight::Internal track if any max_part values are set, so we don't need
2114   to serialise them when they've not been set.
2116 build system:
2118 * Fix conditional for enabling replication code - if chert is disabled but
2119   glass isn't, we should still enable it.
2121 * configure: Add hint for which package to install for rst2html
2123 documentation:
2125 * Don't build, ship or install PDF versions of the API docs by default, but
2126   provide an easy way for people to build it for themselves if they want it.
2128 * Convert equations in rst docs to use LaTeX via the math role and directive.
2130 * Actually ship, process and install geospatial.rst.
2132 * postingsource.rst: Use a modern class in postingsource example.  (Noted by
2133   James Aylett)
2135 * Move the protocol docs for the remote and replication protocols into the net/
2136   subdirectory.
2138 * Remove the dir_contents files and all the machinery to handle them.
2140 * HACKING: Note we now use doxygen 1.8.8 for 1.3.x snapshots and releases.
2142 * HACKING: Now using libtool 2.4.3 to bootstrap snapshots and 1.3.x releases.
2144 * HACKING: Now using automake 1.14.1 to bootstrap snapshots and 1.3.x releases.
2146 * HACKING: Drop note about needing git-svn if you're using git - bootstrap now
2147   only uses git-svn if your Xapian tree was checked out using git-svn.
2149 * HACKING: Need sphinx-doc to generate API docs for Python and Python 3 bindings.
2151 * HACKING: Note that MacTeX seems to be the best option if using homebrew.
2153 portability:
2155 * Don't pass an integer argument to log(), to avoid ambiguity errors with xlC
2156   and Sun's C++ compiler.  (fixes #627)
2158 * Fix compilations issues with Sun's C++ compiler (mostly missing library
2159   headers).
2161 * Implement RealTime::now() using clock_gettime() where it's available, since
2162   it can provide nanosecond resolution.
2164 * Implement RealTime::sleep() using nanosleep() where it's available, since it
2165   has a simpler API and a finer resolution than select().
2167 * Use lround() instead of round() in geospatial code, since we want the result
2168   as an int.  GCC 4.4.3 seems to optimise to use lround() anyway, but other
2169   compilers may not.
2171 * Include <math.h> for lround()/round(). (fixes #628)
2173 * Drop code supporting Microsoft Windows 9x which reached EOL in 2006.
2175 * Under C++11, use unique_ptr for AutoPtr.
2177 * Stop using a reference where we may end up passing *NULL, as that's invalid.
2178   Thanks Nick Lewycky and ubsan for helping track this down.
2180 * In DLHWeight and DPHWeight, avoid dividing by zero when the collection size
2181   is 0.
2183 debug code:
2185 * Fix assertion failure when built with --enable-assertions.  The behaviour
2186   when built without assertions happened to be correct.
2188 * Fix assertion in BitReader::decode(), and remove 'Assert(rd);' in two places
2189   where rd is no longer a pointer.
2191 Xapian-core 1.3.1 (2013-05-03):
2193 This release includes all changes from 1.2.10-1.2.15 which are relevant.
2195 API:
2197 * Give an compilation error if user code tries to include API headers other
2198   than xapian.h directly - these other headers are an internal implementation
2199   detail, but experience has shown that some people try to include them
2200   directly.  Please just use '#include <xapian.h>' instead.
2202 * Update Unicode character database to Unicode 6.2.0.
2204 * Add FieldProcessor class (ticket#128) - currently marked as an experimental
2205   API while we sort out how best to sort out exactly how it interacts with
2206   other QueryParser features.
2208 * Add implementation of several TF-IDF weighting schemes via a new TfIdfWeight
2209   class.
2211 * Add ExpandDeciderFilterPrefix class which only return terms with a particular
2212   prefix.  (fixes #467)
2214 * QueryParser: Adjust handling of Unicode opening/closing double quotes - if a
2215   quoted boolean term was started with ASCII double quote, then only ASCII
2216   double quote can end it, as otherwise it's impossible to quote a term
2217   containing Unicode double quotes.
2219 * Database::check(): If the database can't be opened, don't emit a bogus
2220   warning about there being too many documents to cross-check doclens.
2222 * TradWeight,BM25Weight: Throw SerialisationError instead of NetworkError if
2223   unserialise() fails.
2225 * QueryParser: Change the default stemming strategy to STEM_SOME, to eliminate
2226   the API gotcha that setting a stemmer is ignored until you also set a
2227   strategy.
2229 * Deprecate Xapian::ErrorHandler.  (ticket#3)
2231 * Stem: Generate a compact and efficient table to decode language names.  This
2232   is both faster and smaller than the approach we were using, with the added
2233   benefit that the table is auto-generated.
2235 * xapian.h:
2237   + Add check for Qt headers being included before us and defining
2238     'slots' as a macro - if they are, give a clear error advising how to work
2239     around this (previously compilation would fail with a confusing error).
2241   + Add a similar check for Wt headers which also define 'slots' as a macro
2242     by default.
2244 testsuite:
2246 * tests/generate-api_generated: Test that the string returned by a
2247   get_description() method isn't empty.
2249 * Use git commit hash in title of test coverage reports generated from a git
2250   tree.
2252 matcher:
2254 * Drop MatchNothing subqueries in OR-like situations in add_subquery() rather
2255   than adding them and then handling it later.
2257 * Handle the left side of AND_NOT and AND_MAYBE being MatchNothing in
2258   add_subquery() rather than in done().
2260 * Handle QueryAndLike with a MatchNothing subquery in add_subquery() rather
2261   than done().
2263 * Query: Multi-way operators now store their subquery pointers in a custom
2264   class rather than std::vector<Xapian::Query>.  The custom class take the
2265   same amount of space, or often less.  It's particularly efficient when
2266   there are two subqueries, which is very desirable as we no longer flatten a
2267   subtree of the same operator as we build the query.
2269 * Optimise an unweighted query term which matches all the documents in a
2270   subdatabase to use the "MatchAll" postlist.  (ticket#387)
2272 brass backend:
2274 * Iterating positional data now decodes it lazily, which should speed up
2275   phrases which include common words.
2277 * Compress changesets in brass replication. Increments the changeset version.
2278   Ticket #348
2280 * Restore two missing lines in database checking where we report a block with
2281   the wrong level.
2283 * When checking if a block was newly allocated in this revision, just look
2284   at its revision number rather than consulting the base file's bitmap.
2286 chert backend:
2288 * Iterating positional data now decodes it lazily, which should speed up
2289   phrases which include common words.
2291 remote backend:
2293 * Prefix compress list of terms and metadata keys in the remote protocol.
2294   This requires a remote protocol major version bump.
2296 build system:
2298 * Fix the 'libxapian' to be 'libxapian-1.3' and 'xapian.m4' to be
2299   'xapian-1.3.m4' (this was supposed to be the case for 1.3.0, but the
2300   change wasn't made correctly).
2302 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
2303   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
2304   V=1' and 'make V=0' which are broadly equivalent and more standard.
2306 * configure: If we fail to find a function needed for the remote backend, don't
2307   autodisable it - it's more helpful to error out so the use can decide if they
2308   want to pass --disable-backend-remote to disable it, or work out what values
2309   to pass for LIBS, etc to make it work.  This also matches what we do for the
2310   disk based backends.
2312 * automake 1.13.1 is now used to generate snapshots and releases.
2314 * Add check-syntax make target to support editor syntax checks.
2316 * Fix to build when configured with --disable-backend-brass
2317   --disable-backend-chert.  (ticket#586)
2319 * Generate a check for compatible _DEBUG settings if built with MSVC.
2320   (ticket#389)
2322 * If you run "make coverage-check" by hand, the previous default of compressed
2323   HTML is unhelpful, so don't default to passing --html-gzip to genhtml, but
2324   instead add support for GENHTML_ARGS.
2326 * API methods and functions are now marked as 'const', 'pure', or 'nothrow'
2327   allowing compilers which support such annotations to generate more efficient
2328   code.  (tickets #151, #454)
2330 documentation:
2332 * HACKING: Note which MacPorts are needed for development work.
2334 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
2335   message.
2337 tools:
2339 * xapian-check: Add "fix" option, which currently will regenerate iamchert if
2340   it isn't valid, and will regenerate base files from the .DB files (only
2341   really tested on databases which have just been compacted).
2343 portability:
2345 * Fix warning with GCC in build with assertions enabled.
2347 * common/fileutils.cc: Add safeunistd.h for mkdir, required by GCC 4.7
2348   (reported by Gaurav Arora).
2350 * backends/brass/brass_databasereplicator.cc: Use new/delete to avoid variable
2351   length array gcc extension and comply with c++98
2353 * Mark file descriptors as close-on-exec where supported.
2355 * api/queryinternal.cc: Need <functional> for mem_fun().
2357 * Work around Apple's OS X SDK defining a check() macro.
2359 * Add an option to use a flock() based locking implementation for brass and
2360   chert - this is much simpler than using fcntl() due to saner semantics around
2361   releasing locks when closing other descriptors on the same file (at least on
2362   platforms where flock() isn't just a compatibility wrapper around fcntl()).
2363   Sadly we can't simply switch to this without breaking locking compatibility
2364   with previous releases, but it's useful for platforms without fcntl()
2365   locking (it's enabled for DJGPP) and may be useful for custom builds for
2366   special purposes.
2368 packaging:
2370 * xapian-core.spec: Remove xapian-chert-update.
2372 debug code:
2374 * Building with --enable-log works once again.
2376 Xapian-core 1.3.0 (2012-03-14):
2378 API:
2380 * Update Unicode character database to Unicode 6.1.0.  (ticket#497)
2382 * TermIterator returned by Enquire::get_matching_terms_begin(),
2383   Query::get_terms_begin(), Database::synonyms_begin(),
2384   QueryParser::stoplist_begin(), and QueryParser::unstem_begin() now stores the
2385   list of terms to iterate much more compactly.
2387 * QueryParser:
2389   + Allow Unicode curly double quote characters to start and/or end phrases.
2391   + The set_default_op() method will now reject operators which don't make
2392     sense to set.  The operators which are allowed are now explicitly
2393     documented in the API docs.
2395 * Query: The internals have been completely reimplemented (ticket#280).  The
2396   notable changes are:
2398   + Query objects are smaller and should be faster.
2400   + More readable format for Query::get_description().
2402   + More compact serialisation format for Query objects.
2404   + Query operators are no longer flattened as you build up a tree (but the
2405     query optimiser still combines groups of the same operator).  This means
2406     that Query objects are truly immutable, and so we don't need to copy Query
2407     objects when composing them.  This should also fix a few O(n*n) cases when
2408     building up an n-way query pair-wise.  (ticket#273)
2410   + The Query optimiser can do a few extra optimisations.
2412 * There's now explicit support for geospatial search (this API is currently
2413   marked as experimental).  (ticket#481)
2415 * There's now an API (currently experimental) for checking the integrity of
2416   databases (partly addresses ticket#238).
2418 * Database::reopen() now returns true if the database may have been reopened
2419   (previously it returned void).  (ticket#548)
2421 * Deprecate Xapian::timeout in favour of POSIX type useconds_t.
2423 * Deprecate Xapian::percent and use int instead in the API and our own code.
2425 * Deprecate Xapian::weight typedef in favour of just using double and change
2426   all uses in the API and our own code.  (ticket#560)
2428 * Rearrange members of Xapian::Error to reduce its size (from 48 to 40 bytes on
2429   x86-64 Linux).
2431 * Assignment operators for PositionIterator and TermIterator now return *this
2432   rather than void.
2434 * PositionIterator, PostingIterator, TermIterator and ValueIterator now
2435   handle their reference counts in hand-crafted code rather than using
2436   intrusive_ptr/RefCntPtr, which means the compiler can inline the destructor
2437   and default constructor, so a comparison to an end iterator should now
2438   optimise to a simple NULL pointer check, but without the issues which the
2439   ValueIteratorEnd_ proxy class approach had (such as not working in templates
2440   or some cases of overload resolution).
2442 * Enquire:
2444   + Previously, Enquire::get_matching_terms_begin() threw InvalidArgumentError
2445     if the query was empty.  Now we just return an end iterator, which is more
2446     consistent with how empty queries behave elsewhere.
2448   + Remove the deprecated old-style match spy approach of using a MatchDecider.
2450 * Remove deprecated Sorter class and MultiValueSorter subclass.
2452 * Xapian::Stem:
2454   + Add stemmers for Armenian (hy), Basque (eu), and Catalan (ca).
2456   + Stem::operator= now returns a reference to the assigned-to object.
2458 testsuite:
2460 * Make unittest use the test harness, so it gets all the valgrind and fd leak
2461   checks, and other handy features all the other tests have.
2463 * Improve test coverage in several places.
2465 * Compress generated HTML files in coverage report.
2467 flint backend:
2469 * Remove flint backend.
2471 remote backend:
2473 * When propagating exceptions from a remote backend server, the protocol now
2474   sends a numeric code to represent which exception is being propagated, rather
2475   than the name of the type, as a number can be turned back into an exception
2476   with a simple switch statement and is also less data to transfer.
2477   (ticket#471)
2479 * Remote protocol (these changes require a protocol major version bump):
2481   + Unify REPLY_GREETING and REPLY_UPDATE.
2483   + Send (last_docid - doccount) instead of last_docid and (doclen_ubound -
2484     doclen_lbound) instead of doclen_ubound.
2486 * Remove special check which gives a more helpful error message when a modern
2487   client is used against a remote server running Xapian <= 0.9.6.
2489 build system:
2491 * Various changes allow us to now remove XAPIAN_VISIBILITY_DEFAULT from a
2492   number of functions which aren't in the public API (partly addresses
2493   ticket#63).
2495 * configure: For this development series, the library gets a -1.3 suffix and
2496   include files are installed with an extra /xapian-1.3 component to make
2497   parallel installs easier.
2499 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
2500   will then jump to the appropriate column for a compiler error or warning, not
2501   just the appropriate line.
2503 * Snowball compiler now reports "FILE:LINE:" before each error so tools like
2504   vim's quickfix mode can parse this and bring up the line with the error
2505   automatically.
2507 * docs/doxygen_api.conf.in: Don't generate XML from doxygen for the bindings -
2508   the bindings now do this for themselves.  (ticket#262)
2510 documentation:
2512 * INSTALL: Update GCC details - we now recommend 4.3 or newer (was 4.1), and
2513   note that while 3.1 is the hard minimum requirement, the oldest we've tested
2514   with at all recently was 3.3.
2516 * docs/deprecation.rst: Updated.
2518 tools:
2520 * delve:
2522   + Move delve from examples to bin and rename to xapian-delve.
2524   + Send errors to stderr not stdout.
2526 * xapian-check: Now reports useful descriptions rather than cryptic numeric
2527   codes for B-tree errors.
2529 debug code:
2531 * Add assertions that the index is in range when dereferencing MSetIterator and
2532   ESetIterator.
2534 * Fix various errors in debug logging statements.
2536 * Add QUERY category for debug logging.
2538 Xapian-core 1.2.23 (2016-03-28):
2540 API:
2542 * PostingSource: Public member variables are now wrapped by methods (mostly
2543   getters and/or setters, depending on whether they should be readable,
2544   writable or both).  In 1.3.5, the public members variables have been
2545   deprecated - we've added the replacement methods in 1.2.23 as well to make
2546   it easier for people to migrate over.
2548 chert backend:
2550 * xapian-check now performs additional consistency checks for chert. Reported
2551   by Jean-Francois Dockes and Bob Cargill via xapian-discuss.
2553 documentation:
2555 * Update links to Xapian website and trac to use https, which is now supported,
2556   thanks to James Aylett.
2558 portability:
2560 * On older Linux kernels, rename() of a file within a directory on NFS can
2561   sometimes erroneously fail with EXDEV.  This should only happen if you
2562   try to rename a file across filing systems, so workaround this issue by
2563   retrying up to 5 times on EXDEV (which should be plenty to avoid this
2564   bug, and we don't want to risk looping forever).  Fixes #698, reported by
2565   Mark Dufour.
2567 Xapian-core 1.2.22 (2015-12-29):
2569 API:
2571 * Add FLAG_CJK_NGRAM for QueryParser and TermGenerator.  Has the same effect as
2572   setting the environment variable XAPIAN_CJK_NGRAM.  Fixes #180, reported by
2573   Richard Boulton, with contributions from Pavel Strashkin, Mikkel Kamstrup
2574   Erlandsen and Brandon Schaefer.
2576 * Fix bug parsing multiple non-exclusive filter terms - previously this could
2577   result in such filters effectively being ignored.
2579 * Fix Database::get_doclength_lower_bound() over multiple databases when some
2580   are empty or consist only of zero-length documents.  Previously this would
2581   report a lower bound of zero, now it reports the same lowest bound as a
2582   single database containing all the same documents.
2584 * Make Database::get_wdf_upper_bound("") return 0.
2586 * Mark constructors taking a single argument as "explicit" to avoid unwanted
2587   implicit conversions.
2589 testsuite:
2591 * If command line option --verbose/-v isn't specified, set the verbosity level
2592   from environmental variable VERBOSE.
2594 * Skip timed tests if $AUTOMATED_TESTING is set.  Fixes #553, reported by
2595   Dagobert Michelsen.
2597 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
2599 * apitest: Revert disabling of part of adddoc5 for clang - the test failure was
2600   in fact due to a bug in 1.3.x, and 1.2.x was never affected.
2602 * apitest: Tweak bounds checks in dbstats1 testcase - multi backends should
2603   give tight bounds.
2605 brass backend:
2607 * Format limit on docid now correctly imposed when sizeof(int) > 4.
2609 * Avoid potential DB corruption with full-compaction when using 64K blocks.
2611 chert backend:
2613 * Format limit on docid now correctly imposed when sizeof(int) > 4.
2615 * Avoid potential DB corruption with full-compaction when using 64K blocks.
2617 flint backend:
2619 * Format limit on docid now correctly imposed when sizeof(int) > 4.
2621 * Avoid potential DB corruption with full-compaction when using 64K blocks.
2623 remote backend:
2625 * Fix to handle total document length exceeding 34,359,738,368.  (Fixes #678,
2626   reported by matf).
2628 * Avoid dividing by zero when getting the average length for an empty database.
2630 * Stop apparent error from remote server when read-only client disconnects.  A
2631   read-only client just closes the connection when done, but the server
2632   previously reported "Got exception NetworkError: Received EOF", which sounds
2633   like there was a problem.  Now we just say "Connection closed" here, and
2634   "Connection closed unexpectedly" if the client connects in the middle of an
2635   exchange.  Possibly fixes #654, reported by Germán M. Bravo.
2637 * Give a clearer error message when the client and server remote protocol
2638   versions aren't compatible.
2640 * Check length of key in MSG_SETMETADATA.
2642 build system:
2644 * pkg-config: Fix library name in .pc file to say "xapian" not "xapian-core".
2645   Reported by Eric Lindblad to the xapian-devel list.
2647 * Private symbol decode_length() is no longer visible outside the library.
2649 documentation:
2651 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
2652   'git cherry-pick' from working as it should.  The git repo history should be
2653   sufficient for complying with GPLv2 2(a).
2655 * Strip out "quickstart" examples which are out of date and rather redundant
2656   with the "simple" examples.
2658 * Correct documentation of Enquire::get_query().  If no query has been set,
2659   the documentation said Xapian::InvalidArgumentError was thrown, but in
2660   fact we just return a default initialised Query object (i.e. Query()).  This
2661   seems reasonable behaviour and has been the case since Xapian 0.9.0.
2663 * Document xapian-compact --blocksize takes an argument.
2665 * Update snowball website link to snowballstem.org.
2667 tools:
2669 * xapian-replicate: Fix replication for files > 4GB on 32-bit platforms.
2670   Previously replication would fail to copy a file whose size didn't fit in
2671   size_t.  Fixes #685, reported by Josh Elsasser.
2673 * xapian-tcpsrv: Better error if -p/--port not specified
2675 * quest: Support `-f cjk_ngram`.
2677 examples:
2679 * xapian-metadata: Extend "list" subcommand to take optional key prefix.
2681 portability:
2683 * Fix new warnings from recent versions of GCC and clang.
2685 * Add spaces between literal strings and macros which expand to literal strings
2686   for C++11 compatibility in __WIN32__-specific code.
2688 * Need <unistd.h> for unlink() on FreeBSD, reported by Germán M. Bravo via
2689   github PR 72.
2691 * Fix testsuite to build when S_ISSOCK() isn't defined.
2693 * Don't provide our own implementation of sleep() under __WIN32__ if there
2694   already is one - mingw provides one, and in some situations it seems to clash
2695   with ours.  Reported to xapian-discuss by John Alveris.
2697 * Add missing '#include <arpa/inet.h>' to htons().  Seems to be implicitly
2698   included on most platforms, but Interix needs it.  Reported by Eric Lindblad
2699   on xapian-discuss.
2701 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
2702   compiler, as it fires for functions ending in a "throw" statement.  Genuine
2703   instances will be caught by compilers with superior warning machinery.
2705 * Prefer scalbn() to ldexp() where possible, since the former doesn't ever set
2706   errno.
2708 * '#include <config.h>' in the "simple" examples, as when compiling with xlC on
2709   AIX, _LARGE_FILES gets defined by AC_SYS_LARGEFILE to enable large file
2710   support, and defining this changes the ABI of std::string, so it also needs
2711   to be defined when compiling code using Xapian.
2713 * On cygwin, include <arpa/inet.h> instead of winsock headers for htons() and
2714   htonl().
2716 * Include <cygwin/version.h> for CYGWIN_VERSION_API_MAJOR.
2718 * Avoid referencing static members via an object in that object's own
2719   definition, as this doesn't work with all compilers (noted with GCC 3.3), and
2720   is a bit of an odd construct anyway.  Reported by Eric Lindblad on
2721   xapian-discuss.
2723 * GCC < 3.4.2 lacks operator<< overloads for unsigned long long on some
2724   platforms, so simply work around this by using str(), as this isn't
2725   performance sensitive code.  Reported by Eric Lindblad on xapian-discuss.
2727 * Fix delete which should be delete[] in brass backend cursor code.
2729 Xapian-core 1.2.21 (2015-05-20):
2731 API:
2733 * QueryParser: Extend the set of characters allowed in the start of a range to
2734   be anything except for '(' and characters <= ' '.  This better matches what's
2735   accepted for a range end (anything except for ')' and characters <= ' ').
2736   Reported by Jani Nikula.
2738 matcher:
2740 * Reimplement OP_PHRASE for non-exact phrases.  The previous implementation was
2741   buggy, giving both false positives and false negatives in rare cases when
2742   three or more terms were involved.  Fixes #653, reported by Jean-Francois
2743   Dockes.
2745 * Reimplement OP_NEAR - the new implementation consistently requires the terms
2746   to occur at different positions, and fixes some previously missed matches.
2748 * Fix a reversed check for picking the shorter position list for an exact
2749   phrase of two terms.  The difference this makes isn't dramatic, but can be
2750   measured (at least with cachegrind).  Thanks to kbwt for spotting this.
2752 * When matching an exact phrase, if a term doesn't occur where we want, use
2753   its actual position to advance the anchor term, rather than just checking
2754   the next position of the anchor term.
2756 brass backend:
2758 * Fix cursor versioning to consider cancel() and reopen() as events where
2759   the cursor version may need incrementing, and flag the current cursor version
2760   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
2762 * Avoid using file descriptions < 3 for writable database tables, as it risks
2763   corruption if some code in the same process tries to write to stdout or
2764   stderr without realising it is closed.  (Partly addresses #651)
2766 chert backend:
2768 * Fix cursor versioning to consider cancel() and reopen() as events where
2769   the cursor version may need incrementing, and flag the current cursor version
2770   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
2772 * Avoid using file descriptions < 3 for writable database tables, as it risks
2773   corruption if some code in the same process tries to write to stdout or
2774   stderr without realising it is closed.  (Partly addresses #651)
2776 flint backend:
2778 * Fix cursor versioning to consider cancel() and reopen() as events where
2779   the cursor version may need incrementing, and flag the current cursor version
2780   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
2782 remote backend:
2784 * Fix sort by value when multiple databases are in use and one or more are
2785   remote.  This change necessitated a minor version bump in the remote
2786   protocol.  Fixes #674, reported by Dylan Griffith.  If you are upgrading a
2787   live system which uses the remote backend, upgrade the servers before the
2788   clients.
2790 build system:
2792 * The compiler ABI check in the public API headers now issues a warning
2793   (instead of an error) for an ABI mismatch for ABI versions 2 and later
2794   (which means GCC >= 3.4).  The changes in these ABI versions are bug fixes
2795   for corner cases, so there's a good chance of things working - e.g. building
2796   xapian-bindings with GCC 5.1 (which defaults to ABI version 8) against
2797   xapian-core built with GCC 4.9 (which defaults to ABI version 2) seems to
2798   work OK.  A warning is still useful as a clue to what is going on if linking
2799   fails due to a missing symbol.
2801 * xapian-config,xapian-core.pc: When compiling with xlC on AIX, the reported
2802   --cxxflags/--cflags now include -D_LARGE_FILES=1 as this is defined for the
2803   library, and defining it changes the ABI of std::string with this compiler,
2804   so it must also be defined when building code using the Xapian API.
2806 * xapian-core.pc: Include --enable-runtime-pseudo-reloc in --libs output for
2807   mingw and cygwin, like xapian-config does.
2809 * xapian-core.pc: Fix include directory reported by `pkg-config --cflags`.
2810   This bug was harmless if xapian-core was installed to a directory which was
2811   on the default header search path (such as /usr/include).
2813 * xapian-config: Fix typo so cached result of test in is_uninstalled() is
2814   actually used on subsequent calls.  Fixes #676, reported (with patch) by Ryan
2815   Schmidt.
2817 * configure: Changes in 1.2.19 broke the custom macro we use to probe for
2818   supported compiler flags such that the flags never got used.  This release
2819   fixes this problem.
2821 * configure: Set default value for AUTOM4TE before AC_OUTPUT so the default
2822   will actually get used.  Only relevant when building in maintainer mode
2823   (e.g. from git).
2825 * soaktest: Link with libtool's '-no-install' or '-no-fast-install', like we
2826   already do for other test programs, which means that libtool doesn't need to
2827   generate shell script wrappers for them on most platforms.
2829 documentation:
2831 * API documentation: Minor wording tweaks and formatting improvements.
2833 * docs/deprecation.rst: Add deprecation of omindex --preserve-nonduplicates
2834   which happened in 1.2.4.
2836 * HACKING: Update URL.
2838 * HACKING: libtool 2.4.6 is now used for bootstrapping snapshots and releases.
2840 tools:
2842 * xapian-compact: Make sure we open all the tables of input databases at the
2843   same revision.  (Fixes #649)
2845 * xapian-metadata: Add 'list' subcommand to list all the metadata keys.
2847 * xapian-replicate: Fix connection timeout to be 10 seconds rather than 10000
2848   seconds (the incorrect timeout has been the case since 1.2.3).
2850 * xapian-replicate: Set SO_KEEPALIVE for xapian-replicate's connection to the
2851   master, and add command line option to allow setting socket-level timeouts
2852   (SO_RCVTIMEO and SO_SNDTIMEO) on platforms that support them.  Fixes #546,
2853   reported by nkvoll.
2855 * xapian-replicate-server: Avoid potentially reading uninitialised data if a
2856   changeset file is truncated.
2858 portability:
2860 * Add spaces between literal strings and macros which expand to literal strings
2861   for C++11 compatibility.
2863 * ValueCountMatchSpy::top_values_begin(): Fix the comparison function not to
2864   return true for two equal elements, which manifests as incorrect sorting in
2865   some cases when using clang's libc++ (which recent OS X versions do).
2867 * apitest: The adddoc5 testcase fails under clang due to an exception handling
2868   bug, so just #ifdef out the problematic part of the testcase when building
2869   with clang for now.
2871 * Fix clang warnings on OS X.  Reported by Germán M. Bravo.
2873 * Fix examples to build with IBM's xlC compiler on AIX - they were failing due
2874   to _LARGE_FILES being defined for the library build but not for the examples,
2875   and defining this changes the ABI of std::string with this compiler.
2877 * configure: Improve the probe for whether the test harness can use RTTI to
2878   work for IBM's xlC compiler (which defaults to not generating RTTI).
2880 * Fix to build with Sun's C++ compiler.
2882 * Use F_DUPFD where available to dup to a file descriptor which is >= 2, rather
2883   than calling dup() until we get one.
2885 * When unserialising a double, avoid reading one byte past the end of the
2886   serialised value.  In practice this was harmless on most platforms, as
2887   dbl_max_mantissa is 255 for IEEE-754 format doubles, and at least GCC's
2888   std::string keeps the buffer nul-terminated.  Reported by Germán M. Bravo in
2889   github PR#67.
2891 * When unserialising a double, add missing cast to unsigned char when we check
2892   if the value will fit in the double type.  On machines with IEEE-754 doubles
2893   (which is most current platforms) this happened to work OK before.  It would
2894   also have been fine on machines where char is unsigned by default.
2896 * Fix incorrect use of "delete" which should be "delete []".  This is
2897   undefined behaviour in C++, though the type is POD, so in practice this
2898   probably worked OK on many platforms.
2900 debug code:
2902 * Fix some overly strict assertions in flint, which caused apitest's
2903   cursordelbug1 to fail with assertions on.
2905 Xapian-core 1.2.20 (2015-03-04):
2907 chert backend:
2909 * After splitting a block, we always insert the new block in the parent right
2910   after the block it was split from - there's no need to binary chop.
2912 build system:
2914 * Generate and install a file for pkg-config.  (Fixes#540)
2916 * configure: Update link to cygwin FAQ in error message.
2918 documentation:
2920 * include/xapian/weight.h: Document the enum stat_flags values.
2922 * docs/postingsource.rst: Use a modern class in postingsource example.  (Noted
2923   by James Aylett)
2925 * docs/deprecation.rst,docs/replication.rst: Fix typos.
2927 * Update doxygen configuration files to avoid warnings about obsolete tags from
2928   newer doxygen versions.
2930 * HACKING: Update details of building Xapian packages.
2932 tools:
2934 * xapian-check: For chert and brass, cross-check the position and postlist
2935   tables to detect positional data for non-existent documents.
2937 portability:
2939 * When locking a database for writing, use F_OFD_SETLK where available, which
2940   avoids having to fork() a child process to hold the lock.  This currently
2941   requires Linux kernel >= 3.15, but it has been submitted to POSIX so
2942   hopefully will be widely supported eventually.  Thanks to Austin Clements for
2943   pointing out this now exists.
2945 * Fix detection of fdatasync(), which appears to have been broken practically
2946   forever - this means we've probably been using fsync() instead, which
2947   probably isn't a big additional overhead.  Thanks to Vlad Shablinsky for
2948   helping with Mac OS X portability of this fix.
2950 * configure: Define MINGW_HAS_SECURE_API under mingw to get _putenv_s()
2951   declared in stdlib.h.
2953 * Use POSIX O_NONBLOCK in preference to O_NDELAY - the semantics of the latter
2954   differ between BSD and System V.
2956 * According to POSIX, strerror() may not be thread safe, so use alternative
2957   thread-safe ways to translate errno values where possible.
2959 * On Microsoft Windows, avoid defining EADDRINUSE, etc if they're already
2960   defined, and use WSAE* constants un-negated - they start from a high value
2961   so won't collide with E* constants.
2963 debug code:
2965 * Add more assertions to the chert backend code.
2967 Xapian-core 1.2.19 (2014-10-21):
2969 API:
2971 * Xapian::BM25Weight:
2973   + Improve BM25 upper bound in the case when our wdf upper bound > our
2974     document length lower bound.  Thanks to Craig Macdonald for pointing out
2975     this trick.
2977   + Pre-multiply termweight by (param_k1 + 1) rather than doing it for
2978     every weighted term in every document considered.
2980 testsuite:
2982 * Don't report apparent leaks of fds opened on /dev/urandom - at least on
2983   Linux, something in the C library seems to lazily open it, and the report of
2984   a possible leak followed by assurance that it's OK really is just noise we
2985   can do without.
2987 matcher:
2989 * Fix false matches reported for non-exact phrases in some cases.  Fixes the
2990   reduced testcase in #657, reported by Jean-Francois Dockes.
2992 brass backend:
2994 * Only full sync after writing the final base file (only affects Max OS X).
2996 chert backend:
2998 * Only full sync after writing the final base file (only affects Max OS X).
3000 flint backend:
3002 * Only full sync after writing the final base file (only affects Max OS X).
3004 build system:
3006 * For Sun's C++ compiler, pass -library=Crun separately since libtool looks for
3007   " -library=stlport4 " (with the spaces).  (fixes#650)
3009 * Remove .replicatmp (created by the test suite) upon "make clean".
3011 documentation:
3013 * include/xapian/compactor.h: Fix formatting of doxygen comment.
3015 * HACKING: freecode no longer accepts updates, so drop that item from the
3016   release checklist.
3018 * docs/overview.rst: Add missing database path to example of using
3019   xapian-progsrv in a stub database file.
3021 portability:
3023 * Suppress unused typedef warnings from debugging logging macros, which occur
3024   in functions which always exit via throwing an exception when compiling with
3025   recent versions of GCC or clang.
3027 * Fix debug logging code to compile with clang.  (fixes #657, reported by
3028   Germán M. Bravo)
3030 debug code:
3032 * Add missing RETURN() markup for debug logging in a few places, highlighted by
3033   warnings from recent GCC.
3035 * Fix incorrect return types in debug logging annotations so that code compiles
3036   when configured with --enable-log.
3038 Xapian-core 1.2.18 (2014-06-22):
3040 API:
3042 * Document: Fix get_docid() to return the docid for the sub-database (as it
3043   is explicitly documented to) for Document objects passed to functors like
3044   KeyMaker during the match.  (fixes#636, reported by Jeff Rand).
3046 * Document: Don't store the termname in OmDocumentTerm - we were only using it
3047   in get_description() output and an exception message.  Speeds up indexing
3048   etext.txt using simpleindex by 0.4%, and should reduce memory usage a bit
3049   too.  (Change inspired by comments from Vishesh Handa on xapian-devel).
3051 * Database: Iterating the values in a particular slot is now a bit more
3052   efficient for inmemory and remote backends (but still slow compared to
3053   flint, chert and brass).
3055 testsuite:
3057 * apitest: Expand crashrecovery1 to check that the expected base files exist
3058   and ones which shouldn't exist don't.
3060 * queryparsertest: Fix testcase for empty wildcard followed by negation to
3061   enable FLAG_LOVEHATE so the negation is actually parsed.  Fortunately the
3062   fixed testcase passes.
3064 matcher:
3066 * OP_SYNONYM: avoid fetching the doclength if the weighting scheme doesn't
3067   need it and the calculated wdf for the synonym is <= doclength_lower_bound
3068   for the current subdatabase.  (fixes #360)
3070 build system:
3072 * Releases are now bootstrapped with libtool 2.4.2 instead of 2.4, and with
3073   config.guess and config.sub updated to the latest versions.
3075 documentation:
3077 * Add an example of initializing SimpleStopper using a file listing stopwords.
3078   (Patch from Assem Chelli)
3080 * Improve the descriptions of the stem_strategy values in the API docs.
3081   (Reported by "oilap" on #xapian)
3083 * docs/sorting.rst: Fix incorrect parameter types in Xapian::Weight
3084   subclass example.
3086 * docs/glossary.rst: Add definition of "collection frequency".
3088 * HACKING:
3090   + makeindex is now in Debian package texlive-binaries.
3092   + Replace a link to the outdated autotools "goat book" with a link to the
3093     "Portable Shell" chapter of the autoconf manual.
3095 * include/xapian/base.h: Remove very out of date comments talking about atomic
3096   assignment and locking - since 0.5.0 we've adopted a "user locks" policy.
3097   (Reported by Jean-Francois Dockes)
3099 examples:
3101 * delve:
3103   + Add -A <prefix> option to list all terms with a particular prefix.
3105   + Send errors to stderr not stdout.
3107   + If -v is specified more than once, show even more info in some cases.
3108     (NEWS file claimed this was backported in 1.2.15, but it actually wasn't).
3110 * quest:
3112   + Add --default-op option.
3114   + Add --weight option to allow the weighting scheme to be specified.
3116 portability:
3118 * Explicitly '#include <algorithm>' for std::max(), fixing build with VS2013.
3119   (Fixes#641, reported by "boomboo").
3121 * Fix testcase blocksize1 not to try to delete an open database, which isn't
3122   possible under Windows.  (Fixes #643, reported by Chris Olds)
3124 * docs/quickstart.rst: Split --cxxflags and --libs for portability (noted by
3125   "Hurricane Tong" on xapian-devel).
3127 * Fix warnings with clang 5.0.
3129 debug code:
3131 * Add assertions that weighting scheme upper bounds aren't exceeded.
3133 Xapian-core 1.2.17 (2014-01-29):
3135 API:
3137 * Enquire::set_sort_by_relevance_then_value() and
3138   Enquire::set_sort_by_relevance_then_key(): Fix sense of reverse parameter.
3139   Reported by "boomboo" on IRC.
3141 * BM25Weight: Fix case where (k1 == 0 || b == 0) but k2 != 0.  Reported by
3142   "boomboo" on IRC.
3144 * Unicode::tolower(): Fix to give correct results for U+01C5, U+01C8, U+01CB,
3145   and U+01F2 (previously these were left unchanged).
3147 testsuite:
3149 * Automatically probe for and hook in eatmydata to the testsuite using the
3150   wrapper script it now includes.
3152 * Fix apitest to build when brass, chert or flint are disabled.
3154 brass backend:
3156 * Fix handling of invalid block sizes passed to Xapian::Brass::open() - the
3157   size gets fixed as documented, but the uncorrected size was passed to the
3158   base file (and abort() was called if 0 was passed).
3160 * Validate "dir_end" when reading a block.  (fixes #592)
3162 chert backend:
3164 * Fix handling of invalid block sizes passed to Xapian::Chert::open() - the
3165   size gets fixed as documented, but the uncorrected size was passed to the
3166   base file (and abort() was called if 0 was passed).
3168 * Validate "dir_end" when reading a block.  (fixes #592)
3170 flint backend:
3172 * Fix handling of invalid block sizes passed to Xapian::Flint::open() - the
3173   size gets fixed as documented, but the uncorrected size was passed to the
3174   base file (and abort() was called if 0 was passed).
3176 * Validate "dir_end" when reading a block.  (fixes #592)
3178 build system:
3180 * configure: Improve reporting of GCC version.
3182 * Use -no-fast-install on platforms where -no-install causes libtool to emit a
3183   warning.
3185 * docs/Makefile.am: Fix handling of MAINTAINER_NO_DOCS.
3187 * Include UnicodeData.txt and the script to generate the unicode tables from
3188   it.
3190 documentation:
3192 * postingsource.rst: Clarify a couple of points (reported by "vHanda" on IRC).
3194 portability:
3196 * Protect the ValueIterator::check() method against Mac OS X SDK headers
3197   which define a check() macro.
3199 * Fix warning from xlC compiler.
3201 * Avoid use of grep -e in configure, as /usr/bin/grep on Solaris doesn't
3202   support -e.
3204 * Fix check for flags which might be needed for ANSI mode for compilers called
3205   'cxx'.
3207 * configure: Improve handling of Sun's C++ compiler - trick libtool into not
3208   adding -library=Cstd, and prefer -library=stdcxx4 if supported.  Explicitly
3209   add -library=Crun which seems to be required, even though the documentation
3210   suggests otherwise.
3212 Xapian-core 1.2.16 (2013-12-04):
3214 API:
3216 * PositionIterator,PostingIterator,TermIterator,ValueIterator: Don't segfault
3217   if skip_to() or check() is called on an iterator which is already at_end().
3218   Reported by David Bremner.
3220 * ValueCountMatchSpy: get_description() on a default-constructed
3221   ValueCountMatchSpy object no longer fails when xapian-core is built with
3222   --enable-log.
3224 * ValueCountMatchSpy: get_total() on a default-constructed ValueCountMatchSpy
3225   object now returns 0 rather than segfaulting.
3227 testsuite:
3229 * If -v/--verbose is specified more than once to a test program, show the
3230   diagnostic output for passing tests as well as failing/skipped ones.
3232 * queryparsertest: Change qp_scale1 to time 5 repetitions of the large query to
3233   help average out variations.
3235 * queryparsertest: Add test coverage for explicit synonym of a term with a
3236   prefix (e.g. ~foo:search).
3238 * apitest: Remove code from registry* testcases which tries to test the
3239   consequences of throwing an exception from a destructor - it's complex to
3240   ensure we don't leak memory while doing this (it seems GCC doesn't release
3241   the object in this case, but clang does), and it's generally frowned upon,
3242   plus C++11 makes destructors noexcept by default.
3244 * Fix "make check" to actually removed cached databases first, as is
3245   intended.
3247 brass backend:
3249 * When moving a cursor on a read-only table, check if the block we want is in
3250   the internal cursor.  We already do this for a writable table, as it is
3251   necessary for correctness, but it's a cheap check and may avoid asking the
3252   OS for a block we actually already have.
3254 * Correctly report the database as closed rather than 'Bad file descriptor'
3255   in certain cases.
3257 * Reuse a cursor for reading values from valuestreams rather than creating
3258   a new one each time.  This can dramatically reduce the number of blocks
3259   redundantly reread when sorting by value.  The rereads will generally get
3260   served from VM cache, but there's still an overhead to that.
3262 chert backend:
3264 * When moving a cursor on a read-only table, check if the block we want is in
3265   the internal cursor.  We already do this for a writable table, as it is
3266   necessary for correctness, but it's a cheap check and may avoid asking the
3267   OS for a block we actually already have.
3269 * Correctly report the database as closed rather than 'Bad file descriptor'
3270   in certain cases.
3272 * Reuse a cursor for reading values from valuestreams rather than creating
3273   a new one each time.  This can dramatically reduce the number of blocks
3274   redundantly reread when sorting by value.  The rereads will generally get
3275   served from VM cache, but there's still an overhead to that.
3277 flint backend:
3279 * When moving a cursor on a read-only table, check if the block we want is in
3280   the internal cursor.  We already do this for a writable table, as it is
3281   necessary for correctness, but it's a cheap check and may avoid asking the
3282   OS for a block we actually already have.
3284 * Correctly report the database as closed rather than 'Bad file descriptor'
3285   in certain cases.
3287 build system:
3289 * Compress source tarballs with xz instead of gzip.
3291 * Split XAPIAN_LIBS out of XAPIAN_LDFLAGS so that -l flags for libraries
3292   configure detects are needed appear after -L flags specified by the user
3293   that may be needed to find such libraries.  (fixes#626)
3295 * XO_LIB_XAPIAN now handles the user specifying a relative path in
3296   XAPIAN_CONFIG, e.g.: "./configure XAPIAN_CONFIG=../xapian-core/xapian-config"
3298 * Adjust XO_LIB_XAPIAN to strip _gitNNN suffix from snapshot versions.
3300 * configure: Handle git snapshot naming when calculating REVISION.
3302 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
3303   will then jump to the appropriate column for a compiler error or warning, not
3304   just the appropriate line.
3306 * configure: Report GCC version in configure output.
3308 documentation:
3310 * The API documentation shipped with the release is now generated with
3311   doxygen 1.8.5 instead of 1.5.9, which is most evident in the different
3312   HTML styling newer doxygen uses.
3314 * Document how Utf8Iterator handles invalid UTF-8 in API documentation.
3316 * Improve how descriptions of deprecated features appear in the API
3317   documentation.
3319 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
3320   message.
3322 * docs/overview.rst: Correct documentation for how to specify "prog" remote
3323   databases in stub files.
3325 * Direct users to git in preference to SVN - we'll be switching entirely in
3326   the near future.
3328 tools:
3330 * xapian-chert-update: Fix -b to work rather than always segfaulting (reported
3331   in http://bugs.debian.org/716484).
3333 * xapian-chert-update: The documented alias --blocksize for -b has never
3334   actually been supported, so just drop mentions of it from --help and the man
3335   page.
3337 * xapian-check:
3339   + Fix chert database check that first docid in each doclength chunk is more
3340     than the last docid in the previous chunk - previously this didn't actually
3341     work.
3343   + Fix database check not to falsely report "position table: Junk after
3344     position data" whenever there are 7 unused bits (7 is OK, *more* than 7
3345     isn't).
3347   + Fix to report block numbers correctly for links within the B-tree.
3349   + If the METAINFO key is missing, only report it once per table.
3351   + Fix database consistency checking to always open all the tables at the same
3352     revision - not doing this could lead to false errors being reported after a
3353     commit interrupted by the process being killed or the machine crashing.
3354     Reported by Joey Hess in http://bugs.debian.org/724610
3356 examples:
3358 * quest: Add --check-at-least option.
3360 portability:
3362 * configure: clang doesn't support -Wstrict-null-sentinel or -Wlogical-op, so
3363   don't pass it these options.
3365 * Fix build errors and warnings with mingw.
3367 * Suppress "unused local typedef" warnings from GCC 4.8.
3369 * If the compiler supports C++11, use static_assert to implement
3370   CompileTimeAssert.
3372 * tests/zlib-vg.c: Fix two warnings when compiled with clang.
3374 * Fix failure when built with -D_GLIBCXX_DEBUG - we were modifying the top()
3375   element of a heap before calling pop(), such that the heap comparison
3376   operation (which is called when -D_GLIBCXX_DEBUG is on to verify the heap is
3377   valid) would read off the end of the data.  In a normal build, this issue
3378   would likely never manifest.
3380 * configure: When generating ABI compatibility checks in xapian/version.h, pass
3381   $CXXFLAGS and $CPPFLAGS to $CXXCPP as they could contain options which affect
3382   the ABI (such as -fabi-version for GCC).  (Fixes #622)
3384 * Microsoft GUIDs in binary form have reversed byte order in the first three
3385   components compared to standard UUIDs, so the same database would report a
3386   different UUID on Windows to on other platforms.  We now swap the bytes to
3387   match the standard order.  With this fix, the UUIDs of existing databases
3388   will appear to change on Windows (except in rare "palindronic" cases).
3390 * Fix a couple of issues to get Xapian to build and work on AIX.
3392 * common/safeuuid.h: Remove bogus take-address-of from uuid handling code for
3393   NetBSD and OpenBSD.
3395 * Under cygwin, use cygwin_conv_path() if using a new enough cygwin version,
3396   rather than the now deprecated cygwin_conv_to_win32_path().  Reported by
3397   "Haroogan" on the xapian-devel mailing list.
3399 * common/safeuuid.h: Add missing '#include <cstdlib>' and qualify free with std.
3401 * Fix 'unused label' warning when chert backend is disabled.
3403 * xapian.h: Add check for Wt headers being included before us and defining
3404   'slots' as a macro - if they are, give a clear error advising how to work
3405   around this (previously compilation would fail with a confusing error).
3407 debug code:
3409 * Fix assertion failure for when an OrPostList decays to an AndPostList - the
3410   ordering of the subqueries by estimated termfreq may not be the same as it
3411   was when the OrPostList was constructed, as the subqueries may themselves
3412   have decayed.  Reported by Michel Pelletier.
3414 * Fix -Wcast-qual warning from GCC 4.7 when configured with --enable-log.
3416 Xapian-core 1.2.15 (2013-04-16):
3418 API:
3420 * QueryParser/TermGenerator: Don't include CJK codepoints which are
3421   punctuation in N-grams.
3423 * TermGenerator: Fix bug where we failed to generate the first bigram
3424   from the second sequence of N-grammable CJK characters in a piece of text.
3426 brass backend:
3428 * Call fdatasync()/fsync() when creating the "iambrass" file.
3430 chert backend:
3432 * Call fdatasync()/fsync() when creating the "iamchert" file.
3434 flint backend:
3436 * Call fdatasync()/fsync() when creating the "iamflint" file.
3438 build system:
3440 * XO_LIB_XAPIAN now handles the user specifying XAPIAN_CONFIG without a path,
3441   for example: ./configure XAPIAN_CONFIG=xapian-config-1.3
3443 tools:
3445 * delve: If -v is specified more than once, show even more info in some cases.
3447 portability:
3449 * Fix warning due to needlessly casting away const-ness in debug logging.
3451 * Fix pointer truncation bug in lemon parser generator, which probably affects
3452   regenerating the query parser on WIN64.
3454 debug code:
3456 * Fix to build when configured with --enable-log.
3458 Xapian-core 1.2.14 (2013-03-14):
3460 API:
3462 * MSet::get_document(): Don't cache retrieved Document objects unless they
3463   were requested with fetch().  This avoids using a lot of memory when many
3464   MSet entries are retrieved.  (Fixes #604)
3466 testsuite:
3468 * apitest: Improved test coverage.
3470 matcher:
3472 * Check if a candidate document has at least the minimum weight needed
3473   before checking positional information, which speeds up slow phrase
3474   searches (partly addresses #394).
3476 brass backend:
3478 * Fix multipass compaction not to damage document values, and to merge the
3479   database stats correctly.  (fixes #615)
3481 chert backend:
3483 * Fix multipass compaction not to damage document values, and to merge the
3484   database stats correctly.  (fixes #615)
3486 flint backend:
3488 * Fix multipass compaction bug.  (fixes #615)
3490 tools:
3492 * xapian-replicate:
3494   + Fix handling of delays between replication events - the subtraction of the
3495     target time and the current time was reversed, so we wouldn't sleep when
3496     before the deadline, but would sleep after it for the amount we'd missed it
3497     by.
3499   + On Microsoft Windows, we no longer sleep for more than 43 years if the
3500     target time for a replication event had already passed.  (Fixes #472)
3502 portability:
3504 * matcher/queryoptimiser.cc: Need <functional> for mem_fun().
3506 * tests/harness/testsuite.cc: Don't provide explicit template types to
3507   make_pair - it isn't useful, and breaks with C++11.  Fixes build error with
3508   MSVC2012.
3510 * examples/quest.cc: Fix to build with Sun Studio 12 compiler.  (ticket#611)
3512 Xapian-core 1.2.13 (2013-01-09):
3514 API:
3516 * TermGenerator: Add new method TermGenerator::set_max_word_length() to allow
3517   this limit to be adjusted by the user.
3519 * QueryParser: Implicitly close any unclosed brackets at the end of the query
3520   string.  Patch from Sehaj Singh Kalra.
3522 * DateValueRangeProcessor: Add extra constructor overloaded form so that in
3523   DateValueRangeProcessor(1, "date:"), the const char * gets interpreted as
3524   std::string rather than bool.
3526 testsuite:
3528 * apitest: Assorted test coverage improvements.
3530 * When reporting valgrind errors, skip any warnings before the error in the
3531   valgrind log.
3533 matcher:
3535 * Improved fix for #590 - count all matching LeafPostList objects with a Weight
3536   object rather than trying to prune at the MultiAndPostList level based on
3537   max_wt (if wdf is always zero for a term, BM25 gives max_wt of 0, which lead
3538   to us never counting that subquery.
3540 * Fix calculation of 0.0/0.0 in some cases.  This then got used as a minimum
3541   weight, but it seems this gives -nan (at least on x86-64 Linux) so it may
3542   have been harmless in practice.
3544 * We no longer use the highest weighted MSet entry to calculate percentages, so
3545   remove code which finds it.
3547 brass backend:
3549 * Close excess file handles before we get the fcntl lock, which avoids the
3550   lock being released again if one is open on the lock file.  Notably this
3551   avoids a situation where multiple threads in the same process could succeed
3552   in locking a database concurrently.
3554 chert backend:
3556 * Close excess file handles before we get the fcntl lock, which avoids the
3557   lock being released again if one is open on the lock file.  Notably this
3558   avoids a situation where multiple threads in the same process could succeed
3559   in locking a database concurrently.
3561 flint backend:
3563 * Close excess file handles before we get the fcntl lock, which avoids the
3564   lock being released again if one is open on the lock file.  Notably this
3565   avoids a situation where multiple threads in the same process could succeed
3566   in locking a database concurrently.
3568 remote backend:
3570 * Improve the UnimplementedError message for a MatchSpy subclass which doesn't
3571   implement name() so it's clearer that it is this particular subclass which
3572   can't be used remotely, rather than all MatchSpy objects.
3574 build system:
3576 * The build system is now generated with automake 1.11.6 rather than 1.11.1,
3577   which fixes a security issue in "make distcheck" (not something users will
3578   usually run, but it seems worth addressing).
3580 * Use user-specified LIBS for configure tests, which is what you'd expect to
3581   happen, and provides a way for the user to tell configure where to find
3582   library functions which configure can't find for itself.
3584 * INCLUDES is now deprecated in automake, so use AM_CPPFLAGS instead.
3586 * Test coverage rules now assume lcov 1.10 which allows them to be simpler
3587   and not to require a patched version of lcov.
3589 documentation:
3591 * valueranges.html: Update documentation to reflect change in Xapian 1.1.2 -
3592   DateValueRangeProcessor and StringValueRangeProcessor now support a prefix or
3593   suffix.
3595 * Clarify that the "reverse" parameter of set_sort_by_relevance_then_value()
3596   and set_sort_by_relevance_then_key() only affects the ordering of the
3597   value/key part of the sort.
3599 * docs/quickstart.html: Fix seriously outdated statement that Xapian doesn't
3600   create the database directory - that changed in 0.7.2 (released 2003-07-11).
3602 * HACKING: Try to make it clearer we're looking for a dual-licence on submitted
3603   patches.
3605 tools:
3607 * xapian-replicate:
3609   + Add a --full-copy option to force a full copy to be sent.  (ticket#436)
3611   + Add --quiet option, and be a little more verbose by default.
3613   + Allow files > 32G to be be copied by replication.
3615   + Fix "if (fd > 0)" tests in some replication code to be "if (fd >= 0)".
3616     In practice this is unlikely to actually have caused problems since
3617     stdin is typically still open and using fd 0.
3619   + Simplify how we open the .DB file on the replication slave to just call
3620     open() once with O_CREAT, rather than once without, than stat() if that
3621     fails, and then again with O_CREAT|O_TRUNC if stat() doesn't show an
3622     ordinary file exists.
3624 examples:
3626 * quest:
3628   + New --flags command line option to allow setting arbitrary QueryParser
3629     flags.
3631   + Align option descriptions in --help output, and make the initial letter of
3632     such descriptions consistently lowercase.
3634 portability:
3636 * Fix testsuite harness to compile with GCC 4.7.
3638 * On platforms with the F_MAXFD fcntl but without closefrom(), we were failing
3639   to close the highest numbered open fd in our closefrom() replacement.
3641 * Our closefrom() replacement on Linux now works around valgrind not hiding
3642   some extra fds it has open, but then complaining if we try to close them.
3644 + Pass O_BINARY when opening replication related files in some cases where we
3645   weren't before, which will probably help solve ticket #472.
3647 * configure: socketpair() needs -lnetwork on Haiku.
3649 * Micro-optimisation in Unicode handling - GCC doesn't currently optimise the
3650   arithmetic shift right idiom we use, but it documents that signed right shift
3651   does sign extension so we now just use a right shift for GCC.
3653 debug code:
3655 * Preserve errno over debug logging calls, so they can safely be added to code
3656   which expects errno not to change.
3658 Xapian-core 1.2.12 (2012-06-27):
3660 build system:
3662 * 1.2.11 had its library version information incorrectly set.  This resulted in
3663   the shared library having an incorrect SONAME - e.g. on Linux,
3664   libxapian.so.21 instead of libxapian.so.22.  This release has been made to
3665   fix this problem.
3667 documentation:
3669 * AUTHORS: Add the GSoC students.
3671 Xapian-core 1.2.11 (2012-06-26):
3673 API:
3675 * Add new QueryParser::STEM_ALL_Z stemming strategy, which stems all terms and
3676   adds a Z prefix.  (Patch from Sehaj Singh Kalra, fixes ticket#562)
3678 * Add TermGenerator::set_stemming_strategy() method, with strategies which
3679   correspond to those of QueryParser.  Based on patch from Sehaj Singh Kalra,
3680   with some tweaks for adding term positions in more cases.  (Fixes ticket#563)
3682 * Correct "BM25Weight" to "TradWeight" in exception message from TradWeight.
3684 * We were failing to call init() for user-defined Weight objects providing the
3685   term-independent weight.  These now get called with init(0.0).
3687 * Xapian::Auto::open_stub() now throws a Xapian::DatabaseOpeningError exception
3688   if the stub file can't be opened.  Previously we failed to check for this
3689   condition, which resulted in us treating the file as empty.
3691 testsuite:
3693 * When the testsuite is using valgrind, we used to run remote servers under
3694   valgrind too (but with --tool=none) to get consistent behaviour as valgrind's
3695   emulation of x87 excess precision isn't exact.  Now we only do this if x87 FP
3696   instructions are actually in use (which means x86 architecture and configure
3697   run with --disable-sse).
3699 * Make sure XAPIAN_MAX_CHANGESETS gets unset after replication testcases which
3700   set it, so further testcases don't waste time generating changesets.
3702 * Improved test coverage (including more tests for closed databases -
3703   ticket#337).
3705 brass backend:
3707 * After closing the database, methods which try to use the termlist would throw
3708   FeatureUnavailableError with message "Database has no termlist", assuming
3709   that the termlist table not being open meant it wasn't present.  Fix to check
3710   if the postlist_table is open to determine which case we're in.
3712 chert backend:
3714 * After closing the database, methods which try to use the termlist would throw
3715   FeatureUnavailableError with message "Database has no termlist", assuming
3716   that the termlist table not being open meant it wasn't present.  Fix to check
3717   if the postlist_table is open to determine which case we're in.
3719 inmemory backend:
3721 * Check if the database is closed in metadata_keys_begin() for InMemory
3722   Databases.
3724 build system:
3726 * xapian-config: Don't interpret a missing .la file as meaning that we only
3727   have static libraries.
3729 documentation:
3731 * Fix API documentation for Query constructors - both XOR and ELITE_SET can
3732   take any number of subqueries, not only exactly two.
3734 * Backport missing API documentation comments for operator++ and operator*
3735   methods or PositionIterator, PostingIterator and TermGenerator.
3737 * docs/replication.rst: Update documentation - since 1.2.5, the value of
3738   XAPIAN_MAX_CHANGESETS determines how many changesets we keep.
3740 * docs/admin_notes.rst: Correction - we don't "create a lock file", we "lock a
3741   file".
3743 * Fix API documentation for TradWeight constructor - "k1" should be "k".
3745 portability:
3747 * configure: Overhaul handling of compilers which pretend to be GCC.  Clang
3748   is now detected, and we only pass it warning flags it actually understands.
3749   And we now check for symbol visibility support with Intel's compiler.
3751 * configure: Solaris automatically pulls in library dependencies, so set
3752   link_all_deplibs_CXX=no there.
3754 * configure: We now check -Bsymbolic-functions for all compilers.
3756 * configure: Enable -Wdouble-promotion for GCC >= 4.6.
3758 * Pass -ldl last when compiling zlib-vg.so, as that seems to be needed on
3759   Ubuntu 12.04.
3761 * Fix incorrect use of "delete" which should be "delete []".  This is
3762   undefined behaviour in C++, though the type is POD, so in practice this
3763   probably worked OK on many platforms.
3765 * In BM25Weight when k1 or b is zero (not the default), we used to multiply
3766   an uninitialised double by zero, which is undefined behaviour, but in
3767   practice will often give zero, leading to the desired results.
3769 * xapian.h: Add check for Qt headers being included before us and defining
3770   'slots' as a macro - if they are, give a clear error advising how to work
3771   around this (previously compilation would fail with a confusing error).
3773 Xapian-core 1.2.10 (2012-05-09):
3775 API:
3777 testsuite:
3779 * apitest: Extend tradweight1 to test that TradWeight(0) means that wdf and
3780   document length don't affect the weight of a term.
3782 * termgentest: Check that TermGenerator discards words > 64 bytes.
3784 matcher:
3786 * Don't count unweighted subqueries of MultiAndPostList in percentage
3787   calculations, as OP_FILTER maps to MultiAndPostList now.  (ticket#590)
3789 brass backend:
3791 * When compacting, if the output database is empty, don't write out a metainfo
3792   tag.  Take care not to divide by zero when computing the percentage size
3793   change for a table.
3795 chert backend:
3797 * When compacting, if the output database is empty, don't write out a metainfo
3798   tag.  Take care not to divide by zero when computing the percentage size
3799   change for a table.
3801 documentation:
3803 * API documentation:
3805  + Note version when Database::close() was added.
3807  + Fix switched lower and upper in API documentation for Weight methods
3808    get_doclength_lower_bound() and get_doclength_upper_bound().  Correct
3809    maximum to minimum in get_doclength_lower_bound() comment and note that this
3810    excludes zero length documents.  Fix "An lower" to "A lower".
3812 * docs/admin_notes.html: Mention that postlist and termlist tables also hold
3813   value info for chert.  Mention that xapian-chert-update was removed in 1.3.0.
3814   Mention that you need to use copydatabase from 1.2.x to convert flint to
3815   chert.
3817 * HACKING: Update section on patches to mention git (git diff and git
3818   format-patch), and using "-r" with normal diff, and also that ptardiff offers
3819   a nice way to diff against an unpacked tarball.
3821 debug code:
3823 * Fix use of AssertEq() on NULL, which doesn't compile, at least with recent
3824   GCC.
3826 Xapian-core 1.2.9 (2012-03-08):
3828 API:
3830 * QueryParser: Fix FLAG_AUTO_SYNONYMS not to enable auto multi-word synonyms
3831   too (but in a different way to trunk so as to not break the ABI).
3833 matcher:
3835 * Fix issue with running AND, OR and XOR queries against a database with no
3836   documents in it - this was leading to a divide by zero, which led to
3837   MSet::get_matches_estimated() reporting 2147483648 on i386.
3839 build system:
3841 * Remove configure's --with-stlport and --with-stlport-compiler options, as
3842   they don't allow you to actually specify what you need to (at least to use
3843   the Debian STLport package), and instead document what to pass to configure
3844   to enable building with STLport (though it seems to no longer be actively
3845   maintained, and the debug mode (which is probably the most interesting
3846   feature now) doesn't seem to work on Debian stable).
3848 documentation:
3850 * Document that OP_ELITE_SET with non-term subqueries might pick subqueries
3851   which don't match anything.  Closes ticket#49.
3853 * Document that you can define a static operator delete method in your subclass
3854   if deallocation needs to be handled specially.  (Closes ticket#554)
3856 * Assorted minor documentation improvements.
3858 portability:
3860 * Address new warnings from GCC 4.6.
3862 * Fix argument order when linking xapian-check to fix mingw build.
3863   (ticket#567)
3865 * Add some missing explicit header includes to fix build with STLport.
3867 Xapian-core 1.2.8 (2011-12-13):
3869 API:
3871 * Add support to TermGenerator and QueryParser for indexing and searching CJK
3872   text using n-grams.  Currently this is only enabled when the environmental
3873   variable XAPIAN_CJK_NGRAM is set to a non-empty value.
3875 documentation:
3877 * Add link from index page to apidoc.pdf.
3879 * quickstart.html: Correct link which was to quickstartsearch.cc.html but
3880   should be to quickstartindex.cc.html.
3882 * overview.html,quickstart.html: Fix several factual errors.
3884 * API documentation:
3886   + Improve documentation comments for several methods.
3888   + Add documentation for function parameters which didn't have it.
3890   + Remove bogus paragraph in WritableDatabase::replace_document()
3891     documentation comment which had been cut and pasted from delete_document()
3892     documentation comment.  (Fixes ticket#579)
3894   + Explicitly document which value slot numbers are valid.  (Fixes ticket#555)
3896   + Escape < and > in doxygen comments so "<foo>" doesn't get eaten by doxygen.
3898 portability:
3900 + Some fixes for warnings when cross-compiling to mingw.
3902 * tests/soaktest/soaktest.cc: With Sun's compiler, random() and srandom()
3903   aren't in <cstdlib> so we need to use <stdlib.h> instead.
3905 Xapian-core 1.2.7 (2011-08-10):
3907 API:
3909 * Document objects now track whether any document positions have been modified
3910   so that replacing a modified document can completely skip considering
3911   updating positions if none have changed.  Currently the flint, chert, and
3912   brass backends implement this optimisation.  A common case this speeds up is
3913   adding and/or removing boolean filter terms to/from existing documents - for
3914   example this gives an 18% speedup for adding tags in notmuch.
3916 testsuite:
3918 * Make sure that perftest isn't run with libeatmydata preloaded, as making
3919   fsync() a no-op makes performance tests rather bogus.
3921 remote backend:
3923 * Remove unnecessary call to reopen() in the remote servers in a case where
3924   either we had just called it or we are using a writable database and so
3925   reopen() doesn't do anything.
3927 build system:
3929 * configure: -Wshadow gives bogus warnings with 4.0 (at least on Mac OS X), so
3930   disable it for GCC < 4.1 (like the comments already said we did!)
3932 documentation:
3934 * Improve the documentation comment for Database::close().  (ticket#504)
3936 * Fix typo in documentation comment for Enquire constructor which reversed the
3937   intended sense (though the text was fairly obviously wrong before).
3939 * Improve documentation of QueryParser::add_boolean_prefix()'s exclusive
3940   parameter to talk about terms and prefixes rather than values and fields
3941   (which was confusing since "document value" has a particular meaning in
3942   Xapian).
3944 * docs/facets.html: Expand descriptions for indexing and finding facets.
3945   Fix errors in example code.
3947 * docs/index.html: Add links to Omega and bindings documentation.
3949 * docs/remote_protocol.html: Fixed typo which reversed the intended sense.
3951 * xapian-check --help: Document that checking a whole database performs
3952   additional cross-checks between the tables.
3954 * docs/admin_notes.html: Add note about xapian-chert-update.
3956 * docs/deprecation.html: Note here that WritableDatabase::flush() is
3957   deprecated in favour of WritableDatabase::commit().
3959 portability:
3961 * Fix -Wshadow warnings from GCC 4.6.
3963 * Fix warning from GCC 3.3.
3965 debug code:
3967 * Fix some problems with the templates used to implement output of parameters
3968   and return values in debug logging.
3970 Xapian-core 1.2.6 (2011-06-12):
3972 API:
3974 * QueryParser:
3976   + Add new set_max_wildcard_expansion() method to allow limiting the number of
3977     terms a wildcard can expand to.  (ticket#350)
3979   + If default_op is OP_NEAR or OP_PHRASE then disable stemming of the terms,
3980     since we don't index positional information for stemmed terms by default.
3982 * Spelling correction was failing to correctly handle words which had the same
3983   trigram in an even number of times.
3985 testsuite:
3987 * We now actually include the soaktest code in the release tarballs.
3989 matcher:
3991 * Eliminate some vector copies when handling phrase subqueries in the query
3992   optimiser.
3994 brass backend:
3996 * Kill the child process which holds the lock with SIGKILL as that can't be
3997   ignored, whereas SIGHUP can be in some cases.
3999 chert backend:
4001 * Kill the child process which holds the lock with SIGKILL as that can't be
4002   ignored, whereas SIGHUP can be in some cases.
4004 flint backend:
4006 * Kill the child process which holds the lock with SIGKILL as that can't be
4007   ignored, whereas SIGHUP can be in some cases.
4009 documentation:
4011 * The HTML documentation is now maintained in reStructured Text format.
4013 * docs/queryparser.html: Document the precedence order of operators.
4015 * docs/scalability.html: Bring up-to-date.
4017 * docs/overview.html: Document "remote" in stub databases.
4019 * docs/postingsource.html: Add PostingSource example.  (ticket#503)
4021 * include/xapian/database.h: Add @exception InvalidArgumentError for
4022   Database::get_document() (ticket#542).
4024 * Ship ChangeLog.0 in the tarball.
4026 * Assorted minor improvements.
4028 examples:
4030 * examples/delve: Report has_positions().
4032 * examples/simpleindex: Add short description to usage message.
4034 portability:
4036 * Fix to build for mingw.
4038 Xapian-core 1.2.5 (2011-04-04):
4040 API:
4042 * Enquire::get_eset() now accepts a min_wt argument to allow the minimum wanted
4043   weight to be specified.  Default is 0, which gives the previous behaviour.
4045 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
4046   integer the same way at the end of the query as in the middle.
4048 * Replication:
4050   + Only keep $XAPIAN_MAX_CHANGESETS changeset files when generating a new one
4051     (previously this variable only controlled if we generated changesets or
4052     not).  Closes ticket#278.
4054   + $XAPIAN_MAX_CHANGESETS is reread each time, rather than only when the
4055     database is opened.
4057   + If you build Xapian with DANGEROUS mode enabled, changeset files now
4058     actually have the appropriate flag set (the reader will currently throw an
4059     exception, but that's better than quietly handling them incorrectly).
4061 testsuite:
4063 * Compaction tests which generate stub files now close them before performing
4064   the actual compaction, to avoid issues on Microsoft Windows (ticket#525).
4066 * Improve test coverage.
4068 matcher:
4070 * Fix memory leak if an exception is thrown during the match.
4072 brass backend:
4074 * Bumped format version number (we now store the oldest revision for which we
4075   might have a replication changeset).
4077 * Optimise not to read the bitmaps from the base files when opening a database
4078   for reading (cross-port of equivalent change to chert).
4080 * Optimise not to update doclength when it hasn't changed (cross-port of
4081   equivalent change to chert).
4083 * If we try to delete an old base file and it isn't there, just continue rather
4084   than throwing an exception.  We wanted to get rid of it anyway, and it may be
4085   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
4086   was rather a pessimistic assessment.
4088 chert backend:
4090 * Optimise not to read the bitmaps from the base files when opening a database
4091   for reading.
4093 * Optimise not to update doclength when it hasn't changed.
4095 * xapian-chert-update: Fix to handle larger databases, and databases which
4096   have values set.
4098 * If we try to delete an old base file and it isn't there, just continue rather
4099   than throwing an exception.  We wanted to get rid of it anyway, and it may be
4100   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
4101   was rather a pessimistic assessment.
4103 flint backend:
4105 * Optimise not to read the bitmaps from the base files when opening a database
4106   for reading (cross-port of equivalent change to chert).
4108 * Optimise not to update doclength when it hasn't changed (cross-port of
4109   equivalent change to chert).
4111 * If we try to delete an old base file and it isn't there, just continue rather
4112   than throwing an exception.  We wanted to get rid of it anyway, and it may be
4113   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
4114   was rather a pessimistic assessment.
4116 remote backend:
4118 * xapian-tcpsrv: If we can't bind to the specified port because it is a
4119   privileged one, exit with code 77 (EX_NOPERM) to make it easier to
4120   automatically handle failure when starting the server from a script.
4122 build system:
4124 * Snapshots and releases are now bootstrapped with autoconf 2.68 and libtool
4125   2.4.
4127 * configure: -Wstrict-null-sentinel was added in GCC 4.0.1 and so doesn't work
4128   with GCC 4.0.0.  For simplicity, only enable it for GCC >= 4.1.
4130 documentation:
4132 * INSTALL: Note how to build for a non-default arch on a multi-arch platform.
4134 * include/xapian/enquire.h: Fix doxygen markup so alternative overloaded forms
4135   of Enquire::get_mset() appear in the API documentation.
4137 * collapsing.html: Add missing document (written some time ago, but never
4138   actually added to builds).
4140 * replication.html: Update documentation to make it clear that users shouldn't
4141   create the destination directory for replication themselves.
4143 * docs/intro_ir.html: Update link to a paper.  Update text about book "to be
4144   published in 2008".
4146 * docs/deprecation.html:
4148   + PostingSource now offers a replacement for Enquire::set_bias().
4150   + OmegaScript: $set{spelling,true} is now deprecated.
4152   + Add note about botched removal of Enquire.get_matching_terms from Python
4153     bindings (now fully removed).
4155   + Note removal of "if idx in mset" from Python bindings.
4157   + Deprecate MSet.items and ESet.items from Python bindings (ticket#531).
4159 * docs/admin_notes.html: Update for 1.2.5.
4161 * Updates to documentation of internals.
4163 tools:
4165 * xapian-replicate-server: Fix race condition between checking if a file
4166   exists and opening it to replicate it.
4168 * xapian-replicate: Complain unless host name and port number are specified -
4169   previously these defaulted to an empty string and 0, which resulted in
4170   potentially confusing error messages.
4172 * xapian-replicate: If --master isn't specified, default to DATABASE.
4174 examples:
4176 * quest: Report any spelling correction (requires the database contains
4177   spelling data of course).
4179 * copydatabase: Add --no-renumber option.
4181 portability:
4183 * api/compactor.cc: Add missing header <ctime> for time() (ticket#530).
4185 * api/compactor.cc: Use msvc_posix_rename() under __WIN32__ to atomically
4186   update stub file after compaction (ticket#525).
4188 * Fix uninitialised variable warnings with gcc -O3.
4190 * Eliminate std::string member of global static object used when compiled with
4191   --enable-log which was causes problems on Mac OS X.
4193 * Fix some issues highlighted by clang++ warnings.
4195 Xapian-core 1.2.4 (2010-12-19):
4197 API:
4199 * QueryParser:
4201   + Avoid a double free if Query construction throws an exception in a
4202     particular case.  Fixes ticket#515.
4204   + Allow phrase generators between a probabilistic prefix and the term itself
4205     (e.g. path:/usr/local).
4207   + The correct window size wasn't being set in some cases when default_op was
4208     set to OP_PHRASE.
4210 * Enquire::get_mset():
4212   + Avoid pointlessly trying to allocate lots of memory if the first document
4213     requested is larger than the size of the database.
4215   + An empty query now returns an MSet with firstitem set correctly -
4216     previously firstitem was always 0 in this case.
4218 * Document: Initialise docid to 0 when creating a document from
4219   scratch, as documented.
4221 * Compactor:
4223   + Move the database compaction and merging functionality into this new class,
4224     and make xapian-compact a simple wrapper around this class.  (ticket#175)
4226   + Inputs can now be stub database directories or files, in which case the
4227     databases in the stub are used as inputs.
4229   + Add support for compacting to a stub database, which can be one of the
4230     inputs (for atomic update).
4232   + If spellings and/or synonyms were only present in some source databases,
4233     they weren't copied to the output database, but now they are.
4235 testsuite:
4237 * Improve test coverage (particularly for Xapian::Utf8Iterator and
4238   Xapian::Stem).
4240 * Add zlib-vg.c to distribution tarballs.
4242 * tests/runtest: Add XAPIAN_TESTSUITE_LD_PRELOAD hook to allow libeatmydata to
4243   easily be used to speed up testsuite runs.
4245 matcher:
4247 * The matcher wasn't recalculating the max possible weight after a subquery of
4248   XOR reached its end.  This caused an assertion failure in debug builds, and
4249   is a missed optimisation opportunity.
4251 * Implement SelectPostList::check() so that check() on OP_NEAR and OP_PHRASE
4252   subqueries will just check a single document, not a potentially huge numbers
4253   of documents.
4255 * BM25Weight: Fix calculation order to avoid inconsistent weights due to
4256   rounding when certain non-default parameter combinations are used.
4258 * TradWeight: Fix calculation order to avoid inconsistent weights due to
4259   rounding with TradWeight(0).
4261 * Fix regression in speed of OP_OR queries in certain cases due to optimisation
4262   added in 1.0.21/1.2.1.
4264 * In the query optimiser, use value range bounds to detect value ranges which
4265   must be empty.
4267 remote backend:
4269 * Add support for iterating metadata keys with the remote backend.  This change
4270   necessitated an increase in the minor version of the remote protocol.  If you
4271   are upgrading a live system which uses the remote backend, upgrade the
4272   servers before the clients.
4274 build system:
4276 * xapian-config: Add --static option which makes other options report values
4277   for static linking.
4279 * xapian-config is now removed by "make distclean" not "make clean".
4281 * configure: FreeBSD and OpenBSD don't need explicit dependency libraries, so
4282   set link_all_deplibs_CXX=no there.
4284 * This release uses autoconf 2.67 rather than 2.65.
4286 documentation:
4288 * INSTALL: Raise recommended GCC version from 3.3 to 4.1, since that's the
4289   oldest we regularly test with.
4291 * replication.html: Update and improve in various ways.
4293 * Remove lingering "experimental" marker from PostingSource and
4294   ValueCountMatchSpy API documentation.
4296 * index.html: Add links to replication and facets documents, and fix typo in
4297   serialisation document link.
4299 * internals.html: Add link to replication protocol.
4301 * Change the categorisation document to talk about facets, since that's the
4302   terminology that seems to be most widely used these days, and
4303   "categorisation" can also mean automatically assigning categories to
4304   documents.  Also update to reflect the final API.
4306 * deprecation.html: Add guidelines for supporting other software.
4308 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
4309   currently supported.
4311 * PLATFORMS: Move PLATFORMS information to the wiki and replace with a pointer.
4313 tools:
4315 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
4316   This could have caused problems, though we've had no reports of any (the
4317   bug was found with _GLIBCXX_DEBUG).
4319 * xapian-compact: Add --quiet/-q option to suppress progress output.
4320   (ticket#437)
4322 * xapian-replicate: If a full copy was attempted, but was not put live, display
4323   an explanatory message (in verbose mode).
4325 examples:
4327 * examples/quest: Add command line options to allow prefixes to be specified
4328   for the QueryParser.
4330 * examples/delve: Add '-z' option to count zero-length documents.
4332 * examples/simplesearch: Fix cut-and-paste errors in usage message and
4333   --version output.
4335 portability:
4337 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
4338   control of which SSE instructions to use.
4340 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
4342 * configure: Beef up the test for whether -lm is required and add a special
4343   case to force it to be for Sun's C++ compiler - there's some interaction with
4344   libtool and/or shared objects which means that the previous configure test
4345   didn't think -lm is needed here when it is.
4347 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
4349 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
4350   68030 as well as 68000.
4352 * Fix compilation with Sun's C++ compiler.
4354 * Fix testsuite to build on Solaris < 10.
4356 Xapian-core 1.2.3 (2010-08-24):
4358 API:
4360 * Database::get_spelling_suggestion() will now suggest a correction even if the
4361   passed word is in the dictionary, provided the correction has at least the
4362   same frequency.  Partly addresses #225.
4364 * QueryParser:
4366   + Fix handling of groups of terms which are all stopwords - in situations
4367     where this causes a problem we now disable stopword checks for such groups.
4368     (ticket#245)
4370   + Fix to be smarter about handling a boolean filter term containing ".." in
4371     the presence of valuerangeprocessors.
4373 testsuite:
4375 * New "unittest" program for testing low level functions directly.  Currently
4376   this has tests for the internal resolve_relative_path() function.
4377   (ticket#243)
4379 remote backend:
4381 * Retry select() if it fails with EINTR while waiting for connect(), and
4382   discriminate cases with same failure message to aid debugging.
4384 documentation:
4386 * Fix documentation comment for Xapian::timeout type - it holds a time interval
4387   in milliseconds not microseconds (the API docs for the methods which use it
4388   explicitly correctly document that the timeouts are in milliseconds).
4390 * libuuid moved from e2fsprogs to util-linux-ng about a year ago, so update
4391   documentation, comments, and configure error messages to reflect this.
4393 portability:
4395 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
4396   (ticket#492).
4398 * Fix handling of some obscure cases of resolving relative paths on Microsoft
4399   Windows.  (ticket#243).
4401 * Optimise closing of all unwanted file descriptors after forking by using
4402   closefrom() if available, and otherwise providing our own implementation
4403   (optimised to some extent for many platforms).
4405 * Fix test harness to build under Microsoft Windows (ticket#495).
4407 packaging:
4409 * xapian-core.spec: Add xapian-metadata and cmake related files to RPM
4410   packaging.
4412 * xapian-core.spec: Update BuildRequires to specify libuuid-devel instead of
4413   e2fsprogs-devel.
4415 debug code:
4417 * Improve logging of function parameter placeholder strings.
4419 Xapian-core 1.2.2 (2010-06-27):
4421 brass backend:
4423 * Sync changes from each Btree table to disk right after syncing changes to
4424   its base file, which allows more time for the table changes to be written
4425   and may also be more efficient with some Linux kernel versions.
4427 chert backend:
4429 * Sync changes from each Btree table to disk right after syncing changes to
4430   its base file, which allows more time for the table changes to be written
4431   and may also be more efficient with some Linux kernel versions.
4433 tools:
4435 * xapian-check: Don't try to check document lengths are consistent between the
4436   postlist and termlist tables if it would use more than 1GB of memory, and
4437   handle std::bad_alloc or std::length_error when trying to allocate space
4438   for this.  This issue affected sup users, as sup allocates docids such that
4439   they are sparse and large docids can easily occur.
4441 examples:
4443 * delve: Show the database's UUID.
4445 portability:
4447 * Revert 1.2.1 change to visibility of Xapian::Weight's copy constructor as
4448   it making it private broke compilation with GCC 4.1 (which seems to be a
4449   bug in this compiler version).
4451 * tests/harness/testsuite.cc: Need <cstdio> for sprintf().  Fixes compilation
4452   error which was masked if valgrind was installed.  (ticket#489)
4454 packaging:
4456 * xapian-core.spec: Update for 1.2.x - add e2fsprogs-devel to BuildRequires and
4457   add new files to install.
4459 Xapian-core 1.2.1 (2010-06-22):
4461 This release includes all changes from 1.0.21 which are relevant.
4463 API:
4465 * QueryParser: Add support for open-ended ranges (ticket#480).
4467 * Add new optional parameter to QueryParser::add_boolean_prefix() to allow the
4468   user to indicate a prefix isn't "exclusive" and that multiple instances
4469   should be combined with OP_AND rather than OP_OR.  Fixes ticket#402.  This
4470   change should also improve efficiency as it avoids copying the lists of
4471   prefixes and compares them more efficiently.
4473 * You can now specify a custom stemming algorithm by subclassing
4474   Xapian::StemImplementation, mostly based on patch from Evgeny Sizikov in
4475   ticket#448.
4477 * Fix replication bug: when multiple commits were made to the master database
4478   while a client was performing a full copy, the client would only apply the
4479   first changeset and then try to make the database live, but fail due to
4480   trying to set the wrong revision number.
4482 * Replication no longer sleeps between applying changesets to an offline
4483   database.  It's only necessary to sleep for a live database (to allow readers
4484   to complete a search without getting DatabaseModifiedErrror.
4486 * xapian-replicate: Add new "-r" command line option to specify how long
4487   replication sleeps for between applying changesets to a live database.
4489 * If a Btree table doesn't exist when applying a replication changeset, create
4490   it.  This fixes replicating a revision where a lazy table is created.
4491   (ticket#468)
4493 testsuite:
4495 * zlib can produce "uninitialised" output from "initialised" input - the
4496   output does decode to the input, so this is presumably just some unused bits
4497   in the output, so we use an LD_PRELOAD hack to get valgrind to check the
4498   input is initialised and then tell it that the output is initialised.
4500 * Don't pass NULL to closedir(), which fixes test harness failures on platforms
4501   without /proc/self/fd.
4503 * Use safesyswait.h, fixing build failure on "make check" on FreeBSD.
4505 * Check is SA_SIGINFO is defined before using it as it isn't available
4506   everywhere.  Fixes testsuite build failure on GNU Hurd.
4508 * Add a "soaktest" testsuite, intended to contain long-running tests with
4509   random data.  Currently contains a single test which builds and runs random
4510   queries, checking that the results returned are consistent when asking for
4511   different result ranges.
4513 * Test UUID returned by Database::get_uuid() is 36 characters long.
4515 matcher:
4517 * Xapian no longer forces the wdf_max value to be at least one in
4518   BM25Weight::get_maxpart().  We used to do this so that a non-existent term in
4519   the query would cause it not to achieve 100%, but now we calculate
4520   percentages based on the number of matching subqueries, and it is more
4521   natural for a non-existent term to get zero weight (ditto for a term which
4522   always has wdf 0).
4524 * OP_VALUE_RANGE and OP_VALUE_GE now use value streams directly which is much
4525   more efficient for chert (the default backend in 2.2.x).  As an example, a
4526   range query testcase which previously took 29 seconds now takes 0.4 seconds
4527   (70 times faster).  (ticket#432)
4529 * The term statistics from multiple databases are now gathered in a simpler
4530   way which is a bit faster and uses less memory.
4532 build system:
4534 * Install headers under PREFIX/include not PREFIX/include/xapian.  If you used
4535   XO_LIB_XAPIAN or xapian-config in your build system, the headers would still
4536   have been found.
4538 * Releases and snapshots are now generated with libtool 2.2.10 instead of
4539   2.2.6.
4541 * Fix build failures with some combinations of backends disabled (partially
4542   addresses ticket#361 - some combinations still fail).
4544 * Add check to configure that GCC actually supports visibility for the platform
4545   being built for, which fixes compiler warnings with platforms which don't
4546   (such as Mac OS X and mingw).
4548 documentation:
4550 * Update documentation - replication and PostingSource aren't experimental in
4551   1.2.x.
4553 portability:
4555 * Make use of built-in UUID API on FreeBSD and NetBSD.  (ticket#470)
4557 * Fix mingw build.
4559 debug code:
4561 * Add new pretty printer for values reported by calls and returns in debug
4562   logging - in particular, strings are now reported with non-printable
4563   characters escaped.
4565 * Debug logging should have less runtime overhead when built in but not in use.
4567 * Drop support for --enable-log=profile - dedicated profiling tools are likely
4568   to return more useful results.
4570 Xapian-core 1.2.0 (2010-04-28):
4572 This release includes all changes from 1.0.20 which are relevant.
4574 testsuite:
4576 * Fix --abort-on-error to actually work.
4578 * Exit with status 1 not 0 if we caught an exception from the harness itself.
4580 Xapian-core 1.1.5 (2010-04-16):
4582 This release includes all changes from 1.0.19 which are relevant.
4584 API:
4586 * Database replication now handles an exception while applying a changeset
4587   better.
4589 * If environment variable XAPIAN_MAX_CHANGESETS is set on a replication client
4590   then any changesets read are saved so the replicated copy can itself be
4591   replicated.
4593 testsuite:
4595 * Use sigsetjmp() and siglongjmp() where available so that the set of blocked
4596   signals get restored and the test harness can catch a second incidence of a
4597   particular signal in a run.  Use sigaction() instead of signal() where
4598   available, which allows us to report the address associated with SIGSEGV,
4599   SIGFPE, SIGILL, and SIGBUS.
4601 * Add machinery to check for leaked file descriptors.  Currently this requires
4602   /proc/self/fd to work (which is present on Linux and some other platforms).
4603   Remove the crude ulimit in runtest which has caused problems on some Debian
4604   buildds.
4606 * The test harness now explicitly catches const char * exceptions and reports
4607   their contents.
4609 brass backend:
4611 * Ensure that the wdf upper bound is correctly updated when replacing
4612   documents.
4614 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
4616 chert backend:
4618 * Ensure that the wdf upper bound is correctly updated when replacing
4619   documents.
4621 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
4623 * xapian-check: Check that the initial doclen chunk exists.
4625 flint backend:
4627 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
4629 remote backend:
4631 * Add remote backend support for WritableDatabase::add_spelling() and
4632   WritableDatabase::remove_spelling().  This bumps the remote protocol to
4633   version 35.0 (so both client and servers will need updating).  Suggesting
4634   spelling corrections isn't yet supported.  (ticket#178)
4636 build system:
4638 * XO_LIB_XAPIAN: Give a more specific error message for the cases where
4639   XAPIAN_CONFIG isn't found, is a directory, or isn't executable.
4641 examples:
4643 * delve:
4645   + If any documents are specified with "-d<docid>", "-V<slot>" now only show
4646     values for those documents.
4648   + Remove undocumented -k option, which has been a compatibility alias for -V
4649     since 0.9.10.  Just use -V instead.
4651 * xapian-metadata: Add new example program which allows you to get and set
4652   individual user metadata entries.
4654 Xapian-core 1.1.4 (2010-02-15):
4656 This release includes all changes from 1.0.18 which are relevant.
4658 API:
4660 * Xapian::TermGenerator,Xapian::QueryParser,Xapian::Unicode::is_wordchar():
4661   Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories to is_wordchar(),
4662   which is used by TermGenerator and QueryParser.  Also make TermGenerator and
4663   QueryParser ignore several zero-width space characters.  This is a better
4664   but less compatible version of a fix in 1.0.18.
4666 * Implement support for iterating valuestreams for multidatabases.
4668 * Xapian::Stem: Update the german and german2 stemming algorithms to the latest
4669   versions from Snowball.  These add an extra rule for the "-nisse" ending.
4671 * Xapian::ValueCountMatchSpy: Replace get_values() with values_begin() and
4672   values_end().
4674 * Xapian::MatchSpy: Provide an iterator for accessing the top values found
4675   instead of taking a vector by reference to return them in.
4677 * Xapian::NumericRanges: Remove experimental API we aren't happy with yet.
4679 * Xapian::DatabaseReplica, Xapian::DatabaseMaster: Remove experimental
4680   API we aren't happy with.  Replication is still supported via the
4681   command line programs.  (ticket#347)
4683 * Xapian::score_evenness(): Remove as it turns out not to be useful in practice.
4684   (ticket#435)
4686 * Xapian::ValueWeightPostingSource: A ValueWeightPostingSource with no entries
4687   would report -infinity as its upper bound, which could cause no results to be
4688   incorrectly returned for some queries involving such an object.
4690 * Xapian::WritableDatabase::close() fixed to commit() changes (unless a
4691   transaction is in progress).
4693 testsuite:
4695 * apitest: Improve test coverage in various places.
4697 matcher:
4699 * Uses of values during the match (sorting by value or Sorter, MatchSpy,
4700   MatchDecider, and collapsing) now use value stream iteration which is
4701   a lot more efficient for chert and brass (but may be slower for flint).
4703 brass backend:
4705 * New development backend.  Changes over chert:
4707   + Batched posting list changes during indexing use significantly less memory.
4709   + Instead of using complex code to iterate modified posting lists and
4710     documents length lists, brass can flush individual such lists to disk
4711     and then iterates them from there.
4713   + To iterate all terms, chert flushes all pending postlist changes.  In the
4714     case where a prefix is specified, brass only flushes postlist changes for
4715     terms starting with the specified prefix, and doesn't flush document length
4716     changes.
4718 chert backend:
4720 * Promote chert to being the stable backend.
4722 * Change the packing of integers and strings into sortable keys, which reduces
4723   database size by 2.5% in tests.  This means an incompatible change in the
4724   chert format.  You can use the new xapian-chert-update utility to update a
4725   chert database from the old format to the new format.  It works much like
4726   xapian-compact so should take a similar amount of time (and results in a
4727   compact database).
4729 * xapian-compact:
4731   + Prune unused docids off the end of each database when merging multiple
4732     databases with renumbering.
4734   + Extend --no-renumber to support merging databases, but only if they have
4735     disjoint ranges of used document ids.
4737   + Ensure that the resultant database has a fresh UUID (previously chert
4738     copied the UUID from the first input).
4740 * xapian-check:
4742   + Fix checking of the METAINFO key in chert.  For small databases, the
4743     statistics fit in few enough bytes that incorrect check appeared to
4744     succeed and no errors were reported, but for larger databases an
4745     error was incorrectly reported.
4747   + Rework the checking of postlist chunks to use a cleaner approach which
4748     should report errors better.
4750   + Use a type wider than 32 bits to keep count of items in a table.
4751     Previously xapian-check would report the number of entries modulo
4752     4294967296.
4754 * When iterating a value stream, skip_to() now only assigns the value to a
4755   std::string when it reaches its target.  This saves a lot of unnecessary
4756   string copying - in a real-world test it improved the time for 100 queries
4757   from 3.66s to 3.10s.
4759 * When skipping through a chunk of postings to find the one we want, don't
4760   bother to unpack the wdf values we're skipping over.  This should save a
4761   significant amount of time in certain cases where the profile data shows
4762   about a third of the time is spent in the function where this happens.
4764 * Report locking failure due to running out of file descriptors better.
4766 flint backend:
4768 * xapian-compact:
4770   + Prune unused docids off the end of each database when merging multiple
4771     databases with renumbering.
4773   + Ensure that the resultant database has a fresh UUID (previously flint
4774     didn't set a UUID so one would be generated on demand when next requested,
4775     but only if the database was writable).
4777 * Report locking failure due to running out of file descriptors better.
4779 remote backend:
4781 * Add support for WritableDatabase::set_metadata() and Database::get_metadata()
4782   to the remote backend (based largely on patch in #178).
4784 inmemory backend:
4786 * Read the document data and values lazily for the inmemory backend like we do
4787   for other backends.  They're much less costly to fetch than if a disk or
4788   network access is involved, but it avoids copying potentially large data
4789   which may not be needed.  Consistency here also makes things easier to
4790   understand for both users and developers.
4792 build system:
4794 * This release uses autoconf 2.65 rather than 2.64.
4796 documentation:
4798 * docs/replication.html: Add note about not using reopen() with databases being
4799   updated by the replication client.
4801 * docs/admin_notes.html: Update for chert and other recent changes.
4803 * Remove out-of-date reference in the API documentation comment to an
4804   add_slot() method.  This no longer exists - you need to use multiple
4805   ValueCountMatchSpy objects to monitor more than one slot.
4807 examples:
4809 * simpleexpand,simpleindex,simplesearch: Handle --help and --version.
4811 debug code:
4813 * The debug log now reports boolean values as "true" and "false" (instead of
4814   "1" and "0").
4816 Xapian-core 1.1.3 (2009-09-18):
4818 This release includes all changes from 1.0.15-1.0.17 which are relevant.
4820 API:
4822 * Update Unicode character database to Unicode 5.2.  (ticket#351)
4824 * Rename Xapian::Sorter to Xapian::KeyMaker, paving the way for using it to
4825   build collapse keys too.  Xapian::Sorter remains for compatibility (and is
4826   now a subclass of Xapian::KeyMaker) but is deprecated.
4828 * Resolve the inconsistency in MultiValueSorter::add()'s "forward" parameter
4829   versus the "reverse" parameters which the Enquire sorting functions now take
4830   by replacing the class with MultiKeyMaker with a renamed method add_value()
4831   with a "reverse" parameter.  MultiValueSorter remains with the old semantics
4832   for compatibility but is deprecated.  (ticket#359)
4834 * QueryParser: Don't apply spelling correction to wildcarded terms, or to terms
4835   at the end of the query which we expand under FLAG_PARTIAL.
4837 * Add new Error subclass SerialisationError which we throw for serialisation
4838   related errors (which previously mostly threw NetworkError.
4840 * Rename Xapian::SerialisationContext to Xapian::Registry.
4842 * Add DecreasingValueWeightPostingSource class, which reads weights from a
4843   value slot in which a significant range of the values are in decreasing
4844   order.  This functions similarly to ValueWeightPostingSource, but can be much
4845   more efficient.
4847 * Add new Xapian::MatchSpy class:
4849   + This replaces the use of Xapian::MatchDecider as a "matchspy", which is now
4850     deprecated.  The new class only inspects, and can't reject.  It can work
4851     with remote databases, with the results being serialised to return them
4852     across the link.
4854   + Add subclass ValueCountMatchSpy, which counts the occurrences of each value
4855     in a slot in the search results seen (useful for faceted or categorisation
4856     systems).  The results can be grouped into ranges using the NumericRange
4857     and NumericRanges classes, and the score_evenness() function.  This API is
4858     currently experimental.
4860 * Remove default implementation of Weight::clone() which returns NULL.  We
4861   always need clone() to be implemented because it's called for every term
4862   in the query, not just used for the remote backend.
4864 chert backend:
4866 * Rewrite the low level packing and unpacking functions more efficiently.  As
4867   well as being generally faster, the pack functions now take a reference to a
4868   string to append to, which avoids creating a lot of temporary string objects.
4869   Indexing HTML files with omindex is 5-10% faster.  Searching for "The" on
4870   gmane (which results in a lot of unpacking of postings and document lengths)
4871   is about 35% faster.  (ticket#326)
4873 * xapian-compact: Don't report an absent lazy input table as 0 size.
4875 * Fix ChertModifiedPostList to skip added-but-then-deleted-before-flush
4876   documents.  (ticket#392)
4878 * Fix WritableDatabase::get_doclength() to work properly after a call to commit
4879   for the chert backend (ticket#397).
4881 * Fix to work with the metainfo key stored in the latest format of chert
4882   databases.
4884 * Avoid doing pointless work by trying to delete non-existent lists of values
4885   when we're just adding documents.
4887 * Fix code to find the first docid in the next chunk (ticket#399).
4889 * Add support for chert databases without a termlist table (ticket#181).
4890   Currently the only way to create such a database is to create a chert
4891   database and do "rm termlist.*".
4893 flint backend:
4895 * xapian-compact: Don't report an absent lazy input table as 0 size.
4897 remote backend:
4899 * Remote protocol major version has changed to support serialising MatchSpy
4900   objects.
4902 * Fixed not to sometimes read off the end of the returned matches when
4903   searching multiple databases, some of which are remote, and when the primary
4904   ordering is by relevance.
4906 build system:
4908 * This release uses autoconf 2.64 rather than 2.63.  This means configure now
4909   makes use of shell functions, which makes it ~13% smaller, and should also
4910   make it execute faster.
4912 * configure: Send stderr output from ldconfig to config.log.
4914 * Add optional third parameter to XO_LIB_XAPIAN autoconf macro which specifies
4915   the basename for the "xapian-config" script (defaults to "xapian-config" to
4916   give the current behaviour).
4918 * This release uses doxygen 1.5.9 to generate the API documentation.
4920 documentation:
4922 * Minor improvements to the formatting of the collated API documentation.
4924 portability:
4926 * Fix code to compile with Sun's C++ compiler.
4928 * Fix our uuid_unparse_lower() replacement for older libuuid to actually
4929   compile (really fixes ticket#368).
4931 * Fix xapian-config to work with Solaris 10 /bin/sh.  (ticket#405)
4933 debug code:
4935 * Use C++ syntax for NULL with a type in log output.
4937 Xapian-core 1.1.2 (2009-07-23):
4939 This release includes all changes from 1.0.14 which are relevant.
4941 API:
4943 * Move support for a prefix/suffix from NumberValueRangeProcessor to
4944   StringValueRangeProcessor, and change NumberValueRangeProcessor and
4945   DateValueRangeProcessor to inherit from StringValueRangeProcessor so all
4946   three now support a prefix/suffix.  (ticket#220)
4948 * Query: Trim 4 bytes off the internals.  (ticket#280)
4950 * QueryParser: If default_op is OP_NEAR or OP_PHRASE then make the window size
4951   (9 + no_of_terms) to match the default for an explicit NEAR or PHRASE.
4952   (ticket#254)
4954 testsuite:
4956 * Sort out the clash between two different patches to fix leaking file
4957   descriptors when running tests with the remotetcp backend (broken by
4958   changes in 1.1.1).
4960 matcher:
4962 * If the highest weighted document doesn't match all the terms in the query,
4963   its percentage weight is now calculated by simply counting how many weighted
4964   leaf subqueries match it instead of scaling by the proportion of the weight
4965   which matches (which required accessing the termlist for that document).
4966   (ticket#363).
4968 * XOR with a SYNONYM subquery could previously achieve 100% - this has been
4969   fixed.
4971 flint backend:
4973 * Backport the lazy update changes from chert to flint:
4975   WritableDatabase::replace_document() now updates the database lazily in
4976   simple cases - for example, if you just change a document's values and
4977   replace it with the same docid, then the terms and document data aren't
4978   needlessly rewritten.  Caveats: currently we only check if you've looked at
4979   the values/terms/data, not if they've actually been modified, and only keep
4980   track of the last document read.
4982 build system:
4984 * Update to always use C++ forms for ISO C standard headers (ticket#330).
4986 * Fix several places where Xapian::doccount is used instead of
4987   Xapian::termcount, and similar issues.  It's still not possible to make
4988   these types different sizes, but we're now closer to this goal.
4989   (ticket#385).
4991 documentation:
4993 * Note that PostingSource and Weight objects returned by clone() and
4994   unserialise() methods will be deallocated with "delete".
4996 debug code:
4998 * Fix debug logging not to segfault on NULL Query::Internal pointers.
5000 Xapian-core 1.1.1 (2009-06-09):
5002 This release includes all changes from 1.0.13 which are relevant.
5004 API:
5006 * New Query::OP_SYNONYM operator, which matches the same documents as OP_OR,
5007   but attempts to weight as if the all the subqueries were a single term with
5008   their combined wdf, which should give better relevance weights.
5010 * QueryParser's synonym, wildcard, and partial query features now use
5011   the new OP_SYNONYM operator.
5013 * PostingSource: Add new set_maxweight() method to allow subclasses to tell
5014   the matcher that their maximum weight has decreased.  Make get_maxweight()
5015   a non-virtual method of the baseclass which returns the last set maxweight
5016   (which will require updates to most user subclasses. (ticket#340)
5018 * DatabaseReplica: Fix SEGV when calling get_description() on a default
5019   constructed DatabaseReplica.
5021 * Make Query::MatchAll and Query::MatchNothing const since they're immutable.
5022   All the public methods of Query are const, so this should be completely API
5023   compatible.
5025 * Methods returning an end iterator for a ValueIterator now actually return a
5026   proxy object which silently converts to ValueIterator if required.  This
5027   proxy object allows a comparison with an "_end()" method to be optimised
5028   better so that it just ends up comparing the internal member of the iterator
5029   class with NULL (previously a call to ValueIterator's destructor remained).
5030   This should be API compatible, but note that it is definitely now more
5031   efficient just to compare against the return value of the relevant _end()
5032   method than to store the end iterator explicitly.
5034 testsuite:
5036 * Testcase valuestats4 requires transactions, so indicate that and remove the
5037   explicit SKIP for inmemory.
5039 * Testcase changemaxweightsource1 uses ChangeMaxweightPostingSource, which
5040   doesn't work with multi or remote, so mark the test accordingly.
5042 * We've decided that "going back" with skip_to() or check() should have
5043   unspecified behaviour, so stop testing how this case behaves!
5045 matcher:
5047 * Subclass MultiPostList directly from PostList instead of from LeafPostList.
5048   This gets rid of two unused data members per MultiPostList in exchange for
5049   having to define 5 extra "never called" methods, but 4 of these just
5050   tailcall.
5052 * Store termfreqs and reltermfreqs for query terms in a single map rather than
5053   one map for each, which saves is more compact and likely to be faster.
5055 chert backend:
5057 * xapian-check: For chert, check value stats are the correct format and that
5058   the streamed values are consistent with their stats (ticket#277).
5060 * xapian-check: Chert doesn't store termlist entries for documents without
5061   terms, which resulted in us reporting an error when we found document ids in
5062   the doclength "postlist" which were greater than any with an entry in the
5063   termlist.  Instead compare these entries against db.get_last_docid() if we
5064   are checking a whole db and the db can be opened.  If not, suppress this
5065   check.
5067 remote backend:
5069 * When serialising stats, serialise the termfreq and reltermfreq together,
5070   rather than in separate lists.  This gives a smaller serialised form, and
5071   matches these both being stored in the same map now.  This is an incompatible
5072   remote protocol change, so bump the major version to 32.  (ticket#362)
5074 build system:
5076 * Some build failures with --disable-backend-XXX options have been fixed, but
5077   we haven't exhaustively tested all combinations.
5079 * Ship common/win32_uuid.cc and common/win32_uuid.h (ticket#367).
5081 documentation:
5083 * Update PostingSource documentation to describe how init() is called again if
5084   a PostingSource is reused.  Fixes #352.
5086 portability:
5088 * Fixed to build with GCC 4.4.
5090 * Drop support for GCC 2.95.3 and 3.0.x - we now require at least 3.1 as doing
5091   so eliminates some preprocessor conditionals which we aren't able to test
5092   regularly as we don't have easy access to such old GCC versions.  GCC 3.1 is
5093   nearly 7 years old now, and GCC3 didn't get widespread use until later
5094   versions anyway.  If you still need to use GCC < 3.1, Xapian 1.0.x should
5095   build with 2.95.3 or newer.
5097 * Older versions of libuuid don't have uuid_unparse_lower() so probe for it in
5098   configure, and if it isn't present provide an inline version in safeuuid.h
5099   (ticket#368).
5101 * Fixed to build with MSVC (ticket#379).
5103 * Add static_cast<char>() to str(bool) overload to suppress bogus MSVC warning
5104   (ticket#377).
5106 debug code:
5108 * common/debuglog.h: Add missing initialisation of uncaught_exception variable
5109   in a couple of places.
5111 Xapian-core 1.1.0 (2009-04-22):
5113 API:
5115 * All deprecated xapian-core features listed for removal in 1.1.0 have been
5116   removed.  See deprecation.html for details, and suggested updates.
5118 * The Unicode character categorisation functions have been updated from
5119   Unicode 5.0 to 5.1.
5121 * Add NON_SPACING_MARK to is_wordchar() for better tokenisation of languages
5122   which use such marks - for example, Arabic.  This is better than the stop-gap
5123   fix in 1.0 of treating NON_SPACING_MARK as a phrase-generator character
5124   when parsing queries, but it does mean that databases built from data
5125   containing such characters will need to be rebuilt.  (ticket#355)
5127 * The details of how to subclass Xapian::Weight to implement your own
5128   weighting scheme have changed incompatibly to allow user weighting schemes
5129   to have access to the same statistics as built-in schemes (ticket#213)
5130   If you have a existing subclass of Xapian::Weight you'll need to update it.
5132 * New Database methods get_doclength_upper_bound(), get_doclength_lower_bound()
5133   and get_wdf_upper_bound(), primarily intended for allowing weighting schemes
5134   to calculate tighter upper bounds on weights (which BM25Weight and TradWeight
5135   now do) which allows matcher weight-based optimisations to be more effective.
5136   Chert actually tracks doclength bounds and a global (rather than per term)
5137   upper bound on wdf; other backends return much less tight bounds, but these
5138   still lead to better upper bounds on weights.
5140 * Enquire::get_eset() now uses an unmodified of probabilistic formula, and
5141   doesn't return terms which would get a negative weight from it (since that
5142   means they are expected to be harmful not helpful).
5144 * Add Database::close() method, which will release system resources (in
5145   particular, close filehandles) held by a database.  This is particularly
5146   useful when wrapping the API for languages with garbage collection.
5148 * Change Database::positionlist_begin() not to throw exceptions if the term or
5149   document doesn't exist.
5151 * Xapian databases now have a UUID, readable with Database::get_uuid().
5153 * A new Database replication API has been added (currently experimental).
5155 * MSet::get_termfreq() will now fall back to looking up the term frequency in
5156   the database rather than raising an exception if a term wasn't present in
5157   the query.
5159 * Calling RSet:add_document() with argument 0 now throws InvalidArgumentError.
5161 * QueryParser sped up (new version of lemon); queryparsertest runs 2.2% faster.
5163 * Add ValueSetMatchDecider, which is a matchdecider which is intended to be
5164   passed a set of values to look for in documents, and selects documents based
5165   on the presence of those values.
5167 * Add new Xapian::PostingSource class to allow passing custom sources of
5168   postings and weights to the matcher.  Built-in PostingSource subclasses:
5169   FixedWeightPostingSource, ValueMapPostingSource, ValuePostingSource, and
5170   ValueWeightPostingSource.  (Currently experimental).
5172 * Database: Add get_value_freq(), get_value_lower_bound() and
5173   get_value_upper_bound() methods to get statistics about the values stored in
5174   a slot.  Add support for the value statistics methods to chert, inmemory,
5175   multi and remote databases.
5177 * Enquire::get_eset() now faster for large ESet size.
5179 * Xapian::Document objects now have a reduced memory footprint.
5181 * Enquire::set_collapse_key() now allows you to specify a maximum number of
5182   matches with each collapse key to keep (which defaults to 1, giving the
5183   previous behaviour).  Enquire can now report bounds and an estimate of what
5184   the total number of matches would have been if collapsing wasn't in use.
5186 * WritableDatabase::commit() is a new, preferred alias for
5187   WritableDatabase::flush().  (ticket#266)
5189 * Add methods for serialising documents and queries to strings, and
5190   unserialising back from strings.  (ticket#206)
5192 testsuite:
5194 * stemtest: No longer checks environment variables OM_STEMTEST_SKIP_RANDOM,
5195   OM_STEMTEST_LANGUAGES, and OM_STEMTEST_SEED.
5197 * perftest: New performance testsuite.  This is intended to contain intended to
5198   contain potentially time-consuming performance tests, which log output to
5199   an XML file for later analysis.  It's not run by "make check" - use "make
5200   check-perf" to run it.
5202 * apitest: Now runs tests over both flint and chert for multi, remotetcp, and
5203   remoteprog.
5205 * Wait for subprocesses to finish at end of tests with remotetcp backend, to
5206   avoid test failures when the same database is used for the next testcase.
5208 matcher:
5210 * Internally, pass around non-normalised document lengths as Xapian::termcount
5211   (unsigned integer) not Xapian::doclength (double).  This gives a 3% speedup
5212   for 10 term OR queries!
5214 chert backend:
5216 * New development backend.  Use Chert::open() to explicitly create a chert
5217   format database, or set XAPIAN_PREFER_CHERT=1 in the environment to
5218   prefer chert when creating a new database without an explicit type.
5220 * Quartz and Flint stored the document length alongside every posting list
5221   entry.  Chert instead stores a chunked list of all the document lengths
5222   which saves a lot of space, and is a big win for large queries or those
5223   which don't need the document lengths.  This structure is used to
5224   implement much faster iteration (six times faster in a test) over all
5225   document ids (which speeds up queries using unary NOT, e.g. `NOT apples'),
5226   and to test for the existence of documents (instead of checking the record
5227   table for an entry).
5229 * Document values are now stored in a chunked stream for each slot for
5230   efficient access to the same slot in lots of documents.  This makes
5231   operations like sort by value much more efficient.
5233 * WritableDatabase::replace_document() now updates the database lazily in
5234   simple cases - for example, if you just change a document's values and
5235   replace it with the same docid, then the terms and document data aren't
5236   needlessly rewritten.  Caveats: currently we only check if you've looked at
5237   the values/terms/data, not if they've actually been modified, and only keep
5238   track of the last document read.
5240 flint backend:
5242 * If we can't obtain a write lock while trying to create a new database
5243   we now report the lock failure with DatabaseLockError, not
5244   DatabaseOpeningError - it's more useful to know that the lock attempt failed
5245   in this situation.
5247 * Improve reporting of failures to obtain lock due to unexpected errors.
5249 * xapian-check: Don't stop checking a table after an error in certain cases -
5250   instead increment the error counter and try to continue checking from the
5251   next item.
5253 remote backend:
5255 * The remote database protocol major version has been increased, allowing
5256   a significant amount of compatibility code to be removed.  This change means
5257   that new clients won't work with old servers, and old clients won't work
5258   with new servers.  If upgrading a live system, you will need to take this
5259   into account.
5261 * The remote servers now always default to opening a Database and the client
5262   has to send a protocol message to explicitly request write access.  This
5263   allows a single server to support multiple readers and one writer
5264   simultaneously.  (ticket#145)
5266 * Database::get_document() no longer does an unnecessary copy of the document's
5267   values.
5269 * Change serialisation of queries to be more compact and easier to parse.
5271 stub databases:
5273 * Stub databases used to assume that any relative paths were relative to the
5274   current working directory.  They now assume that relative paths are
5275   relative to the directory holding the stub database file.
5277 * Stub database lines which begin with a '#' character are now ignored,
5278   allowing comments in stub database files.
5280 * New "stub directory" database type - this is a directory containing a stub
5281   database file named "XAPIANDB".
5283 * Don't just ignore lines with no spaces in a stub database file.
5285 * Bad lines in a stub file were being ignored after we'd seen a good entry.
5287 * Add new Auto::open_stub() overload which opens a stub database file
5288   containing a single entry as a WritableDatabase.
5290 * Add support for "inmemory" to stub database (which is useful now that stub
5291   databases can be opened for writing).
5293 * A stub database file is now allowed to contain no database entries, which
5294   results in an empty Database object (this avoids user code having to special
5295   case to handle "0 or more" databases).
5297 build system:
5299 * To allow installations of Xapian 1.0 and 1.1 to easily coexist, the library
5300   is now libxapian-1.1; xapian.m4 is now xapian-1.1.m4; headers are now
5301   installed in $prefix/include/xapian-1.1.  If you use XO_LIB_XAPIAN or
5302   xapian-config as we recommend, this should all be transparent.  Also
5303   programs and scripts have a default program suffix to -1.1 unless overridden
5304   using the --program-suffix argument to configure (if you really want no
5305   suffix, "./configure --program-suffix=" will achieve this).
5307 * On Linux and k*bsd-gnu, override libtool's link_all_deplibs_CXX to "no".
5309 * On Linux, override libtool's sys_lib_dlsearch_path_spec to a list generated
5310   in a more reliable way which includes all the default directories.
5312 * configure: --enable-debug and --enable-debug-verbose have been deprecated
5313   since 1.0.0, so remove specific errors pointing to the replacements.
5315 documentation:
5317 * Disable "JAVADOC_AUTOBRIEF" in doxygen configuration since we always try to
5318   write a brief description explicitly, and JAVADOC_AUTOBRIEF causes problems
5319   in some cases.
5321 * docs/deprecation.html: Describe what "experimental" features are, and why
5322   replication and posting sources are currently experimental.
5324 * docs/deprecation.html: Deprecate Stem_get_available_languages() from the
5325   python bindings.
5327 examples:
5329 * Use C++ forms of C headers in examples (ticket#330).
5331 packaging:
5333 * xapian-core.spec: We no longer need to run autoreconf to work around
5334   libtool's incomplete sys_lib_dlsearch_path_spec or to pick up distro-specific
5335   patches for link_all_deplibs.
5337 debug code:
5339 * Report get_description() rather than the pointer value for
5340   Xapian::Query::Internal* parameters to internal functions.
5342 * The debug logging framework has been overhauled.  See HACKING for details
5343   of how it now works.
5345 * Faster integer to string functions inside the library (this is a general
5346   improvement, but will particularly speed up debug logging as that converts a
5347   lot of integers to strings).
5349 Xapian-core 1.0.23 (2011-01-14):
5351 API:
5353 * QueryParser: Avoid a double free if Query construction throws an exception
5354   in a particular case.  Fixes ticket#515.
5356 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
5357   integer the same way at the end of the query as in the middle.
5359 * Enquire::get_mset(): Avoid pointlessly trying to allocate lots of memory
5360   if the first document requested is larger than the size of the database.
5362 * Enquire::get_mset(): An empty query now returns an MSet with firstitem set
5363   correctly - previously firstitem was always 0 in this case.
5365 matcher:
5367 * The matcher wasn't recalculating the max possible weight after a subquery of
5368   XOR reached its end.  This caused an assertion failure in debug builds, and
5369   is a missed optimisation opportunity.
5371 tools:
5373 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
5374   This could have caused problems, though we've had no reports of any (the
5375   bug was found with _GLIBCXX_DEBUG).
5377 Xapian-core 1.0.22 (2010-10-03):
5379 API:
5381 * Xapian::Document: Initialise docid to 0 when creating a document from
5382   scratch, as documented.
5384 * Xapian::QueryParser: Allow phrase generators between a probabilistic prefix
5385   and the term itself (e.g. path:/usr/local).
5387 matcher:
5389 * Back out the OP_OR efficiency improvement made in 1.0.21 since this change
5390   slows down some other common cases.  We'll address this fully in 1.2.4, but
5391   that fix is more invasive than we are comfortable with for 1.0.x at this
5392   point.
5394 build system:
5396 * xapian-config: Add --static option which makes other options report values
5397   for static linking.
5399 documentation:
5401 * deprecation.html: Add guidelines for supporting other software.
5403 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
5404   currently supported.
5406 * Fix documentation for Xapian::timeout type - it holds a time interval in
5407   milliseconds not microseconds (the API docs for the methods which use it
5408   explicitly correctly document that the timeouts are in milliseconds).
5410 portability:
5412 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
5413   (ticket#492).
5415 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
5416   control of which SSE instructions to use.
5418 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
5420 * configure: Beef up the test for whether -lm is required and add a special
5421   case to force it to be for Sun's C++ compiler - there's some interaction with
5422   libtool and/or shared objects which means that the previous configure test
5423   didn't think -lm is needed here when it is.
5425 * Fix test harness to build under Microsoft Windows (ticket#495).
5427 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
5429 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
5430   68030 as well as 68000.
5432 packaging:
5434 * xapian-core.spec: Add cmake related files to RPM packaging.
5436 Xapian-core 1.0.21 (2010-06-18):
5438 API:
5440 * Xapian::Stem now recognises "nb" and "nn" as additional codes for the
5441   Norwegian stemmer.
5443 * Xapian::QueryParser now correctly parses a wildcarded term in between two
5444   other terms (ticket#484).
5446 testsuite:
5448 * Improve test coverage of OP_VALUE_RANGE and MSet::get_percent().
5450 matcher:
5452 * OP_OR could skip a matching document if it decayed to OP_AND or OP_AND_MAYBE
5453   during the match in some cases.  Fixes ticket#476.
5455 * OP_XOR with non-leaf subqueries could skip matching documents in some cases,
5456   and OP_XOR of three or more sub-queries could return incorrect weights.
5457   Fixes ticket#475.
5459 * OP_OR is now more efficient if a subquery is potentially expensive (e.g.
5460   ValueRangePostList, OP_NEAR, OP_PHRASE).  A 10-fold speed-up with
5461   ValueRangePostList has been observed.
5463 flint backend:
5465 * When iterating a table, if the table changes underneath we could end up
5466   returning the same entry twice.  (Debian#579951)
5468 * A cancelled transaction (or a failing operation implicitly cancelling
5469   pending changes) now marks the tables as unmodified, which fixes an exception
5470   trying to read block 0 if one of the tables is empty on disk.
5472 quartz backend:
5474 * When iterating a table, if the table changes underneath we could end up
5475   returning the same entry twice.  (Debian#579951)
5477 remote backend:
5479 * When daemonising, read the max fd to close with sysconf() instead of using
5480   a hardcoded value of 256, and work even if stdin and stdout have been closed.
5482 build system:
5484 * Install files to make Xapian easier to use with cmake.
5486 documentation:
5488 * Update the list of languages that the Xapian::Stem constructor recognises.
5490 * Assorted minor improvements to the collated API documentation.
5492 portability:
5494 * On x86 processors, Xapian now defaults to using SSE2 FP instructions.  This
5495   avoids issues with excess precision and it a bit faster too.  If you need
5496   to support processors without SSE2 (this means pre-Pentium4 for Intel) then
5497   configure with --disable-sse.  (ticket#387)
5499 * Fix warning when compiling for mingw with GCC 4.2.1.
5501 * Remove mutable from a couple of reference class members - mutable doesn't
5502   make sense for a reference and some compilers warn about it.
5504 Xapian-core 1.0.20 (2010-04-27):
5506 API:
5508 * MSet: Fix incorrect values reported by get_matches_estimated(),
5509   get_matches_lower_bound(), and get_matches_upper_bound() in certain cases
5510   when sorting and collapsing (ticket#464).
5512 documentation:
5514 * deprecation.html: Note how to disable deprecation warnings. (ticket#393)
5516 examples:
5518 * delve: Add -a option to list all terms in a database.
5520 * delve: -d and -V command line options now report out of range and invalid
5521   numbers.
5523 portability:
5525 * The getopt warning fix for Cygwin in 1.0.19 caused build failures on Mac OS X
5526   (and probably some other platforms with non-GNU getopt implementations), so
5527   replace with a fix which is only enabled for Cygwin. (ticket#469)
5529 Xapian-core 1.0.19 (2010-04-15):
5531 API:
5533 * QueryParser: Fix leak if Xapian::Database throws an exception during parsing
5534   (ticket#462).
5536 testsuite:
5538 * Explicitly flush after indexing for quartz and flint, so we see any
5539   exceptions from the flush (the implicit flush from the destructor swallows
5540   any exceptions).
5542 * apitest: Add databasemodified1 testcase to provide some test coverage for
5543   DatabaseModifiedError.
5545 flint backend:
5547 * When updating a document, rather than decoding the old positions, comparing
5548   with the new, and then encoding the new if different, we now just encode the
5549   new and then compare the encoded forms.  (ticket#428)
5551 * Avoid trying to delete the document positions when we know there aren't any.
5553 * Fix memory leak if Database::allterms_begin() throws an exception
5554   (ticket#462).
5556 * xapian-check: Report document id for document length mismatch.
5558 * Fix potential issues with iterators over a WritableDatabase which is modified
5559   during iteration.  No problems have actually been observed with flint, only
5560   in 1.1.4 with chert in cases which don't occur in flint, but it seems likely
5561   the issue can manifest for flint in other situations.  Fixes ticket#455.
5563 * Initialise zlib z_stream structure members zalloc, zfree, and opaque with
5564   Z_NULL rather than 0 cast to the appropriate type, as that's what the zlib
5565   documentation says to do.  Add missing initialisation of opaque for the
5566   inflate z_stream which the zlib docs say is needed (reading the zlib code,
5567   this isn't true for current versions, so this improves robustness rather
5568   than fixing an observable bug).
5570 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
5571   undefined behaviour (as a block overlaps itself).
5573 quartz backend:
5575 * Fix potential issues with iterators over a WritableDatabase which is modified
5576   during iteration.  No problems have actually been observed with quartz, only
5577   in 1.1.4 with chert in cases which don't occur in quartz, but it seems likely
5578   the issue can manifest for quartz in other situations.  Fixes ticket#455.
5580 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
5581   undefined behaviour (as a block overlaps itself).
5583 build system:
5585 * Force -fno-strict-aliasing for GCC 4.2 to avoid bad code being generated due
5586   to a bug in that compiler version.  Fixes ticket#449.  This issue hasn't been
5587   observed to affect Xapian 1.0.x, but it seems prudent to backport the fix.
5589 documentation:
5591 * INSTALL: Correct description of --enable-assertions.  It does NOT enable
5592   debugging symbols, and shouldn't control checks on bad data passed to API
5593   calls (if it does anywhere, that's a bug).  Note that Xapian will run more
5594   slowly with assertions on.
5596 * spelling.html:
5598   + Add section on indexing.
5600   + Add a note about removing automatically added spelling dictionary entries.
5602   + Move the "algorithm" section to the end, as it is really just background
5603     information for the curious.
5605 * include/xapian/queryparser.h: Document the possible exception messages from
5606   QueryParser::parse_query().
5608 * include/xapian/termgenerator.h: Note how TermGenerator handles stopwords.
5610 examples:
5612 * delve: Display the lastdocid value when displaying general database
5613   statistics.
5615 * simpleindex: Explicitly call flush() on the database, as that is good
5616   practice (since you see any exceptions).
5618 portability:
5620 * Fix compilation failure in testsuite on OpenBSD, introduced by new regression
5621   test in 1.0.18.  Fixes ticket#458.
5623 * Fix getopt-related warning on Cygwin.
5625 Xapian-core 1.0.18 (2009-02-14):
5627 API:
5629 * Document: Add new add_boolean_term() method, which is an alias for add_term()
5630   with wdfinc=0.
5632 * QueryParser:
5634   + Add support for quoting boolean terms so they can contain arbitrary
5635     characters (partly addresses ticket#128).
5637   + Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories, plus several
5638     zero-width space characters, as phrase generators.  This mirrors a better
5639     fix in 1.1.4, but without losing compatibility with existing databases.
5641   + Fix handling of an explicit AND before a hated term (foo AND -bar).
5642     (ticket#447)
5644 * TermIterator: Only include trailing '+' or '#' on a term if it isn't followed
5645   by a word character (makes more sense and matches QueryParser's behaviour).
5646   (ticket#446)
5648 * Database: Fix many methods to behave better on a database with no
5649   subdatabases, such as is constructed by Database().  Fixes ticket#415.
5651 testsuite:
5653 * Add test coverage for xapian-compact, and improve coverage for
5654   WritableDatabase::replace_document().
5656 * apitest: Rename matchfunctor<n> to matchdecider<n> to match current
5657   terminology.
5659 flint backend:
5661 * When updating documents, don't update posting entries which haven't changed.
5662   Largely fixes ticket #250.
5664 * If the number of entries in the position table happened to be 4294967296 or
5665   an exact multiple, Xapian would ignore positional data for that table when
5666   running queries, and xapian-compact wouldn't copy its contents.
5668 * Iterating all the terms in the database with a prefix is now slightly more
5669   efficient.
5671 * Fix locking code to work if stdin and/or stdout have been closed.
5673 * If a document is replaced with itself unmodified, we no longer increase the
5674   automatic flush counter.
5676 * When iterating a posting list modified since the last flush(), the reported
5677   wdf is now correct (previously it was too high by its old value).
5679 * Replacing a document deleted since the last flush failed to update the
5680   collection frequency and wdf, and caused an assertion failure when assertions
5681   were enabled.
5683 * WritableDatabase::replace_document() didn't always remove old positional
5684   data (the only effect is that the position table was bloated by unwanted
5685   entries).
5687 * xapian-inspect:
5689   + New "until" command which shows entries until a specified key is reached.
5691   + New "open" command which allows easy switching between tables.
5693 * xapian-compact: Fix typos in --help output.
5695 quartz backend:
5697 * Replacing a document deleted since the last flush failed to update the
5698   collection frequency and wdf, and caused an assertion failure when assertions
5699   were enabled.
5701 * WritableDatabase::replace_document() didn't always remove old positional
5702   data (the only effect is that the position table was bloated by unwanted
5703   entries).
5705 remote backend:
5707 * Throw UnimplementedError if a MatchDecider is used with the remote backend.
5708   Previously Xapian returned incorrect results in this case.
5710 build system:
5712 * configure: With --enable-maintainer-mode, enable -Werror for GCC >= 4.1
5713   rather than >= 4.0 as Apple's GCC 4.0 gives bogus uninitialised variable
5714   warnings.
5716 documentation:
5718 * The API documentation now includes Xapian::Error and subclasses, and doesn't
5719   mention Xapian::Query::Internal.
5721 * Make clear in the Xapian::Document API documentation that this class is a
5722   lazy handle and discuss the issues this can cause.
5724 * INSTALL: Improve text about zlib dependency.
5726 * HACKING: Add details of our licensing policy for accepting patches.
5728 examples:
5730 * quest: If no database is specified, still parse the query and report
5731   Query::get_description() to provide an easy way to check how a query parses.
5733 portability:
5735 * Fix GCC 4.2 warning.
5737 xapian-core 1.0.17 (2009-11-18):
5739 API:
5741 * QueryParser:
5743   + Fix handling of a group of two or more terms which are all stopwords which
5744     notably caused issues when default_op was OP_AND, but could probably
5745     manifest in other cases too.  Fixes ticket#406.
5747   + Fix interaction of FLAG_PARTIAL and FLAG_SYNONYM.  (ticket#407)
5749 * Database: A database created via the default constructor no longer causes a
5750   segfault when the methods get_metadata() or metadata_keys_begin() are called.
5752 flint backend:
5754 * Don't try to close the fd one more than the maximum allowable when locking
5755   the database.  Harmless, except it causes a warning when running under
5756   valgrind.  (ticket#408)
5758 remote backend:
5760 * Xapian::Sorter isn't supported with the remote backend so throw
5761   UnimplementedError rather than giving incorrect results.  (ticket#384)
5763 * Fix potential reading off the end of the MSet which is returned internally
5764   by the remote server.
5766 documentation:
5768 * Various documentation comment improvements for the Database class.
5770 examples:
5772 * examples/quest.cc: Tighten up the type of the error we catch to detect an
5773   unknown stemming language.
5775 portability:
5777 * xapian-config: Need to quote ^ for Solaris /bin/sh.
5779 * configure: Actually use any flags we determine are needed to switch the
5780   compiler to proper ANSI C++ mode, when building xapian-core - this stopped
5781   working in 1.0.12, breaking support for HP's aCC, Compaq's cxx, Sun's CC, and
5782   SGI's CC.
5784 Xapian-core 1.0.16 (2009-09-10):
5786 flint backend:
5788 * Fix a typo which stopped this fix in 1.0.12 from working (ticket #398):
5790   If we fail to get the lock after we spawn the child lock process (the common
5791   case is because the database is already open for writing) then we now clean
5792   up the child process properly.
5794 documentation:
5796 * Improve API documentation of QueryParser::set_default_op() and
5797   QueryParser::get_default_op().
5799 portability:
5801 * Fix build failure on Mac OS X 10.6.
5803 Xapian-core 1.0.15 (2009-08-26):
5805 testsuite:
5807 * Fix the test harness not to report heaps of bogus errors when using valgrind
5808   3.5.0.
5810 flint backend:
5812 * Backport the lazy update changes from 1.1.2:
5814   WritableDatabase::replace_document() now updates the database lazily in
5815   simple cases - for example, if you just change a document's values and
5816   replace it with the same docid, then the terms and document data aren't
5817   needlessly rewritten.  Caveats: currently we only check if you've looked at
5818   the values/terms/data, not if they've actually been modified, and only keep
5819   track of the last document read.
5821 * Fix PostingIterator::skip_to() on an unflushed WritableDatabase to skip
5822   documents which were added and deleted since the last flush.  (ticket#392)
5824 documentation:
5826 * Overhaul the doxygen options we use and tweak various documentation comments
5827   to improve the generated API documentation.
5829 * Explicitly document that an empty prefix argument to
5830   QueryParser::add_prefix() means "no prefix".
5832 * Update the documentation comments for Enable::set_sort_by_value(),
5833   set_sort_by_value_then_relevance(), and set_sort_by_relevance_then_value() to
5834   mention sortable_serialise() as a good way to store numeric values for
5835   sorting.
5837 Xapian-core 1.0.14 (2009-07-21):
5839 API:
5841 * When using more than one ValueRangeProcessor, QueryParser didn't reset the
5842   begin and end strings to ignore any changes made by a ValueRangeProcessor
5843   which returned false, so further ValueRangeProcessors would see any changes
5844   it had made.  This is now fixed, and test coverage improved.
5846 testsuite:
5848 * The test harness code which launches xapian-tcpsrv child processes was
5849   failing to close a file descriptor for each one launched due to a bug in
5850   the code which is meant to track them.  This was causing apitest to fail
5851   on OpenBSD (ticket#382).  Also wait between testcases for any spawned
5852   xapian-tcpsrv processes to exit to avoid spurious failures when a database is
5853   reused by the next testcase.
5855 * tests/runtest.in: Use "ulimit -n" where available to limit the number of
5856   available file descriptors to 64 so we catch file descriptor leaks sooner.
5858 * When measuring CPU time used for scalability tests, we no longer try to
5859   include the CPU time used by child processes, as we can only get that for
5860   child processes which have exited and it's hard to ensure that they have
5861   with the current framework.  Although this means we only tests the
5862   client-side scaling for remote tests, the local backend tests cover most of
5863   the work done by the server part of the remote backend.
5865 * apitest: In testcase topercent2, don't expect max_attained or max_possible to
5866   be exact as rounding errors in different ways of calculating can cause small
5867   variations.  On trunk we already have similar code because the new weighting
5868   scheme stuff gives different bounds in the different cases.  This should fix
5869   testsuite failures seen on some of the Debian and Ubuntu buildds.
5871 * The test harness now always reports the full exception message (was
5872   conditional on --verbose), and output for different exception types and
5873   other causes of failure is now more consistent.
5875 * For scalability tests, the test harness now increases the number of
5876   repetitions until the first run takes more than 0.001 seconds, to avoid
5877   trying to base calculations on a length of time we probably can't reliably
5878   measure to start with.
5880 * Add test coverage for Stem::get_description() for each supported language.
5882 * queryparsertest: Reenable tests which require the inmemory backend to be
5883   enabled by fixing typo XAPIAN_HAS_BACKEND_INMEMORY ->
5884   XAPIAN_HAS_INMEMORY_BACKEND.
5886 flint backend:
5888 * Use F_FULLFSYNC where available (Mac OS X currently) to ensure that changes
5889   have been committed to disk.  (ticket#288)
5891 remote backend:
5893 * Fix handling of percentage weights in various cases when we're searching
5894   multiple remote databases or a mix of local and remote databases.
5896 build system:
5898 * configure: -Wshadow produces false positives with GCC 4.0, so only enable it
5899   for >= 4.1 since we enable -Werror for maintainer-mode builds for GCC >= 4.0.
5901 * configure: Check that we can find the valgrind/memcheck.h header as well as
5902   the valgrind binary.
5904 * Change how snowball generates the data used by its among operation - instead
5905   of using pointers to the strings in struct among, store an offset into a
5906   constant pool, as this reduces the number of relocations by about 2300, which
5907   should decrease the time taken by the dynamic linker when loading the
5908   library.  This also reduces the size of the shared library significantly
5909   (on x86-64 Linux, the stripped shared library is 4% smaller).
5911 Xapian-core 1.0.13 (2009-05-23):
5913 API:
5915 * Xapian::Document no longer ever stores empty values explicitly.  This
5916   wasn't intentional behaviour, and how this case was handled wasn't
5917   documented.  The amended behaviour is consistent with how user metadata
5918   is handled.  This change isn't observable using Document::get_value(),
5919   but can be noticed when iterating with Document::values_begin(), using
5920   Document::values_count(), or trying to delete the value with
5921   Document::remove_value().
5923 testsuite:
5925 * Fix testcase scaleweight4 not to fail on x86 when compiled with -O0.  The
5926   problem was in the testcase code, and was caused by excess precision in
5927   intermediate FP values.
5929 * Testcases which check that operations have the expected O(...) behaviour now
5930   check CPU time instead of wallclock time on most platforms, which should
5931   eliminate occasional failures due to load spikes from other processes.
5932   (ticket#308)
5934 * Fix test failures due to SKIP_TEST_FOR_BACKEND("inmemory") not skipping when
5935   it should due to comparing char * strings with == (on trunk the return value
5936   being tested is std::string rather than const char *).
5938 * Improve test coverage in several corner cases.
5940 * Fix testcase consistency2 to actually be run (fortunately it passes).
5942 * In the generated testcases, call get_description() on the default
5943   constructed object of each class to make sure that works (and doesn't try to
5944   dereference NULL, or fail some assertion, etc).  All currently checked
5945   classes are fine - this is to avoid future regressions or such problems with
5946   new classes.
5948 * In the test coverage build, use "--coverage" instead of "-fprofile-arcs
5949   -ftest-coverage".
5951 * The test harness now has the inmemory backend flagged as supporting
5952   user-specified metadata (apart from iteration over metadata keys).
5954 matcher:
5956 * If a query contains a MatchAll subquery, check for it before checking the
5957   other terms so that the loop which checks how many terms match can exit
5958   early if they all match.
5960 * When an OR or ANY_MAYBE decayed to an AND, we were carefully swapping the
5961   children for maximum efficiency, but the condition was reversed so we were
5962   in fact making things worse.  This was noticed because it was resulting in
5963   the same query running faster when more results were asked for!
5965 * Only build the termname to termfreq and weight map for the first subdatabase
5966   instead of rebuilding it for each one.  Also don't copy this map to return
5967   it.  This should speed up searches a little, especially those over multiple
5968   databases.
5970 * If a submatcher fails but ErrorHandler tells us to continue without it, we
5971   just use a NULL pointer to stand in rather than allocating a special dummy
5972   place-holder object.
5974 * Remove AndPostList, in favour of MultiAndPostList.  AndPostList was only used
5975   as a decay product (by AndMaybePostList and OrPostList), and doesn't appear
5976   to be any faster.  Removing it reduces CPU cache pressure, and is less code
5977   to maintain.
5979 * Call check() instead of skip_to() on the optional branch of AND_MAYBE.
5981 flint backend:
5983 * Fix a bug in TermIterator::skip_to() over metadata keys.
5985 remote backend:
5987 * Fix xapian-tcpsrv --interface option to work on MacOS X (ticket#373).
5989 * Fix typo which caused us to return the docid instead of the maximum weight
5990   a document from a remote match could return!  This could have led to wrong
5991   results when searching multiple databases with the remote backend, but
5992   probably usually didn't matter as with BM25 the weights are generally small
5993   (often all < 1) while docids are inevitably >= 1.
5995 inmemory backend:
5997 * The inmemory backend doesn't support iterating over metadata keys.  Trying
5998   to do so used to give an empty iteration, but has now been fixed to throw
5999   UnimplementedError (and this limitation has now been documented).
6001 build system:
6003 * Remove a lot of unused header inclusions and some unused code which should
6004   make the build faster and slightly smaller.
6006 * Fix to compile under --disable-backend-flint, --disable-backend-remote, and
6007   --disable-backend-inmemory.
6009 * Don't remove any built sources in "make clean" even under
6010   --make-maintainer-mode as that breaks switching a tree away from
6011   maintainer-mode with: make distclean;./configure
6013 * configure: Enable more GCC warnings - "-Woverloaded-virtual" for all
6014   versions, "-Wstrict-null-sentinel" for 4.0+, "-Wlogical-op
6015   -Wmissing-declarations" for 4.3+.  Notably "-Wmissing-declarations" caught
6016   that consistency2 wasn't being run.
6018 * Internally, fix the few places where we pass std::string by value to pass
6019   by const reference instead (except where we need a modifiable copy anyway) as
6020   benchmarking shows that const reference is slightly faster and generates
6021   less code with GCC's reference counted std::string implementation - with a
6022   non-reference counted implementation, const reference should be much faster.
6023   (ticket#140)
6025 documentation:
6027 * INSTALL: We no longer regularly test build with GCC 2.95.4 and we're raising
6028   the minimum GCC version required to 3.1 for Xapian 1.1.x.
6030 * Document what passing maxitems=0 to Enquire::get_mset() does.
6032 * docs/queryparser.html: Add examples of using a prefix on a phrase or
6033   subexpression.
6035 * Correct doxygen comments for user metadata functions:
6036   Database::get_metadata() can't throw UnimplementedError but
6037   WritableDatabase::set_metadata() can.
6039 * Document that Database::metadata_keys_begin() returns an end iterator if the
6040   backend doesn't support metadata.
6042 * HACKING: Update the list of Debian/Ubuntu packages needed for a development
6043   environment.
6045 debug code:
6047 * Fix build with --enable-debug.
6049 * Added some more assertions.
6051 Xapian-core 1.0.12 (2009-04-19):
6053 API:
6055 * WritableDatabase::remove_spelling() now works properly.
6057 * The QueryParser now treats NON_SPACING_MARK Unicode characters as phrase
6058   generators, which improves handling of Arabic.  This is a stop-gap solution
6059   for 1.0.x which will work with existing databases without requiring
6060   reindexing - in 1.1.0, NON_SPACING_MARK will be regarded as part of a word.
6061   (ticket#355)
6063 * Fix undefined behaviour in distribution of OP_NEAR and OP_PHRASE over a
6064   non-leaf subquery (indentified by valgrind on testcase nearsubqueries1).
6065   (ticket#349)
6067 * Enhance distribution of OP_NEAR/OP_PHRASE over non-leaf subqueries to work
6068   when there are multiple non-leaf subqueries (ticket#201).
6070 * Enquire::get_mset() no longer needlessly checks if the documents exist.
6072 * PostingIterator::get_description() output improved visually in some cases.
6074 testsuite:
6076 * Add make targets to assist generating a testsuite code coverage report with
6077   lcov.  See HACKING for details.
6079 * Improved test coverage in a number of places and removed some used code as
6080   shown by lcov's coverage report.
6082 flint backend:
6084 * xapian-compact:
6086   + Now handles databases which contains no documents but have user metadata
6087     (ticket#356).
6089   + Fix test for the total document length overflowing.
6091 * Release the database lock if the database is closed due to an unrecoverable
6092   error during modifications. (ticket#354)
6094 * If we fail to get the lock after we spawn the child lock process (the common
6095   case is because the database is already open for writing) then we now clean
6096   up the child process properly.
6098 build system:
6100 * Overriding CXXFLAGS at make-time (e.g. "make CXXFLAGS=-Os") no longer
6101   overrides any flags configure detected to be required to make the compiler
6102   accept ISO C++ (for GCC, no such flags are required, so this doesn't
6103   change anything).
6105 documentation:
6107 * Update documentation and code comments to reflect that 1.1 will be a
6108   development series, and 1.2 the next release series.
6110 * docs/admin_notes.html: Document the child process used for locking which
6111   exec-s "cat" (ticket #258).
6113 * include/xapian/unicode.h: Fix documentation comment typos.
6115 * include/xapian/matchspy.h: Removed currently unused header to stop doxygen
6116   from generating documentation for it.
6118 Xapian-core 1.0.11 (2009-03-15):
6120 API:
6122 * Enquire::get_mset():
6124   + Now throws UnimplementedError if there's a percentage cutoff and sorting is
6125     primarily by value - this has never been correctly supported and it's
6126     better to warn people than give incorrect results.
6128   + No longer needlessly copies the results internally.
6130   + When searching multiple databases, now recalculates the maximum attainable
6131     weight after each database which may allow it to terminate earlier.
6132     (ticket#336).
6134   + Fix inconsistent percentage scores when sorting primarily by value, except
6135     when a MatchDecider is also being used; document this remaining problem
6136     case.  (ticket#216)
6138 * Enquire::set_sort_by_value() (and similar methods): Rename the wrongly named
6139   "ascending" parameter to "reverse", and note that its value should always be
6140   explicitly given since defaulting to "reverse=true" is confusing and the
6141   default will be deprecated in 1.1.0.  (ticket#311)
6143 * Database::allterms_begin(): Fix memory leak when iterating all terms from
6144   more than one database.
6146 * Query::get_terms_begin(): Don't return "" from the TermIterator (happened
6147   when the query contained or was Query::MatchAll).
6149 * Add QueryParser::FLAG_DEFAULT to make it easier to add flags to those set by
6150   default.
6152 testsuite:
6154 * The testsuite now reports problems detected by valgrind with newer valgrind
6155   versions.  Drop support for running the testsuite under valgrind < 3.3.0
6156   (well over a year old) as this greatly simplifies the configure tests.
6158 * Fix usage message for options which take arguments in --help output from test
6159   programs - "-x=foo" doesn't work, the correct syntax is "-x foo".
6161 * If comparing MSet percentages fails, report the differing percentages if in
6162   verbose mode.
6164 * Add test that backends don't truncate total document length to 32 bits.
6166 * Disable lockfileumask1 (regression testcase added in 1.0.10) on Cygwin and on
6167   OS/2.
6169 flint backend:
6171 * The configure test for pread() and pwrite() got accidentally disabled in
6172   0.8.4 and we've always been using llseek() followed by read() or write()
6173   since then.  The configure test is now fixed, and gives a slight speedup
6174   (3% measured for searching).
6176 * The child process used to implement WritableDatabase locking now changes
6177   directory to / so that it doesn't block unmounting of any partitions and
6178   closes any open file descriptors which aren't relating to locking so that
6179   if those files are closed by our parent and deleted the disk space gets
6180   released right away.
6182 * We now reuse the same zlib zstream structures rather than using a fresh
6183   one for each operation.  This doesn't make a measurable difference in
6184   our own tests on Linux but reportedly is measurably faster on some
6185   systems.  (ticket #325)
6187 quartz backend:
6189 * The pread()/pwrite() fix also speeds up quartz.
6191 remote backend:
6193 * Avoid copying Query::Internal objects needlessly when unserialising Query
6194   objects.
6196 inmemory backend:
6198 * Store the (non-normalised) document lengths as Xapian::termcount (unsigned
6199   int) rather than Xapian::doclength (double) which saves 4 bytes per document.
6201 build system:
6203 * configure: The output of g++ --version changed format (again) with GCC 4.3
6204   which meant configure got "g++" for the version.  Instead use the (hopefully)
6205   more robust technique of using g++ -E to pull out __GNUC__ and
6206   __GNUC_MINOR__.
6208 documentation:
6210 * API documentation:
6212   + WritableDatabase::flush() can't throw DatabaseLockError.
6214   + WritableDatabase's constructor can throw at least DatabaseCorruptError or
6215     DatabaseLockError.
6217   + Document how to get all matches from Enquire::get_mset().
6219   + Other minor improvements.
6221 * docs/sorting.html: Clarify meaning.
6223 portability:
6225 * Fix "#line" directives in generated file queryparser/queryparser_internal.cc
6226   to give a relative path - previously they had a full path when generated by a
6227   VPATH build (as release tarballs are), and this confused GCC 2.95 and
6228   depcomp.
6230 * Fix for compiling with Sun's compiler (untested as we no longer have access
6231   to it).
6233 Xapian-core 1.0.10 (2008-12-23):
6235 API:
6237 * Composing an OP_NEAR query with two non-term subqueries now throws
6238   UnimplementedError instead of AssertionError (in a --enable-assertions build)
6239   or leading to unexpected results (otherwise).  This partly addresses bug#201.
6241 * Using a MultiValueSorter with no values set no longer causes a hang or
6242   segmentation fault (but it is still rather pointless!)
6244 matcher:
6246 * If we're using values for sorting and for another purpose, cache the
6247   Document::Internal object created to get the value for sorting, like we do
6248   between other uses.
6250 flint backend:
6252 * If the disk became full while flushing database changes to disk, the
6253   WritableDatabase object would throw a DatabaseError exception but be left in
6254   an inconsistent state such that further use could lead to the database on
6255   disk ending up in a "corrupt" state (theoretically fixable, but no tool
6256   to fix such a database exists).  Now we try to ensure that the object is
6257   left in a consistent state, but if doing so throws a further exception, we
6258   put the WritableDatabase object in a "closed" state such that further
6259   attempts to use it throw an exception.
6261 * Create the lockfile "flintlock" with permissions 0666 so that the umask is
6262   honoured just like we do for the other files (previously we used 0600).
6263   Previously it wasn't possible to lock a database for update if it was
6264   owned by another user, even if you otherwise had sufficient permissions via
6265   "group" or "other".
6267 * Fix garbled exception message when a base file can't be reread.
6269 quartz backend:
6271 * Fix garbled exception message when a base file can't be reread.
6273 remote backend:
6275 * xapian-tcpsrv and xapian-progsrv now accept -w as a short form of --writable,
6276   as was always intended.
6278 build system:
6280 * This release now uses newer versions of the autotools (autoconf 2.62 ->
6281   2.63; automake 1.10.1 -> 1.10.2).
6283 documentation:
6285 * INSTALL: Add new paragraphs about HP's aCC and IRIX (adapted from footnotes
6286   in PLATFORMS).
6288 * PLATFORMS: HP testdrive has been shut down, so all mark all those machines as
6289   "no longer available".  Update atreus' build report to 1.0.10.
6291 * docs/queryparser.html: Add link to valueranges.html.
6293 examples:
6295 * delve: Add missing "and" to --help output.  Report termfreq and collection
6296   freq for each term we're asked about.
6298 portability:
6300 * Fix to build with GCC 4.4 snapshot.
6302 Xapian-core 1.0.9 (2008-10-31):
6304 API:
6306 * Database::get_spelling_suggestion() is now faster (15% speed up for parsing
6307   queries with FLAG_SPELLING_CORRECTION set in a test on real world data).
6309 * Fix OP_ELITE_SET segmentation fault due to excess floating point precision
6310   on x86 Linux (and possibly other platforms).
6312 * Database::allterms_begin() over multiple databases now gives a TermIterator
6313   with operations O(log(n)) rather than potentially O(n) in the number of
6314   databases.
6316 * Add new Database methods metadata_keys_begin() and metadata_keys_end() to
6317   allow the complete list of metadata in a database to be retrieved (this
6318   API addition is needed so that copydatabase can copy database metadata).
6320 testsuite:
6322 * Remove the cached test databases before running the testsuite.
6324 * apitest: Fix cursordelbug1 to work on Microsoft Windows (bug#301).
6326 * apitest,queryparsertest: Skip tests which fail because the timer granularity
6327   is too coarse to measure how long the test took.  In practice, this is only
6328   an issue on Microsoft Windows (bug#300 and bug#308).
6330 matcher:
6332 * Adjust percent cutoff calculations in the matcher in a way which corresponds
6333   to the change to percentage calculations made in 1.0.7 to allow for excess
6334   precision.
6336 * Query::MatchAll no longer gives match results ranked by increasing document
6337   length.
6339 flint backend:
6341 * xapian-compact: Fix crash while compacting spelling table for a single
6342   database when built with MSVC, and probably other platforms, though Linux
6343   got lucky and happened to work (bug#305).
6345 build system:
6347 * configure: Disable -Wconversion for now - it's not useful for older GCC and
6348   is buggy in GCC 4.3.
6350 * configure: Set -Wstrict-overflow to 1 instead of 5, to avoid unreasonable
6351   warnings under GCC 4.3.
6353 documentation:
6355 * Minor improvements to API documentation, including documenting the
6356   XAPIAN_FLUSH_THRESHOLD environmental variable in WriteableDatabase::flush()
6357   (bug#306).
6359 * valueranges.html: Fix typos in example code, and drop superfluous empty
6360   destructor from ValueRangeProcessor subclass.
6362 * HACKING: Several improvements.
6364 examples:
6366 * copydatabase: Also copy user metadata.
6368 Xapian-core 1.0.8 (2008-09-04):
6370 API:
6372 * Fix output of RSet::get_description
6374 testsuite:
6376 * Report subtotals per backend, rather than per testgroup per backend to make
6377   the output easier to read.
6379 flint backend:
6381 * Fix WritableDatabase::add_document() and replace_document() not to be O(n*n)
6382   in the number of values in the new document.
6384 * Fix handling of a table created lazily after the database has had commits,
6385   and which is then cursored while still in sequential mode.
6387 * Fix failure to remove all the Btree entries in some cases when all the
6388   postings for a term are removed.  (bug#287)
6390 * xapian-inspect: Show the help message on start-up.  Correct the documented
6391   alias for next from ' ' to ''.  Avoid reading outside of input string when it
6392   is empty.  (bug#286)
6394 quartz backend:
6396 * Backport fix from flint for WritableDatabase::add_document() and
6397   replace_document() not to be O(n*n) in the number of values in the new
6398   document.
6400 build system:
6402 * configure: Report bug report URL in --help output.
6404 * xapian-config: Report bug report URL in --help output.
6406 * configure: Fix deprecation error for --enable-debug=full to say to instead
6407   use '--enable-assertions --enable-log' not '--enable-debug --enable-log'.
6409 documentation:
6411 * valueranges.html: Expand on some sections.
6413 examples:
6415 * quest: Fix to catch QueryParserError instead of const char * which
6416   QueryParser threw in Xapian < 1.0.0.
6418 * copydatabase: Use C++ forms of C headers.  Only treat '\' as a directory
6419   separator on platforms where it is.  Update counter every 13 counting up to
6420   the end so that the digits all "rotate" and the counter ends up on the exact
6421   total.
6423 portability:
6425 * Eliminate literal top-bit-set characters in testsuite source code.
6427 Xapian-core 1.0.7 (2008-07-15):
6429 API:
6431 * OP_VALUE_RANGE, OP_VALUE_GE, and OP_VALUE_LE:
6433   + If there were gaps in the document id numbering, these operators could
6434     return document ids which weren't present in the database.  This has been
6435     fixed.
6437   + These operators are now more efficient when there are a lot of "missing"
6438     document ids (bug#270).
6440   + Optimise Query(OP_VALUE_GE, <n>, "") to Query::MatchAll.
6442 * Xapian::QueryParser:
6444   + QueryParser now stops parsing immediately when it hits a syntax error.
6445     This doesn't change behaviour, but does mean failing to parse queries is
6446     now more efficient.
6448   + Cases of O(N*N) behaviour have been fixed.
6450 * Xapian::Stem now recognises "nl" as an alias for "dutch" (debian bug 484458).
6452 * Setting sort by value was being ignored by a Xapian::Enquire object which had
6453   previously had a Xapian::Sorter set (bug#256).
6455 testsuite:
6457 * Improved test coverage in a few places.
6459 matcher:
6461 * When using a MatchDecider, we weren't reducing matches_lower_bound unless
6462   all the potential results were retrieved, which led to the lower bound
6463   being too high in some such cases.
6465 * We now track how many documents were tested by a MatchDecider and how many
6466   of those it rejected, and set matches_estimated based on this rate.  Also,
6467   matches_upper_bound is reduced by the number of rejected documents.
6469 * Fixed matches_upper_bound in some cases when collapsing and using a
6470   MatchDecider.
6472 * Fixed matches_lower_bound when collapsing and using a percentage cutoff.
6474 * When using two or more of a MatchDecider, collapsing, or a percentage
6475   cutoff, we now only round the scaled estimate once, and we also round it to
6476   the nearest rather than always rounding down.  Hopefully this should
6477   improve the estimate a little in such cases.
6479 * Fix problem on x86 with the top match getting 99% rather than 100% (caused
6480   by excess precision in an intermediate value).
6482 flint backend:
6484 * If Database::reopen() is called and the database revision on disk hasn't
6485   changed, then do as little work as possible.  Even if it has changed, don't
6486   bother to recheck the version file (bug#261).
6488 * xapian-compact:
6490   + Fix check for user metadata key to not match other key types we may add in
6491     the future.  When compacting, we can't assume how we should handle them.
6493   + If the same user metadata key is present in more than one source database
6494     with different tag values, issue a warning and copy an arbitrary tag value.
6496   + Fix potential SEGV when compacting database(s) with user metadata but no
6497     postings.
6499   + In error message, refer to "iamflint" as the "version file", not the
6500     "meta file".
6502 * xapian-inspect:
6504   + Print top-bit-set characters as escaped hex forms as they often won't be
6505     valid UTF-8 sequences.
6507   + If we're passed a database directory rather than a single table, issue a
6508     special error message since this is an obvious mistake for users to make.
6510 * Fix cursor handling for a modified table which has previously only had
6511   sequential updates which usually manifested as zlib errors (bug#259).
6513 quartz backend:
6515 * Fix cursor handling for a modified table which has previously only had
6516   sequential updates which usually manifested as incorrect data being returned
6517   (bug#259).
6519 * Calling skip_to() as the first operation on an all-documents PostingIterator
6520   now works correctly.
6522 remote backend:
6524 * Improve performance of matches with multiple databases at least one of which
6525   is remote, and when the top hit is from a remote database (bug#279).
6527 * When remote protocol version doesn't match, the error message displayed
6528   now shows the minor version number supplied by the server correctly.
6530 * We now wait for the connection to close after sending MSG_SHUTDOWN for a
6531   WritableDatabase, which ensures that changes have been written to disk
6532   and the lock released before the WritableDatabase destructor returns
6533   (as is the case with a local database).
6535 * We no longer ever send MSG_SHUTDOWN for a read-only Database - just closing
6536   the connection is enough (and is protocol compatible).
6538 inmemory backend:
6540 * Fix bug which resulted in the values not being stored correctly when
6541   replacing an existing document, or if there are gaps in the document id
6542   numbering.
6544 build system:
6546 * This release now uses newer versions of the autotools (autoconf 2.61 ->
6547   2.62; automake 1.10 -> 1.10.1; libtool 1.5.24 -> 1.5.26).  The newer
6548   autoconf reportedly results in a faster configure script, and warns about
6549   use of unrecognised configure options.
6551 * Fix configure to recognise --enable-log=profile and fix build problems when
6552   this is enabled.
6554 * "make up" in the "tests" subdirectory now does "make" in the top-level.
6556 * Fix "make distcheck" by using dist-hook to install generated files from
6557   either srcdir or builddir, with the appropriate dependency to generate them
6558   automatically in maintainer mode builds.
6560 documentation:
6562 * intro_ir.html: Improve wording a bit.
6564 * The documentation now links to trac instead of bugzilla.  For links to the
6565   main website, we now prefer xapian.org to www.xapian.org.
6567 * Doxygen-generated API documentation:
6569   + Improved documentation in several places.
6571   + The helper macro XAPIAN_VISIBILITY_DEFAULT no longer appears in the output.
6573   + Header and directory relationship graphs are no longer generated as they
6574     aren't actually informative here.
6576 * HACKING: Numerous updates and improvements.
6578 examples:
6580 * quest: Output get_description() of the parsed query.
6582 portability:
6584 * Fix build with GCC 2.95.3.
6586 * Fix build with GCC 4.3.
6588 * Newer libtool features improved support for Mac OS X Leopard and added
6589   support for AIX 6.1.
6591 debug code:
6593 * Database::get_spelling_suggestion() now debug logs with category APICALL
6594   rather than SPELLING, for consistency with all other API methods.
6596 * Added APICALL logging to a few Database methods which didn't have it.
6598 * Remove debug log tracing from get_description() methods since logging for
6599   other methods calls get_description() methods on parameters, so logging these
6600   calls just makes for more confusing debug logs.  A get_description() method
6601   should have no side-effects so it's not very interesting even when explicitly
6602   called by the user.
6604 Xapian-core 1.0.6 (2008-03-17):
6606 API:
6608 * Add new query operators OP_VALUE_LE and OP_VALUE_GE which perform "single
6609   ended" range checks, and a corresponding new Query constructor.
6611 * Add Unicode::toupper() to complement Unicode::tolower().
6613 * Xapian::Stem has been further optimised - stemtest now runs ~2.5% faster.
6615 testsuite:
6617 * tests/runtest: Fixed to handle test programs with a ".exe" extension.
6619 * tests/queryparsertest: Add a couple more testcases which already work to
6620   improve test coverage.
6622 * tests/apitest: Add caseconvert1 testcase to test Unicode::tolower() and
6623   Unicode::toupper().
6625 flint backend:
6627 * xapian-check: Fix not to report an error for a database containing no
6628   postings but some user metadata.
6630 * Update the base files atomically to avoid problems with reading processes
6631   finding partially written ones.
6633 * Create lazy tables with the correct revision to avoid producing a database
6634   which we later report as "corrupt" (bug#232).
6636 * xapian-compact: Fix compaction for databases which contain user metadata
6637   keys.
6639 quartz backend:
6641 * Update the base files atomically to avoid problems with reading processes
6642   finding partially written ones.
6644 remote backend:
6646 * The addition of OP_VALUE_LE and OP_VALUE_GE required an update to the Query
6647   serialisation, which required a minor remote protocol version bump.
6649 * Fix to actually set the writing half as the connection as non-blocking when
6650   a timeout is specified.  This would have prevented timeouts from operating
6651   correctly in some situations.
6653 build system:
6655 * configure: GCC warning flag overhaul:  Stop passing "-Wno-multichar" since
6656   any multi-character character literal is bound to be a typo (I believe we
6657   were only passing it after misinterpreting its sense!)  Pass
6658   "-Wformat-security", and "-Wconversion" for all GCC versions.  Add
6659   "-Winit-self" and "-Wstrict-overflow=5" for GCC >= 4.2.  The latter might
6660   prove too aggressive, but seems reasonable so far.  Fix some minor niggles
6661   revealed by "-Wconversion" and "-Wstrict-overflow=5".
6663 * Add XAPIAN_NORETURN() annotations to functions and non-virtual methods which
6664   don't return.
6666 documentation:
6668 * docs/intro_ir.html: Briefly mention how pure boolean retrieval is supported.
6670 * docs/valueranges.html: Fix example of using multiple VRPs to come out as a
6671   "program listing".
6673 * include/xapian/queryparser.h: Fix incorrect example in doccomment.
6675 * docs/quickstart.html: Remove information covered by INSTALL since
6676   there's no good reason to repeat it and two copies just risks one
6677   getting out of date (as has happened here!)
6679 * docs/quickstart.html: Fix very out of date reference to MSet::items
6680   (bug#237).
6682 * PLATFORMS: Remove reports for 0.8.x as they're too old to be interesting.
6683   Separate out 0.9.x reports.  Add Solaris 9 and 10 success reports from James
6684   Aylett.  Update from Debian buildd logs.
6686 portability:
6688 * Now builds on OS/2, thanks to a patch by Yuri Dario.
6690 * Fix testsuite to build on mingw (broken by changes in 1.0.5).
6692 debug code:
6694 * Fix --enable-assertions build, broken by changes in 1.0.5.
6696 Xapian-core 1.0.5 (2007-12-21):
6698 API:
6700 * More sophisticated sorting of results is now possible by defining a
6701   functor subclassing Xapian::Sorter (bug#100).
6703 * Xapian::Enquire now provides a public copy constructor and assignment
6704   operator (bug#219).
6706 * Xapian::Document::values_begin() didn't ensure that values had been read
6707   when working on a Document read from a database.  However, values_end() did
6708   (and so did values_count()) so this wasn't generally a problem in practice.
6710 * Xapian::PostingIterator::skip_to() now works correctly when running over
6711   multiple databases.
6713 * Xapian::Database::postlist_begin() no longer adds a "MultiPostList" wrapper
6714   for the common case when there's only one subdatabase.
6716 * Xapian::TradWeight now avoids division by zero in the (rare) situation of the
6717   average document length being zero (which can only happen if all documents
6718   are empty or only have terms with wdf 0).
6720 * Calling Xapian::WritableDatabase methods when we don't have exactly one
6721   subdatabase now throws InvalidOperationError.
6723 testsuite:
6725 * apitest:
6727   + Testcases now describe the conditions they need to run, and are
6728     automatically collated by a Perl script.  This makes it significantly
6729     easier to add a new testcase.
6731   + The test harness's "BackendManager" has been overhauled to allow
6732     cleaner implementations of testcases which are currently hard to
6733     write cleanly, and to make it easier to add new backend settings.
6735   + Add a "multi" backend setting which runs suitable tests over two
6736     subdatabases combined.  There's a corresponding new make target
6737     "check-multi".
6739   + Add more feature tests of document values.
6741   + sortrel1 now runs for inmemory too.
6743   + Add simple feature test for TradWeight being used to run a query.
6745   + Fix spell3 to work on Microsoft Windows (bug#177).
6747   + API classes are now tested to check they have copy constructors and
6748     assignment operators, and also that most have a default constructor.
6750   + quartztest testcases adddoc2 and adddoc3 have been reworked as apitest
6751     testcases adddoc5 and adddoc6, which run for other backends.
6753   + stubdb1 now explicitly creates the database it needs - generally this
6754     bug didn't manifest because an earlier test has already created it.
6756 * queryparsertest: Add feature tests to check that ':' is being inserted
6757   between prefix and term when it should be.
6759 * Fix extracting of valgrind error messages in the test harness.
6761 * tests/valgrind.supp: Add more variants of the zlib suppressions.
6763 matcher:
6765 * Xapian::Enquire: When the "first" parameter to get_mset() is non-zero, avoid
6766   copying all the wanted items after performing the match.
6768 * Fix bug in handling a pure boolean match over more than one database under
6769   set_docid_order(ASCENDING) - we used to exit early which isn't correct.
6771 * When collapsing on a value, give a better lower bound on the number of
6772   matches by keeping track of the number of empty collapse values seen.
6774 * Xapian::BM25Weight: Fix bug when k2 is non-zero: a non-initialised value
6775   influenced the weight calculations.  By default k2 is zero, so this bug
6776   probably won't have affected most users.
6778 * The mechanism used to collate term statistics across multiple databases has
6779   been greatly simplified (bug#45).
6781 flint backend:
6783 * xapian-check:
6785   + Update to handle flint databases produced by Xapian 1.0.3 and later.
6787   + Fix not to go into an infinite loop if certain checks fail.
6789 quartz backend:
6791 * quartzcompact: Fix equality testing of C strings to use strcmp() rather than
6792   '=='!  In practice, using '==' often gives the desired effect due to pooling
6793   of constant strings, but this may have resulted in a bug on some platforms.
6795 remote backend:
6797 * If we're doing a match with only one database which is remote then just
6798   return the unserialised MSet from the remote match.  This requires an
6799   update to the MSet serialisation, which requires a minor remote protocol
6800   version bump.
6802 build system:
6804 * XO_LIB_XAPIAN now hooks LT_INIT as well as AC_PROG_LIBTOOL and
6805   AM_PROG_LIBTOOL.
6807 * Distribute preautoreconf, dir_contents, docs/dir_contents and
6808   tests/dir_contents.
6810 * Fix preautoreconf to correctly handle all the sources passed to doxygen to
6811   create the collated internal source documentation, and to work in a VPATH
6812   build.
6814 documentation:
6816 * sorting.html: New document on the topic of sorting match results.
6818 * HACKING,admin_notes.html,bm25.html,glossary.html,intro_ir.html,overview.html,
6819   quickstart.html,scalability.html,termgenerator,html,synonyms.html: Assorted
6820   minor improvements.
6822 * valueranges.html: State explicitly that Xapian::sortable_serialise() is used
6823   to encode values at index time, and give an example of how it is called.
6825 * API documentation:
6827  + Clarify get_wdf() versus get_termfreq().
6829  + We now use pngcrush to reduce the size of PNG files in the HTML version.
6831  + The HTML version no longer includes various intermediate files which doxygen
6832    generates.
6834  + Hide the v102 namespace from Doxygen as it isn't user visible.
6836  + Stop describing get_description() as an "Introspection method", as this
6837    doesn't help to explain what it does, and get_description() doesn't really
6838    fall under common formal definitions of "introspection".
6840 * index.html: Add a list of documents on particular topics and include links to
6841   previously unlinked-to documents.  Weed down the top navigation bar which had
6842   grown to unwieldy length.
6844 * PLATFORMS: Update for Debian buildds.
6846 * Improve documentation comment for Document::termlist_count().
6848 * admin_notes.html: Note that this document is up-to-date for 1.0.5.
6850 * INSTALL: zlib 1.2.0 apparently fixes a memory leak in deflateInit2(), which
6851   we use, so that's another reason to prefer 1.2.x.
6853 portability:
6855 * Add explicit includes of C headers needed to build with the latest snapshots
6856   of GCC 4.3.  Fix new warnings.
6858 * xapian-config: On platforms which we know don't need explicit dependencies,
6859   --ltlibs now gives the same output as --libs.
6861 * The minimum supported GCC version is now 2.95.3 (rather than 2.95) as 2.95.3
6862   added support for '#include <sstream>' which means we no longer need to
6863   maintain our own version.
6865 * Fix build with SGI's compiler on IRIX.
6867 * Fix or suppress some MSVC warnings.
6869 debug code:
6871 * Remove incorrect assertion in MultiAndPostList (bug#209).
6873 * Fix build when configured with "--enable-log --disable-assertions".
6875 Xapian-core 1.0.4 (2007-10-30):
6877 API:
6879 * Query:
6881   + Add OP_SCALE_WEIGHT operator (and a corresponding constructor which
6882     takes a single subquery and a parameter of type "double").  This
6883     multiplies the weights from the subquery by the parameter, allowing
6884     adjustment of the importance of parts of the query tree.
6886   + Deprecate the essentially useless constructor Query(Query::op, Query).
6888 * QueryParser:
6890   + A field prefix can now be set to expand to more than one term prefix.
6891     Similarly, multiple term prefixes can now be applied by default.  This is
6892     done by calling QueryParser::add_boolean_prefix() or
6893     QueryParser::add_prefix() more than once with the same field name but a
6894     different term prefix (previously subsequent calls with the same field name
6895     had no effect).
6897   + Trying to set the same field as probabilistic and boolean now throws
6898     InvalidOperationError.
6900   + Fix parsing of `term1 site:example.org term2', broken by changes in 1.0.2.
6902   + Drop special treatment for unmatched ')' at the start of the query, as it
6903     seems rather arbitrary and not particularly useful and was causing us to
6904     parse `(site:example.org) -term' incorrectly.
6906   + The QueryParser now generates pure boolean Query objects for strings such
6907     as `site:example.org' by applying OP_SCALE_WEIGHT with a factor of 0.0.
6909   + Fix handling of `"quoted phrase" +term' and `"quoted phrase" -term'.
6911   + Fix handling of `site:example.org -term'.
6913   + Fix problem with spelling correction of hyphenated terms (or other terms
6914     joined with phrase generators): the position of the start of the term
6915     wasn't being reset for the second term in the generated phrase, resulting
6916     in out of bounds errors when substituting the new value in the corrected
6917     query string.
6919   + The parser stack is now a std::vector<> rather than a fixed size, so it
6920     will typically use less memory, and can't hit the fixed limit.
6922   + Fix handling of STEM_ALL and update the documentation comment for
6923     QueryParser::set_stemming_strategy() to explain how it works clearly.
6925 * PostingIterator: positionlist_begin() and get_wdf() should now always
6926   throw InvalidOperationError where they aren't meaningful (before in some
6927   cases UnimplementedError was thrown).
6929 testsuite:
6931 * Add tests for new features.
6933 * Add another valgrind suppression for a slightly different error from zlib
6934   in Ubuntu gutsy.
6936 * Remove quartztest's test_postlist1 and test_postlist2, replacing the coverage
6937   lost by extending and adding tests which work with other backends as well.
6939 * If a test throws a subclass of std::exception, the test harness now
6940   reports the class name and the extra information returned by std::exception's
6941   what() method.
6943 matcher:
6945 * Several performance improvements have been made, mainly to the handling
6946   of OP_AND and related operations (OP_FILTER, OP_NEAR, and OP_PHRASE).
6947   In combination, these are likely to speed up searching significantly
6948   for most users - in tests on real world data we've seen savings of 15-55%
6949   in search times).  These improvements are:
6951   + OP_AND of 3 or more sub-queries is now processed more efficiently.
6953   + Sub-queries from adjacent OP_AND, OP_FILTER, OP_NEAR, and OP_PHRASE are now
6954     combined into a single multi-way OP_AND operation, and the filters which
6955     implement the near/phrase restrictions are hoisted above this so they need
6956     to check fewer documents (bug#23).
6958   + If an OP_OR or OP_AND_MAYBE decays to OP_AND, we now ensure that the less
6959     frequent sub-query is on the left, which OP_AND is optimised to expect.
6961 * When the Enquire::get_mset() parameter checkatleast is set, and we're sorting
6962   by relevance with forward ordering by docid, and the query is pure boolean,
6963   the matcher was deciding it was done before the checkatleast requirement was
6964   satisfied.  Then the adjustments made to the estimated and max statistics
6965   based on checkatleast meant the results claimed there were exactly msize
6966   results.  This bug has now been fixed.
6968 * Queries involving an OP_VALUE_RANGE filter now run around 3.5 times faster
6969   (bug#164).
6971 * The calculations behind MSet::get_matches_estimated() were always rounding
6972   down fractions, but now round to the nearest integer.  Due to cumulative
6973   rounding, this could mean that the estimate is now a few documents higher in
6974   some cases (and hopefully a better estimate).
6976 * Implement explicit swap() methods for internal classes MSetItem and ESetItem
6977   which should make the final sort of the MSet and ESet a little more
6978   efficient.
6980 flint backend:
6982 * Fixed a bug introduced in 1.0.3 - trying to open a flint database for reading
6983   no longer fails if it isn't writable.
6985 * We no longer use member function pointers in the Btree implementation which
6986   seems to speed up searching a little.
6988 remote backend:
6990 * The remote protocol minor version has been increased (to accommodate
6991   OP_SCALE_WEIGHT).  If you are upgrading a live system which uses the
6992   remote backend, upgrade the servers before the clients.
6994 build system:
6996 * Added macro machinery to allow branch prediction hints to be specified and
6997   used by compilers which support this (current GCC and Intel C++).
6999 * In a developer build, look for rst2html.py if rst2html isn't found as some
7000   Linux distros have it installed under with an extension.
7002 documentation:
7004 * In the API documentation, explicitly note that Database::get_metadata()
7005   returns an empty string when the backend doesn't support user-specified
7006   metadata, and that WritableDatabase::set_metadata() throws UnimplementedError
7007   in this case.  Also describe the current behaviour with multidatabases.
7009 * README: Remove the ancient history lesson - this material is better left to
7010   the history page on the website.
7012 * deprecation.html:
7014   + Deprecate the non-pythonic iterators in favour of the pythonic ones.
7016   + Move "Stem::stem_word(word)" in the bindings to the right section (it was
7017     done in 1.0.0, as already indicated).
7019   + Improve formatting.
7021 * When running rst2html, using "--verbose" was causing "info" messages to be
7022   included in the HTML output, so drop this option and really fix this issue
7023   (which was thought to have been fixed by changes in 1.0.3).
7025 * install.html: Reworked - this document now concentrates on giving
7026   a brief overview of building which should be suitable for most common cases,
7027   and defers to the INSTALL document in each tarball for more details.
7029 * PLATFORMS: Update from tinderbox and buildbot.
7031 * remote.html: xapian-tcpsrv has been able to handle concurrent read
7032   access since 0.3.1 (7 years ago) so update the very out-of-date information
7033   here.  Also, note that some newer features aren't supported by the remote
7034   backend yet.
7036 * HACKING: Note specifically that std::list::size() is O(n) for GCC.
7038 * intro_ir.html: Add link to the forthcoming book "Introduction to
7039   Information Retrieval", which can be read online.
7041 * scalability.html: Update size of gmane.
7043 * quartzdesign.html: Note that Quartz is now deprecated.
7045 debug code:
7047 * The debug assertion code has been rewritten from scratch to be cleaner and
7048   pull in fewer other headers.
7050 Xapian-core 1.0.3 (2007-09-28):
7052 API:
7054 * Add support for user specified metadata (bug#143).  Currently supported by
7055   the flint and inmemory backends.
7057 * Deprecate Enquire::register_match_decider() which has always been a no-op.
7059 * Improve the lower bound on the number of matching documents for an AND query
7060   - if the sum of the lower bounds for the two sides is greater than the
7061   number of documents in the database, then some of them must have both terms.
7063 * Spelling correction: Fix off-by-one error in loop bounds when initialising
7064   (bug#194).
7066 * If the check_at_least parameter to Enquire::get_mset() is used, but there
7067   aren't that many results, then MSet::get_matches_lower_bound() and
7068   MSet::get_matches_upper_bound() weren't always reported as equal - this
7069   bug is now fixed.
7071 * When sorting by value, and using the check_at_least parameter to
7072   Enquire::get_mset(), some potential matches weren't being counted.
7074 * Failing to create a flint or quartz database because we couldn't create the
7075   directory for it now throws DatabaseCreateError not DatabaseOpeningError.
7077 testsuite:
7079 * Fix display of valgrind output when a test fails because valgrind detected
7080   a problem.
7082 * Add another version of valgrind suppression for the zlib end condition check
7083   as this gives a different backtrace for zlib in Ubuntu gutsy.
7085 flint backend:
7087 * The Flint database format has been extended to support user metadata, and
7088   each termlist entry is now a byte shorter (before compression).  As a
7089   result, Xapian 1.0.2 and earlier won't be able to read Xapian 1.0.3
7090   databases.  However, Xapian 1.0.3 can read older databases.  If you open an
7091   older flint database for writing with Xapian 1.0.3, it will be upgraded
7092   such that it cannot then be read by Xapian 1.0.2 and earlier.
7094 * Zlib compression wasn't being used for the spelling or synonym tables (due
7095   to a typo - Z_DEFAULT_COMPRESSION where it should be Z_DEFAULT_STRATEGY).
7097 * xapian-check: Allow "db/record." and "db/record.DB" as arguments.
7099 * Fix "key too long" exception message by substituting FLINT_BTREE_MAX_KEY_LEN
7100   with its numeric value.
7102 * Assorted minor efficiency improvements.
7104 * If we reach the flush threshold during a transaction, we now write out the
7105   postlist changes, but don't actually commit them.
7107 * Check length of new terms is at most 245 bytes for flint in add_document()
7108   and replace_document() so that the API user gets an error there rather
7109   than when flush() is called (explicitly or implicitly).  Fixes bug#44.
7111 * Flint used to read the value of the environmental variable
7112   XAPIAN_FLUSH_THRESHOLD when the first WritableDatabase was opened and would
7113   then cache this value.  However the program using Xapian may have changed
7114   it, so we now reread it each time a WritableDatabase is opened.
7116 * Implement TermIterator::positionlist_count() for the flint backend.
7118 remote backend:
7120 * Fix the result of MSet::get_matches_lower_bound() when using the
7121   check_at_least parameter to get_mset().
7123 inmemory backend:
7125 * Implement TermIterator::positionlist_count() for the inmemory backend.
7127 build system:
7129 * xapian-config: We always need to include dependency_libs in the output of
7130   `xapian-config --libs` if shared libraries are disabled.
7132 * Distribution tarballs are now in the POSIX "ustar" format.  This supports
7133   pathnames longer than 99 characters (which we now have a few instances of
7134   in the doxygen generated documentation) and also results in a distribution
7135   tarball that is about half the size!  This format should be readable by any
7136   tar program in current use - if your tar program doesn't support it, we'd
7137   like to know (but note that the GNU tar tarball is smaller than the size
7138   reduction in the xapian-core tarball...)
7140 * configure no longer generates msvc/version.h - this is now entirely handled
7141   by the MSVC-specific makefiles.
7143 documentation:
7145 * Add a glossary.
7147 * docs/stemming.html: Reorder the initial paragraphs so we actually answer the
7148   question "What is a stemming algorithm?" up front.
7150 * When running rst2html, use "--exit-status=warning" rather than "--strict".
7151   The former actually gives a non-zero exit status for a warning or worse,
7152   while the former doesn't, but does include any "info" messages in the output
7153   HTML.
7155 * docs/deprecation.rst: Add "Database::positionlist_begin() throwing
7156   RangeError and DocNotFoundError".
7158 * valueranges.rst: Correct out-of-date reference to float_to_string.
7160 * HACKING: Document a few more "coding standards".
7162 * PLATFORMS: Updated.
7164 * docs/overview.html: Restore HTML header accidentally deleted in November
7165   2006.
7167 * Fix several typos.
7169 portability:
7171 * Add missing instances of "#include <string.h>" to fix compilation with recent
7172   GCC 4.3 snapshots.
7174 * Fix some warnings for various compilers and platforms.
7176 Xapian-core 1.0.2 (2007-07-05):
7178 API:
7180 * Xapian now offers spelling correction, based on a dynamically maintained
7181   list of spelling "target" words.  This is currently supported by the
7182   flint backend, and works when searching multiple databases.
7184 * Xapian now offers search-time synonym expansion, based on an externally
7185   provided synonym dictionary.  This is currently supported by the flint
7186   backend, and works when searching multiple databases.
7188 * TermGenerator: now offers support for generating spelling correction
7189   data.
7191 * QueryParser:
7193   + New flag FLAG_SPELLING_CORRECTION to enable spelling correction, and a new
7194     method, "get_corrected_query_string()" to get the spelling corrected
7195     query string.
7197   + New flags have been added to allow the new synonym expansion feature to be
7198     enabled and controlled.  Synonym expansion can either be automatic, or only
7199     for terms explicitly indicated in the query string by the new "~" operator.
7201   + The precedence of the boolean operators has been adjusted to match their
7202     usual precedence in mathematics and programming languages.  "NOT" now binds
7203     as tightly as "AND" (previously "AND NOT" would bind like "AND", but just
7204     "NOT" would bind like "OR"!)  Also "XOR" now binds more tightly than "OR",
7205     but less tightly than "AND" (previously it bound just like "OR").
7207   + '+' and '-' have been fixed to work on bracketed subexpressions as
7208     documented.
7210   + If the stemmer is "none", no longer put a Z prefix on terms; this now
7211     matches the output of TermGenerator.
7213 * Add new Xapian::sortable_serialise() and Xapian::sortable_unserialise()
7214   functions which serialise and unserialise numbers (currently only
7215   doubles) to a string representation which sorts in numeric order.  Small
7216   integers have a short representation.
7218 * NumberValueRangeProcessor has been changed to work usefully.  Previously
7219   the numbers had to be the same length; now numbers are serialised to
7220   strings such that a string sort on the string orders the numbers correctly.
7221   Negative and floating point numbers are also supported now.  The old
7222   NumberValueRangeProcessor is still present in the library to preserve
7223   ABI compatibility, but code linking against 1.0.2 or later will pick
7224   up the new implementation, which really lives in a sub-namespace.
7226 * Documents now have a get_docid() method, to get the document ID from the
7227   database they came from.
7229 * Add support for a new type of match decider, called a "matchspy".  Unlike
7230   the old deciders, this will reliably be tested on every candidate
7231   document, so can be used to tally statistics on them.
7233 * Fixed a segfault when getting a description for a MatchNothing query
7234   joined with AND_NOT (bug #176).
7236 * Header files have been tidied up to remove some unnecessary includes.
7237   Applications using "#include <xapian.h>" will not be affected.  We don't
7238   intend to support direct inclusion of individual header files from the xapian
7239   directory, but if you do that, you may have to update you code.
7241 testsuite:
7243 * Feature tests added for all new features.
7245 * Improved test coverage in queryparsertest.  Some tests in queryparsertest
7246   now use flint databases, so the test now ensures that the .flint
7247   subdirectory exists.
7249 * The test harness no longer creates <dbdir>/log for flint (flint doesn't
7250   create a log like quartz does).
7252 * apitest: "-bremote" must now be "-bremoteprog" (to better match
7253   "-bremotetcp"); "-bvoid" must now be "-bnone" (to better describe not
7254   using a database backend).
7256 * To complement "make check-flint", "make check-quartz", and "make
7257   check-remote", you can now run tests for the remotetcp backend with
7258   "make check-remotetcp", for the remoteprog backend with "make
7259   check-remoteprog", for the inmemory backend with "make check-inmemory", and
7260   tests not requiring a backend with "make check-none".
7262 * Several extra tests of the check_at_least parameter supplied to
7263   get_mset() were added.
7265 * Fix memory leak and fd leak in remotetcp handling, so apitest now passes
7266   under valgrind.
7268 * quartztest: no longer test QuartzPostList::get_collection_freq(), which
7269   has been removed.
7271 * Add regression test emptyquery2 for bug #176.
7273 * Add regression test matchall1 for bug with MatchAll queries.
7275 * Enhanced test coverage of match functor, to check that it returns all
7276   matching documents.
7278 matcher:
7280 * Fix bug when check_at_least was supplied - the matches after the
7281   requested MSet size were being returned to the user.  The parameter is
7282   also now handled in a more efficient way - no extra memory is required
7283   (previously, extra memory proportional to the value of check_at_least was
7284   required).
7286 * Fix bug which used incorrect statistics, and caused assertion failures,
7287   when performing a search using a MatchAll query.
7289 * Optimisation for single term queries: we don't need to look at the top
7290   document's termlist to determine that it matches all the query terms.
7292 flint backend:
7294 * The value and position tables are now only created if there is anything to
7295   add to them.  So if you never use document values, there's no value.DB,
7296   value.baseA, or value.baseB.  This means the table doesn't need to be opened
7297   for searching (saving a file handle and a number of syscalls) and when
7298   flushing changes, we don't need to update baseA/baseB just to keep the
7299   revisions in step.  The flint database version has been increased, but the
7300   new code will happily open and read/update flint databases from Xapian 1.0.0
7301   and 1.0.1.  Xapian 1.0.2 flint databases can't be read by Xapian 1.0.1 or
7302   earlier though.
7304 * Two new optional tables are now supported: "spelling", which is used to
7305   store information for spelling correction, and "synonym", which is used
7306   to store synonym information.
7308 * xapian-compact: Now compacts and merges spelling and synonym tables.
7309   Also has a new option "--no-renumber" to preserve document ids from
7310   source databases.
7312 * xapian-check: Now checks the spelling and synonym tables (only the Btree
7313   structure is currently checked, not the information inside).
7315 * Database::term_exists(), Database::get_termfreq(), and
7316   Database::get_collection_freq() are now slightly more efficient for flint
7317   databases.
7319 * New utility 'xapian-inspect' which allowing interactive inspection of key/tag
7320   pairs in a flint Btree.  Useful for development and debugging, and an
7321   approximate equivalent to quartzdump.
7323 * WritableDatabase::delete_document() no longer cancels pending changes if the
7324   document doesn't exist.
7326 * Fix handling of exceptions during commit - previously, this could result
7327   in tables getting out-of-sync, perhaps even resulting in a corrupt database.
7329 * Optimise iteration of all documents in the case where all the document
7330   IDs up to lastdocid are used; in this case, we no longer need to access disk
7331   to get the document IDs.
7333 quartz backend:
7335 * WritableDatabase::delete_document() no longer cancels pending changes if the
7336   document doesn't exist.
7338 * We no longer create a postlist just to find the termfreq or collection
7339   frequency.
7341 remote backend:
7343 * Calling WritableDatabase::delete_document() on a non-existent document now
7344   correctly propagates DocNotFoundError.
7346 * The minor remote protocol version has increased (to fix the previous issue).
7347   You should be able to cleanly upgrade a live system by upgrading servers
7348   first and then clients.
7350 * progclient: Reopen stderr on the child process to /dev/null rather than
7351   closing it.  This fixes apitest with the remoteprog backend to pass when run
7352   under valgrind (it failed in this case in 1.0.0 and 1.0.1).  It probably
7353   has no effect otherwise.
7355 * check_at_least is now passed to the remote server to reduce the work
7356   needed to produce the match, and the serialised size of the returned MSet.
7358 inmemory backend:
7360 * Bug fix: using replace_document() to add a document with a specific
7361   document id above the highest currently used would create empty documents
7362   for all document ids in between.
7364 build system:
7366 * Work around an apparent bug in automake which causes the entries in .libs
7367   subdirectories generated for targets of bin_PROGRAMS not to be removed on
7368   make clean.  This was causing make distcheck to fail.
7370 * Snapshots and releases are now bootstrapped with automake 1.10, and
7371   libtool 1.5.24.
7373 * HTML documentation generated from RST files is now installed.
7375 documentation:
7377 * The API documentation is now generated with Doxygen 1.5.2, which fixes the
7378   missing docs for Xapian::Query.
7380 * Ship and install internals.html.
7382 * Generating the doxygen-collated documentation of the library internals (with
7383   "make doxygen_source_docs") now only tries to generate an HTML version.  The
7384   PDF version kept exceeding TeX limits, and HTML is a more useful format for
7385   this anyway.
7387 * API docs for Xapian::QueryParser now make it clear that the default value for
7388   the stemming strategy is STEM_NONE.
7390 * API docs now describe the NumberValueRangeProcessor more clearly.
7392 * Several typo fixes and assorted wording improvements.
7394 * queryparser.html: Mention "AND NOT" as an alternative way to write "NOT",
7395   and document synonym expansion.
7397 * admin_notes.html: Updated for changes in this release, and corrected a
7398   few minor errors.
7400 * spelling.rst: New file, documenting the spelling correction feature.
7402 * synonyms.rst: New file, documenting the synonyms expansion feature.
7404 * valueranges.rst: The NumberValueRangeProcessor is now documented.
7406 * HACKING: Mention new libtool, and more details about preferring
7407   pre-increment.  Also add a note about 2 space indentation of protection
7408   level declarations in classes.
7410 * INSTALL: note that zlib must be installed before you can build.
7412 examples:
7414 * copydatabase: Now copies synonym and spelling data.  Also, fix a cosmetic
7415   bug with progress output when a specified database directory has a trailing
7416   slash.
7418 portability:
7420 * Fix to build on with OpenBSD's zlib (xapian-core 1.0.0 and 1.0.1 didn't).
7422 * Fixed to build with older zlib such as zlib 1.1.5 which Solaris apparently
7423   uses (xapian-core 1.0.0 and 1.0.1 didn't).  However, we recommend using zlib
7424   1.2.x as decompressing is apparently about 20% faster.
7426 * msvc/version.h.in: Generated version.h for MSVC build no longer has the
7427   remote backend marked as disabled.
7429 * Fix warnings from Intel's C++ compiler.
7431 * Fixes for compilation with gcc-2.95 and GCC 4.3 snapshots.
7433 packaging:
7435 * RPMs:
7437   + Rename xapian.spec to xapian-core.spec to match tarball name.
7439   + Append the user name to BuildRoot.
7441 debug code:
7443 * Better debug logging from the queryparser internals.
7445 Xapian-core 1.0.1 (2007-06-11):
7447 API:
7449 * Xapian::Error:
7451   + Make Error::error_string member std::string rather than char * to avoid
7452     problems with double free() with copied Error objects.  Unfortunately
7453     this mean an incompatible ABI change which we had hoped to avoid until
7454     1.1.0, but in this case there didn't seem to be a sane way to fix the
7455     problem without an ABI change.
7457   + Error::get_description() now converts my_errno to error_string if it hasn't
7458     been already rather than not including any error description in this case.
7460   + Add new method "get_description()" to get a string describing the error
7461     object.  This is used in various examples and scripts, improving their
7462     error reporting.
7464 * Xapian::Database: Add new form of allterms_begin() and allterms_end()
7465   which allow iterating of all terms with a particular prefix.  This
7466   is easier to use than checking the end condition yourself, and is
7467   more efficiently implemented for the remote backend (fixes bug#153).
7469 * Xapian::Enquire: Passing an uninitialised Database object to Enquire will
7470   now cause InvalidArgumentError to be thrown, rather than causing a segfault
7471   when you call Enquire::get_mset().  If you really want an empty database,
7472   you can use Xapian::InMemory::open() to create one.
7474 * Xapian::QueryParser: Multiple boolean prefixed terms with the same term
7475   prefix are now combined with OR before such groups are combined with AND
7476   (bug#157).  Multiple value ranges on the same value are handled similarly.
7478 * Xapian::Query OP_VALUE_RANGE: Avoid calling db->get_lastdocid() repeatedly
7479   as we know the answer won't change - this reduces the run time of a
7480   particular test case by 25%.
7482 testsuite:
7484 * Add test for serialisation of error strings.
7486 * Improved output in various situations:
7488   + Quote strings in TEST_STRINGS_EQUAL().
7490   + queryparsertest: Use TEST_STRINGS_EQUAL when comparing query descriptions
7491     against their expected output, since this makes it much easier to see the
7492     differences.
7494   + Report whole message for exceptions, rather than a truncated version, in
7495     verbose mode.
7497   + Make use of Xapian::Error::get_description(), giving better error
7498     reports.
7500 * queryparsertest: New test of custom ValueRangeProcessor subclass
7501   (qp_value_customrange1).
7503 * apitest: flintdatabaseformaterror1 and flintdatabaseformaterror2 now use a
7504   genuine Xapian 0.9.9 flint database for their tests, and more cases are
7505   tested.  The two tests have also been split into 3 now.
7507 * Fix test harness not to invoke undefined behaviour in cases where a paragraph
7508   of test data contains two or fewer characters.
7510 * Implement a better fix for the MSVC ifstream issue which was fixed in 1.0.0.
7511   This fixes an unintentional side-effect of the previous fix which meant that
7512   apitest's consistency1 wasn't working as intended (it now has a regression
7513   test to make sure it is testing what we intend).
7515 flint backend:
7517 * xapian-compact: Don't uncompress and recompress tags when compacting a
7518   database.  This speeds up xapian-compact rather a lot (by more than 50% in a
7519   quick test).
7521 * If the docid counter wraps, Flint now throws DatabaseError (fixes bug#152).
7523 * Remove the special case error message for pre-0.6 databases since they'll
7524   be quartz format (the check is only in flint because this code was taken from
7525   quartz).
7527 quartz backend:
7529 * If the docid counter wraps, Quartz now throws DatabaseError (fixes bug#152).
7531 remote backend:
7533 * The remote protocol now has a minor version number.  If the major
7534   version number is the same, a client can work with any server with
7535   the same or higher minor version number, which makes upgrading live
7536   systems easier for most remote protocol changes - just upgrade the servers
7537   first.
7539 * When a read-only remote database is closed, the client no longer sends a
7540   (totally bogus) MSG_FLUSH to the server, and the reply is also eliminated.
7541   This reduces the time taken to close a remote database a little (fixes
7542   bug#149).
7544 inmemory backend:
7546 * skip_to() on an allterms TermIterator from an InMemory Database can no longer
7547   move backwards.
7549 * An allterms TermIterator now initialises lazily, which can save some work if
7550   the first operation is a skip_to() (as it often will be).
7552 build system:
7554 * Fix VPATH compilation in maintainer mode with gcc-2.95.
7556 * Fix multiple target rule for generating the queryparser source files in
7557   parallel builds.
7559 * Distribute missing stub Makefiles for "bin", "examples", and
7560   "include/xapian".
7562 documentation:
7564 * Document the design flaw with NumberValueRangeProcessor and why it shouldn't
7565   be used.
7567 * ValueRangeProcessor and subclasses now have API documentation and an overview
7568   document.
7570 * Expand documentation of value range Query constructor.
7572 * Improved API documentation for the TermGenerator class.
7574 * docs/deprecation.rst:
7576   + Fix copy and paste error - set_sort_forward() should be changed to
7577     set_docid_order().
7579   + Improve entry for QueryParserError.
7581 * PLATFORMS: Updated from tinderbox.
7583 examples:
7585 * copydatabase: Rewritten to use the ability to iterate over all the documents
7586   in a database.  Should be much more efficient for databases with sparsely
7587   distributed document IDs.
7589 * simpleindex: Rewritten to use the TermGenerator class, which eliminates a
7590   lot of non-Xapian related code and is more typical of what a user is likely
7591   to want to do.
7593 * simplesearch,simpleexpand: Rewritten to use the QueryParser class, which
7594   is more typical of what a user is likely to want to do.
7596 portability:
7598 * xapian-config: Add special case check for host_os matching linux* or
7599   k*bsd-gnu since vanilla libtool doesn't correctly probe link_all_deplibs=no
7600   for them.
7602 packaging:
7604 * RPMs: Add "# norootforbuild" comment which SuSE's build scripts look for.
7605   Rename "Source0:" to "Source:" as there's only one tarball now.  Add gcc-c++
7606   and zlib-devel to "Build-Requires:".
7608 * The required automake version has been lowered to 1.8.3, so RPMs can now be
7609   built on RHEL 4 and SLES 9.
7611 Xapian-core 1.0.0 (2007-05-17):
7613 API:
7615 * Xapian::Database:
7617   + The Database(const std::string &) constructor has been marked as "explicit".
7618     Hopefully this won't affect real code, but it's possible.  Instead of
7619     passing a std::string where a Xapian::Database is expected, you'll now
7620     have to explicitly write `Xapian::Database(path)' instead of `path'.
7622   + Fixed problem when calling skip_to() on an allterms iterator over multiple
7623     databases which could cause a debug assertion in debug builds, and possible
7624     misbehaviour in normal builds.
7626 * Xapian::Error:
7628   + The constructors of Error subclasses which take a `const std::string &'
7629     parameter are now explicit.  This is very unlikely to affect any real code
7630     but if it does, just write `Xapian::Error(msg)' instead of `msg'.
7632   + Xapian::Error::get_type() now returns const char* rather than std::string.
7633     Generally existing code will just work (only one change was required in
7634     Xapian itself) - the simplest change is to write `std::string(e.get_type())'
7635     instead of `e.get_type()'.
7637   + Previously, the errno value was lost when an error was propagated from
7638     a remote server to the client, because errno values aren't portable
7639     between platforms.  To fix this, Error::get_errno() is now deprecated and
7640     you should use Error::get_error_string() instead, which returns a string
7641     expanded from the errno value (or other system error code).
7643 * Xapian::QueryParser:
7645   + Now assumes input text is encoded as UTF-8.
7647   + We've made several changes to term generation strategy.  Most notably:
7648     Unicode support has been added; '_' now counts as a word character; numbers
7649     and version numbers are now parsed as a single term; single apostrophes are
7650     now included in a term; we now store unstemmed forms of all terms; and we
7651     no longer try to "normalise" accents.
7653   + parse_query() now throws the new Xapian::Error subclass QueryParserError
7654     instead of throwing const char * (bug#101).
7656   + Pure NOT queries are now supported (for example, `NOT apples' will match
7657     all documents not indexed by the stemmed form of `apples').  You need
7658     to enable this feature by passing QueryParser::FLAG_PURE_NOT in flags
7659     to QueryParser::parse_query().
7661   + We now clear the stoplist when we parse a new query.
7663   + Queries such as `+foo* bar', where no terms in the database match the
7664     wildcard `foo*', now match no documents, even if `bar' exists.  Handling
7665     of `-foo*' has also been fixed.
7667   + Now supports wildcarding the last term of a query to provide better support
7668     for incremental searching.  Enabled by QueryParser::FLAG_PARTIAL.
7670   + The default prefix can now be specified to parse_query() to allow parsing
7671     of text entry boxes for particular fields.
7673   + QueryParser::set_stemming_options() has been deprecated since 0.9.0 and
7674     has now been removed.
7676 * Xapian::Stem:
7678   + Now assumes input text is encoded as UTF-8.
7680   + We've updated to the latest version of the Snowball stemmers.  This means
7681     that a small number of words produce different (and generally better)
7682     stems and that some new stemmers are supported: german2 (like german but
7683     normalises umlauts), hungarian, kraaij_pohlmann (a different Dutch
7684     stemmer), romanian, and turkish.
7686 * Xapian::TermGenerator:
7688   + New class which generates terms from a piece of text.
7690 * Xapian::Enquire:
7692   + The Enquire(const Database &) constructor has been marked as "explicit".
7693     This probably won't affect real code - certainly no Xapian API methods
7694     or functions take an Enquire object as a parameter - but calls to user
7695     methods or functions taking an Enquire object could be affected.  In
7696     such cases, you'll now have to explicitly write `Xapian::Enquire(db)'
7697     instead of `db'.
7699   + Enquire::get_eset() now produces better results when used with multiple
7700     databases - without USE_EXACT_TERMFREQ they should be much more similar to
7701     results from an equivalent single database; with USE_EXACT_TERMFREQ they
7702     should be identical.
7704   + Track the minimum weight required to be considered for the MSet separately
7705     from the minimum item which could be considered.  Trying to combine the two
7706     caused several subtle bugs (bug#86).
7708   + Enquire::get_query() is now `const'.  Should have no effect on user code.
7710   + Enquire::get_mset() now handles the common case of an "exact" phrase search
7711     (where the window size is equal to the number of terms) specially.
7713   + Enquire::include_query_terms and Enquire::use_exact_termfreq are now
7714     deprecated in favour of capitalised versions Enquire::INCLUDE_QUERY_TERMS
7715     and Enquire::USE_EXACT_TERMFREQ (for consistency with our other manifest
7716     constants, and general C/C++ conventions).
7718 * Xapian::RSet:
7720   + RSet::contains(MSetIterator) is now `const'.  Should have no effect on user
7721     code.
7723 * Xapian::SimpleStopper::add() now takes `const std::string &' not `const
7724   std::string'.  Should have no effect on user code.
7726 * Xapian::Query:
7728   + We now only perform internal validation on a Query object when it's either
7729     constructed or changed, to avoid O(n^2) behaviour in some cases.
7731   + Xapian::Query::MatchAll (an alias for Query("")) matches all terms in the
7732     document (useful for "pure NOT" queries) and Xapian::Query:MatchNothing
7733     is now a more memorable alias for Query().
7735 * Instead of explicitly checking that a term exists before opening its
7736   postlist, we now do both in one operation, which is more efficient.
7738 * MatchDecider::operator() now returns `bool' not `int'.
7740 * ExpandDecider::operator() now returns `bool' not `int'.
7742 * Xapian::TermIterator::get_termfreq() now throws InvalidOperationError
7743   if called on a TermIterator from a freshly created Document (since
7744   there's no meaningful term frequency as there's no Database for
7745   context).
7747 * <xapian/output.h> is no longer available as an externally visible header.
7748   It's not been included by <xapian.h> since 0.7.0.  Instead of using
7749   `cout << obj;' use `cout << obj.get_description();'.
7751 * New constant Xapian::BAD_VALUENO which is -1 cast to Xapian::valueno.
7753 * New Xapian::ValueRangeProcessor hierarchy: DateValueRangeProcessor,
7754   NumberValueRangeProcessor, and StringValueRangeProcessor.  In
7755   conjunction with the new QueryParser::add_valuerangeprocessor()
7756   method and the new Query::OP_VALUE_RANGE op these allow you to
7757   implement ranges in the query parser, such as `$50..100',
7758   `10..20kg', `01/02/2007..03/04/2007'.
7760 testsuite:
7762 * Many new and improved testcases in various areas.
7764 * If a test throws an unknown exception, say so in the test failure message.
7765   If it throws std::string, report the first 40 characters (or first line if
7766   less than 40 characters) of the string even in non-verbose mode.
7768 * Use of valgrind improved:
7770   + The test harness now only hooks into valgrind if environment variable
7771     XAPIAN_TESTSUITE_VALGRIND is set, which makes it easy to run test programs
7772     under valgrind in the normal way.  The runtest script sets this
7773     automatically.
7775   + runtest now passes "--leak-resolution=high" to valgrind to prevent
7776     unrelated leak reports related to STL classes from being combined.
7778   + configure tests for valgrind improved and streamlined.
7780   + New runsrv script to run xapian-tcpsrv and xapian-progsrv.  We need to
7781     run these under valgrind to avoid issues with excess numerical precision
7782     in valgrind's FP handling, but we can use "--tool=none" which is a lot
7783     faster than running them under valgrind's default memcheck tool.
7785 * The test harness now starts xapian-tcpsrv in a more reliable way - it will
7786   try sequentially higher port numbers, rather than failing because a
7787   xapian-tcpsrv (or something else) is already using the default port.
7788   It also no longer leaks file descriptors (which was causing later tests
7789   to fail on some platforms), and if xapian-tcpsrv fails to start, the error
7790   message is now reported.
7792 * remotetest has been removed and its testcases have either been added to
7793   apitest or just removed if redundant with tests already in apitest.
7795 * termgentest is a new test program which tests the Xapian::TermGenerator
7796   class.
7798 * TEST_EQUAL_DOUBLE() now uses a slightly less stringent threshold -
7799   DBL_EPSILON is too strict for calculations which include multiple
7800   steps.  Also, we now use it instead of doubles_are_equal_enough() and
7801   weights_are_equal_enough() which try to perform the same job.
7803 * New macro TEST_STRINGS_EQUAL() which displays the strings on separate lines
7804   so the differences can be clearly seen.
7806 * Test programs are now linked with '-no-install' which means that libtool
7807   doesn't need to generate shell script wrappers for them on most platforms.
7809 * runtest: Now turns on MALLOC_CHECK_ and MALLOC_PERTURB_ for glibc if
7810   valgrind isn't being used.
7812 * Better support for Microsoft Windows:
7814   + test_emptyterm2 no longer tries to delete a database from disk while a
7815     WritableDatabase object still exists for it, since this isn't supported
7816     under Microsoft Windows.
7818   + Fallback handling when srcdir isn't specified how takes into account .exe
7819     extensions and different path separators.
7821 flint backend:
7823 * Flint is now the default backend.
7825 * xapian-check: New program which performs consistency checks on a flint
7826   database or table.
7828 * xapian-compact: Now prunes unused docids off the start of each source
7829   database's range of docids.
7831 * Positional information is now encoded using a highly optimised fls()
7832   implementation, which is much faster than the FP code 0.9.x used.
7833   Unfortunately the old encoding could occasionally add extra bits
7834   on some architectures, which was harmless except the databases
7835   wouldn't be portable.  Because of this, the flint format has had to
7836   be changed incompatibly.
7838 * The lock file is now called "flintlock" rather than "flicklock" (which
7839   was a typo!)
7841 * Flint now releases its lock correctly if there's an error in
7842   WritableDatabase's constructor.  Previously the lock would remain until
7843   the process exited.
7845 * Flint now throws new Xapian::Error subclass DatabaseVersionError instead of
7846   DatabaseOpeningError when it fails to open a database because it has an
7847   unsupported version.  DatabaseVersionError is a subclass of
7848   DatabaseOpeningError so existing code should continue to work, but it's
7849   now much easier to determine if the problem is that a database needs
7850   rebuilding.
7852 * If you try to open a flint database with an older or newer version than
7853   flint understands, the exception message now gives the version understood,
7854   rather than "I only understand FLINT_VERSION" (literally).
7856 * If we fail to obtain the lock, report why in the exception message.
7858 * Flint now compresses tags in the record and termlist tables using zlib.
7860 * More robust code to handle the flint locking child process, in case of
7861   unexpected errors.
7863 * If a document was replaced more than once between flushes, the document
7864   length wouldn't be updated after the first change.
7866 quartz backend:
7868 * Quartz is still supported, but use in new projects is deprecated (use Flint
7869   instead).  Quartz will be removed eventually.
7871 * quartzcheck: Test if this is a quartz database by looking at "meta" not
7872   "record_DB".  If "record_DB" is >= 2GB and we don't have a LFS aware stat
7873   function then stat can fail even though the file is there.  Also open the
7874   database explicitly as a Quartz database for extra robustness.
7876 * If a document was replaced more than once between flushes, the document
7877   length wouldn't be updated after the first change.
7879 remote backend:
7881 * The remote backend is now supported under Microsoft Windows.
7883 * Open a fresh copy of the database(s) on each connection to a xapian-tcpsrv
7884   rather than relying on being able to share a database across fork() or
7885   between threads (which we don't promise will work).
7887 * xapian-tcpsrv: New "--interface" option allows the hostname or address of the
7888   interface to listen on to be specified (the default is the previous behaviour
7889   of listening on all interfaces).
7891 * If name lookup fails, report the h_errno code from gethostbyname() rather
7892   than whatever value errno happens to currently have!
7894 * Fix bugs in query unserialisation.
7896 * The remote backend now supports all operations (get_lastdocid(), and
7897   postlist_begin() have now been implemented).
7899 * Currently a read-only server can be opened as a WritableDatabase (which is
7900   a minor bug we plan to fix).  In this case, operations which write will fail
7901   and the exception is now InvalidOperationError not NetworkError.
7903 * If a remote server catches NetworkTimeoutError then it will now only
7904   propagate it if we can send it right away (since the connection is
7905   probably unhappy).  After that (and for any other NetworkError) we now
7906   just rethrow it locally to close the connection and let it be logged if
7907   required.
7909 * The timeout parameter to RemoteDatabase wasn't being used, instead the
7910   client would wait indefinitely for the server to respond.
7912 * A timeout of zero to the remote backend now means "never timeout".  This
7913   is now the default idle timeout for WritableDatabase (the connection
7914   timeout default is now 10 seconds, rather than defaulting to the idle
7915   timeout).
7917 * Fix handling of the document length in remote termlists.
7919 * The remote backend now checks when decoding serialised string that the
7920   length isn't more than the amount of data available (bug#117).
7922 * The remote backend now handles the unique term variants of delete_document
7923   and replace_document on the server side.
7925 * The RSet serialisation now encodes deltas between docids (rather than the
7926   docids themselves) which greatly reduces the size of the encoding of a
7927   sparse RSet for a large database.
7929 * We now encode deltas between term positions when sending data after calling
7930   positionlist_begin() on a remote database.
7932 * When using a MatchDecider with remote database(s), don't rerun the
7933   MatchDecider on documents which a remote server has already checked.
7935 * Apply the "decreasing weights with remote database" optimisation which we use
7936   in the sort_by_relevance case in the sort_by_relevance_then_value case too.
7938 * We now throw NetworkError rather than InternalError for invalid data received
7939   over the remote protocol.
7941 * We now close stderr of the spawned backend program when using the "prog" form
7942   of the remote backend.  Previously stderr output would go to the client
7943   application's stderr.
7945 muscat36 backend:
7947 * Support for the old Muscat 3.6 backends has been completely removed.  It's
7948   still possible to convert Muscat 3.6 databases to Xapian databases by
7949   building 0.9.10 and using copydatabase to create a quartz database, which can
7950   then be read by 1.0.0 (and converted to a flint database using copydatabase
7951   again).
7953 build system:
7955 * We've added GCC visibility annotations to the library, which when using GCC
7956   version 4.0 or later reduce the size and load time of the library and
7957   increase the runtime speed a little.  Under x86_64, the stripped library is
7958   6.4% smaller (1.5% smaller with debug information).
7960 * configure: If using GCC, use -Bsymbolic-functions if it is supported
7961   (it requires a very recent version of ld currently).  This option reduces the
7962   size and load time of the shared library by resolving references within the
7963   library when it's created.
7965 * We automatically define _FORTIFY_SOURCE in config.h if GCC is in use
7966   and it's not already set (you can override this as documented in INSTALL).
7967   This adds some checking (mostly at compile time) that important return
7968   values aren't ignored and that array bounds aren't exceeded.
7970 * `./configure --enable-quiet' already allows you to specify at configure time
7971   to pass `--quiet' to libtool.  Now you can override this at make-time by
7972   using `make QUIET=' (to turn off `--quiet') or `make QUIET=y' (to turn on
7973   `--quiet').
7975 * In non-maintainer mode, we don't need the tools required to rebuild some of
7976   the documentation, so speed up configure by not even probing for them in
7977   this common case.
7979 * The makefiles now use non-recursive make in all directories except "docs" and
7980   "tests".  For users, this means that the build is faster and requires less
7981   disk space (bug#97).
7983 * configure: Add proper detection for SGI's C++ (check stderr output of
7984   "CC -v") and automatically pass -ptused in CXXFLAGS for xapian-core and any
7985   applications using xapian-config --cxxflags since it seems to be required to
7986   avoid template linking errors.
7988 * XO_LIB_XAPIAN now checks for the case where XAPIAN_CONFIG wasn't specified
7989   and xapian-config wasn't found, but the library appears to be installed -
7990   this almost certainly means that the user has installed xapian-core from
7991   a package, but hasn't installed the -dev or -devel package, so include
7992   that advice in the error message.
7994 * `./configure --with-stlport-compiler' now requires a compiler name as an
7995   argument.
7997 * configure: Disable probes for f77, gcj, and rc completely by preventing
7998   the probe code from even appearing in configure - this reduces the size of
7999   configure by 209KB (~25%) and should speed it up significantly.
8001 * configure: Suppress more unhelpful warnings and "remarks" for HP's aCC, and
8002   turn on "+wlint", which seems useful.
8004 * A number of cases of unnecessary header inclusions have been addressed,
8005   which should speed up compilation (fewer headers to parse when compiling
8006   many source files).  This also reduces dependencies within the source code,
8007   and thus the number of files which need to be rebuilt when a header is
8008   changed.
8010 * configure: Cache the results of some of our custom tests.
8012 documentation:
8014 * The documentation has all been updated for changes in Xapian 1.0.0.
8016 * Many of the documentation comments in the API headers (which are collated
8017   using doxygen to generated the API reference) have been improved, and some
8018   missing ones added.  Also, internal classes, members, and methods are now all
8019   marked as such so that none should appear in the generated documentation.  In
8020   particular, the class inheritance graphs should be a lot clearer.  A few other
8021   problems have also been addressed.
8023 * docs/internals.html: New separate index page for the "internal"
8024   documentation.
8026 * docs/deprecated.html: New document describing deprecation policy.  This
8027   includes lists of features which have been removed, or which are deprecated
8028   and scheduled for removal, along with suggested replacements.
8030 * docs/admin_notes.html: New document introducing Xapian for sysadmins.
8032 * docs/termgenerator.html: New document describing the new term generation
8033   strategy implemented by the Term::Generator class.
8035 * docs/bm25.html,docs/intro_ir.html: These have been overhauled to make them
8036   fit better with the rest of the documentation, and with Xapian itself.
8038 * docs/overview.html: Fixed links to error classes in generated API
8039   documentation.
8041 * HACKING,INSTALL: Many updates and improvements.
8043 * xapian-config: Improve --version output so that help2man produces a better
8044   man page.
8046 * PLATFORMS: Remove reports for 0.7.* and demote reports for 0.8.* to "older
8047   reports" status.  All SF compilefarm machines are now "no longer available",
8048   so update the symbols and key to reflect this.  Update with recent success
8049   reports from the tinderbox and other sources.
8051 * AUTHORS: Thanks several bug reporters I missed before, as well as recent
8052   contributors.
8054 * docs/code_structure.html now looks nicer and includes links to
8055   svn.xapian.org.
8057 * docs/remote_protocol.html: Fixed several typos and other errors, and document
8058   all the new messages.
8060 * We no longer include docs/apidoc/latex/* in the xapian-core tarballs since
8061   it's just useless bloat.
8063 examples:
8065 * delve:
8067   + Report the exception error string if open a database fails.
8069   + Rename "-k" to "-V" since "keys" were renamed to "values" long ago.  Keep
8070     "-k" as an alias for now, but don't advertise it.  Add handling so "-V3"
8071     shows value #3 for every document in the database.
8073   + No longer stems terms by default.  Add "-s/--stemmer" option to allow a
8074     stemmer to be specified.
8076 * quest: Add "--stemmer" option to allow stemming language to be set, or
8077   stemming to be disabled.
8079 portability:
8081 * Fix compilation with GCC 4.3 snapshot.
8083 * Always use pid_t not int for holding a process id, and use AC_TYPE_PID_T to
8084   `#define pid_t int' if <sys/types.h> doesn't provide pid_t.
8086 * Pass the 4th parameter of setsockopt() as char* which works whether the
8087   function actually takes char* or void* (since C++ allows implicit conversion
8088   from char* to void*).
8090 * Most warnings in the MSVC build have been fixed.
8092 * Refactored most portability workarounds into safeXXXX.h headers.
8094 * Building for mingw in a cygwin environment should work better now.
8096 packaging:
8098 * RPM spec file:
8100   + Updated for the changes in this release.
8102   + ChangeLog.examples is now packaged.
8104 debug code:
8106 * Rename --enable-debug* configure options - conflating the options to "turn on
8107   assertions" and "turn on logging" is confusing. `--enable-debug[=partial]'
8108   becomes `--enable-assertions'; `--enable-debug-verbose' becomes
8109   `--enable-log' and `--enable-debug=full' becomes `--enable-assertions
8110   --enable-log'.  For now the old options give an error telling you the new
8111   equivalent.
8113 * Debug logging from expand is now all of type EXPAND (some was of types
8114   MATCHER and WTCALC before).
8116 * Hook the debug tracing in the lemon generated parser into Xapian's debug
8117   logging framework.
8119 * New assertion types: AssertEqParanoid() and AssertNeParanoid().
8121 * Retry write() if it fails when writing a debug log entry to ensure to avoid
8122   the risk of a partial write.
8124 Xapian-core 0.9.10 (2007-03-04):
8126 API:
8128 * Fix WritableDatabase::replace_document() not to lose positional information
8129   for a document if it is replaced with itself with unmodified postings.
8131 * QueryParser: Add entries to the "unstem" map for prefixed boolean filters
8132   (e.g. type:html).
8134 * Fix inconsistent ordering of documents between pages with
8135   Enquire::set_sort_by_value_then_relevance (fixes bug#110).
8137 testsuite:
8139 * Workaround apparent bug in MSVC's ifstream class.
8141 flint and quartz backends:
8143 * Fix possible double-free after a transaction fails.
8145 * Fix code for recovering from failing to open a table for reading
8146   mid-modification.  If modifications are so frequent that opening for reading
8147   fails 100 times in a row, throw DatabaseModifiedError not
8148   DatabaseOpeningError.
8150 * Don't call std::string::append(ptr, 0) when ptr may be uninitialised
8151   or NULL (rather suspect, and reported to cause SEGV-like behaviour with
8152   MSVC).
8154 * Ensure both_bases is set to false if we don't have both bases when
8155   opening a table using an existing object.
8157 * Use MS Windows API calls to delete files and open files we might want to
8158   delete while they are still open (i.e. the flint and quartz btree base
8159   files).  This fixes a problem when a writer can't discard an old revision at
8160   the exact moment a reader is opening it (bug #108).
8162 remote backend:
8164 * Fix WritableDatabase::has_positions() to refetch the cached value if it
8165   might be out of date.
8167 * Fix incorrect serialisation of a query with non-default termpositions.
8169 inmemory backend:
8171 * If replace_document is used to set the docid of a newly added document which
8172   has previously existed, ensure we mark that document as valid.
8174 documentation:
8176 * Assorted improvements to API documentation.
8178 * docs/Makefile.am: The larger pool_size we set in 0.9.9 for building
8179   sourcedoc.pdf was a bit marginal, so increase it further.
8181 * docs/stemming.html,docs/install.html: Correct 2 references to "CVS" to say
8182   "SVN" instead.
8184 * HACKING: Update the release checklist.
8186 portability:
8188 * Fix flint and quartz to allow 2GB+ B-tree tables when compiling with MSVC.
8190 packaging:
8192 * RPMs: Remove "." from end of "Summary:".  Package the new man page for
8193   xapian-progsrv.
8195 Xapian-core 0.9.9 (2006-11-09):
8197 testsuite:
8199 * Use popen() to run xapian-tcpsrv and wait for "Listening..." before returning
8200   rather than just sleeping for 1 second and hoping that's enough.
8202 * If we can't start xapian-tcpsrv because the port is in use, try higher
8203   numbered ports.
8205 remote backend:
8207 * xapian-tcpsrv: If the port requested is in use, exit with code 69
8208   (EX_UNAVAILABLE) which is useful if you're trying to automate launching of
8209   xapian-tcpsrv instances.
8211 * xapian-tcpsrv: Output "Listening..." once the socket is open and read for
8212   connections (this allows the testsuite to wait until xapian-tcpsrv is ready
8213   before connecting to it).
8215 * xapian-progsrv: Now supports --help, --version, and has a man page.  Fixes
8216   Bug #98.
8218 * Turn on TCP_NODELAY for the TCP variant of the remote backend which
8219   dramatically improves the latency of operations on the database.
8221 build system:
8223 * internaltest: Disable serialiselength1 and serialisedoc1 when the remote
8224   backend is disabled to fix build error in this case.
8226 * Move libbtreecheck.la from testsuite/ to backends/quartz/.
8228 * Move the testsuite harness from testsuite/ to tests/harness/.
8230 documentation:
8232 * Ship our custom INSTALL file rather than the generic one from autoconf which
8233   we've accidentally been shipping instead since 0.9.5.
8235 * docs/Makefile.am: Building sourcedoc.pdf needs a larger pool_size now we're
8236   using pdflatex.
8238 * HACKING: Update debian packaging checklist.
8240 * PLATFORMS: Updated with results from tinderbox.
8242 portability:
8244 * Create "safefcntl.h" as a replacement for <fcntl.h> instead of using
8245   "utils.h" for this purpose, since "utils.h" pulls in many other things we
8246   often don't need.
8248 packaging:
8250 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
8252 Xapian-core 0.9.8 (2006-11-02):
8254 API:
8256 * QueryParser: Don't require a prefixed boolean term to start with an
8257   alphanumeric - allow the same set of characters as we do for the second
8258   and subsequent characters.
8260 flint backend:
8262 * Only force a flush on WritableDatabase::allterms_begin() if there are
8263   actually pending changes.
8265 quartz backend:
8267 * Only force a flush on WritableDatabase::allterms_begin() if there are
8268   actually pending changes.
8270 * quartzcheck: Avoid dying because of an unhandled exception if the Btree
8271   checking code finds an error in the low-level Btree structure.  Add a
8272   catch for any other unknown exceptions.
8274 build system:
8276 * When building with GCC, turn on warning flag -Wshadow even when not in
8277   maintainer mode (provided it is supported by the GCC version being used).
8279 * testsuite/backendmanager.cc: Fix compilation when valgrind is detected by
8280   configure.
8282 * If generating apidoc.pdf fails, display the logfile pdflatex generates since
8283   that is likely to show what failed.
8285 documentation:
8287 * Produce a PDF for apidoc rather than PostScript, since the PDF is smaller,
8288   plus at least as easy to print and easier to view for most users.  Use
8289   pdflatex to generate the PDF directly rather than going via a DVI file which
8290   apparently produces a better result and also avoids problems on some Linux
8291   distros where latex is a symlink to pdfelatex (bug#81, bug#95).
8293 * HACKING: Mention automake 1.10 is out but we've not tested it yet.
8295 * HACKING: Add entries to release checklist: make sure new API methods
8296   are wrapped by the bindings, and that bug submitters are thanked.
8298 * HACKING: Note that on Debian, tetex-extra is needed for
8299   fancyhdr.sty.
8301 * HACKING: Note that dch can be used to update debian/changelog.
8303 * docs/code_structure.html: Document backends/remote.
8305 * PLATFORMS: Update from tinderbox.
8307 portability:
8309 * configure: When checking if we need -lm, don't use a constant argument to
8310   log() as the compiler might simply evaluate the whole expression at compile
8311   time.
8313 * configure: Redhat's GCC 2.96 doesn't support -Wundef even though real GCC
8314   version before and after it do!
8316 * configure: Avoid use of double quotes in double-quoted backticks since
8317   it causes problems on some platforms.
8319 * backends/flint/flint_io.cc: Fix compilation on windows (needs to
8320   #include "safewindows.h" to get definition of SSIZE_T).
8322 * Fix our implementation of om_ostringstream to compile so that the build
8323   works once more on older compilers without <sstream> (regression probably
8324   introduced in 0.9.7).
8326 packaging:
8328 * xapian.spec: Package xapian-progsrv.
8330 Xapian-core 0.9.7 (2006-10-10):
8332 API:
8334 * QueryParser:
8336   + Allow a distance to be optionally specified for NEAR - e.g.
8337     "cats NEAR/3 dogs" (bug#92).
8339   + Implement "ADJ" operator - like "NEAR" except the terms must
8340     appear in matching documents in the same order as in the query.
8342   + Fix bug in how we handle prefixed quoted phrases and prefixed brackets.
8344   + Fix parsing of loved and hated prefixed phrases and bracketted expressions.
8346   + Fix handling of stopwords in boolean expressions.
8348   + Don't ignore a stopword if it's the only query term.
8350 * Document::add_value() failed to replace an existing value with the same
8351   number, contrary to what the documentation says (bug #82).
8353 * Enquire::set_sort_by_value(): Don't fetch the document data when fetching
8354   the value to sort on.  Simple benchmarking showed this to speed up sort by
8355   value by a factor of between 3 and 9!
8357 * Implement transactions for flint and quartz.  Also supported are "unflushed"
8358   transactions, which provided an efficient way to atomically group a number
8359   of database modifications.
8361 * The Xapian::Error and Xapian::ErrorHandler classes have been reimplemented.
8362   The new versions have better, clearer documentation comments and are cleaner
8363   internally.
8365 * Change how doubles are serialised by TradWeight, BM25Weight, and in the
8366   remote backend protocol.  The new encoding allows us to transfer any double
8367   value which can be represented by both machines precisely and compactly.
8369 testsuite:
8371 * Add targets "check-flint", "check-quartz", and "check-remote" in tests and at
8372   the top level which run the subset of tests which test the respective backend.
8374 * apitest: Run tests on flint if flint is enabled, rather than if quartz is
8375   enabled!
8377 * apitest: Speed up deldoc4 when run in verbose mode - some stringstream
8378   implementations are very inefficient when the string grows long.
8380 * Turn on GLIBCXX_FORCE_NEW when running tests under valgrind to stop the GNU
8381   C++ STL from using a pooling allocator.  This helps make velgrind's leak
8382   tracking more reliable.
8384 * Probe for required valgrind logging options at configure time rather than
8385   when running the test program.  This saves about 2 seconds per test program
8386   invocation.
8388 * Fix testsuite harness to show valgrind output when a test fails (when running
8389   under valgrind in verbose mode).  This had stopped working, probably due to
8390   changes in valgrind 3.
8392 * internaltest: Check that the destructor on a temporary object gets called
8393   at the correct time (Sun C++ deliberately gets this wrong by default, and it
8394   would be good to catch any other compilers which do the same).
8396 * apitest: When running tests on the remote backend and running under valgrind,
8397   run xapian-tcpsrv and xapian-progsrv under valgrind too to avoid issues
8398   with the precision of doubles (bug#94).
8400 flint backend:
8402 * Retry on EINTR from fcntl or waitpid when creating or releasing the flint
8403   lock file.
8405 * xapian-compact: Add --blocksize option to allow the blocksize to be set
8406   (default is 8K as before.)
8408 * WritableDatabase::replace_document(did, doc) was double-incrementing the
8409   "changes" counter when document did didn't exist so it would flush twice
8410   as often - fixed.
8412 * WritableDatabase::postlist_begin(): Remove forced flush when iterating the
8413   posting list of a term which has modified postings pending.
8415 quartz backend:
8417 * quartzcompact: Add --blocksize option to allow the blocksize to be set
8418   (default is 8K as before.)
8420 * WritableDatabase::replace_document(did, doc) was double-incrementing the
8421   "changes" counter when document did didn't exist so it would flush twice
8422   as often - fixed.
8424 remote backend:
8426 * Most of the remote backend has been rewritten.  It now supports most
8427   operations which a local database does (including writing!), the protocol
8428   used is more compact, and a number of layers of classes have been eliminated
8429   and the sequences of method calls simplified, so the code should be easier to
8430   understand and maintain despite doing more.  A number of bugs have been fixed
8431   in the process.
8433 * xapian-tcpsrv: Report errno if we catch a Xapian::Error which has it set.
8435 * xapian-tcpsrv: Fix memory leak in query unserialisation.
8437 build system:
8439 * Now using autoconf 2.60 for snapshots and releases.  Also now using a
8440   libtool patch which improves support for Sun C++'s -library=stlport4 option.
8442 * configure: Fix generation of version.h to work with Solaris sed.
8444 * automake adds suitable rules for rebuilding doxygen_api_conf and
8445   doxygen_source_conf, so remove our less accurate versions.  Also fix
8446   dependencies for regenerating the doxygen documentation, and make the
8447   documentation build work with parallel make.
8449 * Make use of the dist_ prefix to avoid having to list files in EXTRA_DIST as
8450   well as in *_DATA and man_MANS.
8452 * Removed a few unused #include-s.
8454 * include/xapian/error.h: Add hook to allow SWIG bindings to be built using
8455   GCC's visibility support.
8457 * configure: Turn on automake's -Wportability to help ensure our Makefile.am's
8458   are written in a portable way.
8460 * configure: Disable probing and short-cut tests for a FORTRAN compiler.  We
8461   don't use one, but current libtool versions always check for it regardless.
8463 * xapian-config: Prune -L/usr/lib from output of `xapian-config --libs'.
8465 documentation:
8467 * docs/scalability.html: quartzcompact and xapian-compact now allow you to set
8468   the blocksize, so there's no need to use copydatabase if you want to migrate
8469   a database to a larger blocksize.  Mention gmane.  Other minor tweaks.
8471 * Eliminate "XAPIAN_DEPRECATED" from generated documentation.
8473 * PLATFORMS: Added success report for Nexenta (alpha 5), MSVC, and sparc linux.
8474   Updated other results from tinderbox.
8476 * Add links to the wiki from README and the documentation index.
8478 * docs/overview.html: Add discussion of uses of terms vs values.
8480 * docs/overview.html: Rewrite the section on Xapian::Document to remove some
8481   very out-of-date information and make it clearer.
8483 * include/xapian/database.h: Note that automatically allocated document IDs
8484   don't reuse IDs from deleted documents.
8486 * include/xapian/enquire.h: Note that "set_sort_by_relevance" is the default
8487   setting.
8489 * docs/queryparser.html,include/xapian/queryparser.h: Add note that
8490   FLAG_WILDCARD requires you to call set_database.
8492 * HACKING: Add some advice regarding debugging using -D_GLIBCXX_DEBUG,
8493   valgrind, and gdb.
8495 * HACKING: Give URL to Alexandre Duret-Lutz's autotools tutorial, which is much
8496   more up-to-date than the "goat book".
8498 * HACKING: Update and expand the information about the debian packaging.
8500 * Add missing dir_contents files.
8502 portability:
8504 * xapian/version.h: Add a check that _GLIBCXX_DEBUG is set compatibly if we're
8505   compiling with GNU C++ 3.4 or newer.
8507 * Add configure check to see if "-lm" is needed to get maths functions since
8508   newer versions of Sun's C++ compiler seem to require this.
8510 * Automatically put Sun's C++ compiler into "ANSI C++ compliant library" mode
8511   (using -library=stlport4).  This allows us to remove most of the special
8512   case bits of code we've accumulated for just this compiler, which improves
8513   maintainability.
8515 * Sun's C++ compiler implements non-standards-conforming lifetimes for
8516   temporary objects by default.  This means database locks don't get released
8517   when they should, so we now always pass "-features=tmplife" for Sun C++
8518   which selects the behaviour specified by the C++ standard.
8520 Xapian-core 0.9.6 (2006-05-15):
8522 API:
8524 * Rename Xapian::xapian_version_string() and companions to
8525   Xapian::version_string(), etc.  Keep the old functions as aliases which are
8526   marked as deprecated.
8528 * QueryParser: Add rules to handle a boolean filter with a "+" in front (such
8529   as +site:xapian.org).
8531 testsuite:
8533 * queryparsertest: Add another prefix testcase to improve coverage.
8535 build system:
8537 * configure: Simpler check for VALGRIND being set to empty value.
8539 * include/Makefile.am: Add xapian/version.h.timestamp as a dependency on
8540   all-local so that xapian/version.h actually gets regenerated when required.
8542 * Eliminate XAPIAN_BUILD_BACKEND_* from config.h and just use
8543   XAPIAN_HAS_*_BACKEND from xapian/version.h instead.
8545 documentation:
8547 * remote_protocol.html: Document keep-alive messages.
8549 * xapian/enquire.h: Remove bogus documentation for a parameter which doesn't
8550   exist.
8552 * PLATFORMS: Added a summary.  Updated and pruned old entries for which we
8553   have a newer close match.
8555 * HACKING: Expand on details of what's required when changing Xapian (discuss
8556   documentation requirements, and more on why feature tests are vital).
8558 * HACKING: Update section on building debian packages.
8560 portability:
8562 * The tarball is generated with a patched version of libtool 1.5.22 which
8563   fixes libtool bugs on HP-UX and some BSD platforms.
8565 * configure: Fix problems with test for snprintf which affected cygwin, and
8566   possibly some other platforms.
8568 * configure: Tweak version.h generation to cope with CXXCPP putting carriage
8569   returns into its output as can happen on cygwin.
8571 * Fix renaming of "iamflint.tmp" for MS Windows where you can't rename an open
8572   file.
8574 * Fixed MSVC7 warnings.
8576 * Added workaround for newlib header bug.
8578 Xapian-core 0.9.5 (2006-04-08):
8580 API:
8582 * QueryParser:
8584   + Fix FLAG_BOOLEAN_ANY_CASE to really allow any case combination - previously
8585     it only allowed all uppercase or all lowercase.
8587   + Fix QueryParser's handling of terms with trailing "#", "+", or "-" when
8588     set_database has been called and the term doesn't exist in the database
8589     with the suffix.
8591 * Add mechanism to allow xapian-bindings to override deprecation warnings so
8592   we can continue to wrap deprecated methods without lots of warnings.
8594 * Move Enquire::get_matching_terms_end() and Document::termlist_end() inline in
8595   header.
8597 * Database::termlist_begin(): Eliminate the MultiTermList wrapper in the common
8598   case where we're only dealing with a single database.
8600 * Fix TermIterator::positionlist_begin() to work on TermIterator from
8601   Database::termlist_begin().  Make TermList::positionlist_begin() pure
8602   virtual and put dummy implementations in BranchTermList and other
8603   subclasses which can't (or don't) implement it.  This makes it hard to
8604   accidentally fail to implement it in a backend's TermList subclass.
8606 * TermIterator::positionlist_begin() with the remote backend now throws
8607   UnimplementedError instead of InvalidOperationError.
8609 * Implement Enquire::set_sort_by_relevance_then_value().
8611 testsuite:
8613 * Added missing feature test for QueryParser::FLAG_BOOLEAN_ANY_CASE.
8615 * remotetest: Check mset size in tcpmatch1.
8617 flint backend:
8619 * xapian-compact: Fixed segfault from passing an unknown option (e.g.
8620   "xapian-compact --foo").
8622 quartz backend:
8624 * quartzdump,quartzcompact: Fixed segfault from passing an unknown option
8625   (e.g.  "quartzdump --foo").
8627 remote backend:
8629 * xapian-tcpsrv: Don't perform a name lookup on the IP address which an
8630   incoming connection is from as that could easily slow down the search
8631   response - instead just print the IP address itself if output is verbose.
8633 * xapian-tcpsrv: Allow up to 5 connections in the listen queue instead of just
8634   one.
8636 build system:
8638 * Removed unused code from the matcher and the remote, quartz, and flint
8639   backends.
8641 documentation:
8643 * All installed binaries now support --help and --version and have a man page
8644   (which is generated using help2man).
8646 * docs/overview.html: Bring up to date.
8648 * docs/remote_protocol.html: Document messages for requesting and sending a
8649   termlist and a document.
8651 * PLATFORMS, AUTHORS: Updated.
8653 * INSTALL: Improve wording.
8655 * HACKING: Note that we now use a lightly patched version of libtool 1.5.22.
8657 * HACKING: aclocal is part of automake, not autoconf.
8659 portability:
8661 * Added some tweaks to help support compilation with MSVC.
8663 packaging:
8665 * RPMs: package the new man pages.
8667 debug code:
8669 * Add missing spaces in some debug output.
8671 Xapian-core 0.9.4 (2006-02-21):
8673 API:
8675 * Flag deprecated methods such that the compiler gives a warning, for compilers
8676   which support such a feature (most notably GCC >= 3.1).
8678 * Correct typo in name of definition of function xapian_revision().
8680 testsuite:
8682 * Updated uses of deprecated methods in the testsuite.
8684 build system:
8686 * xapian-config: Set exec_prefix and prefix at top of script so that
8687   xapian-config works after xapian-core is installed.
8689 documentation:
8691 * Add documentation comment for Enquire::set_sort_by_value_then_relevance().
8693 * README: Add pointer to HACKING.  Change "CVS access" to "SVN access".
8695 * PLATFORMS: Updated from tinderbox.
8697 * COPYING: Update second occurrence of old FSF address.
8699 Xapian-core 0.9.3 (2006-02-16):
8701 API:
8703 * Added 4 functions to report version information for the library version being
8704   used (which may not be the same as that compiled against if shared libraries
8705   are in use):  xapian_version_string(), xapian_major_version(),
8706   xapian_minor_version(), xapian_revision().
8708 * Xapian::QueryParser:
8710   + Fix handling of "+" terms in a query when the default query operator is
8711     AND.  Added regression test for this.
8713   + Added "AND NOT" as a synonym for "NOT".  Added feature tests for this.
8715 * Fix prototype for ESet::operator[] to take parameter of type termcount
8716   instead of doccount (doccount and termcount are both typedefs to the same
8717   type so this really just makes the prototype more consistent).
8719 * Xapian::Stem: Check for malloc and calloc failing to allocate memory and
8720   throw an exception.  Richard has fixed this upstream in snowball, so this is
8721   a temporary fix until we import a new version of snowball.
8723 * Xapian::Database: Trying to open a database for reading which doesn't exist
8724   now fails with DatabaseOpeningError instead of FeatureUnavailableError.
8725   Added regression test for this.
8727 * Add Stopper::get_description() and SimpleStopper::get_description().
8729 testsuite:
8731 * Fixed testsuite harness to work with valgrind on 64 bit platforms.
8733 * Merged the "running tests" section of docs/tests.html into the similar
8734   section in HACKING, and make docs/tests.html refer the reader to HACKING for
8735   more information.
8737 * Tidied and enhanced environmental variables which the test suite harness
8738   recongnises:
8740   + OM_TEST_BACKEND: Removed support since the "-b" switch to apitest allows
8741     you control which backend is used, making OM_TEST_BACKEND pretty much
8742     redundant.
8744   + XAPIAN_SIG_DFL: Renamed to XAPIAN_TESTSUITE_SIG_DFL.
8746   + XAPIAN_TESTSUITE_OUTPUT: New environmental variable to control use of
8747     ANSI colour escape sequences in test output (set to "plain" to disable
8748     them, unset, empty, or "auto" to check if stdout is a tty, or anything
8749     else to force colour).
8751 flint backend:
8753 * xapian-compact: Added "--multipass" option to merge postlists in pairs or
8754   triples until all are merged.  Generally this is faster than an N-way merge,
8755   but it does require more disk space for temporary files so it's not the
8756   default.
8758 quartz backend:
8760 * quartzcheck: If the database is too broken to open, emit a warning message
8761   and bump the error count.
8763 build system:
8765 * Now generate snapshots and releases with automake 1.9.6 (was 1.9.5) and
8766   libtool 1.5.22 (was 1.5.18).
8768 * configure: If not cross-compiling, try to actually run a test program built
8769   with the C++ compiler, not just link one.
8771 * configure: Fix to actually skip the check for valgrind if VALGRIND is set to
8772   an empty value.
8774 * configure: Add sanity check for MS Windows that "find" is Unix-like find, not
8775   MSDOS-like.
8777 * Fix conditional compilation of flint backend - it was being disabled when
8778   quartz was, not when flint was supposed to be.
8780 documentation:
8782 * INSTALL,README: Updated.
8784 * Give pointer to replacements for the deprecated Enquire sorting methods
8785   in the doxygen collated documentation.
8787 * PLATFORMS: Added success reports for ppc64 linux and Fedora Core 4.  Updated
8788   from the tinderbox.
8790 * HACKING: Note platforms valgrind now has solid support for; Improve
8791   phrasing in a few places.
8793 * Upgrade to using doxygen 1.4.6 for generating API documentation.
8795 * Change title of the "full source" documentation to "Internal Source
8796   Documentation" rather than "Full source documentation" to make it
8797   clearer it's only useful if you want to modify Xapian itself.
8799 * Fix documentation comments for the values of QueryParser::feature_flag so
8800   doxygen actually pulls out the documentation for them.  Add documentation for
8801   the parameters of QueryParser::parse_query().
8803 * queryparser.html: Document wildcards.
8805 portability:
8807 * Fix compilation with GCC 4.0.1 and later (need to forward declare class
8808   InMemoryDatabase) (bug #69).
8810 * Fix compilation under cygwin (broken in 0.9.2).
8812 * Don't pass NULL for the second parameter of execl() - the Linux man page
8813   says execl takes "one or more pointers to null-terminated strings".  Also
8814   cast the NULL to (void*) to avoid "missing sentinel" warning from GCC4.
8816 * Use snprintf instead of sprintf where available (we were attempting to
8817   do this in some places before, but the configure test was broken so
8818   sprintf was always being used).
8820 * Enable more warnings under aCC and fix minor issues highlighted.  Suppress
8821   "Entire translation unit was empty" warning which isn't useful to us.
8823 * Write top-bit set characters in the source using \xXX notation to avoid
8824   warnings from Intel's C++ compiler.
8826 * configure: TYPE_SOCKLEN_T fails hard, so only run it if we've successfully
8827   run other socket tests.
8829 * queryparser/accentnormalisingitor.h: #include <limits.h> for CHAR_BIT.
8831 * bin/xapian-compact.cc: Fix printf type mismatch on 64 bit platforms.
8833 * Replace pair<bool, string> with a simple class BoolAndString - the pair
8834   results in a 4328 byte symbol on HP-UX which gets truncated (to 4000 bytes).
8835   Most likely this is harmless, but it causes a warning.
8837 * configure: Disable flint backend by default if building for djgpp or msdos.
8839 * xapian-config: Previously when linking without libtool we've always thrown
8840   in dependency_libs, even though only some platforms need it (because it's
8841   generally pretty harmless).  However some Linux distros have an unhelpful
8842   policy of not packaging .la files, so libxapian.la isn't available to
8843   extract dependency_libs from.  Linux is a platform which doesn't require
8844   dependency_libs to be explicitly linked, so extend xapian-config to not
8845   pull in dependency_libs if libtool's link_all_deplibs_CXX=no.
8847 * xapian-config: If the current platform needs dependency_libs and
8848   libxapian.la's dependency_libs contains another .la file, transform it into a
8849   pair of -L and -l options, and recursively expand its dependency_libs (if
8850   any).
8852 * Don't pass functions with C++ linkage to places wanting pointers to functions
8853   with C linkage.  So far this has worked for us, but it causes warnings with
8854   some compilers, and may not be portable.
8856 * Compaq C++ 7.1 doesn't suffer from the problem which previously prevented
8857   it from building Xapian.  This release includes workarounds for some
8858   oddities with errno.h support in this compiler, but currently the build
8859   fails when trying to link a binary with the library.
8861 packaging:
8863 * RPM: Invoke %setup correctly in xapian.spec.
8865 debug code:
8867 * Add missing '#include <iostream>' when TIMING_PATCH is defined.
8869 Xapian-core 0.9.2 (2005-07-15):
8871 API:
8873 * QueryParser:
8875   + Added optional "flags" argument to parse_query method.
8877   + Add flag FLAG_BOOLEAN_ANY_CASE which tells the QueryParser that boolean
8878     operators such as "AND", "OR", and "NEAR" should be recognised even if
8879     they aren't fully capitalised (so "and", "And", "aNd", etc will work too).
8881   + Add flag FLAG_WILDCARD which tells the QueryParser to allow right
8882     truncation e.g. "xap*".
8884   + Fixed to handle "-site:microsoft.com" where site is a boolean prefix.
8885     Added testcases for this.
8887 testsuite:
8889 * The test harness was incorrectly creating a quartz database when a flint one
8890   was requested, which meant tests weren't being run against flint and so it
8891   had bugs rendering it pretty much unusable.
8893 * Added regression test longpositionlist1 (to check encoding/decoding a long
8894   position list, which flint had problems with).
8896 flint backend:
8898 * Bumped format version number.
8900 * Added new "xapian-compact" program which can compact and merge flint
8901   databases in a similar way to how quartzcompact does for quartz databases.
8903 * Fixed to auto-detect database type when opening an existing Flint database
8904   as a WritableDatabase.
8906 * The code to encode the position list size, first entry, and last entry
8907   didn't match the code to decode them!  Reworked both to match, using a
8908   slightly more compact encoding.
8910 * We were failing to append "DB" to the path when opening a table for reading.
8912 * Rewrite of FlintAllTermsList with several fewer member variables.  The
8913   rewrite fixes a bug too - the old version wasn't ignoring the metainfo
8914   entry which is now in the postlist table.
8916 * It seems we need to explicitly kill the child process used for locking.
8917   Otherwise when we have two databases locked just closing the connection
8918   doesn't cause the child to die.  I don't understand why it's needed, but this
8919   fix is at least clean.
8921 quartz backend:
8923 * quartzcompact: Fix mis-repacking of keys in positionlist table when merging
8924   several databases.
8926 * Disable assertion in allterms iteration which is incorrect in a corner case.
8927   This is only a problem if a termname contains zero bytes and you're using a
8928   debug build.  Add regression test test_specialterms2.
8930 remote backend:
8932 * Implement sorting on a value with the remote backend.
8934 build system:
8936 * Pass automake options to AM_INIT_AUTOMAKE rather than specifying them in
8937   Makefile.am.  This way, the version requirements for autoconf and automake
8938   are stated close together.
8940 * configure: -Wshadow causes false positives with GCC 3.0.4, so only enable it
8941   for 3.1 and up.
8943 * configure: Eliminate use of "ln -s" when generating include/xapian/version.h
8944   since it seems to cause problems on Solaris in some setups and isn't really
8945   necessary.
8947 * Add dependency mechanism so version.h gets regenerated when the template is
8948   changed.
8950 * configure: Check for spaces in build directory, source directory, or install
8951   prefix and die with a helpful message.
8953 * Add dependency to generate queryparser_token.h.
8955 * Eliminated TOP_SRCDIR and TOP_BUILDDIR - it's better to just use top_srcdir
8956   and top_builddir directly.
8958 * configure: Generate the list of source files to feed to doxygen by inspecting
8959   all the Makefile.am files prior to running autoreconf rather than by using
8960   "find" when the user runs ./configure.  This speeds up configure, avoids
8961   generating docs for random .cc and .h files which aren't part of xapian-core,
8962   and avoids problems with picking up FIND.EXE on MS Windows.
8964 documentation:
8966 * Expanded explanation of the "descending docid with boolean weighting" trick
8967   for fast date ordered searching in Enquire::set_docid_order() API docs.
8969 * docs/intro_ir.html: Citeseer has moved, so update link.
8971 * testsuite/testsuite.cc: Update URL for valgrind FAQ in comment.
8973 * COPYING: Update FSF address.
8975 * HACKING: Minor updates to release checklist.
8977 portability:
8979 * Assorted tweaks towards allowing compilation with MSVC.
8981 packaging:
8983 * xapian.spec.in: Package xapian-compact.
8985 Xapian-core 0.9.1 (2005-06-06):
8987 API:
8989 * Fix SEGV on get_terms_begin() on an empty Query object.  This was causing
8990   a SEGV in Omega with an empty query.
8992 * Put Query::get_terms_end() inline in header.
8994 flint backend:
8996 * Added the new "flint" backend, which starts out as a copy of the quartz
8997   backend plus some modifications and replacements.  When creating a database
8998   without a specified backend, quartz is still used unless the environmental
8999   variable XAPIAN_PREFER_FLINT is set to a non-empty value.
9001 * apitest now runs tests on flint as well as the other backends.
9003 * Removed undocumented (and hence the little used) quartz "log" feature.
9005 * Implement new fork+fcntl+exec based locking (for Unix) and CreateFile based
9006   locking (for Windows - currently untested).
9008 * Move the special key/tag pair holding the total document length and doc id
9009   high water mark from the record table to the postlist table.  This means that
9010   when appending documents, the insertion point will now always be at the end
9011   of the record table which is more efficient.  We need to jump around the
9012   postlist table to merge postings in anyway.
9014 * Changed metafile magic to be different from quartz, and make the metafile
9015   version a datestamp which we'll change each time the format changes.
9017 * Check the return value of close() when writing the metafile.
9019 * Flint position list table now stores entries using interpolative coding
9020   (which is significantly more compact).
9022 quartz backend:
9024 * quartzcheck: Fixed corner case where you couldn't check a single Btree table
9025   which was just the DB and baseA/baseB files in a directory (Xapian doesn't
9026   produce anything like this, but btreetest does while unit testing the
9027   Btree code).
9029 build system:
9031 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
9033 * configure: Pass more -W flags to g++ (including -Wundef which caught the
9034   getopt problem fixed in this release).  Fixed new GCC warnings from these new
9035   flags.
9037 * Fixed a lingering DOXYGEN_HAVE_DOT reference.
9039 * Fixed accidentally pruned #define which meant that getopt code was being
9040   included even on systems which use glibc (on such systems, we should use
9041   the glibc copy of the code instead).
9043 * queryparser/queryparser.lemony: Add missing '#include <config.h>'.
9045 documentation:
9047 * Added missing documentation comments for a QueryParser methods added in
9048   0.9.0.
9050 * docs/quartzdesign.html: Removed warning that quartz is still in development.
9052 * PLATFORMS: Updated from tinderbox.
9054 * configure: Describe CC_FOR_BUILD in configure --help output.
9056 * HACKING: Updated release instructions to refer to SVN, and note that release
9057   tarballs are now built specially rather than being copies of snapshots.
9058   Update information about the SVN tag name to use for debian files.
9060 * HACKING: Add "email Fabrice" to the release checklist so that RPM
9061   spec files don't lag behind.
9063 * Fixed a few spelling mistakes.
9065 packaging:
9067 * xapian.spec: Remove bogus %setup line left over from when we packaged
9068   xapian-core and xapian-examples together from separate tarballs.
9070 debug code:
9072 * api/omqueryinternal.cc: Fixed compilation with --enable-debug.
9074 * common/omdebug.h: Replace C style cast with static_cast<> which reveals that
9075   we were discarding const (harmlessly though).
9077 Xapian-core 0.9.0 (2005-05-13):
9079 API:
9081 * Query objects really need to be immutable after construction (otherwise we
9082   need a copy-on-write mechanism).  To achieve this the following API changes
9083   were required:
9085   + Remove Query::set_length() in favour of an optional length
9086     parameter to Enquire::set_query().
9088   + Eliminated Query::set_elite_set_size() in favour of optional parameter
9089     to constructor.
9091   + Eliminated Query::set_window() in favour of an optional parameter to the
9092     constructor.
9094 * Removed OP_WEIGHT_CUTOFF, since it doesn't actually seem to add useful
9095   functionality over using Enquire::set_cutoff().
9097 * MSet::max_size() (which only exists so that MSet is an STL container) now
9098   returns MSet::size() and is inlined from the header.
9100 * Added ESet::max_size() (for STL compatibility).
9102 * Fixed Xapian::RSet to have the same "it's a handle" copy semantics as most of
9103   the other classes.
9105 * Rewritten QueryParser class:
9107   + Uses Lemon instead of Bison to generate the parser, which enables us to
9108     stop using static data, so this class is at last reentrant.
9110   + QueryParser now uses a PIMPL style with reference counted internals like
9111     most of the other Xapian classes.
9113   + Direct access to member variables has gone, which unfortunately forces an
9114     API change (but this fixes bug #39).  Instead of accessing
9115     QueryParser::termlist member variable, iterate over terms using
9116     Query::get_terms_begin() and get_terms_end() on the returned Query object.
9117     Direct access to stoplist is replaced by QueryParser::get_stoplist_begin()
9118     and get_stoplist_end(); and to unstem by get_unstem_begin() and
9119     get_unstem_end().
9121   + The rewrite parses many real world examples better than the old version.
9123   + Now allow searches for C#, etc.  If a database has been set, for this and +
9124     and - suffixes, check if the term actually exists, and if not, ignore the
9125     suffix if the unsuffixed term exists.
9127   + Added QueryParser::get_description() method (not very descriptive yet!)
9129   + Added backward compatibility wrapper for old version of
9130     QueryParser::set_stemming_options().
9132   + xapian.h now automatically includes xapian/queryparser.h.  Directly
9133     including xapian/queryparser.h will continue to work for now, but is
9134     deprecated.
9136   + QueryParser::parse_query() was failing to clear termlist and unstem
9137     - the rewrite fixes this.
9139   + New QueryParser parses "term prefix:(term2 term3)" correctly.
9141 * Added Xapian::SimpleStopper which just stops terms specified by a pair of
9142   iterators.  This should be sufficient for the majority of uses.
9144 * Tidied up the Enquire sorting API and added ability to reverse sort on a
9145   value.  Removed sort_bands support.
9147 * Enquire::get_description() improved.
9149 * Methods which return an end iterator where the internals are just NULL are
9150   now inline in the header for efficiency.  Should we ever need to change an
9151   implementation, we can easily move methods back into the library and bump the
9152   library version suitably.
9154 * Added Stem::operator() as preferred alternative to Stem::stem_word().
9156 * Simplified Stem internal design by restructuring to eliminate a few internal
9157   methods.
9159 * BM25Weight: Avoid fetching document length if we're simply going to multiply
9160   it by zero!
9162 testsuite:
9164 * Fixed TEST_EQUAL_DOUBLE to use DBL_EPSILON correctly.
9166 * Rewrite of index_utils test harness code, removing unused and unusual
9167   features.  Data files for tests are now easier to write.  These changes
9168   also fix the bug that ^x didn't actually decode hex values correctly.
9170 * tests/testdata/etext.txt: Stripped carriage returns.
9172 * apitest: Extended stemlang1 to check that trying to create
9173   a stemmer for a non-existent language throws InvalidArgumentError.
9175 * queryparsertest:
9177   + Moved into tests/ subdirectory.
9179   + Reworked to use the standard testsuite harness.
9181   + Added tests for new features in the rewritten QueryParser.
9183 quartz backend:
9185 * quartzcheck: Now checks the structure of all the tables, not
9186   just the postlist table, and cross-checks doclen values between
9187   termlist and postlist tables.  Recognises "--help" option.  Should
9188   now continue after an error (typically it would crash before), and
9189   counts the number of errors found.  Now exits with non-zero status
9190   if any errors were found.  More readable output.
9192 * quartzcompact: Extended to allow merging several quartz
9193   databases to produce a single compact quartz database.  This
9194   allows for faster building - simple index in chunks, then merge
9195   the chunks.
9197 * quartzcompact: Made full compaction a tiny bit more compact.
9199 * quartzcompact: Added "fuller compaction" mode, which ignores the usual "at
9200   least 4 items per block" rule.  This achieves slightly tighter compaction,
9201   though it's probably not advisable to use this option if you plan to update
9202   the compacted database.
9204 * Improved compaction by a few % in non-full case.  Tighter bound on amount of
9205   memory to reserve to read the tag into.
9207 * Fix skip_to on an allterms TermIterator to set the current term when the
9208   skip_to-ed term is in the database.  Add regression test for this
9209   (allterms5).
9211 * Values are stored in sorted order so we can stop unpacking the list once we
9212   get to one after the one we're looking for (in the case where the one we're
9213   looking for doesn't exist).
9215 build system:
9217 * configure: Check that the C++ compiler can actually link a program.
9218   AC_LANG_CXX doesn't, and if it can't find a C++ compiler it'll just return
9219   "g++" which just leads to a later configure test failing in a confusing way.
9221 * configure: corrected configure output of "none known for yes" or "none known
9222   for no" to "none known for g++-3.2" or similar.
9224 * include/xapian/version.h: Define XAPIAN_HAS_xxx_BACKEND for each backend
9225   which is enabled.  The bindings need this, and user code might find it useful
9226   too.
9228 * include/xapian/database.h: Don't declare the backend factory functions if the
9229   corresponding backend has been disabled.  This means that trying to use a
9230   disabled backend will be caught at compile time rather than link time.
9232 * configure: Enhanced valgrind test to (a) see if --tool=memcheck
9233   is needed and (b) see if valgrind actually works (we don't want to
9234   try to use an x86 valgrind on an x86_64 box).
9236 * configure: Suppress 2 Intel C++ warnings which we can't easily code around,
9237   and enable -Werror automatically with --enable-maintainer-mode.
9239 * Clearer make rules for building Postscript doxygen docs.
9241 * Removed some no longer used code.
9243 * Moved a number of method definitions out of headers because they are virtual,
9244   or too large to be sensible candidates for inlining.
9246 * Eliminated the extra library for the queryparser - it's tiny compared to the
9247   main library and having it around just complicates things.
9249 * configure: We no longer need Bison, but we do need CC_FOR_BUILD to compile
9250   Lemon with.
9252 * Snapshot generator now appends _svn6789 or similar to the version string.
9253   Adjusted configure and XO_LIB_XAPIAN macro to take this into account.
9255 * configure: If any tools needed for documentation are missing
9256   and we're in maintainer mode, die with a suitable error in
9257   configure rather than with strange errors when building the
9258   documentation.
9260 * docs/Makefile.am: Explicitly set the pool_size for latex, because we
9261   now seem to overflow the default setting on some systems.
9263 * docs/Makefile.am: Use $(MAKE) instead of make.
9265 documentation:
9267 * Numerous improvements to documentation comments.  Added documentation
9268   comments for QueryParser class.
9270 * HACKING: Added better description of how reference-counted API
9271   classes are structured.
9273 * HACKING: Note that '#include <limits>' isn't supported by GCC 2.95,
9274   and other assorted minor tweaks.
9276 * HACKING: Note how to disable use of VALGRIND on the make check
9277   command line, or when using runtest directly.
9279 * Updated all documentation mentions of CVS to talk about Subversion
9280   instead.
9282 * PLATFORMS: Updated from tinderbox and other sources.
9284 * PLATFORMS: Added minimal testcase which fails to compile with
9285   Compaq's C++ compiler (cxx).
9287 * INSTALL,README: Updated.
9289 * docs/queryparser.html: Note that + and - work on phrases and
9290   bracketed expressions.
9292 * docs/intro_ir.html: Corrected two errors.
9294 * docs/stemming.html: Stemming appears to be applicable to Japanese
9295   so don't say it isn't!
9297 examples:
9299 * Moved xapian-examples module to examples subdirectory of xapian-core.
9301 * quest: Added stopword handling.
9303 portability:
9305 * configure: autoconf identifies Intel's C++ compiler as GCC, so probe for
9306   which we actually have.
9308 * Xapian will now compile cleanly with Intel C++ 8.1 on ia64 Linux and
9309   on x86 Linux.
9311 * backends/quartz/btree.cc: Fixed GCC compilation warning.
9313 * tests/api_db.cc: Fixed warning from Sun's C++ compiler.
9315 * configure: Automatically enable ANSI C++ mode for SGI's compiler
9316   with '-LANG:std'; check that any automatically determined flags
9317   for ANSI C++ mode actually allow us to compile a trivial program
9318   - if they don't it probably means the compiler isn't the one we
9319   were expecting, but one installed with the same name, so we now
9320   drop the flags in this case.
9322 * The compile on IRIX with SGI compiler is now warning free, apart from two
9323   "unused variable" warnings in Snowball generated code.
9325 * On WIN32, don't define NOMINMAX if it is already defined.
9327 packaging:
9329 * xapian.spec: Don't say "%makeinstall" in a comment since rpm
9330   tries to expand it and explodes.
9332 * xapian.spec: '/usr/share' -> '%{_datadir}'.
9334 * xapian.spec: Put the .so in the -devel package (it's only useful
9335   for linking to - the .so.* files are all that's needed at runtime).
9337 debug code:
9339 * net/socketserver.cc: Fixed typo in debug code.
9341 Xapian-core 0.8.5 (2004-12-23):
9343 quartz backend:
9345 * quartzcompact: When full_compaction is enabled, don't fill the last few bytes
9346   of a block if that would mean we needed an extra item and the overhead for
9347   that item would use up more of the next block than we save.  This reduces the
9348   table size after full compaction by up to 0.2% in my tests!
9350 * quartzcompact: Tables sizes will always be a whole number of Kbytes, since
9351   the blocksize is, so report the size in K.  Also report the change in size as
9352   well as the before and after sizes.
9354 * quartzcompact: Added missing '#include <config.h>' so that largefile support
9355   is enabled when we call stat() and we report compression statistics for
9356   tables > 2G.
9358 * quartzcompact: Added --no-full / -n option to disable full compaction.  This
9359   may be useful if you want to update the database after compacting it (need to
9360   test to see if this option is actually useful).
9362 * Renamed Btree::compress() to Btree::compact() for consistency with
9363   "full_compaction" and "quartzcompact".  Also, "compress" is confusing since
9364   we use that term in the zlib patch.
9366 build system:
9368 * xapian-config: Fixed --libs output to not include libxapian.la.
9370 * Added missing '#include <config.h>' to various .cc files (the omissions were
9371   probably harmless, but config.h should be included as the first thing any
9372   source file does).
9374 documentation:
9376 * Minor updates.
9378 packaging:
9380 * RPM spec file: %makeinstall puts the wrong paths in the .la files so use
9381   "make DESTDIR=... install" instead.
9383 debug code:
9385 * Fixed to build with AssertParanoid enabled.
9387 Xapian-core 0.8.4 (2004-12-08):
9389 API:
9391 * Added constructors to Database and WritableDatabase which fulfil the role
9392   that the Auto::open() factory functions currently do.  Auto::open() is
9393   now deprecated.
9395 * Removed the ability to write a Xapian object to an ostream directly, as
9396   it's little used and potentially dangerous ('cout << mset[i];' will
9397   compile, but you almost certainly meant 'cout << *mset[i];').  You can
9398   get the old effect by writing 'cout << obj->get_description();' instead
9399   of 'cout << obj;'.  Note that including xapian.h no longer pulls in
9400   fstream, which code may have been implicitly relying on - if this is
9401   a problem add '#include <fstream>' after '#include <xapian.h>'.
9403 * QueryParser: Be smarter about when to add a ':' when adding a term prefix.
9405 * BoolWeight::unserialise() now returns BoolWeight*, and similarly for
9406   TradWeight and BM25Weight.  BoolWeight::clone() now returns BoolWeight *.
9408 * If a database contains no positional information, change NEAR and PHRASE
9409   queries into AND queries (as otherwise they'd return no matches at all)
9410   (bug #56).  Added feature test phraseorneartoand1.
9412 * Renamed BM25 parameters to match standard naming in papers and elsewhere
9413   (A->k3, B->k1, C->k2, D->b), eliminated the extra factor of 2 which our C
9414   had, and reordered the parameters to k1, k2, k3.  This is an incompatible API
9415   change for BM25Weight(), so if you are using custom parameters for BM25
9416   you'll need to update your code.
9418 * During query expansion, if we estimate the term frequency, ensure it has a
9419   sane value (>= r and <= N - R + r) rather than bodging around the problem
9420   later on.
9422 * TradWeight, BM25Weight: termfreq is always exact for matching (we only
9423   approximate it for query expansion) so replace code to work around bad
9424   approximations with Assert() to make sure this never happens.
9426 testsuite:
9428 * runtest: Enhanced to allow it to run test programs under valgrind and other
9429   tools (gdb was already supported).
9431 * runtest: now works with valgrind 2.1.2 and later (valgrind's --logfile-fd
9432   option was renamed to --log-fd).
9434 * runtest: Allow VALGRIND environmental variable to override the value we got
9435   from configure.
9437 * Added a dependency so "make check" regenerates runtest if necessary.
9439 * The test programs now point the user to the runtest script if srcdir can't
9440   be guessed.  And they no longer look for the test program in the tests
9441   subdirectory of the current directory.
9443 * btreetest: Fixed memory leaks in test_cursor1 (the testcase itself was
9444   causing the leak, not the library).
9446 * apitest: Fixed mset_range_is_same() and mset_range_is_same_weights() helper
9447   functions which were only comparing the first item in the range.  Thankfully
9448   the tests still all pass so this wasn't hiding any bugs.
9450 * apitest: A modified version of changequery1 fails - the bug is obscure and
9451   subtle, and the fix is tricky so set the modified test to SKIP for now.
9453 * apitest: Added test_weight1 which tests the built-in Xapian::Weight
9454   subclasses and test_userweight1 which tests user defined weighting schemes
9455   (bug#8).
9457 * quartztest: Test with DB_CREATE_OR_OPEN in writelock1.
9459 quartz backend:
9461 * An interrupted update could cause any further updates to fail with "New
9462   revision too low" because the new revision was being calculated incorrectly -
9463   fixed (bug#55).
9465 * Fixed Bcursor::del() which didn't always leave the cursor on the next item
9466   like it should.  This may have been causing problems when trying to remove
9467   the last references to a particular term.
9469 * Fixed ultra-obscure bug in the code which finds a key suitable to
9470   discriminating between two blocks in a B-tree branch (discovered by reading
9471   the code).  Comparing the keys didn't consider the length of the second, so
9472   it is possible the code would miscompare.  But in reality this is extremely
9473   unlikely to happen, and even then would probably just mean that the
9474   discriminating key wouldn't be as short as it could be (wasting a few bytes
9475   but otherwise harmless).
9477 * If we're removing a posting list entirely, often there will only be one
9478   chunk, so avoid creating a Bcursor in this case.
9480 * Simplified Btree::compare_keys() by removing the last case which was dead
9481   code as it was covered by an earlier case.
9483 * Check that any user specified block size is a power of 2.  If the block
9484   size passed is invalid, use the default of 8192 rather than throwing an
9485   exception.
9487 * Started to refactor the Btree manager by introducing Item and Key classes
9488   which take care of handling the on-disk format, and eliminated duplicated
9489   tag reading code in Btree and Bcursor.  These changes will pave the way for
9490   improvements to the on disk format.
9492 * Applied the Quartz "DANGEROUS" patch, but disabled for now.  This way it
9493   won't keep being broken by changes to the code.
9495 * quartzcompact: Added --help and --version; Check that the source path and
9496   desitination path aren't the same; Report each table name when we start
9497   compacting it, and some simple stats on the compaction achieved when we
9498   finish.
9500 muscat36 backend:
9502 * Removed a default parameter value from one variant of
9503   Xapian::Muscat36::open_db() so that there's only one candidate for
9504   open_db(string).
9506 build system:
9508 * xapian-config: If flags are needed to select ANSI mode with the current
9509   compiler, then make xapian-config --cxxflags include them so that Xapian
9510   users don't have to jump through the same hoops we do.
9512 * xapian-config: Added --swigflags option for use with SWIG.
9514 * XO_LIB_XAPIAN now passes ac_top_srcdir to xapian-config which uses it
9515   (if provided) to say "configure.ac" or "configure.in" rather than
9516   "configure.in (or configure.ac)" in the "Add AC_PROG_LIBTOOL"
9517   error message.
9519 * Cleaned up the build system in a few places.
9521 * Removed a few totally unneeded header includes.
9523 * Moved a number of functions and methods out of headers because they're not
9524   good inlining candidates (too big or virtual methods).
9526 * Changed C style casts to C++ style.  The syntax is ugly, but they do make the
9527   intent clearer which is a good thing.  Note this as a coding style guideline
9528   in HACKING.
9530 * configure.ac: Automatically add -Werror to CFLAGS and CXXFLAGS if
9531   maintainer mode is enabled and we're using GCC3 or newer.  Don't do
9532   this for older GCCs as GCC 2.95 issues spurious warnings.
9534 * Reworked how include/xapian/version.h is generated so that it works
9535   better with compilers other than GCC, and with HP-UX sed.
9537 * XAPIAN_VERSION is now a string (e.g. "0.8.4").
9539 * Added new #define XAPIAN_REVISION (which is 4 for version 0.8.4).
9541 documentation:
9543 * docs/bm25.html,docs/intro_ir.html: Reworked to talk about Xapian
9544   rather than Muscat.  Also improved the appearance of the formulae.
9546 * HACKING: Valgrind now supports x86 FreeBSD and PowerPC Linux.
9548 * Documented parameters of Enquire::register_match_decider().
9550 * We now use doxygen 1.3.8 to build documentation for snapshots and releases.
9552 * PLATFORMS: Updated from the tinderbox (which now runs builds on machines
9553   available in HP's testdrive scheme) and other assorted reports.
9555 * PLATFORMS: Removed reports from versions prior to 0.7.0.  So much
9556   has changed that these are of little value.
9558 * docs/scalability.html: Added note warning about benchmarking from cold.
9560 * Assorted other minor documentation improvements.
9562 portability:
9564 * configure.ac: Improved snprintf configure test to actually
9565   check that it works (older implementations may have different
9566   semantics for the return value, and at least one ignores the length
9567   restriction entirely!)
9569 * Reworked the GNU getopt source we use so that the header is clean and
9570   suitable for use from a reasonably ISO-conforming C++ compiler instead of
9571   being full of cruft for working around quirky C compilers which C++ compilers
9572   tend to stumble over.
9574 * Use SOCKLEN_T for the type we need to pass to various socket calls, since
9575   HPUX defines socklen_t yet wants int in those calls.  Reworked the
9576   TYPE_SOCKLEN_T test we use.
9578 * On Windows, we want winsock2.h instead of sys/socket.h.  Mingw doesn't seem
9579   to even have the latter, so I think previously we've been compiling by
9580   picking one up from somewhere random!
9582 * Change the small number of C sources we have to be C++ so we can compile
9583   everything with the C++ compiler.  This way we don't need to worry about
9584   configure choosing a mismatching pair of compilers, or about whether
9585   configure tests with the C compiler don't apply to the C++ compiler, or vice
9586   versa.
9588 * Compiles and passes testsuite with HP's aCC (we have to compile in
9589   ANSI mode, so we automatically add -AA to CXXFLAGS).
9591 * If the link test detects pread and pwrite are present, get configure to try
9592   out prototypes for pread and pwrite.  This is much cleaner than trying to
9593   find the right combination of preprocessor defines to get each platform's
9594   system headers to provide prototypes.
9596 * configure: Disable probing for pread/pwrite on HP-UX as they're present but
9597   don't work when LFS (Large File Support) is enabled, and we definitely want
9598   LFS.
9600 * Fixed some warnings from Sun's C++ compiler.
9602 * Provide our own C_isalpha(), etc replacements for isalpha(), etc
9603   which always work in the C locale and avoid signed char problems.
9605 * For mingw/cygwin, pass -no-undefined when linking libxapianqueryparser.la
9606   so libtool builds a shared library.  Also pass the magic linker flag
9607   -Wl,--enable-runtime-pseudo-reloc if configure has determined it is needed.
9609 * For cygwin, use the underlying MoveFile API call for locking, as link()
9610   doesn't work on FAT partitions.  And don't rely on HAVE_LINK to control
9611   whether we use link() otherwise - if the configure test somehow misfires, a
9612   compilation error is better than using rename() on Unix as that would cause a
9613   second writer to smash the lock of the first.
9615 * Closer to building with Compaq C++ - add "-std strict_ansi" to CXXFLAGS, and
9616   tweaked the code in several places.  It currently dies trying to compile
9617   the PIMPL smart pointer template code which looks hard to fix.
9619 debug code:
9621 * HACKING: Document that %% in XAPIAN_DEBUG_LOG is substituted with
9622   the process-id, and that setting XAPIAN_DEBUG_FLAGS to -1 enables
9623   all debug messages.
9625 * Removed compatibility code for checking environment variables OM_DEBUG_FILE
9626   and OM_DEBUG_TYPES.
9628 Xapian-core 0.8.3 (2004-09-20):
9630 API:
9632 * Fixed bug which caused a segmentation fault or odd "Document not found"
9633   exceptions when new check_at_least parameter to Enquire::get_mset() was used
9634   and there weren't many matches (regression test checkatleast1).
9636 remote backend:
9638 * Renamed omtcpsrv to xapian-tcpsrv and omprogsrv to xapian-progsrv.
9640 packaging:
9642 * RPM packaging now has a separate package for the runtime libraries to
9643   allow 32 and 64 bit versions to be installed concurrently.
9645 * RPM for xapian-core now includes binaries from xapian-examples.
9647 debug code:
9649 * Fixed to compile with debug tracing enabled.
9651 Xapian-core 0.8.2 (2004-09-13):
9653 API:
9655 * Removed the compatibility layer which allowed programs written against the
9656   pre-0.7.0 API to be compiled.
9658 * Added new ESet methods swap(), back() and operator[].
9660 * Xapian::WritableDatabase::replace_document can now be used
9661   to add a document with a specific docid (to allow keeping docids
9662   in sync with numeric UIDs from another system).
9664 * Added Xapian::WritableDatabase::replace_document and
9665   delete_document variants which take a unique id term name rather
9666   than a document id.
9668 * Enquire::get_mset(): If a matchdecider is specified and no matches
9669   are requested, the lower bound on the number of matches must be 0
9670   (since the matchdecider could reject all the matches).
9672 * Renamed Query::is_empty() to Query::empty() for consistency.  Keep
9673   Query::is_empty() for now as a deprecated alias.
9675 * Enquire::set_sorting() now takes an optional third parameter which allows
9676   you to specify a sort by value, then relevance, then docid instead of
9677   by value then docid.
9679 * Enquire::get_mset() now takes an optional "check_at_least" parameter
9680   which allows Omega's MIN_HITS functionality to be implemented in the matcher
9681   (where it can be done a bit more efficiently).
9683 testsuite:
9685 * Reworked quartztest's positionlist1 into a generic api test as apitest's
9686   poslist3.
9688 * apitest: Reenabled allterms2, but with the iterator copying parts removed -
9689   TermIterator is an input_iterator so that part was invalid.
9691 * Overhauled btreetest and quartztest - tests at the Btree level are now all
9692   in btreetest.  Those at the QuartzDatabase level are in quartztest.
9694 * Split api_db.cc into 3 files as it has grown rather large.
9696 * tests/runtest: Added support for easily running gdb on a test program,
9697   automatically sorting out srcdir and libtool.
9699 quartz backend:
9701 * Refactored the quartz backend code to reduce the number of layered classes
9702   and eliminate unnecessary buffering, reducing memory usage so that more
9703   posting list changes can be batched together (see next change) and database
9704   building can be done several times faster.
9706 * Added tunable flush threshold - set XAPIAN_FLUSH_THRESHOLD=50000 to flush
9707   every 50000 documents.  The default is now every 10000 documents (was
9708   every 1000 documents previously).  The optimum value will most likely
9709   depend on your data and hardware.
9711 * WritableDatabase::get_document() no longer forces pending changes to be
9712   flushed.  The document will read things lazily from the database, and that
9713   reading may trigger a forced flush).
9715 * WritableDatabase::get_avlength() no longer forces pending changes to be
9716   flushed.  This means you can now search a modified WritableDatabase without
9717   causing a flush unless the search includes a term whose postlist has pending
9718   modifications.
9720 * Reduced quartz postlist chunk threshold from "2048 or a few bytes more" to
9721   "2000 or a few bytes more" so that full size chunks won't get split by the
9722   Btree.
9724 * Improved the "Db block overwritten" message.  The DatabaseCorruptError
9725   version now suggests multiple writers may be the cause, while the
9726   DatabaseModifiedError version uses less alarming wording and says to call
9727   Database::reopen().
9729 * QuartzWritableDatabase now stores the total document length and the last
9730   docid itself rather than tallying added and removed document length and
9731   writing the last docid back every time a document is added.  This gives
9732   cleaner code and a small performance win.
9734 * Make the first key null for blocks more than 1 away from the leaves.
9735   It saves disk space for a tiny CPU and RAM cost so is bound to be
9736   a win overall.
9738 * matcher/localmatch.cc: Fixed problems handling termweights in queries with
9739   the same term repeated (bug #37) and added regression test (qterminfo2).
9741 * Sped up iteration over all the terms in a database (QuartzCursor now only
9742   reads the tag from the Btree if asked to).
9744 * Cancelling an operation is now implemented more efficiently.
9746 inmemory backend:
9748 * Fixed bugs with deleting a document while a PostingIterator over it is
9749   active.
9751 muscat36 backend:
9753 * Fixed to compile now that internal_end_session() has gone (broken in 0.8.1).
9755 build system:
9757 * Fixed to compile when configured with --disable-inmemory (bug #33).
9759 * XO_LIB_XAPIAN now AC_SUBSTs XAPIAN_VERSION so your application's build
9760   system can easily check for a particular version of Xapian.
9762 * When compiling with GCC, we check that the compiler used to compile the
9763   library and the compiler used to compile the application have compatible
9764   C++ ABI versions.  Unfortunately GCC 3.1 incorrectly reports the same
9765   ABI version as GCC 3.0, so we now special case that test.
9767 * Bumped the versions of the autotools we require for bootstrapping, and
9768   updated the documentation of these in the HACKING document.
9770 * Quote macro names to fix warnings from newer aclocal.
9772 documentation:
9774 * Improved API documentation for Xapian::WritableDatabase::replace_document and
9775   delete_document.
9777 * Added documentation comments for MSet methods size(), empty(), swap(),
9778   begin(), end(), back().
9780 * Removed bogus documentation comments saying that some Enquire methods can
9781   throw DatabaseOpeningError.
9783 * Updated quartz design docs to reflect recent changes.  Also pulled
9784   out the Btree and Bcursor API docs and slotted them in as doxygen
9785   documentation comments - this way they're much more likely to
9786   be kept up-to-date.
9788 * Corrected multiple occurrences of "an Xapian::XXX" to "a Xapian::XXX"
9789   (presumably these all resulted from replacing "Om" with "Xapian::").
9791 * Various minor updates and improvements.
9793 portability:
9795 * Reworked how we cope with fcntl.h #define-ing open on Solaris.  This change
9796   finally allows Sun's C++ compiler to produce a working Xapian build on
9797   sparc Solaris!
9799 * configure.ac: Don't define DATADIR - we no longer use it and clashes
9800   with more recent mingw headers.
9802 * matcher/andpostlist.cc: Initialise lmax and rmax to 0.  This cures
9803   the SIGFPE on apitest's qterminfo2 on alpha linux.
9805 Xapian-core 0.8.1 (2004-06-30):
9807 API:
9809 * New method Xapian::Database::get_lastdocid which returns the highest used
9810   document id for a database (useful for re-synchronizing an indexer which
9811   was interrupted).  Implemented for quartz and inmemory.
9813 * Xapian::MSet::get_matches_*() methods now take collapsing into account, and
9814   the documentation has been clarified to state explicitly that collapsing and
9815   cutoffs are taken into account (bug#31).
9817 * Xapian::MSet: Need to adjust index by firstitem when indexing into items
9818   (bug#28).
9820 * MSetIterator and ESetIterator are now bidirectional iterators (rather than
9821   just input iterators)
9823 * Fixed post-increment forms of PostingIterator, TermIterator,
9824   PositionIterator, and ValueIterator so that *i++ works (as it must for them
9825   to be true input iterators).
9827 * Xapian::QueryParser: If we fail to parse a query, try stripping out
9828   non-alphanumerics (except '.') and reparsing.
9830 * Fixed memory leaked upon Xapian::QueryParser destruction.
9832 * Removed several unused Xapian::Error subclasses (these were used by the
9833   indexer framework which we decided was a failed experiment).
9835 testsuite:
9837 * queryparsertest: Pruned near-duplicate queryparsertest testcases.
9839 * queryparsertest: Added test case for `term NOT "a phrase'.
9841 * remotetest: Use 127.0.0.1 instead of localhost so that tcpmatch1 doesn't fail
9842   just because the network setup is broken.
9844 * apitest: Make emptyquery1 check that Query("") causes an InvalidArgumentError
9845   exception.
9847 quartz backend:
9849 * Fixed bug which meant we sometimes failed to remove a posting when deleting
9850   or replacing a document.
9852 * Fixed PostlistChunkReader to take a copy of the postlist data being read to
9853   avoid problems with reading data from a string that's been deleted.
9855 * Fixed bug in postlist merging which could occasionally extend a postlist
9856   chunk to overlap the docid range of the next chunk.
9858 * Eliminated the split cursor in each Btree object - we only actually need a
9859   single block buffer to handle splitting blocks.  This reduces the memory
9860   overhead of each Bcursor (and hence each QuartzPostList).
9862 * Changed 2 calls to abort() to throw Xapian::DatabaseCorruptError instead,
9864 * If Btree is writable, throw DatabaseCorruptError if we detect overwritten.
9866 * Check the return value of fdatasync()/fsync()/_commit() and raise an error.
9867   If they fail, we really want to know as it could cause data corruption.
9869 * Assorted clean ups, improved comments, debug tracing, assertions.
9871 * When merging in postlist changes, removed an unneeded call to
9872   QuartzBufferedTable::get_or_make_tag() in a case when we're using a cursor
9873   which has already fetched the tag.
9875 * Added SON_OF_QUARTZ define to disable incompatible changes to database
9876   formats by default, and use it to control the docid encoding for keys such
9877   that we're always inserting at the end of the table when added new documents.
9879 * Reopening the readonly version of a writable Btree is now more efficient
9880   (we used to close and reopen all the files and destroy and recreate a lot
9881   of objects and buffers).
9883 * Share file descriptors between the read and write Btree objects so that a
9884   quartz WritableDatabase now uses 5 fds rather than 10.
9886 * Added configure test for glibc, because otherwise we need to include a header
9887   before we can check for glibc in order to define something we should be
9888   defining before we include any headers!  Defining _XOPEN_SOURCE on OpenBSD
9889   seems to do the opposite to Linux and *disable* pread and pwrite!
9891 backends:
9893 * Stripped out the session machinery - all that is actually required is to
9894   ensure that any unflushed changes are flushed when the destructor runs.
9896 * A few other backend interface cleanups.
9898 build system:
9900 * Unified the shlib version numbers (the small benefit of tracking them
9901   individually makes it hard to justify the extra work required, and having one
9902   version simplifies debian packaging too).
9904 * configure.in: Fix typo (STLPORT_CXXLAGS -> STLPORT_CXXFLAGS)
9906 * Removed trivial m4/Makefile.am and autoconf/Makefile.am and do the work
9907   from the top level Makefile.am instead.  It's easier to see the structure
9908   this way, and it also removes a couple of recursive make invocations which
9909   will speed up builds a little.
9911 documentation:
9913 * HACKING: Added a list of subtasks when doing a release.
9914   Currently it's always me that does this, but it may not always be
9915   and anyhow it'll help me to have a list to run through.
9917 * include/xapian/database.h: Remove references to sessions in doxygen
9918   comments.
9920 * docs/quickstart.html: Corrected lingering reference to "om.h" and
9921   note that we need <iostream>.
9923 * docs/quickstartindex.cc.html,docs/quickstartexpand.cc.html,
9924   docs/quickstartsearch.cc.html: Add <iostream>.
9926 * PLATFORMS,AUTHORS: Updated.
9928 * docs/quartzdesign.html: Corrected various pieces of out of date
9929   information, and improved wording in a couple of places.
9931 * docs/scalability.html: Removed the reference to the Quartz update bottleneck
9932   "currently being addressed for Xapian 0.8" as it's now been addressed!  Also
9933   reworded to remove use of first person (it was originally a message sent to
9934   the mailing list).
9936 Xapian-core 0.8.0 (2004-04-19):
9938 * Omega, xapian-examples and xapian-bindings now have their own NEWS files.
9940 API:
9942 * Throw an exception when an empty query is used to build in the binary
9943   operator Query constructor (previously this caused a segfault.  Added
9944   regression test.
9946 * Made the TradWeight constructor explicit.  This is technically an API change
9947   as before you could pass a double where a Xapian::Weight was required - now
9948   you must pass Xapian::TradWeight(2.0) instead of 2.0.  That seems desirable,
9949   and it's unlikely any existing code will be affected.
9951 * Added "explicit" qualifier to constructors for internal use which take a
9952   single parameter.
9954 * Renamed Xapian::Document::add_term_nopos to Xapian::Document::add_term
9955   (with forwarding wrapper method for compatibility with existing code).
9957 * The reference counting mechanism used by most API classes now handles
9958   creating a new object slightly more efficiently.
9960 * Xapian::QueryParser: Don't use a raw term for a term which starts with a
9961   digit.
9963 testsuite:
9965 * apitest, quartztest: Added a couple of tests, and commented out some test
9966   lines which fail in debug builds.
9968 * quartztest: cause a test to fail if there's still a directory after a call
9969   to rmdir(), or if there isn't a directory after calling mkdir().
9971 * apitest: Check returned docids are the expected values in a couple more
9972   cases.  Improved wording of a comment.
9974 quartz backend:
9976 * We now merge a batch of changes into a posting list in a single pass which
9977   relieves an update bottleneck in previous versions.
9979 * When storing the termlist, pack the wdf into the same byte as the reuse
9980   length when possible - doing so typically makes the termlist 14% smaller!
9981   This change is backward compatible (0.7 database will work with 0.8, but
9982   databases built or updated with 0.8 won't work with 0.7).
9984 * quartzcheck: Check the structure within the postlist Btree as well as
9985   the Btree structures themselves.
9987 * Reduced code duplication in the btree manager and btreechecking code.
9989 * quartzdump: Backslash escape space and backslash in output rather than hex
9990   encoding them; renamed start-term and end-term to start-key and end-key;
9991   removed rather pointless "Calling next" message; if there's an error, write
9992   it to stderr not stdout, and exit with return code 1.
9994 * Corrected a number of comments in the source.
9996 * Removed several needless inclusions of quartz_table_entries.h.
9998 * Removed OLD_TERMLIST_FORMAT code - it has been disabled for since 0.6.0.
10000 * Removed all the quartz lexicon code and docs.  It's been disabled for ages,
10001   and we've not missed it.
10003 build system:
10005 * XO_LIB_XAPIAN autoconf macro can now be called without arguments in the
10006   common case where you want the test to fail if Xapian isn't found.
10008 * Fixed the configure test for valgrind - it wasn't working correctly when
10009   valgrind was installed but was too a version to support VALGRIND_COUNT_ERRORS
10010   and VALGRIND_COUNT_LEAKS.
10012 * GCC 2.95 supported -Wno-long-long and is our minimum recommended version, so
10013   unconditionally use -Wno-long-long with GCC, and don't test for it on other
10014   compilers (the old test incorrectly decided to use it with SGI's compiler
10015   resulting in a warning for every file compiled).
10017 documentation:
10019 * Updated the quickstart tutorial and removed the warning that "this
10020   document isn't up to date".
10022 * docs/intro_ir.html: Added a link to "Information Retrieval" by Keith van
10023   Rijsbergen which can be downloaded from his website!
10025 * docs/quartzdesign.html: Some minor improvements.
10027 * docs/matcherdesign.html: Merged in more details from a message sent to the
10028   mailing list.
10030 * docs/queryparser.html: Grammar fixes.
10032 * Doxygen wasn't picking up the documentation for PostingIterator and
10033   PositionListIterator - fixed.  Added doxygen comments for Xapian::Stopper
10034   and Xapian::QueryParser.
10036 * PLATFORMS: Updated with many results from tinderbox and from users.
10038 * AUTHORS: Updated the list of contributors.
10040 * HACKING: XAPIAN_DEBUG_TYPES should be XAPIAN_DEBUG_FLAGS.
10042 * HACKING: Updated to mention that building from CVS requires
10043   `./configure --enable-maintainer-mode' (or use bootstrap).
10045 * HACKING: Added notes about using "using", and pointers to a couple of useful
10046   C++ web resources.
10048 portability:
10050 * Solaris: Code tweaks for compiling with Sun's C++ compiler.
10052 * IRIX: Code tweaks for compiling with SGI's C++ compiler.
10054 * NetBSD mkdir() doesn't cope with a trailing / on the path - fixed our code to
10055   cope with this.
10057 * mingw/cygwin: Only use O_SYNC (on the debug log) if the headers define it.
10059 * backends/quartz/quartz_table_manager.cc: Fix for building on mingw.
10061 * mingw: Added configure test for link() to avoid infinite loop in our C++
10062   wrapper for link.
10064 * mingw and cygwin both need -Wl,--enable-runtime-pseudo-reloc passing when
10065   linking.  Arrange for xapian-config to include this, and check that the ld
10066   installed is a new enough version (or at least that it was at configure
10067   time).  Also pass to programs linked as part of the xapian-core build.
10069 * cygwin: Close a QuartzDatabase or QuartzWritableDatabase before trying to
10070   overwrite it - cygwin doesn't allow use to delete open/locked files...
10072 * backends/quartz/quartz_termlist.cc: Use Xapian::doccount instead of
10073   unsigned int in set_entries().
10075 * Database::Internal::Internal::keep_alive() should be
10076   Database::Internal::keep_alive().
10078 * Make Xapian::Weight::Weight() protected rather than private as we want to be
10079   able to call it from derived classes (GCC 3.4 flags this, other compilers
10080   seem to miss it).
10082 debug code:
10084 * Open debug log with flag O_WRONLY so that we can actually write to it!
10086 * backends/quartz/quartz_values.cc: Fixed problem with dereferencing
10087   a pointer to the end of a string in debug output.
10089 Xapian 0.7.5 (2003-11-26):
10091 API:
10093 * Xapian::QueryParser now supports prefixes on phrases and expressions (e.g.
10094   author:(twain OR poe) subject:"space flight").
10096 * Added missing default constructors for TermIterator, PostingIterator, and
10097   PositionIterator classes.
10099 * Fixed PositionIterator assignment operator.
10101 testsuite:
10103 * queryparsertest: Added testcase for new phrase and expression prefix support.
10105 * apitest: Added regression tests for API fixes.
10107 backends:
10109 * quartzcompact: Fix the name that the meta file gets copied to (was
10110   /path/to/dbdirmeta rather than /path/to/dbdir/meta).
10112 build system:
10114 * Changed to using AM_MAINTAINER_MODE.  If you're doing development work on
10115   Xapian itself, you should configure with "--enable-maintainer-mode" and
10116   ideally use GNU make.
10118 * Fixed configure test for fdatasync to work (I suspect a change in a recent
10119   autoconf broke it as it relied on autoconf internal naming).
10121 * Fully updated to reflect move of libbtreecheck.la from backends/quartz
10122   to testsuite.  btreetest and quartzcheck should build correctly now.
10124 documentation:
10126 * Added first cut of documentation for Xapian::QueryParser query syntax.
10128 * Fixed incorrectly formatted doxygen documentation comments which resulted in
10129   some missing text in the collated API and internal classes documentation.
10131 * Documented --enable-maintainer-mode and problems with BSD make in HACKING.
10133 * Fixed typo in docs/scalability.html.
10135 * PLATFORMS: Updated from the tinderbox.
10137 omega:
10139 * omega: Parsing of the probabilistic query is now delayed until we need some
10140   information from it.  This means that we can now use options set by the
10141   omegascript template to control the behaviour of the query parser.
10142   $set{stemmer,...} now controls the stemming language (e.g. $set{stemmer,fr})
10143   and $setmap{prefix,...} now sets the QueryParser prefix map (e.g.
10144   $setmap{prefix,subject,XT,abstract,XA}).
10146 * omega: Fixed $setmap not to add bogus entries.
10148 * docs/omegascript.txt: Expanded documentation of $set and $setmap to list
10149   values which Omega itself makes use of.
10151 * omega: Cleaned up the start up code quite a bit.
10153 * omega: Removed the unfinished code for caching omegascript command
10154   expansions.  Added code to cache $dbsize.  The only other value correctly
10155   marked for caching is already being cached!
10157 Xapian 0.7.4 (2003-10-02):
10159 API:
10161 * Fixed small memory leak if Xapian::Enquire::set_query() is called more than
10162   once.
10164 * Xapian::ESet now has reference counted internals (library interface version
10165   bumped because of this).
10167 * Removed unused OmDocumentTerm::termfreq member variable.
10169 * OmDocumentTerm ctor now takes wdf, and replaced set_wdf() with inc_wdf() and
10170   dec_wdf().
10172 * Removed unused open_document() method from SubMatch and derived classes.
10174 * Calls made by the matcher to Document::Internal::open_document() now use the
10175   lazy flag provided for precisely this purpose, but apparently never used -
10176   this should give quite a speed boost to any matcher options which use values
10177   (e.g. sort, collapse).
10179 testsuite:
10181 * Finished off support for running tests under valgrind to check for memory
10182   leaks and access to uninitialised variables.
10184 * apitest: Sped up deldoc4.
10186 * btreetest: Removed superfluous `/'s from constructed paths.
10188 * quartztest: adddoc2 now checks that there weren't any extra values created.
10190 backends:
10192 * quartz: don't start the document's TermIterator from scratch on every
10193   iteration in replace_document().  Should be a small performance win.
10195 * quartz: Pass 0 for the lexicon/postlist table when creating a termlist just
10196   to find the doc length.
10198 * quartz: quartz_table_entries.cc: Removed rather unnecessary use of
10199   const_cast.
10201 * quartz: quartz_table.cc: Removed unused variable.
10203 * quartz: Improved encapsulation of class Btree.
10205 build system:
10207 * libbtreecheck.la now has an explicit dependency on libxapian.la.
10209 * We now set the dependencies for libxapian correctly so that linking
10210   applications will pull in other required libraries.
10212 * matcher/Makefile.am: Ship networkmatch.cc even if "make dist" is run from a
10213   tree with the remote backend disabled.
10215 * configure.in: Sorted out tests for gethostbyname and gethostbyaddr using
10216   standard autoconf macros.
10218 * configure.in: If fork is found, but socketpair isn't, automatically disable
10219   the remote backend rather than configure dying with an error.
10221 * autoconf/: Removed various unused autoconf macros.
10223 portability:
10225 * xapian-config.in: Link with libxapianqueryparser before libxapian, since
10226   that's the dependency order.
10228 * Removed or replaced uses of <iostream> and <iosfwd> in the library sources
10229   - we don't need or want the library to pull in cin and friends.
10231 * extra/queryparser.yy: Fixed to build with Sun's C++ compiler.
10233 * Make the dummy source file C++ rather than C so that automake tells libtool
10234   that this is a C++ library - vital for correct linking on some platforms.
10236 * Makefile.am: Pass -no-undefined to libtool so that we can build build a DLL
10237   on MS Windows.
10239 * configure.in: Fixed check for socketpair - we were automatically disabling
10240   the remote backend on platforms where socketpair is in libsocket
10241   (such as Solaris).
10243 * Use O_BINARY for binary I/O if it exists.
10245 * common/utils.h: mkdir() only takes one argument on mingw.
10247 * common/utils.h,testsuite/backendmanager.cc: Touch file using open() rather
10248   than system().
10250 * common/utils.cc: Fixed to compile if snprintf isn't available.
10252 documentation:
10254 * docs/scalability.html: Fixed slip (32GB should be 32TB);  Added note about
10255   Linux 2.4 and ext2 filesize limits.
10257 * PLATFORMS: Updated.
10259 * NEWS: Fixed a few typos.
10261 bindings:
10263 * xapian.i: using namespace std in SWIG parsed segment to sort out typemaps.
10265 packaging:
10267 * Updated RPM packaging.
10269 omega:
10271 * omega: $topdoc now ensures the match has been run; $date no longer ensures
10272   the match has been run.
10274 * omega: Fixed to build with Sun's C++ compiler.
10276 Xapian 0.7.3 (2003-08-08):
10278 API:
10280 * MSetIterator: Fixed MSetIterator::get_document() to work when get_mset() was
10281   called with first != 0 (regression test msetiterator3).
10283 testsuite:
10285 * internaltest: Changed test exception1 to actually test something (hopefully
10286   what was originally intended!)
10288 * Added long option support to the testsuite programs (and quartzdump).
10290 * Testsuite now builds on platforms for which we use our own stringstream
10291   implementation.
10293 * Only use \r in test output if the output is a tty.
10295 * Increased default timeout used by tests running on the remote backend from 10
10296   seconds to 5 minutes to avoid tests failing just because the machine running
10297   them is slow and/or busy.
10299 * Fixed check for broken exception handling - we were getting "Xapian::"
10300   prefixed to one version and not on the other.
10302 * tests/runtest: Set srcdir if it isn't already to make it easy to manually run
10303   test programs from a VPATH build.
10305 * apitest: Check termfreq in allterms4.
10307 backends:
10309 * quartz: Fixed allterms TermIterator to not give duplicate terms when a
10310   posting list is chunked; added regression test (allterms4).
10312 * quartz: Check for EINTR when reading or writing blocks and retry the
10313   operation.  This should mean quartz won't fail falsely if a signal is
10314   received (e.g. if alarm() is used).
10316 build system:
10318 * Renamed libomqueryparser to libxapianqueryparser - for backward compatibility
10319   we still provide a library with the old name for now.
10321 * xapian.m4: Added XO_LIB_XAPIAN to replace OM_PATH_XAPIAN.  XO_LIB_XAPIAN will
10322   automagically enable use of "xapian-config --ltlibs" if A[CM]_PROG_LIBTOOL is
10323   used in configure.in.
10325 * xapian-config: Now supports linking with libtool - using libtool means that
10326   the run-time library path is set and that you can now link with an
10327   uninstalled libxapian.  Also xapian-config will now work once xapian-core's
10328   configure has been run, rather than only after "make all".
10330 * xapian-config: Now automatically tries to link libxapianqueryparser too.
10332 * bootstrap: Removed bootstrap scripts in favour of top-level bootstrap which
10333   creates a top-level configure you can optionally use to configure all checked
10334   out Xapian modules with one command, and which creates a top level Makefile
10335   to build all checked out Xapian modules with one command.
10337 * Added versioning information to libxapian and libxapianqueryparser.
10339 * xapian-example/omega: Use libtool and XO_LIB_XAPIAN so we can link with an
10340   uninstalled Xapian, and so the run time load path gets built into the
10341   binaries (no need to set LD_LIBRARY_PATH just because you install Xapian with
10342   a non-standard prefix).
10344 * configure: Stop the API documentation from being regenerated when
10345   include/xapian/version.h changes (since it's generated by configure).
10347 * Fixed "make dist" in VPATH builds.
10349 portability:
10351 * common/getopt.h: #include <stdlib.h>, <stdio.h>, and <unistd.h> before
10352   defining getopt as a macro - this avoids problems with clobbering prototypes
10353   of getopt() in system headers.
10355 * bin/quartzcompact.cc: Need stdio.h for rename().
10357 * languages/Makefile.am: Fixed compilation for compilers other than GCC.
10359 * Moved rset serialisation into a method of RSet::Internal, so
10360   omrset_to_string() is now just glue code.  This eliminates the need for it to
10361   be a friend of RSet::Internal which Sun's C++ compiler didn't seem to be able
10362   to cope with.
10364 documentation:
10366 * Fix incorrect documentation comment for Enquire::set_set_forward().  (Looked
10367   like a cut&paste error)
10369 * COPYING: Updated FSF address, and reinstated missing section: "How to Apply
10370   These Terms to Your New Programs"
10372 * PLATFORMS: Updated some linux results: RH7.3 on x86, and Debian on alpha and
10373   arm; Updated FreeBSD success report; Updated with results from the tinderbox.
10375 * docs/mkdoc.pl: Don't choke on a comment at the end of the DIST_SUBDIRS line
10376   in a Makefile.am.
10378 * HACKING: Improved note about why libtool 1.5 is needed.
10380 * HACKING: Added note about additional tools needed for building a
10381   distribution.
10383 bindings:
10385 * Fixed VPATH builds.
10387 * python: Fixed to link with libomqueryparser.
10389 * guile,tcl8: Updated typemaps to SWIG 1.3 style.
10391 omega:
10393 * omindex.cc: Added missing `#include <errno.h>'.
10395 * omindex/scriptindex: Fixed signed character issue in accent normalisation.
10397 * omindex: fixed memory and file descriptor leak on indexing a zero-sized file.
10399 * omindex: Fixed sense of test for unreadable files.
10401 * omindex: Improved log messages to distinguish re-indexed/added.
10403 * omindex,omega,scriptindex: Fixed to compile with mingw.
10405 * omindex: Fixed to compile with GNU getopt so we can build on non-glibc
10406   platforms.
10408 examples:
10410 * msearch: Quick fix to get mingw building going.
10412 * getopt: Copied over our fixes for better C++ compatibility.
10414 * simplesearch: Stem search terms.
10416 * simpleindex: Fixed not to run words together between lines.
10418 * simpleindex: Create database if it doesn't exist.
10420 Xapian 0.7.2 (2003-07-11):
10422 testsuite:
10424 * Fixed NULL pointer dereference when a test threw an unexpected exception.
10426 backends:
10428 * Quartz: When asked to create a quartz database, try to create the directory
10429   if it doesn't already exist.  Then we don't have to do it in every single
10430   Xapian program which wants to create a database...
10432 portability:
10434 * common/getopt.h: Fixed to work better with C++ compilers on non-glibc
10435   platforms.
10437 * common/utils.h: missing #include <ctype.h>
10439 * Quartz: Defined _XOPEN_SOURCE=500 for GLIBC so we get pread() and pwrite().
10441 * common/utils.h: Improved mingw implementation of rmdir().
10443 documentation:
10445 * PLATFORMS: Added MacOS X 10.2 success report.
10447 * Improvements to doxygen-generated documentation.
10449 bindings:
10451 * Moved to separate xapian-bindings module.
10453 * Added configure check for SWIG version (require at least 1.3.14).
10455 * bindings/swig/xapian.i: Fixed over-enthusiastic automatic conversion of
10456   termname to std::string.
10458 * PHP4 bindings much closer to working once again; updated guile and tcl8
10459   somewhat.
10461 omega:
10463 * omega: If the same database is listed more than once, only search the first
10464   occurrence.
10466 * omega: use snprintf to help guard against buffer overflows.
10468 Xapian 0.7.1 (2003-07-08):
10470 testsuite:
10472 * Fixed testsuite programs to not try to use "rm -rf" under mingw.
10474 backends:
10476 * Quartz: Use pread() and pwrite() on platforms which support them.  Doing so
10477   avoids one syscall per block read/write.
10479 * Quartz block count is now unsigned, which should nearly double the size of
10480   database for a given block size.  Not tested this yet.
10482 omega:
10484 * omindex: Fixed compilation problem in 0.7.0.
10486 documentation:
10488 * Added new document discussing scalability issues.
10490 * PLATFORMS: Updated.
10492 Xapian 0.7.0 (2003-07-03):
10494 API:
10496 * Moved everything into a Xapian namespace, which the main header now being
10497   xapian.h (rather than om/om.h).
10499 * Three classes have been renamed for better naming consistency:
10500   OmOpeningError is now Xapian::DatabaseOpeningError, OmPostListIterator is
10501   now Xapian::PostingIterator, and OmPositionListIterator is now
10502   Xapian::PositionIterator.
10504 * xapian.h includes <iosfwd> rather than <iostream> - if you were relying on
10505   the implicit inclusion, you'll need to add an explicit "#include <iostream>".
10507 * Replaced om_termname with explicit use of std::string - om_termname was just
10508   a typedef for std::string and the typedef doesn't really buy us anything.
10510 * Older code can be compiled by continuing to use om/om.h which uses #define
10511   and other tricks to map the old names onto the new ones.
10513 * Define XAPIAN_VERSION (e.g. 0.7.0), XAPIAN_MAJOR_VERSION (e.g. 0), and
10514   XAPIAN_MINOR_VERSION (e.g. 7).
10516 * Updated omega and xapian-examples to use Xapian namespace.
10518 queryparser:
10520 * Xapian::QueryParser: Accent normalisation added; Improved error reporting;
10521   Fixed to handle the most common examples found in the wild which used to give
10522   "parse error".
10524 bindings:
10526 * Python bindings brought up to date - use ./configure --enable-bindings to
10527   build them.  Requires Python >= 2.0 - may require Python >= 2.1.
10529 * Enabled optional building of bindings as part of normal build process.  Old
10530   Perl and Java bindings dropped; for Perl, use Search::Xapian from CPAN; Java
10531   JNI bindings will be replaced with a SWIG-based implmentation.
10533 internal implementation changes:
10535 * Removed one wrapper layer from the internal implementation of most API
10536   classes.
10538 * Xapian::Stem now uses reference counted internals.
10540 * Internally a lot of cases of unnecessary header inclusion have been removed
10541   or replaced with forward declarations of classes.  This should speed up
10542   compilation and recompilation of the Xapian library.
10544 * Suppress warnings in Snowball generated C code.
10546 * Reworked query serialisation in the remote backend so that the code is now
10547   all in one place.  The serialisation is now rather more compact and no longer
10548   relies on flex for parsing.
10550 testsuite:
10552 * Moved all the core library tests to tests subdirectory.
10554 * apitest now allows backend to be specified with "-b" rather than having to
10555   mess with environmental variables.
10557 * Testsuite programs can now hook into valgrind for leak checking, undefined
10558   variable checking, etc.
10560 backends:
10562 * Fixed parsing of port number in remote stub databases.
10564 * Quartz: Improved error message when asked to open a pre-0.6 Quartz database.
10566 * Quartz backend: Workaround for shared_level problem turns out to
10567   be arguably the better approach, so made it permanent and tidied up
10568   code.
10570 build system:
10572 * Build system fixed to never leave partial files in place of the expected
10573   output if a build is interrupted.
10575 * quartzcheck, quartzdump, and quartzcompact are now built by "make" rather
10576   than only by "make check".
10578 * xapian-config: Removed --prefix and --exec-prefix - you can't reliably
10579   install Xapian with a different prefix to the one it was configured with,
10580   yet these options give the impression you can.
10582 miscellaneous:
10584 * Fixed sending debug output to a file with XAPIAN_DEBUG_LOG with a value which
10585   didn't contain "%%" (%% expands to the current PID).
10587 * Fixed Xapian::MSetIterator::get_collapse_count() to work as intended.
10589 omega:
10591 * omindex,scriptindex: Normalise accents in probabilistic terms.
10593 * omindex: Read output from pstotext and pdftotext via pipes rather
10594   than temporary files to side-step the whole problem of secure temporary file
10595   creation; Use pdfinfo to get the title and keywords from when indexing a PDF;
10596   Safe filename escaping tweaked to not escape common safe punctuation.
10598 * omindex: Implement an upper limit on the length of URL terms - this is a
10599   slightly conservative 240 characters.  If the URL term would be longer than
10600   this, its last few bytes are replaced by a hash of the tail of the URL.  This
10601   means that (apart from hopefully very rare collisions) urlterms should still
10602   be unique ids for documents.  This is forward and backward compatible for
10603   URLs less than 240 characters.
10605 * omindex: Clean up processing of HTML documents:
10606   - Ignore the contents of <script> and <style> tags in HTML.
10607   - Strip initial whitespace in each tag in an HTML document.
10608   - Try not to split words in half when truncating title and summary.
10610 * query.cc: Set STEM_LANGUAGE near the start of the file so it's easy
10611   for users to change until we get better configurability.
10613 * omega: Replaced half-hearted logging support with flexible OmegaScript-based
10614   approach with new $log command.  Also added $now to allow the current
10615   date/time to be logged.
10617 * templates/xml: added collapse info to xml template.
10619 documentation:
10621 * Assorted minor documentation improvements.
10623 * PLATFORMS: Updated.
10625 rpms:
10627 * Improved RPM packaging of xapian-core and omega.
10629 Xapian 0.6.5 (2003-04-10):
10631 * OmEnquire: optimised the handling when sort_bands == 1 and fixed incorrect
10632   results in this and some other sorting cases; added some sorting testcases.
10634 * OmMSetIterator: added get_collapse_count() which returns a lower bound on
10635   the number of items which were removed by collapsing onto the current item.
10637 * OmStem: added default OmStem constructor and "none" language.  Both of these
10638   give a stemmer object which leaves terms unchanged which should allow for
10639   simpler logic in programs using Xapian.  The default constructor also removes
10640   the need to mess with pointers in some cases.
10642 * Automatically disable the remote backend if we don't have fork() since the
10643   remote backend requires it in several places.
10645 * Fixed to build with debug enabled.
10647 * testsuite: fixed to still build when some backends are disabled.
10649 * extra/parsequerytest.cc: Fixed to build with GCC 2.95.
10651 * Testsuite: Added regression test for Quartz bug which caused problems with
10652   long terms on machines with signed chars.
10654 * testsuite/index_utils.cc: Handling of ^x was just downright wrong due to a
10655   typo.
10657 * Improved portability: Fix for 64 bit machines.  Fixed btreetest to build with
10658   older compilers lacking <sstream>.  Xapian is now much closer to building
10659   with Sun's CFront-based Sun Pro C++ compiler, and with a Linux to mingw
10660   cross-compiler.
10662 * PLATFORMS: Updated with the results of many test builds.
10664 * Improved RPM packaging of xapian-core and omega.
10666 * Documentation: Use http://www.doxygen.org/ as URL for doxygen; Fixed bad link
10667   to our own website in overview.html; code_structure.html now only includes
10668   directories in the build system.
10670 * HACKING: updated.
10672 * Removed bugs/todo.xml, TODO, TODO.release, docs/todo.html, and
10673   docs/todo-release.html from the distribution.  Bugs and todo items will be
10674   tracked in Bugzilla instead.
10676 * Install docs in /usr/share/doc/xapian-core instead of /usr/share/xapian-core.
10678 * omega: If xP and P are both empty, there may be a boolean query, so don't
10679   force first page of hits.
10681 * omega: Fixed off-by-one error in rounding down topdoc - it was possible to
10682   get to an empty page of hits if there were exactly a multiple of HITSPERPAGE
10683   matches and the matcher over-estimated the number of matches and Omega
10684   displayed page links.
10686 * omega: Fixed handling of multiple DB parameters to be as documented.
10688 * omega: Added $collapsed to report get_collapse_count() for the current hit.
10690 * omega: Added $transform{} which does regexp manipulation (currently disabled
10691   until configure tests for regexp library are added)
10693 * omega: Added $uniq{} to eliminate duplicates from a sorted list.
10695 * omega: Don't force page 1 for a query with repeated terms!
10697 * omega: removed duplicates from terms listed in term frequencies.
10699 * omega: Added cgi parameter COLLAPSE to collapse on key values
10701 * omega: Added $value{key[,docid]} support to omegascript
10703 * omega: Renamed DATE1, DATE2, and DAYSMINUS to the more meaningful START, END,
10704   and SPAN (NB SPAN is days before END, or after START, or before today -
10705   whereas SPAN was before *DATE1* or before today).  The old parameters names
10706   are supported (with the original semantics) for now.
10708 * omega: Actually install documentation!
10710 * templates/query: propagate B boolean filters
10712 * templates/godmode: removed link to EuroFerret image
10714 * templates/godmode: added value dumping, for values from 0-255
10716 * omindex: Report correct version number (was hard-wired to 1.0!)
10718 * scriptindex: Allow '_' in fieldnames.  Diagnose bad characters in fieldnames
10719   better.
10721 * dbi2omega: Added DBUSER and DBPASSWD environmental variable support so that
10722   password protected DBs can easily be used
10724 * scriptindex.cc: added missing "#include <stdio.h>" which caused builds
10725   to fail for some platforms.
10727 Xapian 0.6.4 (2002-12-24):
10729 * Quartz backend: Fixed double setting of position list when updating a
10730   document with term position information (overall result was correct, just
10731   inefficient); when deleting a position_list, don't check if it's empty,
10732   just ask the layer below to delete it and let it handle the case when
10733   there's nothing to delete; Fixed unpacking of termlist on platforms where
10734   char is signed.
10736 * OmQueryParser: Added support for searching probabilistic fields (using
10737   <field>:<term>); the unstem multimap now includes "." on the end of a
10738   term if it was there in the query.
10740 * Don't include "om.h" as a dependency for the api docs since it's generated
10741   a configure time and the dependency was forcing users to regenerate the
10742   documentation, which requires doxygen to be installed.
10744 * Bindings: Python bindings updated to work with the updated API (still
10745   disabled by default).
10747 * Muscat 3.6 backend: Fixed to build with the new database factory functions;
10748   fixed compilation warnings; Muscat 3.6 DA and DB databases don't support
10749   positional information.  Instead of throwing an exception when we try to
10750   access it, return an empty position list (like a quartz database with no
10751   position information would).  This allows copydatabase to be used to convert
10752   a Muscat 3.6 database to a quartz one.
10754 * Documentation: quartzdesign and todo list updated.
10756 * quartzcheck: default mode changed to "v" rather than "+", since "+" is too
10757   verbose for a btree of any size; if you pass a quartz database directory,
10758   quartzcheck will now check all the tables which make up a quartz database.
10760 * quartzcompact: new tool which makes a copy of a quartz database with full
10761   compaction turned on - this results in a smaller database which is faster
10762   to search.  The next update will result in a lot of block splitting though
10763   (since all blocks are as full as possible).
10765 * omega: Added $unstem to map a stemmed term to the form(s) used in the query;
10766   $queryterms now only includes the first occurrence of each stemmed form;
10767   $prettyterm makes use of the unstem map; prefer MINHITS to MIN_HITS and
10768   RAWSEARCH to RAW_SEARCH since none of the other CGI parameter names have
10769   _ separating words (continue to support old names for now); fixed default
10770   template to not generate topterms twice, and fixed topterms to not stick
10771   outside the green box; corrected omegascript docs - it's $setrelevant
10772   not $set_relevant.
10774 * scriptindex: index=nopos with new indexnopos action; index and indexnopos now
10775   take an optional prefix argument; index=nopos is handled specially for
10776   backwards compatibility; added new data action to generate terms for date
10777   range searching.
10779 Xapian 0.6.3 (2002-12-14):
10781 * Updated PLATFORMS and todo list.  Noted in HACKING that Bison 1.50 seems to
10782   work with Xapian.
10784 * OmQueryParser now creates an "unstem" multimap to allow probabilistic
10785   query terms to be converted back to the form the user originally typed.
10787 * Updated documentation for remote protocol description and the quickstart
10788   tutorial which were both very out of date.
10790 * No longer use OmSettings to pass matcher parameters.  This completes the
10791   removal of OmSettings.
10793 * Added workaround for problem with cursors sharing levels in the btree.
10794   This should fix sporadic problems with large databases (small databases
10795   have fewer btree levels so aren't affected).
10797 * Stub databases now work again, though with a different format.  The new
10798   format allows multiple databases to be specified in the stub file.
10800 * OmEnquire::get_eset() now takes a flags argument of bit constants |-ed
10801   together instead of 2 bools.
10803 * Applied Martin Porter's better fix for the btree sequential addition bug
10804   which Richard fixed a few months ago.  Richard's fix resulted in a correct
10805   btree, but didn't always utilise space as efficiently as possible.
10807 * Fixed the remote backend to handle weighting schemes after the OmSettings
10808   changes.  You can now even implement your own weighting scheme and use it
10809   with the remote backend provided you register it with SocketServer at
10810   runtime (this feature has been on the todo list for ages).
10812 Xapian 0.6.2 (2002-12-07):
10814 * Set env var XAPIAN_SIG_DFL to stop the testsuite installing its
10815   signal handler (may be useful with some debugging tools).
10817 * backends/quartz/btree.cc: max_item_size wasn't being set due to
10818   some over-zealous code pruning.  It was defaulting to 0, and
10819   was causing the code to write off the end of allocated memory
10820   blocks.
10822 * matcher/localmatch.cc: fixed handling of wtscheme() - we were
10823   trying to use it for the extra weights, and then double
10824   deleting it!
10826 * common/omdebug.cc,common/omdebug.h: Fixed permissions on newly
10827   created log file (was getting 000!); Simplified class internals;
10828   Renamed env vars: OM_DEBUG_FILE is now XAPIAN_DEBUG_LOG,
10829   OM_DEBUG_TYPES is now XAPIAN_DEBUG_FLAGS (old versions still work
10830   for now).
10832 * testsuite/testsuite.cc: Fixed so running "gdb .libs/apitest"
10833   finds srcdir (for an in-tree build at least).
10835 * Fixed to compile with --enable-debug=full.
10837 * docs/remote.html: Updated from OmSettings to factory functions.
10839 * PLATFORMS: ixion is actually Linux 2.2.
10841 * OmWritableDatabase now has a default constructor.
10843 * Weighting scheme now specified by passing OmWeight object to OmEnquire.
10844   This also allows user weighting schemes (just subclass OmWeight and
10845   pass in an instance of this new class).  [This doesn't currently work
10846   with the remote backend.]
10848 * No longer use OmSettings to specify parameters for constructing databases.
10849   Instead there's a factory function for each database type - temporary naming
10850   scheme is OmXxx__open(), mostly because it's easy to grep for later.
10851   Instead of create and overwrite flags, we pass in a value - a new possible
10852   opening mode is "create or open".  [At present stub databases and the
10853   machinery in InMemory to allow the multierrhandler1 test aren't working.
10854   Everything else should be.]
10856 * OmEnquire::get_eset() takes parameters instead of an OmSettings object.
10858 * Fixed reversed sense of use_query_terms (and fixed reversed sense test in
10859   apitest which meant this wasn't spotted).
10861 * Documentation: Link to annotated class lists in doxygen generated
10862   documentation instead of the rather empty index pages; added doxygen
10863   markup so that apidoc now documents header files; updated todo list.
10865 * Documentation: intro doc thing was very out of date in places - fixed.
10867 * Omega: index .php files as HTML, with the PHP code stripped out; omindex
10868   return non-zero return code if an unexpected exception is caught; fixed
10869   HTML parser to not read one character past the end of the document in
10870   some cases; updated in line with OmSettings related changes to the API;
10871   Fixed $dbname to return "default" for the default database instead of "";
10872   templates/query: Removed now unused xDEFAULTOP hidden field, and superfluous
10873   "}"; dbi2omega now more efficient and can be restricted to listed fields.
10875 Xapian 0.6.1 (2002-11-28):
10877 * Fixed to compile with GCC 3.0.
10879 * PLATFORMS: Updated.
10881 Xapian 0.6.0 (2002-11-27):
10883 * Quartz database backend: lexicon disabled (./configure CXXFLAGS=-DUSE_LEXICON
10884   to reenable it), and encoding schemes simplified and made more compact;
10885   extended and added test cases; minimum block size is now 2048 bytes (as
10886   documented before, but now we actually enforce this); btree checking code
10887   split off and only linked in when required; tidied up btreetest's output.
10889 * Replaced our stemmers with those from Snowball.  These give better results,
10890   and are actively maintained by Martin Porter (who wrote the original Xapian
10891   stemmers too).  It also means that Xapian now has stemmers for Finnish,
10892   and Russian, and an implementation of Lovins' English stemmer.
10894 * Assorted improvements to the documentation, especially the documentation
10895   of the internals of the Quartz backend.
10897 * Removed the three uses of RTTI (typeid() and dynamic_cast<>) - one was
10898   totally superfluous, and the other two easily avoided.
10900 * Omega and simpleindex example: limit probabilistic term length to 64
10901   characters to stop the index filling up with junk terms which nobody will
10902   ever search for.
10904 * Omega: Added dbi2omega perl script to dump any database which perl DBI can
10905   access into the dump format expected by scriptindex.
10907 Xapian 0.5.5 (2002-12-04):
10909 * Fixed compilation with --enable-debug.
10911 * Minor documentation updates.
10913 * Omega: Fixed paging on default database; removed xDEFAULTOP from the query
10914   template as it's no longer used; removed bogus unmatched '}' from query
10915   template; added dbi2omega perl script to dump any database which perl DBI
10916   can access into the dump format expected by scriptindex; limit length of
10917   probabilistic terms generated to 64 characters.
10919 Xapian 0.5.4 (2002-10-16):
10921 * Fixed a compilation error with "make check" when using GCC 3.2.
10923 * PLATFORMS: checked 0.5.3 works on OpenBSD and Solaris 7.
10925 Xapian 0.5.3 (2002-10-12):
10927 Notable changes: Improvements to the test suite, and internal code cleanups:
10929 * Internal code cleanups on Quartz Btree implementation.
10931 * Minor documentation updates (TODO and PLATFORMS updated; Martin Porter's
10932   stemming paper removed - see the Snowball site for background stemmer
10933   info).
10935 * Implemented QuartzAllTermsList::get_approx_size().
10937 * Removed a couple of occurrences of "using std::XXX;" from externally
10938   visible headers.
10940 * With GCC, add warning flags "-Wall -W" rather than "-Wall -Wunused" (-Wall
10941   implies -Wunused anyway).  Fixed all the warnings this throws up, except in
10942   languages/ (that code is to be replaced with Snowball soon).
10944 * Test suite: Disable colour test output if stdout isn't a terminal and
10945   reworked check for broken exception handling as the previous  version never
10946   seemed to fire.  Other assorted minor improvements.
10948 * include/om/om.h is now removed on "make distclean" rather than "make clean".
10950 Xapian 0.5.2 (2002-10-06):
10952 Further improvements to documentation and portability:
10954 * docs/: converted all text docs to HTML (except omsettings which will
10955   has odd markup (LaTeX?) and will probably soon be obsolete anyway).
10957 * remote backend: Fixed handling of timeouts which are now in the past - fixes
10958   test failures with redhat/x86.
10960 * quartz backend: now works on 64 bit platforms.
10962 * test suite: try to spot mishandled exceptions and stop them causing bogus
10963   OMEXCEPT failures.
10965 Xapian 0.5.1 (2002-10-02):
10967 This release fixes features improved documentation and some build system
10968 portability fixes.
10970 * PLATFORMS: updated with more test results.
10972 * docs/: tidied up layout of HTML documentation; converted the notes about
10973   BM25 into HTML; updated stemmer docs to reflect intention to use Snowball
10974   instead; included HTML versions of quickstart*.cc.
10976 * automake 1.6.3 and autoconf 2.54 are now required for those working
10977   from CVS to fix a problem with the generated Makefiles and Solaris
10978   make.
10980 * net/Makefile.am: Fixed building of readquery.cc from readquery.ll.
10982 * buildall script is now deprecated - use the new streamlined bootstrap script
10983   in preference.
10985 Xapian 0.5.0 (2002-09-20):
10987 The last release of the software that is now known as Xapian was OmSee 0.4.1 on
10988 November 24th 2000, not far from 2 years ago.
10990 There's been a significant amount of development in this time, so we've
10991 summarised the most notable changes and improvements:
10993   * The project is now called "Xapian". We've renamed the modules in the light
10994     of this change:
10996       + "om" is now "xapian-core"
10997       + "om-examples" is now "xapian-examples", and now contains small,
10998         instructive examples which demonstrate how to use Xapian to implement
10999         particularly features.
11000       + Added "xapian-applications" which contains larger sample applications
11002   * Much improved build system - should now build "out of the box" on many Unix
11003     platforms. Can now VPATH build with vendor tools on most platforms. Builds
11004     as cleanly as we can achieve with GCC 2.95.* (some bogus warnings due to
11005     compiler bugs). Should build without warnings on GCC 3.0, 3.1, and 3.2.
11007   * If using GCC, om/om.h now contains a check that the compiler used to build
11008     Xapian and the compiler used to build the application have compatible C++
11009     ABIs. So you get a clear error message early from the first attempt to
11010     compile a file rather than a confusing error from the linker near the end
11011     of the build.
11013   * RPM packages are now available. We intend to prepare Debian packages in the
11014     near future too.
11016   * xapian-config no longer support "--uninst". It's hard to make this work
11017     reliably and portably, and the effort is better expended elsewhere.
11018     Configure with a prefix and install to a temporary directory instead.
11020   * Xapian can now work with files > 2Gb on OSes which support them.
11022   * Restructured and reworked documentation.
11024   * Removed thread locks. We intend to be "thread-friendly" so different
11025     threads can access different objects without problems. In the rare event
11026     that you want to concurrently call methods on the same object from
11027     different threads you need to create a mutex and lock it. Thus the thread
11028     lock overhead is only incurred when it's necessary.
11030   * Indexgraph removed from core library. It will reappear as an add-on library
11031     at some point.
11033   * Omega's query parser has now been reworked as a separate library.
11035   * Terminology change - "keys" are now known as "values" to avoid confusion,
11036     since they're not like keys in a relational database. The exception is when
11037     a value is used as a key in some operation, e.g. "match_collapse_key".
11039   * Database backends:
11041       + Auto backend: can now be used to create a new database.
11042       + Auto backend: added support for "stub" databases - a text file
11043         specifying the settings for the database to be opened (particularly
11044         useful for allowing easy access to specific remote databases).
11045       + Quartz backend: many fixes and improvements, and the code has been
11046         cleaned up a lot. Implemented deleting of items from postlists.
11047       + Remote backend: implemented term_exists() and get_termfreq();
11048       + Multi-backend: the document length is now fetched from the sub-postlist
11049         rather than the database, which provides a huge speed-up in some cases.
11050       + Sleepycat backend: this experimental backend has been removed.
11051       + Muscat 3.6 backends: now disabled by default.
11053   * Tests:
11055       + Test cases added for most bug fixes and new features.
11056       + stemtest: rewritten in C++ rather than part C++, part perl. Now 15%
11057         faster.
11058       + includetest: removed - it's no longer useful now the code has matured.
11059       + Removed problematic leak checking from testsuite. We plan to use
11060         valgrind instead soon.
11062   * Matcher:
11064       + Fixed several matcher bugs which could cause incorrect results in some
11065         situations.
11066       + Fix bug in expander due to nth_element being called on the wrong
11067         element.
11068       + Added sorting within relevance bands to the matcher.
11069       + Matcher now calculates percentages differently, such that 100%
11070         relevance is actually achievable.
11071       + Matcher now uses a min-heap rather than nth-element to maintain the
11072         proto-mset. This is cleaner and more efficient.
11073       + New operator OP_ELITE_SET replaces match_max_or_terms option.
11074       + Implemented multiple XOR queries.
11075       + Add a new query operator, OP_WEIGHT_CUTOFF, which returns only those
11076         documents from a query which have a weight greater than a specified
11077         cutoff value.
11078       + Removed OmBatchEnquire from system: it may return at a later date, but
11079         for now it is simply out of date and a maintenance liability, and
11080         gives no significant advantage.
11081       + Added experimental match bias functors.
11083   * The API has been cleaned up in various places:
11085       + OmDocumentContents and OmIndexDoc merged to become OmDocument
11086       + OmQuery interface cleaned up
11087       + OmData and OmKey removed - methods which used them now just pass a
11088         string instead
11089       + OmESetItem replaced by OmESetIterator; OmMSetItem by OmMSetIterator;
11090         om_termname_list by OmTermIterator
11091       + OmDocumentTerm and OmDocumentParams removed
11092       + OmMSet::mbound replaced by OmMSet::matches_
11093         {lower_bound,estimated,upper_bound}, giving more information
11094       + Xapian iterators now have default constructors
11095       + Most API classes now have reference counted internals, so assignment
11096         and copying are cheap
11097       + OmStem now has copy constructor and assignment operator
11098       + and more...