Support: quest -f cjk_ngram
[xapian.git] / xapian-core / NEWS
blob39914e6f7b396b92982135ca352a916122a2d097
1 Xapian-core 1.3.3 (2015-06-01):
3 This release includes all changes from 1.2.20-1.2.21 which are relevant.
5 API:
7 * Database:
9   + Add new flag Xapian::DB_RETRY_LOCK which allows opening a database for
10     writing to wait until it can get a write lock.  (Fixes #275, reported by
11     Richard Boulton).
13   + Fix Database::get_doclength_lower_bound() over multiple databases when some
14     are empty or consist only of zero-length documents.  Previously this would
15     report a lower bound of zero, now it reports the same lowest bound as a
16     single database containing all the same documents.
18   + Database::check(): When checking a single table, handle the ".glass"
19     extension on glass database tables, and use the extension to guide the
20     decision of which backend the table is from.
22 * Query:
24   + Add new OP_WILDCARD query operator, which expands wildcards lazily, so now
25     we create the PostList tree for a wildcard directly, rather than creating
26     an intermediate Query tree.  OP_WILDCARD offers a choice of ways to limit
27     wildcard expansion (no limit, throw an exception, use the first N by term
28     name, or use the most frequent N).  (See tickets #48 and #608).
30 * QueryParser:
32   + Add new set_max_expansion() method which provides access to OP_WILDCARD's
33     choice of ways to limit expansion and can set limits for partial terms as
34     well as for wildcards.  Partial terms now default to the 100 most frequent
35     matching terms.  (Completes #608, reported by boomboo).
37   + Deprecate set_max_wildcard_expansion() in favour of set_max_expansion().
39 * Add support for optional reference counting of FieldProcessor and
40   ValueRangeProcessor objects.
42 testsuite:
44 * If command line option --verbose/-v isn't specified, set the verbosity level
45   from environmental variable VERBOSE.
47 * Re-enable replicate3 for glass, as it no longer fails.
49 * Add more test coverage for get_unique_terms().
51 * Don't leave an extra fd open when starting xapian-tcpsrv for remotetcp tests.
53 glass backend:
55 * When reporting freelist errors during a database check, distinguish between a
56   block in use and in the freelist, and a block in the freelist more than once.
58 * Fix compaction and database checking for the change to the format of keys
59   in the positionlist table which happened in 1.3.2.
61 * After splitting a block, we always insert the new block in the parent right
62   after the block it was split from - there's no need to binary chop.
64 * Avoid infinite recursion when we hit the end of the freelist block we're
65   reading and the end of the block we're writing at the same time.
67 * Fix freelist handling to allow for the newly loaded first block of the
68   freelist being already used up.
70 chert backend:
72 * Fix problems with get_unique_terms() on a modified chert database.
74 * Fix xapian-check on a single chert table, which seg faulted in 1.3.2.
76 remote backend:
78 * Avoid dividing zero by zero when calculating the average length for an empty
79   database.
81 build system:
83 * Merge generate-allsnowballheaders script into collate-sbl.
85 portability:
87 * A compiler with good support for C++11 is now required to build Xapian.
88   Most of the actively developed C++ compilers already have decent support,
89   or are close to having it, and it makes development easier and more
90   efficient.  Currently known to work: GCC >= 4.7, recent versions of clang
91   (3.5 works).  Solaris Studio 12.4 compiles the code, but tests currently
92   fail.  IBM's xlC doesn't support enough of C++11 yet.  HP's aCC hasn't
93   been tested, but its documentation suggests it also doesn't support enough
94   of C++11 yet.
96 * Drop workarounds and special cases for old versions of various compilers
97   which don't support C++11.
99 * Use C++11's static_assert() and unique_ptr instead of custom implementations
100   of equivalent functionality.
102 * Building on OS/2 with EMX is no longer supported - EMX was last updated in
103   2001 and comes with GCC 3.2.1, which is much too old to support C++11.
105 * Building with SGI's and Compaq's C++ compilers is no longer supported -
106   both seem to have ceased development, and don't support C++11.
108 * Building with STLport is no longer supported - STLport was last released in
109   2008, so it's no longer actively developed and won't support C++11.
111 * Building on IRIX is no longer supported, because IRIX has reached end of
112   life.
114 * Disable "<FUNCTION> is expected to return a value" warning from Sun's C++
115   compiler, as it fires for functions which end in a "throw" statement.
116   Genuine instances of missing return values will be caught by compilers with
117   superior warning machinery.
119 * Fix warning from GCC 5.1 where template expansion leads to the comparison
120   (bool_value < 255) which is always true.  Warning introduced by changes in
121   1.3.2.
123 * Use getaddrinfo() instead of gethostbyname(), since the latter may not be
124   thread-safe, and as a step towards IPv6 support (see #374), but currently we
125   still only look for IPv4 addresses.
127 * timer_create() seems to always fail on AIX with EAGAIN, so just skip the
128   matchtimelimit1 testcase there.
130 * Under __WIN32__, we need to specify Vista as the minimum supported version to
131   get the AI_ADDRCONFIG flag.  Older versions seem to all be out of support
132   anyway.
134 * Change configure probe for log2() to check for a declaration in <cmath>
135   to get it to fix build on Solaris with Sun C++.  C++11 compilers should all
136   provide log2(), but let's not rely on that just yet as it's easy to provide a
137   fallback implementation.
139 * Use scalbn() instead of ldexp() where possible (which we can in all cases
140   when FLT_RADIX == 2, as it is on pretty much all current platforms).  On
141   overflow and underflow ldexp() sets errno, which it seems better to avoid
142   doing.
144 * The list of stemmers is now in the same static const struct as the version
145   info, and Stem::get_available_languages() is just an inlined wrapper which
146   fetches this structure and returns the appropriate member.  This saves a
147   relocation, reducing library load time a little.
149 * Remove "pure" attribute from API functions which could throw an exception.
150   These functions aren't really pure, and while we're happy for calls to them
151   to be CSE-ed or eliminated entirely, the compiler might make more assumptions
152   than that about a pure function - clang seems to assume pure => nothrow and
153   an exception from such a function can't be caught.
155 * Remove "pure" attribute from sortable_unserialise(), which can raise floating
156   point exceptions FE_OVERFLOW and FE_UNDERFLOW.
158 * Add "nothrow" attribute to more API functions which will never throw an
159   exception.
161 * Make sortable_serialise() an inlined wrapper around a function which won't
162   throw and can be flagged with attribute 'const'.
164 * Tweak sortable_unserialise() not to compare with a fixed string by
165   constructing a temporary std::string object (which could throw
166   std::bad_alloc), and mark it as XAPIAN_NOTHROW.
168 debug code:
170 * Only enable assertions in sortable_serialise() and sortable_unserialise() in
171   the testsuite (since these functions shouldn't throw exceptions), and move
172   the tests of these functions from queryparsertest to unittest to facilitate
173   this.
175 * Add more assertions to the glass backend code.
177 Xapian-core 1.3.2 (2014-11-24):
179 This release includes all changes from 1.2.16-1.2.19 which are relevant.
181 API:
183 * Update Unicode character database to Unicode 7.0.0.
185 * New Xapian::Snipper class from Mihai Bivol's GSOC 2012 project.  (mostly
186   fixes #211)
188 * Fix all get_description() methods to always return UTF-8 text.  (fixes #620)
190 * Database::check():
192   + Alter to take its "out" parameter as a pointer to std::ostream instead of a
193     reference, and make passing NULL mean "do not produce output", and make
194     the second and third parameters optional, defaulting to a quiet check.
196   + Escape invalid UTF-8 data in keys and tags reported by xapian-check, using
197     the same code we use to clean up strings returned by get_description()
198     methods.
200   + Correct failure message which talks above the root block when it's actually
201     testing a leaf key.
203   + Rename DBCHECK_SHOW_BITMAP to DBCHECK_SHOW_FREELIST (old name still
204     provided for now, but flagged as deprecated - DBCHECK_SHOW_BITMAP was new
205     in 1.3.0, so will likely be removed before 1.4.0).
207 * Methods and functions which take a string to unserialise now consistently
208   call that parameter "serialised".
210 * Weight: Make number of distinct terms indexing each document and the
211   collection frequency of the term available to subclasses.  Patch from
212   Gaurav Arora's Language Modelling branch.
214 * WritableDatabase: Add support for multiple subdatabases, and support opening
215   a stub database containing multiple subdatabases as a WritableDatabase.
217 * WritableDatabase can now be constructed from just a pathname (defaulting to
218   opening the database with DB_CREATE_OR_OPEN).
220 * WritableDatabase: Add flags which can be bitwise OR-ed into the second
221   argument when constructing:
223   + Xapian::DB_NO_SYNC: to disable use of fsync, etc
225   + Xapian::DB_DANGEROUS: to enable in-place updates
227   + Xapian::DB_BACKEND_CHERT: if creating, create a chert database
229   + Xapian::DB_BACKEND_GLASS: if creating, create a glass database
231   + Xapian::DB_NO_TERMLIST: create a database without a termlist (see #181)
233   + Xapian::DB_FULL_SYNC flag - if this is set for a database, we use the Mac
234     OS X F_FULL_SYNC instead of fdatasync()/fsync()/etc on the version file
235     when committing.
237 * Database: Add optional flags argument to constructor - the following can be
238   bitwise OR-ed into it:
240   + Xapian::DB_BACKEND_CHERT (only open a chert database)
242   + Xapian::DB_BACKEND_GLASS (only open a glass database)
244   + Xapian::DB_BACKEND_STUB (only open a stub database)
246 * Xapian::Auto::open_stub() and Xapian::Chert::open() are now deprecated in
247   favour of these new flags.
249 * Add LMWeight class, which implements the Unigram Language Modelling weighting
250   scheme.  Patch from Gaurav Arora.
252 * Add implementations of a number of DfR weighting schemes (BB2, DLH, DPH,
253   IfB2, IneB2, InL2, PL2).  Patches from Aarsh Shah.
255 * Add support for the Bo1 query expansion scheme.  Patch from Aarsh Shah.
257 * Add Enquire::set_time_limit() method which sets a timelimit after which
258   check_at_least will be disabled.
260 * Database: Trying to perform operations on a database with no subdatabases now
261   throws InvalidOperationError not DocNotFoundError.
263 * Query: Implement new OP_MAX query operator, which returns the maximum weight
264   of any of its subqueries.  (see #360)
266 * Query: Add methods to allow introspection on Query objects - currently you
267   can read the leaf type/operator, how many subqueries there are, and get a
268   particular subquery.  For a query which is a term, Query::get_terms_begin()
269   allows you to get the term.  (see #159)
271 * Query: Only simplify OP_SYNONYM with a single subquery if that subquery is a
272   term or MatchAll.
274 * Avoid two vector copies when storing term positions in most common cases.
276 * Reimplement version functions to use a single function in libxapian which
277   returns a pointer to a static const struct containing the version
278   information, with inline wrappers in the API header which call this.  This
279   means we only need one relocation instead of 4, reducing library load time a
280   little.
282 * Make TermGenerator flags an anonymous enum, and typedef TermGenerator::flags
283   to int for backward compatibility with existing user code which uses it.
285 * Stem: Fix incorrect Unicode codepoints for o-double-acute and u-double-acute
286   in the Hungarian Snowball stemmer.  Reported by Tom Lane to snowball-discuss.
288 * Stem: Add an early english stemmer.
290 * Provide the stopword lists from Snowball plus an Arabic one, installed in
291   ${prefix}/share/xapian-core/stopwords/.  Patch from Assem Chelli, fixes #269.
293 * Improve check for direct inclusion of Xapian subheaders in user code to
294   catch more cases.
296 * Add simple API to help with creating language-idiomatic iterator wrappers
297   in <xapian/iterator.h>.
299 testsuite:
301 * Extend checkstatsweight1 to check that Weight::get_collection_freq() returns
302   the same number as Database::get_collection_freq().
304 * queryparsertest: Add testcase for FieldProcessor on boolean prefix with
305   quoted contents.
307 * queryparsertest: Enable some disabled cases which actually work (in some
308   cases with slightly tweaked expected answers which are equivalent to those
309   that were shown).
311 * Make use of the new writable multidatabase feature to simplify the
312   multi-database handling in the test harness.
314 * Change querypairwise1_helper to repeat the query build 100 times, as with a
315   fast modern machine we were sometimes trying with so many subqueries that we
316   would run out of stack.
318 * apitest: Use Xapian::Database::check() in cursordelbug1.  (partly addresses
319   #238)
321 * apitest: Test Query ops with a single MatchAll subquery.
323 * apitest: New testcase readonlyparentdir1 to ensure that commit works with a
324   read-only parent directory.
326 matcher:
328 * Streamline collation of statistics for use by weighting schemes - tests show
329   a 2% or so increase in speed in some cases.
331 * If a term matches all documents and its weight doesn't depend on its wdf, we
332   can optimise it to MatchAll (the previous requirement that maxpart == 0 was
333   unnecessarily strict).
335 * Fix the check for a term which matches all documents to use the sub-db
336   termfreq, not the combined db termfreq.
338 * When we optimise a postlist for a term which matches all documents to use
339   MatchAll, we still need to set a weight object on it to get percentages
340   calculated correctly.
342 glass backend:
344 * 'brass' backend renamed to 'glass' - we decided to use names in ascending
345   alphabetical order to make it easier to understand which backend is newest,
346   and since 'flint' was used recently, we skipped over 'd', 'e' and 'f'.
348 * Change positionlist keys to be ordered by term first rather than docid first,
349   which helps phrase searching significantly.  For more efficient indexing,
350   positionlist changes are now batched up in memory and written out in key
351   order.
353 * Use a separate cursor for each position list - now we're ordering the
354   position B-tree by term first, phrase matching would cause a single cursor
355   to cycle between disparate areas of the B-tree and reread the same blocks
356   repeatedly.
358 * Reference count blocks in the btree cursor, so cursors can cheaply share
359   blocks.  This can significantly reduce the amount of memory used by cursors
360   for queries which contain a lot of terms (e.g. wildcards which expand to a
361   lot of terms).
363 * Under glass, optimise the turning of a query into a postlist to reuse the
364   cursor blocks which are the same as the previous term's postlist.  This is
365   particularly effective for a wildcard query which expands to a lot of terms.
367 * Keep track of unused blocks in the Btrees using freelists rather than
368   bitmaps.  (fixes #40)
370 * Eliminate the base files, and instead store the root block and freelist
371   pointers in the "iamglass" file.
373 * When compacting, sync all the tables together at the end.
375 * In DB_DANGEROUS mode, update the version file in-place.
377 * Only actually store the document data if it is non-empty.  The table which
378   holds the document data is now lazily created, so won't exist if you never
379   set the document data.
381 chert backend:
383 * Improve DBCHECK_FIX:
385   + if fixing a whole database, we now take the revision from the first table
386     we successfully look at, which should be correct in most cases, and is
387     definitely better than trying to determine the revision of each broken
388     table independently.
390   + handle a zero-sized .DB file.
392   + After we successfully regenerate baseA, remove any empty baseB file to
393     prevent it causing problems.  Tracked down with help from Phil Hands.
395 remote backend:
397 * Bump remote protocol version to 38.0, due to extra statistics being tracked
398   for weighting.
400 * Make Weight::Internal track if any max_part values are set, so we don't need
401   to serialise them when they've not been set.
403 build system:
405 * Fix conditional for enabling replication code - if chert is disabled but
406   glass isn't, we should still enable it.
408 * configure: Add hint for which package to install for rst2html
410 documentation:
412 * Don't build, ship or install PDF versions of the API docs by default, but
413   provide an easy way for people to build it for themselves if they want it.
415 * Convert equations in rst docs to use LaTeX via the math role and directive.
417 * Actually ship, process and install geospatial.rst.
419 * postingsource.rst: Use a modern class in postingsource example.  (Noted by
420   James Aylett)
422 * Move the protocol docs for the remote and replication protocols into the net/
423   subdirectory.
425 * Remove the dir_contents files and all the machinery to handle them.
427 * HACKING: Note we now use doxygen 1.8.8 for 1.3.x snapshots and releases.
429 * HACKING: Now using libtool 2.4.3 to bootstrap snapshots and 1.3.x releases.
431 * HACKING: Now using automake 1.14.1 to bootstrap snapshots and 1.3.x releases.
433 * HACKING: Drop note about needing git-svn if you're using git - bootstrap now
434   only uses git-svn if your Xapian tree was checked out using git-svn.
436 * HACKING: Need sphinx-doc to generate API docs for Python and Python 3 bindings.
438 * HACKING: Note that MacTeX seems to be the best option if using homebrew.
440 portability:
442 * Don't pass an integer argument to log(), to avoid ambiguity errors with xlC
443   and Sun's C++ compiler.  (fixes #627)
445 * Fix compilations issues with Sun's C++ compiler (mostly missing library
446   headers).
448 * Implement RealTime::now() using clock_gettime() where it's available, since
449   it can provide nanosecond resolution.
451 * Implement RealTime::sleep() using nanosleep() where it's available, since it
452   has a simpler API and a finer resolution than select().
454 * Use lround() instead of round() in geospatial code, since we want the result
455   as an int.  GCC 4.4.3 seems to optimise to use lround() anyway, but other
456   compilers may not.
458 * Include <math.h> for lround()/round(). (fixes #628)
460 * Drop code supporting Microsoft Windows 9x which reached EOL in 2006.
462 * Under C++11, use unique_ptr for AutoPtr.
464 * Stop using a reference where we may end up passing *NULL, as that's invalid.
465   Thanks Nick Lewycky and ubsan for helping track this down.
467 * In DLHWeight and DPHWeight, avoid dividing by zero when the collection size
468   is 0.
470 debug code:
472 * Fix assertion failure when built with --enable-assertions.  The behaviour
473   when built without assertions happened to be correct.
475 * Fix assertion in BitReader::decode(), and remove 'Assert(rd);' in two places
476   where rd is no longer a pointer.
478 Xapian-core 1.3.1 (2013-05-03):
480 This release includes all changes from 1.2.10-1.2.15 which are relevant.
482 API:
484 * Give an compilation error if user code tries to include API headers other
485   than xapian.h directly - these other headers are an internal implementation
486   detail, but experience has shown that some people try to include them
487   directly.  Please just use '#include <xapian.h>' instead.
489 * Update Unicode character database to Unicode 6.2.0.
491 * Add FieldProcessor class (ticket#128) - currently marked as an experimental
492   API while we sort out how best to sort out exactly how it interacts with
493   other QueryParser features.
495 * Add implementation of several TF-IDF weighting schemes via a new TfIdfWeight
496   class.
498 * Add ExpandDeciderFilterPrefix class which only return terms with a particular
499   prefix.  (fixes #467)
501 * QueryParser: Adjust handling of Unicode opening/closing double quotes - if a
502   quoted boolean term was started with ASCII double quote, then only ASCII
503   double quote can end it, as otherwise it's impossible to quote a term
504   containing Unicode double quotes.
506 * Database::check(): If the database can't be opened, don't emit a bogus
507   warning about there being too many documents to cross-check doclens.
509 * TradWeight,BM25Weight: Throw SerialisationError instead of NetworkError if
510   unserialise() fails.
512 * QueryParser: Change the default stemming strategy to STEM_SOME, to eliminate
513   the API gotcha that setting a stemmer is ignored until you also set a
514   strategy.
516 * Deprecate Xapian::ErrorHandler.  (ticket#3)
518 * Stem: Generate a compact and efficient table to decode language names.  This
519   is both faster and smaller than the approach we were using, with the added
520   benefit that the table is auto-generated.
522 * xapian.h:
524   + Add check for Qt headers being included before us and defining
525     'slots' as a macro - if they are, give a clear error advising how to work
526     around this (previously compilation would fail with a confusing error).
528   + Add a similar check for Wt headers which also define 'slots' as a macro
529     by default.
531 testsuite:
533 * tests/generate-api_generated: Test that the string returned by a
534   get_description() method isn't empty.
536 * Use git commit hash in title of test coverage reports generated from a git
537   tree.
539 matcher:
541 * Drop MatchNothing subqueries in OR-like situations in add_subquery() rather
542   than adding them and then handling it later.
544 * Handle the left side of AND_NOT and AND_MAYBE being MatchNothing in
545   add_subquery() rather than in done().
547 * Handle QueryAndLike with a MatchNothing subquery in add_subquery() rather
548   than done().
550 * Query: Multi-way operators now store their subquery pointers in a custom
551   class rather than std::vector<Xapian::Query>.  The custom class take the
552   same amount of space, or often less.  It's particularly efficient when
553   there are two subqueries, which is very desirable as we no longer flatten a
554   subtree of the same operator as we build the query.
556 * Optimise an unweighted query term which matches all the documents in a
557   subdatabase to use the "MatchAll" postlist.  (ticket#387)
559 brass backend:
561 * Iterating positional data now decodes it lazily, which should speed up
562   phrases which include common words.
564 * Compress changesets in brass replication. Increments the changeset version.
565   Ticket #348
567 * Restore two missing lines in database checking where we report a block with
568   the wrong level.
570 * When checking if a block was newly allocated in this revision, just look
571   at its revision number rather than consulting the base file's bitmap.
573 chert backend:
575 * Iterating positional data now decodes it lazily, which should speed up
576   phrases which include common words.
578 remote backend:
580 * Prefix compress list of terms and metadata keys in the remote protocol.
581   This requires a remote protocol major version bump.
583 build system:
585 * Fix the 'libxapian' to be 'libxapian-1.3' and 'xapian.m4' to be
586   'xapian-1.3.m4' (this was supposed to be the case for 1.3.0, but the
587   change wasn't made correctly).
589 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
590   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
591   V=1' and 'make V=0' which are broadly equivalent and more standard.
593 * configure: If we fail to find a function needed for the remote backend, don't
594   autodisable it - it's more helpful to error out so the use can decide if they
595   want to pass --disable-backend-remote to disable it, or work out what values
596   to pass for LIBS, etc to make it work.  This also matches what we do for the
597   disk based backends.
599 * automake 1.13.1 is now used to generate snapshots and releases.
601 * Add check-syntax make target to support editor syntax checks.
603 * Fix to build when configured with --disable-backend-brass
604   --disable-backend-chert.  (ticket#586)
606 * Generate a check for compatible _DEBUG settings if built with MSVC.
607   (ticket#389)
609 * If you run "make coverage-check" by hand, the previous default of compressed
610   HTML is unhelpful, so don't default to passing --html-gzip to genhtml, but
611   instead add support for GENHTML_ARGS.
613 * API methods and functions are now marked as 'const', 'pure', or 'nothrow'
614   allowing compilers which support such annotations to generate more efficient
615   code.  (tickets #151, #454)
617 documentation:
619 * HACKING: Note which MacPorts are needed for development work.
621 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
622   message.
624 tools:
626 * xapian-check: Add "fix" option, which currently will regenerate iamchert if
627   it isn't valid, and will regenerate base files from the .DB files (only
628   really tested on databases which have just been compacted).
630 portability:
632 * Fix warning with GCC in build with assertions enabled.
634 * common/fileutils.cc: Add safeunistd.h for mkdir, required by GCC 4.7
635   (reported by Gaurav Arora).
637 * backends/brass/brass_databasereplicator.cc: Use new/delete to avoid variable
638   length array gcc extension and comply with c++98
640 * Mark file descriptors as close-on-exec where supported. 
642 * api/queryinternal.cc: Need <functional> for mem_fun().
644 * Work around Apple's OS X SDK defining a check() macro.
646 * Add an option to use a flock() based locking implementation for brass and
647   chert - this is much simpler than using fcntl() due to saner semantics around
648   releasing locks when closing other descriptors on the same file (at least on
649   platforms where flock() isn't just a compatibility wrapper around fcntl()).
650   Sadly we can't simply switch to this without breaking locking compatibility
651   with previous releases, but it's useful for platforms without fcntl()
652   locking (it's enabled for DJGPP) and may be useful for custom builds for
653   special purposes.
655 packaging:
657 * xapian-core.spec: Remove xapian-chert-update.
659 debug code:
661 * Building with --enable-log works once again.
663 Xapian-core 1.3.0 (2012-03-14):
665 API:
667 * Update Unicode character database to Unicode 6.1.0.  (ticket#497)
669 * TermIterator returned by Enquire::get_matching_terms_begin(),
670   Query::get_terms_begin(), Database::synonyms_begin(),
671   QueryParser::stoplist_begin(), and QueryParser::unstem_begin() now stores the
672   list of terms to iterate much more compactly.
674 * QueryParser:
676   + Allow Unicode curly double quote characters to start and/or end phrases.
678   + The set_default_op() method will now reject operators which don't make
679     sense to set.  The operators which are allowed are now explicitly
680     documented in the API docs.
682 * Query: The internals have been completely reimplemented (ticket#280).  The
683   notable changes are:
685   + Query objects are smaller and should be faster.
687   + More readable format for Query::get_description().
689   + More compact serialisation format for Query objects.
691   + Query operators are no longer flattened as you build up a tree (but the
692     query optimiser still combines groups of the same operator).  This means
693     that Query objects are truly immutable, and so we don't need to copy Query
694     objects when composing them.  This should also fix a few O(n*n) cases when
695     building up an n-way query pair-wise.  (ticket#273)
697   + The Query optimiser can do a few extra optimisations.
699 * There's now explicit support for geospatial search (this API is currently
700   marked as experimental).  (ticket#481)
702 * There's now an API (currently experimental) for checking the integrity of
703   databases (partly addresses ticket#238).
705 * Database::reopen() now returns true if the database may have been reopened
706   (previously it returned void).  (ticket#548)
708 * Deprecate Xapian::timeout in favour of POSIX type useconds_t.
710 * Deprecate Xapian::percent and use int instead in the API and our own code.
712 * Deprecate Xapian::weight typedef in favour of just using double and change
713   all uses in the API and our own code.  (ticket#560)
715 * Rearrange members of Xapian::Error to reduce its size (from 48 to 40 bytes on
716   x86-64 Linux).
718 * Assignment operators for PositionIterator and TermIterator now return *this
719   rather than void.
721 * PositionIterator, PostingIterator, TermIterator and ValueIterator now
722   handle their reference counts in hand-crafted code rather than using
723   intrusive_ptr/RefCntPtr, which means the compiler can inline the destructor
724   and default constructor, so a comparison to an end iterator should now
725   optimise to a simple NULL pointer check, but without the issues which the
726   ValueIteratorEnd_ proxy class approach had (such as not working in templates
727   or some cases of overload resolution).
729 * Enquire:
731   + Previously, Enquire::get_matching_terms_begin() threw InvalidArgumentError
732     if the query was empty.  Now we just return an end iterator, which is more
733     consistent with how empty queries behave elsewhere.
735   + Remove the deprecated old-style match spy approach of using a MatchDecider.
737 * Remove deprecated Sorter class and MultiValueSorter subclass.
739 * Xapian::Stem:
741   + Add stemmers for Armenian (hy), Basque (eu), and Catalan (ca).
743   + Stem::operator= now returns a reference to the assigned-to object.
745 testsuite:
747 * Make unittest use the test harness, so it gets all the valgrind and fd leak
748   checks, and other handy features all the other tests have.
750 * Improve test coverage in several places.
752 * Compress generated HTML files in coverage report.
754 flint backend:
756 * Remove flint backend.
758 remote backend:
760 * When propagating exceptions from a remote backend server, the protocol now
761   sends a numeric code to represent which exception is being propagated, rather
762   than the name of the type, as a number can be turned back into an exception
763   with a simple switch statement and is also less data to transfer.
764   (ticket#471)
766 * Remote protocol (these changes require a protocol major version bump):
768   + Unify REPLY_GREETING and REPLY_UPDATE.
770   + Send (last_docid - doccount) instead of last_docid and (doclen_ubound -
771     doclen_lbound) instead of doclen_ubound.
773 * Remove special check which gives a more helpful error message when a modern
774   client is used against a remote server running Xapian <= 0.9.6.
776 build system:
778 * Various changes allow us to now remove XAPIAN_VISIBILITY_DEFAULT from a
779   number of functions which aren't in the public API (partly addresses
780   ticket#63).
782 * configure: For this development series, the library gets a -1.3 suffix and
783   include files are installed with an extra /xapian-1.3 component to make
784   parallel installs easier.
786 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
787   will then jump to the appropriate column for a compiler error or warning, not
788   just the appropriate line.
790 * Snowball compiler now reports "FILE:LINE:" before each error so tools like
791   vim's quickfix mode can parse this and bring up the line with the error
792   automatically.
794 * docs/doxygen_api.conf.in: Don't generate XML from doxygen for the bindings -
795   the bindings now do this for themselves.  (ticket#262)
797 documentation:
799 * INSTALL: Update GCC details - we now recommend 4.3 or newer (was 4.1), and
800   note that while 3.1 is the hard minimum requirement, the oldest we've tested
801   with at all recently was 3.3.
803 * docs/deprecation.rst: Updated.
805 tools:
807 * delve:
809   + Move delve from examples to bin and rename to xapian-delve.
811   + Send errors to stderr not stdout.
813 * xapian-check: Now reports useful descriptions rather than cryptic numeric
814   codes for B-tree errors.
816 debug code:
818 * Add assertions that the index is in range when dereferencing MSetIterator and
819   ESetIterator.
821 * Fix various errors in debug logging statements.
823 * Add QUERY category for debug logging.
825 Xapian-core 1.2.21 (2015-05-20):
827 API:
829 * QueryParser: Extend the set of characters allowed in the start of a range to
830   be anything except for '(' and characters <= ' '.  This better matches what's
831   accepted for a range end (anything except for ')' and characters <= ' ').
832   Reported by Jani Nikula.
834 matcher:
836 * Reimplement OP_PHRASE for non-exact phrases.  The previous implementation was
837   buggy, giving both false positives and false negatives in rare cases when
838   three or more terms were involved.  Fixes #653, reported by Jean-Francois
839   Dockes.
841 * Reimplement OP_NEAR - the new implementation consistently requires the terms
842   to occur at different positions, and fixes some previously missed matches.
844 * Fix a reversed check for picking the shorter position list for an exact
845   phrase of two terms.  The difference this makes isn't dramatic, but can be
846   measured (at least with cachegrind).  Thanks to kbwt for spotting this.
848 * When matching an exact phrase, if a term doesn't occur where we want, use
849   its actual position to advance the anchor term, rather than just checking
850   the next position of the anchor term.
852 brass backend:
854 * Fix cursor versioning to consider cancel() and reopen() as events where
855   the cursor version may need incrementing, and flag the current cursor version
856   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
858 * Avoid using file descriptions < 3 for writable database tables, as it risks
859   corruption if some code in the same process tries to write to stdout or
860   stderr without realising it is closed.  (Partly addresses #651)
862 chert backend:
864 * Fix cursor versioning to consider cancel() and reopen() as events where
865   the cursor version may need incrementing, and flag the current cursor version
866   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
868 * Avoid using file descriptions < 3 for writable database tables, as it risks
869   corruption if some code in the same process tries to write to stdout or
870   stderr without realising it is closed.  (Partly addresses #651)
872 flint backend:
874 * Fix cursor versioning to consider cancel() and reopen() as events where
875   the cursor version may need incrementing, and flag the current cursor version
876   as used when a cursor is rebuilt.  Fixes #675, reported by Germán M. Bravo.
878 remote backend:
880 * Fix sort by value when multiple databases are in use and one or more are
881   remote.  This change necessitated a minor version bump in the remote
882   protocol.  Fixes #674, reported by Dylan Griffith.  If you are upgrading a
883   live system which uses the remote backend, upgrade the servers before the
884   clients.
886 build system:
888 * The compiler ABI check in the public API headers now issues a warning
889   (instead of an error) for an ABI mismatch for ABI versions 2 and later
890   (which means GCC >= 3.4).  The changes in these ABI versions are bug fixes
891   for corner cases, so there's a good chance of things working - e.g. building
892   xapian-bindings with GCC 5.1 (which defaults to ABI version 8) against
893   xapian-core built with GCC 4.9 (which defaults to ABI version 2) seems to
894   work OK.  A warning is still useful as a clue to what is going on if linking
895   fails due to a missing symbol.
897 * xapian-config,xapian-core.pc: When compiling with xlC on AIX, the reported
898   --cxxflags/--cflags now include -D_LARGE_FILES=1 as this is defined for the
899   library, and defining it changes the ABI of std::string with this compiler,
900   so it must also be defined when building code using the Xapian API.
902 * xapian-core.pc: Include --enable-runtime-pseudo-reloc in --libs output for
903   mingw and cygwin, like xapian-config does.
905 * xapian-core.pc: Fix include directory reported by `pkg-config --cflags`.
906   This bug was harmless if xapian-core was installed to a directory which was
907   on the default header search path (such as /usr/include).
909 * xapian-config: Fix typo so cached result of test in is_uninstalled() is
910   actually used on subsequent calls.  Fixes #676, reported (with patch) by Ryan
911   Schmidt.
913 * configure: Changes in 1.2.19 broke the custom macro we use to probe for
914   supported compiler flags such that the flags never got used.  This release
915   fixes this problem.
917 * configure: Set default value for AUTOM4TE before AC_OUTPUT so the default
918   will actually get used.  Only relevant when building in maintainer mode
919   (e.g. from git).
921 * soaktest: Link with libtool's '-no-install' or '-no-fast-install', like we
922   already do for other test programs, which means that libtool doesn't need to
923   generate shell script wrappers for them on most platforms.
925 documentation:
927 * API documentation: Minor wording tweaks and formatting improvements.
929 * docs/deprecation.rst: Add deprecation of omindex --preserve-nonduplicates
930   which happened in 1.2.4.
932 * HACKING: Update URL.
934 * HACKING: libtool 2.4.6 is now used for bootstrapping snapshots and releases.
936 tools:
938 * xapian-compact: Make sure we open all the tables of input databases at the
939   same revision.  (Fixes #649)
941 * xapian-metadata: Add 'list' subcommand to list all the metadata keys.
943 * xapian-replicate: Fix connection timeout to be 10 seconds rather than 10000
944   seconds (the incorrect timeout has been the case since 1.2.3).
946 * xapian-replicate: Set SO_KEEPALIVE for xapian-replicate's connection to the
947   master, and add command line option to allow setting socket-level timeouts
948   (SO_RCVTIMEO and SO_SNDTIMEO) on platforms that support them.  Fixes #546,
949   reported by nkvoll.
951 * xapian-replicate-server: Avoid potentially reading uninitialised data if a
952   changeset file is truncated.
954 portability:
956 * Add spaces between literal strings and macros which expand to literal strings
957   for C++11 compatibility.
959 * ValueCountMatchSpy::top_values_begin(): Fix the comparison function not to
960   return true for two equal elements, which manifests as incorrect sorting in
961   some cases when using clang's libc++ (which recent OS X versions do).
963 * apitest: The adddoc5 testcase fails under clang due to an exception handling
964   bug, so just #ifdef out the problematic part of the testcase when building
965   with clang for now.
967 * Fix clang warnings on OS X.  Reported by Germán M. Bravo.
969 * Fix examples to build with IBM's xlC compiler on AIX - they were failing due
970   to _LARGE_FILES being defined for the library build but not for the examples,
971   and defining this changes the ABI of std::string with this compiler.
973 * configure: Improve the probe for whether the test harness can use RTTI to
974   work for IBM's xlC compiler (which defaults to not generating RTTI).
976 * Fix to build with Sun's C++ compiler.
978 * Use F_DUPFD where available to dup to a file descriptor which is >= 2, rather
979   than calling dup() until we get one.
981 * When unserialising a double, avoid reading one byte past the end of the
982   serialised value.  In practice this was harmless on most platforms, as
983   dbl_max_mantissa is 255 for IEEE-754 format doubles, and at least GCC's
984   std::string keeps the buffer nul-terminated.  Reported by Germán M. Bravo in
985   github PR#67.
987 * When unserialising a double, add missing cast to unsigned char when we check
988   if the value will fit in the double type.  On machines with IEEE-754 doubles
989   (which is most current platforms) this happened to work OK before.  It would
990   also have been fine on machines where char is unsigned by default.
992 * Fix incorrect use of "delete" which should be "delete []".  This is
993   undefined behaviour in C++, though the type is POD, so in practice this
994   probably worked OK on many platforms.
996 debug code:
998 * Fix some overly strict assertions in flint, which caused apitest's
999   cursordelbug1 to fail with assertions on.
1001 Xapian-core 1.2.20 (2015-03-04):
1003 chert backend:
1005 * After splitting a block, we always insert the new block in the parent right
1006   after the block it was split from - there's no need to binary chop.
1008 build system:
1010 * Generate and install a file for pkg-config.  (Fixes#540)
1012 * configure: Update link to cygwin FAQ in error message.
1014 documentation:
1016 * include/xapian/weight.h: Document the enum stat_flags values.
1018 * docs/postingsource.rst: Use a modern class in postingsource example.  (Noted
1019   by James Aylett)
1021 * docs/deprecation.rst,docs/replication.rst: Fix typos.
1023 * Update doxygen configuration files to avoid warnings about obsolete tags from
1024   newer doxygen versions.
1026 * HACKING: Update details of building Xapian packages.
1028 tools:
1030 * xapian-check: For chert and brass, cross-check the position and postlist
1031   tables to detect positional data for non-existent documents.
1033 portability:
1035 * When locking a database for writing, use F_OFD_SETLK where available, which
1036   avoids having to fork() a child process to hold the lock.  This currently
1037   requires Linux kernel >= 3.15, but it has been submitted to POSIX so
1038   hopefully will be widely supported eventually.  Thanks to Austin Clements for
1039   pointing out this now exists.
1041 * Fix detection of fdatasync(), which appears to have been broken practically
1042   forever - this means we've probably been using fsync() instead, which
1043   probably isn't a big additional overhead.  Thanks to Vlad Shablinsky for
1044   helping with Mac OS X portability of this fix.
1046 * configure: Define MINGW_HAS_SECURE_API under mingw to get _putenv_s()
1047   declared in stdlib.h.
1049 * Use POSIX O_NONBLOCK in preference to O_NDELAY - the semantics of the latter
1050   differ between BSD and System V.
1052 * According to POSIX, strerror() may not be thread safe, so use alternative
1053   thread-safe ways to translate errno values where possible.
1055 * On Microsoft Windows, avoid defining EADDRINUSE, etc if they're already
1056   defined, and use WSAE* constants un-negated - they start from a high value
1057   so won't collide with E* constants.
1059 debug code:
1061 * Add more assertions to the chert backend code.
1063 Xapian-core 1.2.19 (2014-10-21):
1065 API:
1067 * Xapian::BM25Weight:
1069   + Improve BM25 upper bound in the case when our wdf upper bound > our
1070     document length lower bound.  Thanks to Craig Macdonald for pointing out
1071     this trick.
1073   + Pre-multiply termweight by (param_k1 + 1) rather than doing it for
1074     every weighted term in every document considered.
1076 testsuite:
1078 * Don't report apparent leaks of fds opened on /dev/urandom - at least on
1079   Linux, something in the C library seems to lazily open it, and the report of
1080   a possible leak followed by assurance that it's OK really is just noise we
1081   can do without.
1083 matcher:
1085 * Fix false matches reported for non-exact phrases in some cases.  Fixes the
1086   reduced testcase in #657, reported by Jean-Francois Dockes.
1088 brass backend:
1090 * Only full sync after writing the final base file (only affects Max OS X).
1092 chert backend:
1094 * Only full sync after writing the final base file (only affects Max OS X).
1096 flint backend:
1098 * Only full sync after writing the final base file (only affects Max OS X).
1100 build system:
1102 * For Sun's C++ compiler, pass -library=Crun separately since libtool looks for
1103   " -library=stlport4 " (with the spaces).  (fixes#650)
1105 * Remove .replicatmp (created by the test suite) upon "make clean".
1107 documentation:
1109 * include/xapian/compactor.h: Fix formatting of doxygen comment.
1111 * HACKING: freecode no longer accepts updates, so drop that item from the
1112   release checklist.
1114 * docs/overview.rst: Add missing database path to example of using
1115   xapian-progsrv in a stub database file.
1117 portability:
1119 * Suppress unused typedef warnings from debugging logging macros, which occur
1120   in functions which always exit via throwing an exception when compiling with
1121   recent versions of GCC or clang.
1123 * Fix debug logging code to compile with clang.  (fixes #657, reported by
1124   Germán M. Bravo)
1126 debug code:
1128 * Add missing RETURN() markup for debug logging in a few places, highlighted by
1129   warnings from recent GCC.
1131 * Fix incorrect return types in debug logging annotations so that code compiles
1132   when configured with --enable-log.
1134 Xapian-core 1.2.18 (2014-06-22):
1136 API:
1138 * Document: Fix get_docid() to return the docid for the sub-database (as it
1139   is explicitly documented to) for Document objects passed to functors like
1140   KeyMaker during the match.  (fixes#636, reported by Jeff Rand).
1142 * Document: Don't store the termname in OmDocumentTerm - we were only using it
1143   in get_description() output and an exception message.  Speeds up indexing
1144   etext.txt using simpleindex by 0.4%, and should reduce memory usage a bit
1145   too.  (Change inspired by comments from Vishesh Handa on xapian-devel).
1147 * Database: Iterating the values in a particular slot is now a bit more
1148   efficient for inmemory and remote backends (but still slow compared to
1149   flint, chert and brass).
1151 testsuite:
1153 * apitest: Expand crashrecovery1 to check that the expected base files exist
1154   and ones which shouldn't exist don't.
1156 * queryparsertest: Fix testcase for empty wildcard followed by negation to
1157   enable FLAG_LOVEHATE so the negation is actually parsed.  Fortunately the
1158   fixed testcase passes.
1160 matcher:
1162 * OP_SYNONYM: avoid fetching the doclength if the weighting scheme doesn't
1163   need it and the calculated wdf for the synonym is <= doclength_lower_bound
1164   for the current subdatabase.  (fixes #360)
1166 build system:
1168 * Releases are now bootstrapped with libtool 2.4.2 instead of 2.4, and with
1169   config.guess and config.sub updated to the latest versions.
1171 documentation:
1173 * Add an example of initializing SimpleStopper using a file listing stopwords.
1174   (Patch from Assem Chelli)
1176 * Improve the descriptions of the stem_strategy values in the API docs.
1177   (Reported by "oilap" on #xapian)
1179 * docs/sorting.rst: Fix incorrect parameter types in Xapian::Weight
1180   subclass example.
1182 * docs/glossary.rst: Add definition of "collection frequency".
1184 * HACKING:
1186   + makeindex is now in Debian package texlive-binaries.
1188   + Replace a link to the outdated autotools "goat book" with a link to the
1189     "Portable Shell" chapter of the autoconf manual.
1191 * include/xapian/base.h: Remove very out of date comments talking about atomic
1192   assignment and locking - since 0.5.0 we've adopted a "user locks" policy.
1193   (Reported by Jean-Francois Dockes)
1195 examples:
1197 * delve:
1199   + Add -A <prefix> option to list all terms with a particular prefix.
1201   + Send errors to stderr not stdout.
1203   + If -v is specified more than once, show even more info in some cases.
1204     (NEWS file claimed this was backported in 1.2.15, but it actually wasn't).
1206 * quest:
1208   + Add --default-op option.
1210   + Add --weight option to allow the weighting scheme to be specified.
1212 portability:
1214 * Explicitly '#include <algorithm>' for std::max(), fixing build with VS2013.
1215   (Fixes#641, reported by "boomboo").
1217 * Fix testcase blocksize1 not to try to delete an open database, which isn't
1218   possible under Windows.  (Fixes #643, reported by Chris Olds)
1220 * docs/quickstart.rst: Split --cxxflags and --libs for portability (noted by
1221   "Hurricane Tong" on xapian-devel).
1223 * Fix warnings with clang 5.0.
1225 debug code:
1227 * Add assertions that weighting scheme upper bounds aren't exceeded.
1229 Xapian-core 1.2.17 (2014-01-29):
1231 API:
1233 * Enquire::set_sort_by_relevance_then_value() and
1234   Enquire::set_sort_by_relevance_then_key(): Fix sense of reverse parameter.
1235   Reported by "boomboo" on IRC.
1237 * BM25Weight: Fix case where (k1 == 0 || b == 0) but k2 != 0.  Reported by
1238   "boomboo" on IRC.
1240 * Unicode::tolower(): Fix to give correct results for U+01C5, U+01C8, U+01CB,
1241   and U+01F2 (previously these were left unchanged).
1243 testsuite:
1245 * Automatically probe for and hook in eatmydata to the testsuite using the
1246   wrapper script it now includes.
1248 * Fix apitest to build when brass, chert or flint are disabled.
1250 brass backend:
1252 * Fix handling of invalid block sizes passed to Xapian::Brass::open() - the
1253   size gets fixed as documented, but the uncorrected size was passed to the
1254   base file (and abort() was called if 0 was passed).
1256 * Validate "dir_end" when reading a block.  (fixes #592)
1258 chert backend:
1260 * Fix handling of invalid block sizes passed to Xapian::Chert::open() - the
1261   size gets fixed as documented, but the uncorrected size was passed to the
1262   base file (and abort() was called if 0 was passed).
1264 * Validate "dir_end" when reading a block.  (fixes #592)
1266 flint backend:
1268 * Fix handling of invalid block sizes passed to Xapian::Flint::open() - the
1269   size gets fixed as documented, but the uncorrected size was passed to the
1270   base file (and abort() was called if 0 was passed).
1272 * Validate "dir_end" when reading a block.  (fixes #592)
1274 build system:
1276 * configure: Improve reporting of GCC version.
1278 * Use -no-fast-install on platforms where -no-install causes libtool to emit a
1279   warning.
1281 * docs/Makefile.am: Fix handling of MAINTAINER_NO_DOCS.
1283 * Include UnicodeData.txt and the script to generate the unicode tables from
1284   it.
1286 documentation:
1288 * postingsource.rst: Clarify a couple of points (reported by "vHanda" on IRC).
1290 portability:
1292 * Protect the ValueIterator::check() method against Mac OS X SDK headers
1293   which define a check() macro.
1295 * Fix warning from xlC compiler.
1297 * Avoid use of grep -e in configure, as /usr/bin/grep on Solaris doesn't
1298   support -e.
1300 * Fix check for flags which might be needed for ANSI mode for compilers called
1301   'cxx'.
1303 * configure: Improve handling of Sun's C++ compiler - trick libtool into not
1304   adding -library=Cstd, and prefer -library=stdcxx4 if supported.  Explicitly
1305   add -library=Crun which seems to be required, even though the documentation
1306   suggests otherwise.
1308 Xapian-core 1.2.16 (2013-12-04):
1310 API:
1312 * PositionIterator,PostingIterator,TermIterator,ValueIterator: Don't segfault
1313   if skip_to() or check() is called on an iterator which is already at_end().
1314   Reported by David Bremner.
1316 * ValueCountMatchSpy: get_description() on a default-constructed
1317   ValueCountMatchSpy object no longer fails when xapian-core is built with
1318   --enable-log.
1320 * ValueCountMatchSpy: get_total() on a default-constructed ValueCountMatchSpy
1321   object now returns 0 rather than segfaulting.
1323 testsuite:
1325 * If -v/--verbose is specified more than once to a test program, show the
1326   diagnostic output for passing tests as well as failing/skipped ones.
1328 * queryparsertest: Change qp_scale1 to time 5 repetitions of the large query to
1329   help average out variations.
1331 * queryparsertest: Add test coverage for explicit synonym of a term with a
1332   prefix (e.g. ~foo:search).
1334 * apitest: Remove code from registry* testcases which tries to test the
1335   consequences of throwing an exception from a destructor - it's complex to
1336   ensure we don't leak memory while doing this (it seems GCC doesn't release
1337   the object in this case, but clang does), and it's generally frowned upon,
1338   plus C++11 makes destructors noexcept by default.
1340 * Fix "make check" to actually removed cached databases first, as is
1341   intended.
1343 brass backend:
1345 * When moving a cursor on a read-only table, check if the block we want is in
1346   the internal cursor.  We already do this for a writable table, as it is
1347   necessary for correctness, but it's a cheap check and may avoid asking the
1348   OS for a block we actually already have.
1350 * Correctly report the database as closed rather than 'Bad file descriptor'
1351   in certain cases.
1353 * Reuse a cursor for reading values from valuestreams rather than creating
1354   a new one each time.  This can dramatically reduce the number of blocks
1355   redundantly reread when sorting by value.  The rereads will generally get
1356   served from VM cache, but there's still an overhead to that.
1358 chert backend:
1360 * When moving a cursor on a read-only table, check if the block we want is in
1361   the internal cursor.  We already do this for a writable table, as it is
1362   necessary for correctness, but it's a cheap check and may avoid asking the
1363   OS for a block we actually already have.
1365 * Correctly report the database as closed rather than 'Bad file descriptor'
1366   in certain cases.
1368 * Reuse a cursor for reading values from valuestreams rather than creating
1369   a new one each time.  This can dramatically reduce the number of blocks
1370   redundantly reread when sorting by value.  The rereads will generally get
1371   served from VM cache, but there's still an overhead to that.
1373 flint backend:
1375 * When moving a cursor on a read-only table, check if the block we want is in
1376   the internal cursor.  We already do this for a writable table, as it is
1377   necessary for correctness, but it's a cheap check and may avoid asking the
1378   OS for a block we actually already have.
1380 * Correctly report the database as closed rather than 'Bad file descriptor'
1381   in certain cases.
1383 build system:
1385 * Compress source tarballs with xz instead of gzip.
1387 * Split XAPIAN_LIBS out of XAPIAN_LDFLAGS so that -l flags for libraries
1388   configure detects are needed appear after -L flags specified by the user
1389   that may be needed to find such libraries.  (fixes#626)
1391 * XO_LIB_XAPIAN now handles the user specifying a relative path in
1392   XAPIAN_CONFIG, e.g.: "./configure XAPIAN_CONFIG=../xapian-core/xapian-config"
1394 * Adjust XO_LIB_XAPIAN to strip _gitNNN suffix from snapshot versions.
1396 * configure: Handle git snapshot naming when calculating REVISION.
1398 * configure: Enable -fshow-column for GCC - things like vim's quickfix mode
1399   will then jump to the appropriate column for a compiler error or warning, not
1400   just the appropriate line.
1402 * configure: Report GCC version in configure output.
1404 documentation:
1406 * The API documentation shipped with the release is now generated with
1407   doxygen 1.8.5 instead of 1.5.9, which is most evident in the different
1408   HTML styling newer doxygen uses.
1410 * Document how Utf8Iterator handles invalid UTF-8 in API documentation.
1412 * Improve how descriptions of deprecated features appear in the API
1413   documentation.
1415 * docs/remote_protocol.rst: Correct error in documentation of REPLY_DOCDATA
1416   message.
1418 * docs/overview.rst: Correct documentation for how to specify "prog" remote
1419   databases in stub files.
1421 * Direct users to git in preference to SVN - we'll be switching entirely in
1422   the near future.
1424 tools:
1426 * xapian-chert-update: Fix -b to work rather than always segfaulting (reported
1427   in http://bugs.debian.org/716484).
1429 * xapian-chert-update: The documented alias --blocksize for -b has never
1430   actually been supported, so just drop mentions of it from --help and the man
1431   page.
1433 * xapian-check:
1435   + Fix chert database check that first docid in each doclength chunk is more
1436     than the last docid in the previous chunk - previously this didn't actually
1437     work.
1439   + Fix database check not to falsely report "position table: Junk after
1440     position data" whenever there are 7 unused bits (7 is OK, *more* than 7
1441     isn't).
1443   + Fix to report block numbers correctly for links within the B-tree.
1445   + If the METAINFO key is missing, only report it once per table.
1447   + Fix database consistency checking to always open all the tables at the same
1448     revision - not doing this could lead to false errors being reported after a
1449     commit interrupted by the process being killed or the machine crashing.
1450     Reported by Joey Hess in http://bugs.debian.org/724610
1452 examples:
1454 * quest: Add --check-at-least option.
1456 portability:
1458 * configure: clang doesn't support -Wstrict-null-sentinel or -Wlogical-op, so
1459   don't pass it these options.
1461 * Fix build errors and warnings with mingw.
1463 * Suppress "unused local typedef" warnings from GCC 4.8.
1465 * If the compiler supports C++11, use static_assert to implement
1466   CompileTimeAssert.
1468 * tests/zlib-vg.c: Fix two warnings when compiled with clang.
1470 * Fix failure when built with -D_GLIBCXX_DEBUG - we were modifying the top()
1471   element of a heap before calling pop(), such that the heap comparison
1472   operation (which is called when -D_GLIBCXX_DEBUG is on to verify the heap is
1473   valid) would read off the end of the data.  In a normal build, this issue
1474   would likely never manifest.
1476 * configure: When generating ABI compatibility checks in xapian/version.h, pass
1477   $CXXFLAGS and $CPPFLAGS to $CXXCPP as they could contain options which affect
1478   the ABI (such as -fabi-version for GCC).  (Fixes #622)
1480 * Microsoft GUIDs in binary form have reversed byte order in the first three
1481   components compared to standard UUIDs, so the same database would report a
1482   different UUID on Windows to on other platforms.  We now swap the bytes to
1483   match the standard order.  With this fix, the UUIDs of existing databases
1484   will appear to change on Windows (except in rare "palindronic" cases).
1486 * Fix a couple of issues to get Xapian to build and work on AIX.
1488 * common/safeuuid.h: Remove bogus take-address-of from uuid handling code for
1489   NetBSD and OpenBSD.
1491 * Under cygwin, use cygwin_conv_path() if using a new enough cygwin version,
1492   rather than the now deprecated cygwin_conv_to_win32_path().  Reported by
1493   "Haroogan" on the xapian-devel mailing list.
1495 * common/safeuuid.h: Add missing '#include <cstdlib>' and qualify free with std.
1497 * Fix 'unused label' warning when chert backend is disabled.
1499 * xapian.h: Add check for Wt headers being included before us and defining
1500   'slots' as a macro - if they are, give a clear error advising how to work
1501   around this (previously compilation would fail with a confusing error).
1503 debug code:
1505 * Fix assertion failure for when an OrPostList decays to an AndPostList - the
1506   ordering of the subqueries by estimated termfreq may not be the same as it
1507   was when the OrPostList was constructed, as the subqueries may themselves
1508   have decayed.  Reported by Michel Pelletier.
1510 * Fix -Wcast-qual warning from GCC 4.7 when configured with --enable-log.
1512 Xapian-core 1.2.15 (2013-04-16):
1514 API:
1516 * QueryParser/TermGenerator: Don't include CJK codepoints which are
1517   punctuation in N-grams.
1519 * TermGenerator: Fix bug where we failed to generate the first bigram
1520   from the second sequence of N-grammable CJK characters in a piece of text.
1522 brass backend:
1524 * Call fdatasync()/fsync() when creating the "iambrass" file.
1526 chert backend:
1528 * Call fdatasync()/fsync() when creating the "iamchert" file.
1530 flint backend:
1532 * Call fdatasync()/fsync() when creating the "iamflint" file.
1534 build system:
1536 * XO_LIB_XAPIAN now handles the user specifying XAPIAN_CONFIG without a path,
1537   for example: ./configure XAPIAN_CONFIG=xapian-config-1.3
1539 tools:
1541 * delve: If -v is specified more than once, show even more info in some cases.
1543 portability:
1545 * Fix warning due to needlessly casting away const-ness in debug logging.
1547 * Fix pointer truncation bug in lemon parser generator, which probably affects
1548   regenerating the query parser on WIN64.
1550 debug code:
1552 * Fix to build when configured with --enable-log.
1554 Xapian-core 1.2.14 (2013-03-14):
1556 API:
1558 * MSet::get_document(): Don't cache retrieved Document objects unless they
1559   were requested with fetch().  This avoids using a lot of memory when many
1560   MSet entries are retrieved.  (Fixes #604)
1562 testsuite:
1564 * apitest: Improved test coverage.
1566 matcher:
1568 * Check if a candidate document has at least the minimum weight needed
1569   before checking positional information, which speeds up slow phrase
1570   searches (partly addresses #394).
1572 brass backend:
1574 * Fix multipass compaction not to damage document values, and to merge the
1575   database stats correctly.  (fixes #615)
1577 chert backend:
1579 * Fix multipass compaction not to damage document values, and to merge the
1580   database stats correctly.  (fixes #615)
1582 flint backend:
1584 * Fix multipass compaction bug.  (fixes #615)
1586 tools:
1588 * xapian-replicate:
1590   + Fix handling of delays between replication events - the subtraction of the
1591     target time and the current time was reversed, so we wouldn't sleep when
1592     before the deadline, but would sleep after it for the amount we'd missed it
1593     by.
1595   + On Microsoft Windows, we no longer sleep for more than 43 years if the
1596     target time for a replication event had already passed.  (Fixes #472)
1598 portability:
1600 * matcher/queryoptimiser.cc: Need <functional> for mem_fun().
1602 * tests/harness/testsuite.cc: Don't provide explicit template types to
1603   make_pair - it isn't useful, and breaks with C++11.  Fixes build error with
1604   MSVC2012.
1606 * examples/quest.cc: Fix to build with Sun Studio 12 compiler.  (ticket#611)
1608 Xapian-core 1.2.13 (2013-01-09):
1610 API:
1612 * TermGenerator: Add new method TermGenerator::set_max_word_length() to allow
1613   this limit to be adjusted by the user.
1615 * QueryParser: Implicitly close any unclosed brackets at the end of the query
1616   string.  Patch from Sehaj Singh Kalra.
1618 * DateValueRangeProcessor: Add extra constructor overloaded form so that in
1619   DateValueRangeProcessor(1, "date:"), the const char * gets interpreted as
1620   std::string rather than bool.
1622 testsuite:
1624 * apitest: Assorted test coverage improvements.
1626 * When reporting valgrind errors, skip any warnings before the error in the
1627   valgrind log.
1629 matcher:
1631 * Improved fix for #590 - count all matching LeafPostList objects with a Weight
1632   object rather than trying to prune at the MultiAndPostList level based on
1633   max_wt (if wdf is always zero for a term, BM25 gives max_wt of 0, which lead
1634   to us never counting that subquery.
1636 * Fix calculation of 0.0/0.0 in some cases.  This then got used as a minimum
1637   weight, but it seems this gives -nan (at least on x86-64 Linux) so it may
1638   have been harmless in practice.
1640 * We no longer use the highest weighted MSet entry to calculate percentages, so
1641   remove code which finds it.
1643 brass backend:
1645 * Close excess file handles before we get the fcntl lock, which avoids the
1646   lock being released again if one is open on the lock file.  Notably this
1647   avoids a situation where multiple threads in the same process could succeed
1648   in locking a database concurrently.
1650 chert backend:
1652 * Close excess file handles before we get the fcntl lock, which avoids the
1653   lock being released again if one is open on the lock file.  Notably this
1654   avoids a situation where multiple threads in the same process could succeed
1655   in locking a database concurrently.
1657 flint backend:
1659 * Close excess file handles before we get the fcntl lock, which avoids the
1660   lock being released again if one is open on the lock file.  Notably this
1661   avoids a situation where multiple threads in the same process could succeed
1662   in locking a database concurrently.
1664 remote backend:
1666 * Improve the UnimplementedError message for a MatchSpy subclass which doesn't
1667   implement name() so it's clearer that it is this particular subclass which
1668   can't be used remotely, rather than all MatchSpy objects.
1670 build system:
1672 * The build system is now generated with automake 1.11.6 rather than 1.11.1,
1673   which fixes a security issue in "make distcheck" (not something users will
1674   usually run, but it seems worth addressing).
1676 * Use user-specified LIBS for configure tests, which is what you'd expect to
1677   happen, and provides a way for the user to tell configure where to find
1678   library functions which configure can't find for itself.
1680 * INCLUDES is now deprecated in automake, so use AM_CPPFLAGS instead.
1682 * Test coverage rules now assume lcov 1.10 which allows them to be simpler
1683   and not to require a patched version of lcov.
1685 documentation:
1687 * valueranges.html: Update documentation to reflect change in Xapian 1.1.2 -
1688   DateValueRangeProcessor and StringValueRangeProcessor now support a prefix or
1689   suffix.
1691 * Clarify that the "reverse" parameter of set_sort_by_relevance_then_value()
1692   and set_sort_by_relevance_then_key() only affects the ordering of the
1693   value/key part of the sort.
1695 * docs/quickstart.html: Fix seriously outdated statement that Xapian doesn't
1696   create the database directory - that changed in 0.7.2 (released 2003-07-11).
1698 * HACKING: Try to make it clearer we're looking for a dual-licence on submitted
1699   patches.
1701 tools:
1703 * xapian-replicate:
1705   + Add a --full-copy option to force a full copy to be sent.  (ticket#436)
1707   + Add --quiet option, and be a little more verbose by default.
1709   + Allow files > 32G to be be copied by replication.
1711   + Fix "if (fd > 0)" tests in some replication code to be "if (fd >= 0)".
1712     In practice this is unlikely to actually have caused problems since
1713     stdin is typically still open and using fd 0.
1715   + Simplify how we open the .DB file on the replication slave to just call
1716     open() once with O_CREAT, rather than once without, than stat() if that
1717     fails, and then again with O_CREAT|O_TRUNC if stat() doesn't show an
1718     ordinary file exists.
1720 examples:
1722 * quest:
1724   + New --flags command line option to allow setting arbitrary QueryParser
1725     flags.
1727   + Align option descriptions in --help output, and make the initial letter of
1728     such descriptions consistently lowercase.
1730 portability:
1732 * Fix testsuite harness to compile with GCC 4.7.
1734 * On platforms with the F_MAXFD fcntl but without closefrom(), we were failing
1735   to close the highest numbered open fd in our closefrom() replacement.
1737 * Our closefrom() replacement on Linux now works around valgrind not hiding
1738   some extra fds it has open, but then complaining if we try to close them.
1740 + Pass O_BINARY when opening replication related files in some cases where we
1741   weren't before, which will probably help solve ticket #472.
1743 * configure: socketpair() needs -lnetwork on Haiku.
1745 * Micro-optimisation in Unicode handling - GCC doesn't currently optimise the
1746   arithmetic shift right idiom we use, but it documents that signed right shift
1747   does sign extension so we now just use a right shift for GCC.
1749 debug code:
1751 * Preserve errno over debug logging calls, so they can safely be added to code
1752   which expects errno not to change.
1754 Xapian-core 1.2.12 (2012-06-27):
1756 build system:
1758 * 1.2.11 had its library version information incorrectly set.  This resulted in
1759   the shared library having an incorrect SONAME - e.g. on Linux,
1760   libxapian.so.21 instead of libxapian.so.22.  This release has been made to
1761   fix this problem.
1763 documentation:
1765 * AUTHORS: Add the GSoC students.
1767 Xapian-core 1.2.11 (2012-06-26):
1769 API:
1771 * Add new QueryParser::STEM_ALL_Z stemming strategy, which stems all terms and
1772   adds a Z prefix.  (Patch from Sehaj Singh Kalra, fixes ticket#562)
1774 * Add TermGenerator::set_stemming_strategy() method, with strategies which
1775   correspond to those of QueryParser.  Based on patch from Sehaj Singh Kalra,
1776   with some tweaks for adding term positions in more cases.  (Fixes ticket#563)
1778 * Correct "BM25Weight" to "TradWeight" in exception message from TradWeight.
1780 * We were failing to call init() for user-defined Weight objects providing the
1781   term-independent weight.  These now get called with init(0.0).
1783 * Xapian::Auto::open_stub() now throws a Xapian::DatabaseOpeningError exception
1784   if the stub file can't be opened.  Previously we failed to check for this
1785   condition, which resulted in us treating the file as empty.
1787 testsuite:
1789 * When the testsuite is using valgrind, we used to run remote servers under
1790   valgrind too (but with --tool=none) to get consistent behaviour as valgrind's
1791   emulation of x87 excess precision isn't exact.  Now we only do this if x87 FP
1792   instructions are actually in use (which means x86 architecture and configure
1793   run with --disable-sse).
1795 * Make sure XAPIAN_MAX_CHANGESETS gets unset after replication testcases which
1796   set it, so further testcases don't waste time generating changesets.
1798 * Improved test coverage (including more tests for closed databases -
1799   ticket#337).
1801 brass backend:
1803 * After closing the database, methods which try to use the termlist would throw
1804   FeatureUnavailableError with message "Database has no termlist", assuming
1805   that the termlist table not being open meant it wasn't present.  Fix to check
1806   if the postlist_table is open to determine which case we're in.
1808 chert backend:
1810 * After closing the database, methods which try to use the termlist would throw
1811   FeatureUnavailableError with message "Database has no termlist", assuming
1812   that the termlist table not being open meant it wasn't present.  Fix to check
1813   if the postlist_table is open to determine which case we're in.
1815 inmemory backend:
1817 * Check if the database is closed in metadata_keys_begin() for InMemory
1818   Databases.
1820 build system:
1822 * xapian-config: Don't interpret a missing .la file as meaning that we only
1823   have static libraries.
1825 documentation:
1827 * Fix API documentation for Query constructors - both XOR and ELITE_SET can
1828   take any number of subqueries, not only exactly two.
1830 * Backport missing API documentation comments for operator++ and operator*
1831   methods or PositionIterator, PostingIterator and TermGenerator.
1833 * docs/replication.rst: Update documentation - since 1.2.5, the value of
1834   XAPIAN_MAX_CHANGESETS determines how many changesets we keep.
1836 * docs/admin_notes.rst: Correction - we don't "create a lock file", we "lock a
1837   file".
1839 * Fix API documentation for TradWeight constructor - "k1" should be "k".
1841 portability:
1843 * configure: Overhaul handling of compilers which pretend to be GCC.  Clang
1844   is now detected, and we only pass it warning flags it actually understands.
1845   And we now check for symbol visibility support with Intel's compiler.
1847 * configure: Solaris automatically pulls in library dependencies, so set
1848   link_all_deplibs_CXX=no there.
1850 * configure: We now check -Bsymbolic-functions for all compilers.
1852 * configure: Enable -Wdouble-promotion for GCC >= 4.6.
1854 * Pass -ldl last when compiling zlib-vg.so, as that seems to be needed on
1855   Ubuntu 12.04.
1857 * Fix incorrect use of "delete" which should be "delete []".  This is
1858   undefined behaviour in C++, though the type is POD, so in practice this
1859   probably worked OK on many platforms.
1861 * In BM25Weight when k1 or b is zero (not the default), we used to multiply
1862   an uninitialised double by zero, which is undefined behaviour, but in
1863   practice will often give zero, leading to the desired results.
1865 * xapian.h: Add check for Qt headers being included before us and defining
1866   'slots' as a macro - if they are, give a clear error advising how to work
1867   around this (previously compilation would fail with a confusing error).
1869 Xapian-core 1.2.10 (2012-05-09):
1871 API:
1873 testsuite:
1875 * apitest: Extend tradweight1 to test that TradWeight(0) means that wdf and
1876   document length don't affect the weight of a term.
1878 * termgentest: Check that TermGenerator discards words > 64 bytes.
1880 matcher:
1882 * Don't count unweighted subqueries of MultiAndPostList in percentage
1883   calculations, as OP_FILTER maps to MultiAndPostList now.  (ticket#590)
1885 brass backend:
1887 * When compacting, if the output database is empty, don't write out a metainfo
1888   tag.  Take care not to divide by zero when computing the percentage size
1889   change for a table.
1891 chert backend:
1893 * When compacting, if the output database is empty, don't write out a metainfo
1894   tag.  Take care not to divide by zero when computing the percentage size
1895   change for a table.
1897 documentation:
1899 * API documentation:
1901  + Note version when Database::close() was added.
1903  + Fix switched lower and upper in API documentation for Weight methods
1904    get_doclength_lower_bound() and get_doclength_upper_bound().  Correct
1905    maximum to minimum in get_doclength_lower_bound() comment and note that this
1906    excludes zero length documents.  Fix "An lower" to "A lower".
1908 * docs/admin_notes.html: Mention that postlist and termlist tables also hold
1909   value info for chert.  Mention that xapian-chert-update was removed in 1.3.0.
1910   Mention that you need to use copydatabase from 1.2.x to convert flint to
1911   chert.
1913 * HACKING: Update section on patches to mention git (git diff and git
1914   format-patch), and using "-r" with normal diff, and also that ptardiff offers
1915   a nice way to diff against an unpacked tarball.
1917 debug code:
1919 * Fix use of AssertEq() on NULL, which doesn't compile, at least with recent
1920   GCC.
1922 Xapian-core 1.2.9 (2012-03-08):
1924 API:
1926 * QueryParser: Fix FLAG_AUTO_SYNONYMS not to enable auto multi-word synonyms
1927   too (but in a different way to trunk so as to not break the ABI).
1929 matcher:
1931 * Fix issue with running AND, OR and XOR queries against a database with no
1932   documents in it - this was leading to a divide by zero, which led to
1933   MSet::get_matches_estimated() reporting 2147483648 on i386.
1935 build system:
1937 * Remove configure's --with-stlport and --with-stlport-compiler options, as
1938   they don't allow you to actually specify what you need to (at least to use
1939   the Debian STLport package), and instead document what to pass to configure
1940   to enable building with STLport (though it seems to no longer be actively
1941   maintained, and the debug mode (which is probably the most interesting
1942   feature now) doesn't seem to work on Debian stable).
1944 documentation:
1946 * Document that OP_ELITE_SET with non-term subqueries might pick subqueries
1947   which don't match anything.  Closes ticket#49.
1949 * Document that you can define a static operator delete method in your subclass
1950   if deallocation needs to be handled specially.  (Closes ticket#554)
1952 * Assorted minor documentation improvements.
1954 portability:
1956 * Address new warnings from GCC 4.6.
1958 * Fix argument order when linking xapian-check to fix mingw build.
1959   (ticket#567)
1961 * Add some missing explicit header includes to fix build with STLport.
1963 Xapian-core 1.2.8 (2011-12-13):
1965 API:
1967 * Add support to TermGenerator and QueryParser for indexing and searching CJK
1968   text using n-grams.  Currently this is only enabled when the environmental
1969   variable XAPIAN_CJK_NGRAM is set to a non-empty value.
1971 documentation:
1973 * Add link from index page to apidoc.pdf.
1975 * quickstart.html: Correct link which was to quickstartsearch.cc.html but
1976   should be to quickstartindex.cc.html.
1978 * overview.html,quickstart.html: Fix several factual errors.
1980 * API documentation:
1982   + Improve documentation comments for several methods.
1984   + Add documentation for function parameters which didn't have it.
1986   + Remove bogus paragraph in WritableDatabase::replace_document()
1987     documentation comment which had been cut and pasted from delete_document()
1988     documentation comment.  (Fixes ticket#579)
1990   + Explicitly document which value slot numbers are valid.  (Fixes ticket#555)
1992   + Escape < and > in doxygen comments so "<foo>" doesn't get eaten by doxygen.
1994 portability:
1996 + Some fixes for warnings when cross-compiling to mingw.
1998 * tests/soaktest/soaktest.cc: With Sun's compiler, random() and srandom()
1999   aren't in <cstdlib> so we need to use <stdlib.h> instead.
2001 Xapian-core 1.2.7 (2011-08-10):
2003 API:
2005 * Document objects now track whether any document positions have been modified
2006   so that replacing a modified document can completely skip considering
2007   updating positions if none have changed.  Currently the flint, chert, and
2008   brass backends implement this optimisation.  A common case this speeds up is
2009   adding and/or removing boolean filter terms to/from existing documents - for
2010   example this gives an 18% speedup for adding tags in notmuch.
2012 testsuite:
2014 * Make sure that perftest isn't run with libeatmydata preloaded, as making
2015   fsync() a no-op makes performance tests rather bogus.
2017 remote backend:
2019 * Remove unnecessary call to reopen() in the remote servers in a case where
2020   either we had just called it or we are using a writable database and so
2021   reopen() doesn't do anything.
2023 build system:
2025 * configure: -Wshadow gives bogus warnings with 4.0 (at least on Mac OS X), so
2026   disable it for GCC < 4.1 (like the comments already said we did!)
2028 documentation:
2030 * Improve the documentation comment for Database::close().  (ticket#504)
2032 * Fix typo in documentation comment for Enquire constructor which reversed the
2033   intended sense (though the text was fairly obviously wrong before).
2035 * Improve documentation of QueryParser::add_boolean_prefix()'s exclusive
2036   parameter to talk about terms and prefixes rather than values and fields
2037   (which was confusing since "document value" has a particular meaning in
2038   Xapian).
2040 * docs/facets.html: Expand descriptions for indexing and finding facets.
2041   Fix errors in example code.
2043 * docs/index.html: Add links to Omega and bindings documentation.
2045 * docs/remote_protocol.html: Fixed typo which reversed the intended sense.
2047 * xapian-check --help: Document that checking a whole database performs
2048   additional cross-checks between the tables.
2050 * docs/admin_notes.html: Add note about xapian-chert-update.
2052 * docs/deprecation.html: Note here that WritableDatabase::flush() is
2053   deprecated in favour of WritableDatabase::commit().
2055 portability:
2057 * Fix -Wshadow warnings from GCC 4.6.
2059 * Fix warning from GCC 3.3.
2061 debug code:
2063 * Fix some problems with the templates used to implement output of parameters
2064   and return values in debug logging.
2066 Xapian-core 1.2.6 (2011-06-12):
2068 API:
2070 * QueryParser:
2072   + Add new set_max_wildcard_expansion() method to allow limiting the number of
2073     terms a wildcard can expand to.  (ticket#350)
2075   + If default_op is OP_NEAR or OP_PHRASE then disable stemming of the terms,
2076     since we don't index positional information for stemmed terms by default.
2078 * Spelling correction was failing to correctly handle words which had the same
2079   trigram in an even number of times.
2081 testsuite:
2083 * We now actually include the soaktest code in the release tarballs.
2085 matcher:
2087 * Eliminate some vector copies when handling phrase subqueries in the query
2088   optimiser.
2090 brass backend:
2092 * Kill the child process which holds the lock with SIGKILL as that can't be
2093   ignored, whereas SIGHUP can be in some cases.
2095 chert backend:
2097 * Kill the child process which holds the lock with SIGKILL as that can't be
2098   ignored, whereas SIGHUP can be in some cases.
2100 flint backend:
2102 * Kill the child process which holds the lock with SIGKILL as that can't be
2103   ignored, whereas SIGHUP can be in some cases.
2105 documentation:
2107 * The HTML documentation is now maintained in reStructured Text format.
2109 * docs/queryparser.html: Document the precedence order of operators.
2111 * docs/scalability.html: Bring up-to-date.
2113 * docs/overview.html: Document "remote" in stub databases.
2115 * docs/postingsource.html: Add PostingSource example.  (ticket#503)
2117 * include/xapian/database.h: Add @exception InvalidArgumentError for
2118   Database::get_document() (ticket#542).
2120 * Ship ChangeLog.0 in the tarball.
2122 * Assorted minor improvements.
2124 examples:
2126 * examples/delve: Report has_positions().
2128 * examples/simpleindex: Add short description to usage message.
2130 portability:
2132 * Fix to build for mingw.
2134 Xapian-core 1.2.5 (2011-04-04):
2136 API:
2138 * Enquire::get_eset() now accepts a min_wt argument to allow the minimum wanted
2139   weight to be specified.  Default is 0, which gives the previous behaviour.
2141 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
2142   integer the same way at the end of the query as in the middle.
2144 * Replication:
2146   + Only keep $XAPIAN_MAX_CHANGESETS changeset files when generating a new one
2147     (previously this variable only controlled if we generated changesets or
2148     not).  Closes ticket#278.
2150   + $XAPIAN_MAX_CHANGESETS is reread each time, rather than only when the
2151     database is opened.
2153   + If you build Xapian with DANGEROUS mode enabled, changeset files now
2154     actually have the appropriate flag set (the reader will currently throw an
2155     exception, but that's better than quietly handling them incorrectly).
2157 testsuite:
2159 * Compaction tests which generate stub files now close them before performing
2160   the actual compaction, to avoid issues on Microsoft Windows (ticket#525).
2162 * Improve test coverage.
2164 matcher:
2166 * Fix memory leak if an exception is thrown during the match.
2168 brass backend:
2170 * Bumped format version number (we now store the oldest revision for which we
2171   might have a replication changeset).
2173 * Optimise not to read the bitmaps from the base files when opening a database
2174   for reading (cross-port of equivalent change to chert).
2176 * Optimise not to update doclength when it hasn't changed (cross-port of
2177   equivalent change to chert).
2179 * If we try to delete an old base file and it isn't there, just continue rather
2180   than throwing an exception.  We wanted to get rid of it anyway, and it may be
2181   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
2182   was rather a pessimistic assessment.
2184 chert backend:
2186 * Optimise not to read the bitmaps from the base files when opening a database
2187   for reading.
2189 * Optimise not to update doclength when it hasn't changed.
2191 * xapian-chert-update: Fix to handle larger databases, and databases which
2192   have values set.
2194 * If we try to delete an old base file and it isn't there, just continue rather
2195   than throwing an exception.  We wanted to get rid of it anyway, and it may be
2196   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
2197   was rather a pessimistic assessment.
2199 flint backend:
2201 * Optimise not to read the bitmaps from the base files when opening a database
2202   for reading (cross-port of equivalent change to chert).
2204 * Optimise not to update doclength when it hasn't changed (cross-port of
2205   equivalent change to chert).
2207 * If we try to delete an old base file and it isn't there, just continue rather
2208   than throwing an exception.  We wanted to get rid of it anyway, and it may be
2209   NFS issues telling us the wrong thing.  In particular, DatabaseCorruptError
2210   was rather a pessimistic assessment.
2212 remote backend:
2214 * xapian-tcpsrv: If we can't bind to the specified port because it is a
2215   privileged one, exit with code 77 (EX_NOPERM) to make it easier to
2216   automatically handle failure when starting the server from a script.
2218 build system:
2220 * Snapshots and releases are now bootstrapped with autoconf 2.68 and libtool
2221   2.4.
2223 * configure: -Wstrict-null-sentinel was added in GCC 4.0.1 and so doesn't work
2224   with GCC 4.0.0.  For simplicity, only enable it for GCC >= 4.1.
2226 documentation:
2228 * INSTALL: Note how to build for a non-default arch on a multi-arch platform.
2230 * include/xapian/enquire.h: Fix doxygen markup so alternative overloaded forms
2231   of Enquire::get_mset() appear in the API documentation.
2233 * collapsing.html: Add missing document (written some time ago, but never
2234   actually added to builds).
2236 * replication.html: Update documentation to make it clear that users shouldn't
2237   create the destination directory for replication themselves.
2239 * docs/intro_ir.html: Update link to a paper.  Update text about book "to be
2240   published in 2008".
2242 * docs/deprecation.html:
2244   + PostingSource now offers a replacement for Enquire::set_bias().
2246   + OmegaScript: $set{spelling,true} is now deprecated.
2248   + Add note about botched removal of Enquire.get_matching_terms from Python
2249     bindings (now fully removed).
2251   + Note removal of "if idx in mset" from Python bindings.
2253   + Deprecate MSet.items and ESet.items from Python bindings (ticket#531).
2255 * docs/admin_notes.html: Update for 1.2.5.
2257 * Updates to documentation of internals.
2259 tools:
2261 * xapian-replicate-server: Fix race condition between checking if a file
2262   exists and opening it to replicate it.
2264 * xapian-replicate: Complain unless host name and port number are specified -
2265   previously these defaulted to an empty string and 0, which resulted in
2266   potentially confusing error messages.
2268 * xapian-replicate: If --master isn't specified, default to DATABASE.
2270 examples:
2272 * quest: Report any spelling correction (requires the database contains
2273   spelling data of course).
2275 * copydatabase: Add --no-renumber option.
2277 portability:
2279 * api/compactor.cc: Add missing header <ctime> for time() (ticket#530).
2281 * api/compactor.cc: Use msvc_posix_rename() under __WIN32__ to atomically
2282   update stub file after compaction (ticket#525).
2284 * Fix uninitialised variable warnings with gcc -O3.
2286 * Eliminate std::string member of global static object used when compiled with
2287   --enable-log which was causes problems on Mac OS X.
2289 * Fix some issues highlighted by clang++ warnings.
2291 Xapian-core 1.2.4 (2010-12-19):
2293 API:
2295 * QueryParser:
2297   + Avoid a double free if Query construction throws an exception in a
2298     particular case.  Fixes ticket#515.
2300   + Allow phrase generators between a probabilistic prefix and the term itself
2301     (e.g. path:/usr/local).
2303   + The correct window size wasn't being set in some cases when default_op was
2304     set to OP_PHRASE.
2306 * Enquire::get_mset():
2308   + Avoid pointlessly trying to allocate lots of memory if the first document
2309     requested is larger than the size of the database.
2311   + An empty query now returns an MSet with firstitem set correctly -
2312     previously firstitem was always 0 in this case.
2314 * Document: Initialise docid to 0 when creating a document from
2315   scratch, as documented.
2317 * Compactor:
2319   + Move the database compaction and merging functionality into this new class,
2320     and make xapian-compact a simple wrapper around this class.  (ticket#175)
2322   + Inputs can now be stub database directories or files, in which case the
2323     databases in the stub are used as inputs.
2325   + Add support for compacting to a stub database, which can be one of the
2326     inputs (for atomic update).
2328   + If spellings and/or synonyms were only present in some source databases,
2329     they weren't copied to the output database, but now they are.
2331 testsuite:
2333 * Improve test coverage (particularly for Xapian::Utf8Iterator and
2334   Xapian::Stem).
2336 * Add zlib-vg.c to distribution tarballs.
2338 * tests/runtest: Add XAPIAN_TESTSUITE_LD_PRELOAD hook to allow libeatmydata to
2339   easily be used to speed up testsuite runs.
2341 matcher:
2343 * The matcher wasn't recalculating the max possible weight after a subquery of
2344   XOR reached its end.  This caused an assertion failure in debug builds, and
2345   is a missed optimisation opportunity.
2347 * Implement SelectPostList::check() so that check() on OP_NEAR and OP_PHRASE
2348   subqueries will just check a single document, not a potentially huge numbers
2349   of documents.
2351 * BM25Weight: Fix calculation order to avoid inconsistent weights due to
2352   rounding when certain non-default parameter combinations are used.
2354 * TradWeight: Fix calculation order to avoid inconsistent weights due to
2355   rounding with TradWeight(0).
2357 * Fix regression in speed of OP_OR queries in certain cases due to optimisation
2358   added in 1.0.21/1.2.1.
2360 * In the query optimiser, use value range bounds to detect value ranges which
2361   must be empty.
2363 remote backend:
2365 * Add support for iterating metadata keys with the remote backend.  This change
2366   necessitated an increase in the minor version of the remote protocol.  If you
2367   are upgrading a live system which uses the remote backend, upgrade the
2368   servers before the clients.
2370 build system:
2372 * xapian-config: Add --static option which makes other options report values
2373   for static linking.
2375 * xapian-config is now removed by "make distclean" not "make clean".
2377 * configure: FreeBSD and OpenBSD don't need explicit dependency libraries, so
2378   set link_all_deplibs_CXX=no there.
2380 * This release uses autoconf 2.67 rather than 2.65.
2382 documentation:
2384 * INSTALL: Raise recommended GCC version from 3.3 to 4.1, since that's the
2385   oldest we regularly test with.
2387 * replication.html: Update and improve in various ways.
2389 * Remove lingering "experimental" marker from PostingSource and
2390   ValueCountMatchSpy API documentation.
2392 * index.html: Add links to replication and facets documents, and fix typo in
2393   serialisation document link.
2395 * internals.html: Add link to replication protocol.
2397 * Change the categorisation document to talk about facets, since that's the
2398   terminology that seems to be most widely used these days, and
2399   "categorisation" can also mean automatically assigning categories to
2400   documents.  Also update to reflect the final API.
2402 * deprecation.html: Add guidelines for supporting other software.
2404 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
2405   currently supported.
2407 * PLATFORMS: Move PLATFORMS information to the wiki and replace with a pointer.
2409 tools:
2411 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
2412   This could have caused problems, though we've had no reports of any (the
2413   bug was found with _GLIBCXX_DEBUG).
2415 * xapian-compact: Add --quiet/-q option to suppress progress output.
2416   (ticket#437)
2418 * xapian-replicate: If a full copy was attempted, but was not put live, display
2419   an explanatory message (in verbose mode).
2421 examples:
2423 * examples/quest: Add command line options to allow prefixes to be specified
2424   for the QueryParser.
2426 * examples/delve: Add '-z' option to count zero-length documents.
2428 * examples/simplesearch: Fix cut-and-paste errors in usage message and
2429   --version output.
2431 portability:
2433 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
2434   control of which SSE instructions to use.
2436 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
2438 * configure: Beef up the test for whether -lm is required and add a special
2439   case to force it to be for Sun's C++ compiler - there's some interaction with
2440   libtool and/or shared objects which means that the previous configure test
2441   didn't think -lm is needed here when it is.
2443 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
2445 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
2446   68030 as well as 68000.
2448 * Fix compilation with Sun's C++ compiler.
2450 * Fix testsuite to build on Solaris < 10.
2452 Xapian-core 1.2.3 (2010-08-24):
2454 API:
2456 * Database::get_spelling_suggestion() will now suggest a correction even if the
2457   passed word is in the dictionary, provided the correction has at least the
2458   same frequency.  Partly addresses #225.
2460 * QueryParser:
2462   + Fix handling of groups of terms which are all stopwords - in situations
2463     where this causes a problem we now disable stopword checks for such groups.
2464     (ticket#245)
2466   + Fix to be smarter about handling a boolean filter term containing ".." in
2467     the presence of valuerangeprocessors.
2469 testsuite:
2471 * New "unittest" program for testing low level functions directly.  Currently
2472   this has tests for the internal resolve_relative_path() function.
2473   (ticket#243)
2475 remote backend:
2477 * Retry select() if it fails with EINTR while waiting for connect(), and
2478   discriminate cases with same failure message to aid debugging.
2480 documentation:
2482 * Fix documentation comment for Xapian::timeout type - it holds a time interval
2483   in milliseconds not microseconds (the API docs for the methods which use it
2484   explicitly correctly document that the timeouts are in milliseconds).
2486 * libuuid moved from e2fsprogs to util-linux-ng about a year ago, so update
2487   documentation, comments, and configure error messages to reflect this.
2489 portability:
2491 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
2492   (ticket#492).
2494 * Fix handling of some obscure cases of resolving relative paths on Microsoft
2495   Windows.  (ticket#243).
2497 * Optimise closing of all unwanted file descriptors after forking by using
2498   closefrom() if available, and otherwise providing our own implementation
2499   (optimised to some extent for many platforms).
2501 * Fix test harness to build under Microsoft Windows (ticket#495).
2503 packaging:
2505 * xapian-core.spec: Add xapian-metadata and cmake related files to RPM
2506   packaging.
2508 * xapian-core.spec: Update BuildRequires to specify libuuid-devel instead of
2509   e2fsprogs-devel.
2511 debug code:
2513 * Improve logging of function parameter placeholder strings.
2515 Xapian-core 1.2.2 (2010-06-27):
2517 brass backend:
2519 * Sync changes from each Btree table to disk right after syncing changes to
2520   its base file, which allows more time for the table changes to be written
2521   and may also be more efficient with some Linux kernel versions.
2523 chert backend:
2525 * Sync changes from each Btree table to disk right after syncing changes to
2526   its base file, which allows more time for the table changes to be written
2527   and may also be more efficient with some Linux kernel versions.
2529 tools:
2531 * xapian-check: Don't try to check document lengths are consistent between the
2532   postlist and termlist tables if it would use more than 1GB of memory, and
2533   handle std::bad_alloc or std::length_error when trying to allocate space
2534   for this.  This issue affected sup users, as sup allocates docids such that
2535   they are sparse and large docids can easily occur.
2537 examples:
2539 * delve: Show the database's UUID.
2541 portability:
2543 * Revert 1.2.1 change to visibility of Xapian::Weight's copy constructor as
2544   it making it private broke compilation with GCC 4.1 (which seems to be a
2545   bug in this compiler version).
2547 * tests/harness/testsuite.cc: Need <cstdio> for sprintf().  Fixes compilation
2548   error which was masked if valgrind was installed.  (ticket#489)
2550 packaging:
2552 * xapian-core.spec: Update for 1.2.x - add e2fsprogs-devel to BuildRequires and
2553   add new files to install.
2555 Xapian-core 1.2.1 (2010-06-22):
2557 This release includes all changes from 1.0.21 which are relevant.
2559 API:
2561 * QueryParser: Add support for open-ended ranges (ticket#480).
2563 * Add new optional parameter to QueryParser::add_boolean_prefix() to allow the
2564   user to indicate a prefix isn't "exclusive" and that multiple instances
2565   should be combined with OP_AND rather than OP_OR.  Fixes ticket#402.  This
2566   change should also improve efficiency as it avoids copying the lists of
2567   prefixes and compares them more efficiently.
2569 * You can now specify a custom stemming algorithm by subclassing
2570   Xapian::StemImplementation, mostly based on patch from Evgeny Sizikov in
2571   ticket#448.
2573 * Fix replication bug: when multiple commits were made to the master database
2574   while a client was performing a full copy, the client would only apply the
2575   first changeset and then try to make the database live, but fail due to
2576   trying to set the wrong revision number.
2578 * Replication no longer sleeps between applying changesets to an offline
2579   database.  It's only necessary to sleep for a live database (to allow readers
2580   to complete a search without getting DatabaseModifiedErrror.
2582 * xapian-replicate: Add new "-r" command line option to specify how long
2583   replication sleeps for between applying changesets to a live database.
2585 * If a Btree table doesn't exist when applying a replication changeset, create
2586   it.  This fixes replicating a revision where a lazy table is created.
2587   (ticket#468)
2589 testsuite:
2591 * zlib can produce "uninitialised" output from "initialised" input - the
2592   output does decode to the input, so this is presumably just some unused bits
2593   in the output, so we use an LD_PRELOAD hack to get valgrind to check the
2594   input is initialised and then tell it that the output is initialised.
2596 * Don't pass NULL to closedir(), which fixes test harness failures on platforms
2597   without /proc/self/fd.
2599 * Use safesyswait.h, fixing build failure on "make check" on FreeBSD.
2601 * Check is SA_SIGINFO is defined before using it as it isn't available
2602   everywhere.  Fixes testsuite build failure on GNU Hurd.
2604 * Add a "soaktest" testsuite, intended to contain long-running tests with
2605   random data.  Currently contains a single test which builds and runs random
2606   queries, checking that the results returned are consistent when asking for
2607   different result ranges.
2609 * Test UUID returned by Database::get_uuid() is 36 characters long.
2611 matcher:
2613 * Xapian no longer forces the wdf_max value to be at least one in
2614   BM25Weight::get_maxpart().  We used to do this so that a non-existent term in
2615   the query would cause it not to achieve 100%, but now we calculate
2616   percentages based on the number of matching subqueries, and it is more
2617   natural for a non-existent term to get zero weight (ditto for a term which
2618   always has wdf 0).
2620 * OP_VALUE_RANGE and OP_VALUE_GE now use value streams directly which is much
2621   more efficient for chert (the default backend in 2.2.x).  As an example, a
2622   range query testcase which previously took 29 seconds now takes 0.4 seconds
2623   (70 times faster).  (ticket#432)
2625 * The term statistics from multiple databases are now gathered in a simpler
2626   way which is a bit faster and uses less memory.
2628 build system:
2630 * Install headers under PREFIX/include not PREFIX/include/xapian.  If you used
2631   XO_LIB_XAPIAN or xapian-config in your build system, the headers would still
2632   have been found.
2634 * Releases and snapshots are now generated with libtool 2.2.10 instead of
2635   2.2.6.
2637 * Fix build failures with some combinations of backends disabled (partially
2638   addresses ticket#361 - some combinations still fail).
2640 * Add check to configure that GCC actually supports visibility for the platform
2641   being built for, which fixes compiler warnings with platforms which don't
2642   (such as Mac OS X and mingw).
2644 documentation:
2646 * Update documentation - replication and PostingSource aren't experimental in
2647   1.2.x.
2649 portability:
2651 * Make use of built-in UUID API on FreeBSD and NetBSD.  (ticket#470)
2653 * Fix mingw build.
2655 debug code:
2657 * Add new pretty printer for values reported by calls and returns in debug
2658   logging - in particular, strings are now reported with non-printable
2659   characters escaped.
2661 * Debug logging should have less runtime overhead when built in but not in use.
2663 * Drop support for --enable-log=profile - dedicated profiling tools are likely
2664   to return more useful results.
2666 Xapian-core 1.2.0 (2010-04-28):
2668 This release includes all changes from 1.0.20 which are relevant.
2670 testsuite:
2672 * Fix --abort-on-error to actually work.
2674 * Exit with status 1 not 0 if we caught an exception from the harness itself.
2676 Xapian-core 1.1.5 (2010-04-16):
2678 This release includes all changes from 1.0.19 which are relevant.
2680 API:
2682 * Database replication now handles an exception while applying a changeset
2683   better.
2685 * If environment variable XAPIAN_MAX_CHANGESETS is set on a replication client
2686   then any changesets read are saved so the replicated copy can itself be
2687   replicated.
2689 testsuite:
2691 * Use sigsetjmp() and siglongjmp() where available so that the set of blocked
2692   signals get restored and the test harness can catch a second incidence of a
2693   particular signal in a run.  Use sigaction() instead of signal() where
2694   available, which allows us to report the address associated with SIGSEGV,
2695   SIGFPE, SIGILL, and SIGBUS.
2697 * Add machinery to check for leaked file descriptors.  Currently this requires
2698   /proc/self/fd to work (which is present on Linux and some other platforms).
2699   Remove the crude ulimit in runtest which has caused problems on some Debian
2700   buildds.
2702 * The test harness now explicitly catches const char * exceptions and reports
2703   their contents.
2705 brass backend:
2707 * Ensure that the wdf upper bound is correctly updated when replacing
2708   documents.
2710 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2712 chert backend:
2714 * Ensure that the wdf upper bound is correctly updated when replacing
2715   documents.
2717 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2719 * xapian-check: Check that the initial doclen chunk exists.
2721 flint backend:
2723 * xapian-compact: Now sets lastdocid correctly when using --no-renumber.
2725 remote backend:
2727 * Add remote backend support for WritableDatabase::add_spelling() and
2728   WritableDatabase::remove_spelling().  This bumps the remote protocol to
2729   version 35.0 (so both client and servers will need updating).  Suggesting
2730   spelling corrections isn't yet supported.  (ticket#178)
2732 build system:
2734 * XO_LIB_XAPIAN: Give a more specific error message for the cases where
2735   XAPIAN_CONFIG isn't found, is a directory, or isn't executable.
2737 examples:
2739 * delve:
2741   + If any documents are specified with "-d<docid>", "-V<slot>" now only show
2742     values for those documents.
2744   + Remove undocumented -k option, which has been a compatibility alias for -V
2745     since 0.9.10.  Just use -V instead.
2747 * xapian-metadata: Add new example program which allows you to get and set
2748   individual user metadata entries.
2750 Xapian-core 1.1.4 (2010-02-15):
2752 This release includes all changes from 1.0.18 which are relevant.
2754 API:
2756 * Xapian::TermGenerator,Xapian::QueryParser,Xapian::Unicode::is_wordchar():
2757   Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories to is_wordchar(),
2758   which is used by TermGenerator and QueryParser.  Also make TermGenerator and
2759   QueryParser ignore several zero-width space characters.  This is a better
2760   but less compatible version of a fix in 1.0.18.
2762 * Implement support for iterating valuestreams for multidatabases.
2764 * Xapian::Stem: Update the german and german2 stemming algorithms to the latest
2765   versions from Snowball.  These add an extra rule for the "-nisse" ending.
2767 * Xapian::ValueCountMatchSpy: Replace get_values() with values_begin() and
2768   values_end().
2770 * Xapian::MatchSpy: Provide an iterator for accessing the top values found
2771   instead of taking a vector by reference to return them in.
2773 * Xapian::NumericRanges: Remove experimental API we aren't happy with yet.
2775 * Xapian::DatabaseReplica, Xapian::DatabaseMaster: Remove experimental
2776   API we aren't happy with.  Replication is still supported via the
2777   command line programs.  (ticket#347)
2779 * Xapian::score_evenness(): Remove as it turns out not to be useful in practice.
2780   (ticket#435)
2782 * Xapian::ValueWeightPostingSource: A ValueWeightPostingSource with no entries
2783   would report -infinity as its upper bound, which could cause no results to be
2784   incorrectly returned for some queries involving such an object.
2786 * Xapian::WritableDatabase::close() fixed to commit() changes (unless a
2787   transaction is in progress).
2789 testsuite:
2791 * apitest: Improve test coverage in various places.
2793 matcher:
2795 * Uses of values during the match (sorting by value or Sorter, MatchSpy,
2796   MatchDecider, and collapsing) now use value stream iteration which is
2797   a lot more efficient for chert and brass (but may be slower for flint).
2799 brass backend:
2801 * New development backend.  Changes over chert:
2803   + Batched posting list changes during indexing use significantly less memory.
2805   + Instead of using complex code to iterate modified posting lists and
2806     documents length lists, brass can flush individual such lists to disk
2807     and then iterates them from there.
2809   + To iterate all terms, chert flushes all pending postlist changes.  In the
2810     case where a prefix is specified, brass only flushes postlist changes for
2811     terms starting with the specified prefix, and doesn't flush document length
2812     changes.
2814 chert backend:
2816 * Promote chert to being the stable backend.
2818 * Change the packing of integers and strings into sortable keys, which reduces
2819   database size by 2.5% in tests.  This means an incompatible change in the
2820   chert format.  You can use the new xapian-chert-update utility to update a
2821   chert database from the old format to the new format.  It works much like
2822   xapian-compact so should take a similar amount of time (and results in a
2823   compact database).
2825 * xapian-compact:
2827   + Prune unused docids off the end of each database when merging multiple
2828     databases with renumbering.
2830   + Extend --no-renumber to support merging databases, but only if they have
2831     disjoint ranges of used document ids.
2833   + Ensure that the resultant database has a fresh UUID (previously chert
2834     copied the UUID from the first input).
2836 * xapian-check:
2838   + Fix checking of the METAINFO key in chert.  For small databases, the
2839     statistics fit in few enough bytes that incorrect check appeared to
2840     succeed and no errors were reported, but for larger databases an
2841     error was incorrectly reported.
2843   + Rework the checking of postlist chunks to use a cleaner approach which
2844     should report errors better.
2846   + Use a type wider than 32 bits to keep count of items in a table.
2847     Previously xapian-check would report the number of entries modulo
2848     4294967296.
2850 * When iterating a value stream, skip_to() now only assigns the value to a
2851   std::string when it reaches its target.  This saves a lot of unnecessary
2852   string copying - in a real-world test it improved the time for 100 queries
2853   from 3.66s to 3.10s.
2855 * When skipping through a chunk of postings to find the one we want, don't
2856   bother to unpack the wdf values we're skipping over.  This should save a
2857   significant amount of time in certain cases where the profile data shows
2858   about a third of the time is spent in the function where this happens.
2860 * Report locking failure due to running out of file descriptors better.
2862 flint backend:
2864 * xapian-compact:
2866   + Prune unused docids off the end of each database when merging multiple
2867     databases with renumbering.
2869   + Ensure that the resultant database has a fresh UUID (previously flint
2870     didn't set a UUID so one would be generated on demand when next requested,
2871     but only if the database was writable).
2873 * Report locking failure due to running out of file descriptors better.
2875 remote backend:
2877 * Add support for WritableDatabase::set_metadata() and Database::get_metadata()
2878   to the remote backend (based largely on patch in #178).
2880 inmemory backend:
2882 * Read the document data and values lazily for the inmemory backend like we do
2883   for other backends.  They're much less costly to fetch than if a disk or
2884   network access is involved, but it avoids copying potentially large data
2885   which may not be needed.  Consistency here also makes things easier to
2886   understand for both users and developers.
2888 build system:
2890 * This release uses autoconf 2.65 rather than 2.64.
2892 documentation:
2894 * docs/replication.html: Add note about not using reopen() with databases being
2895   updated by the replication client.
2897 * docs/admin_notes.html: Update for chert and other recent changes.
2899 * Remove out-of-date reference in the API documentation comment to an
2900   add_slot() method.  This no longer exists - you need to use multiple
2901   ValueCountMatchSpy objects to monitor more than one slot.
2903 examples:
2905 * simpleexpand,simpleindex,simplesearch: Handle --help and --version.
2907 debug code:
2909 * The debug log now reports boolean values as "true" and "false" (instead of
2910   "1" and "0").
2912 Xapian-core 1.1.3 (2009-09-18):
2914 This release includes all changes from 1.0.15-1.0.17 which are relevant.
2916 API:
2918 * Update Unicode character database to Unicode 5.2.  (ticket#351)
2920 * Rename Xapian::Sorter to Xapian::KeyMaker, paving the way for using it to
2921   build collapse keys too.  Xapian::Sorter remains for compatibility (and is
2922   now a subclass of Xapian::KeyMaker) but is deprecated.
2924 * Resolve the inconsistency in MultiValueSorter::add()'s "forward" parameter
2925   versus the "reverse" parameters which the Enquire sorting functions now take
2926   by replacing the class with MultiKeyMaker with a renamed method add_value()
2927   with a "reverse" parameter.  MultiValueSorter remains with the old semantics
2928   for compatibility but is deprecated.  (ticket#359)
2930 * QueryParser: Don't apply spelling correction to wildcarded terms, or to terms
2931   at the end of the query which we expand under FLAG_PARTIAL.
2933 * Add new Error subclass SerialisationError which we throw for serialisation
2934   related errors (which previously mostly threw NetworkError.
2936 * Rename Xapian::SerialisationContext to Xapian::Registry.
2938 * Add DecreasingValueWeightPostingSource class, which reads weights from a
2939   value slot in which a significant range of the values are in decreasing
2940   order.  This functions similarly to ValueWeightPostingSource, but can be much
2941   more efficient.
2943 * Add new Xapian::MatchSpy class:
2945   + This replaces the use of Xapian::MatchDecider as a "matchspy", which is now
2946     deprecated.  The new class only inspects, and can't reject.  It can work
2947     with remote databases, with the results being serialised to return them
2948     across the link.
2950   + Add subclass ValueCountMatchSpy, which counts the occurrences of each value
2951     in a slot in the search results seen (useful for faceted or categorisation
2952     systems).  The results can be grouped into ranges using the NumericRange
2953     and NumericRanges classes, and the score_evenness() function.  This API is
2954     currently experimental.
2956 * Remove default implementation of Weight::clone() which returns NULL.  We
2957   always need clone() to be implemented because it's called for every term
2958   in the query, not just used for the remote backend.
2960 chert backend:
2962 * Rewrite the low level packing and unpacking functions more efficiently.  As
2963   well as being generally faster, the pack functions now take a reference to a
2964   string to append to, which avoids creating a lot of temporary string objects.
2965   Indexing HTML files with omindex is 5-10% faster.  Searching for "The" on
2966   gmane (which results in a lot of unpacking of postings and document lengths)
2967   is about 35% faster.  (ticket#326)
2969 * xapian-compact: Don't report an absent lazy input table as 0 size.
2971 * Fix ChertModifiedPostList to skip added-but-then-deleted-before-flush
2972   documents.  (ticket#392)
2974 * Fix WritableDatabase::get_doclength() to work properly after a call to commit
2975   for the chert backend (ticket#397).
2977 * Fix to work with the metainfo key stored in the latest format of chert
2978   databases.
2980 * Avoid doing pointless work by trying to delete non-existent lists of values
2981   when we're just adding documents.
2983 * Fix code to find the first docid in the next chunk (ticket#399).
2985 * Add support for chert databases without a termlist table (ticket#181).
2986   Currently the only way to create such a database is to create a chert
2987   database and do "rm termlist.*".
2989 flint backend:
2991 * xapian-compact: Don't report an absent lazy input table as 0 size.
2993 remote backend:
2995 * Remote protocol major version has changed to support serialising MatchSpy
2996   objects.
2998 * Fixed not to sometimes read off the end of the returned matches when
2999   searching multiple databases, some of which are remote, and when the primary
3000   ordering is by relevance.
3002 build system:
3004 * This release uses autoconf 2.64 rather than 2.63.  This means configure now
3005   makes use of shell functions, which makes it ~13% smaller, and should also
3006   make it execute faster.
3008 * configure: Send stderr output from ldconfig to config.log.
3010 * Add optional third parameter to XO_LIB_XAPIAN autoconf macro which specifies
3011   the basename for the "xapian-config" script (defaults to "xapian-config" to
3012   give the current behaviour).
3014 * This release uses doxygen 1.5.9 to generate the API documentation.
3016 documentation:
3018 * Minor improvements to the formatting of the collated API documentation.
3020 portability:
3022 * Fix code to compile with Sun's C++ compiler.
3024 * Fix our uuid_unparse_lower() replacement for older libuuid to actually
3025   compile (really fixes ticket#368).
3027 * Fix xapian-config to work with Solaris 10 /bin/sh.  (ticket#405)
3029 debug code:
3031 * Use C++ syntax for NULL with a type in log output.
3033 Xapian-core 1.1.2 (2009-07-23):
3035 This release includes all changes from 1.0.14 which are relevant.
3037 API:
3039 * Move support for a prefix/suffix from NumberValueRangeProcessor to
3040   StringValueRangeProcessor, and change NumberValueRangeProcessor and
3041   DateValueRangeProcessor to inherit from StringValueRangeProcessor so all
3042   three now support a prefix/suffix.  (ticket#220)
3044 * Query: Trim 4 bytes off the internals.  (ticket#280)
3046 * QueryParser: If default_op is OP_NEAR or OP_PHRASE then make the window size
3047   (9 + no_of_terms) to match the default for an explicit NEAR or PHRASE.
3048   (ticket#254)
3050 testsuite:
3052 * Sort out the clash between two different patches to fix leaking file
3053   descriptors when running tests with the remotetcp backend (broken by
3054   changes in 1.1.1).
3056 matcher:
3058 * If the highest weighted document doesn't match all the terms in the query,
3059   its percentage weight is now calculated by simply counting how many weighted
3060   leaf subqueries match it instead of scaling by the proportion of the weight
3061   which matches (which required accessing the termlist for that document).
3062   (ticket#363).
3064 * XOR with a SYNONYM subquery could previously achieve 100% - this has been
3065   fixed.
3067 flint backend:
3069 * Backport the lazy update changes from chert to flint:
3071   WritableDatabase::replace_document() now updates the database lazily in
3072   simple cases - for example, if you just change a document's values and
3073   replace it with the same docid, then the terms and document data aren't
3074   needlessly rewritten.  Caveats: currently we only check if you've looked at
3075   the values/terms/data, not if they've actually been modified, and only keep
3076   track of the last document read.
3078 build system:
3080 * Update to always use C++ forms for ISO C standard headers (ticket#330).
3082 * Fix several places where Xapian::doccount is used instead of
3083   Xapian::termcount, and similar issues.  It's still not possible to make
3084   these types different sizes, but we're now closer to this goal.
3085   (ticket#385).
3087 documentation:
3089 * Note that PostingSource and Weight objects returned by clone() and
3090   unserialise() methods will be deallocated with "delete".
3092 debug code:
3094 * Fix debug logging not to segfault on NULL Query::Internal pointers.
3096 Xapian-core 1.1.1 (2009-06-09):
3098 This release includes all changes from 1.0.13 which are relevant.
3100 API:
3102 * New Query::OP_SYNONYM operator, which matches the same documents as OP_OR,
3103   but attempts to weight as if the all the subqueries were a single term with
3104   their combined wdf, which should give better relevance weights.
3106 * QueryParser's synonym, wildcard, and partial query features now use
3107   the new OP_SYNONYM operator.
3109 * PostingSource: Add new set_maxweight() method to allow subclasses to tell
3110   the matcher that their maximum weight has decreased.  Make get_maxweight()
3111   a non-virtual method of the baseclass which returns the last set maxweight
3112   (which will require updates to most user subclasses. (ticket#340)
3114 * DatabaseReplica: Fix SEGV when calling get_description() on a default
3115   constructed DatabaseReplica.
3117 * Make Query::MatchAll and Query::MatchNothing const since they're immutable.
3118   All the public methods of Query are const, so this should be completely API
3119   compatible.
3121 * Methods returning an end iterator for a ValueIterator now actually return a
3122   proxy object which silently converts to ValueIterator if required.  This
3123   proxy object allows a comparison with an "_end()" method to be optimised
3124   better so that it just ends up comparing the internal member of the iterator
3125   class with NULL (previously a call to ValueIterator's destructor remained).
3126   This should be API compatible, but note that it is definitely now more
3127   efficient just to compare against the return value of the relevant _end()
3128   method than to store the end iterator explicitly.
3130 testsuite:
3132 * Testcase valuestats4 requires transactions, so indicate that and remove the
3133   explicit SKIP for inmemory.
3135 * Testcase changemaxweightsource1 uses ChangeMaxweightPostingSource, which
3136   doesn't work with multi or remote, so mark the test accordingly.
3138 * We've decided that "going back" with skip_to() or check() should have
3139   unspecified behaviour, so stop testing how this case behaves!
3141 matcher:
3143 * Subclass MultiPostList directly from PostList instead of from LeafPostList.
3144   This gets rid of two unused data members per MultiPostList in exchange for
3145   having to define 5 extra "never called" methods, but 4 of these just
3146   tailcall.
3148 * Store termfreqs and reltermfreqs for query terms in a single map rather than
3149   one map for each, which saves is more compact and likely to be faster.
3151 chert backend:
3153 * xapian-check: For chert, check value stats are the correct format and that
3154   the streamed values are consistent with their stats (ticket#277).
3156 * xapian-check: Chert doesn't store termlist entries for documents without
3157   terms, which resulted in us reporting an error when we found document ids in
3158   the doclength "postlist" which were greater than any with an entry in the
3159   termlist.  Instead compare these entries against db.get_last_docid() if we
3160   are checking a whole db and the db can be opened.  If not, suppress this
3161   check.
3163 remote backend:
3165 * When serialising stats, serialise the termfreq and reltermfreq together,
3166   rather than in separate lists.  This gives a smaller serialised form, and
3167   matches these both being stored in the same map now.  This is an incompatible
3168   remote protocol change, so bump the major version to 32.  (ticket#362)
3170 build system:
3172 * Some build failures with --disable-backend-XXX options have been fixed, but
3173   we haven't exhaustively tested all combinations.
3175 * Ship common/win32_uuid.cc and common/win32_uuid.h (ticket#367).
3177 documentation:
3179 * Update PostingSource documentation to describe how init() is called again if
3180   a PostingSource is reused.  Fixes #352.
3182 portability:
3184 * Fixed to build with GCC 4.4.
3186 * Drop support for GCC 2.95.3 and 3.0.x - we now require at least 3.1 as doing
3187   so eliminates some preprocessor conditionals which we aren't able to test
3188   regularly as we don't have easy access to such old GCC versions.  GCC 3.1 is
3189   nearly 7 years old now, and GCC3 didn't get widespread use until later
3190   versions anyway.  If you still need to use GCC < 3.1, Xapian 1.0.x should
3191   build with 2.95.3 or newer.
3193 * Older versions of libuuid don't have uuid_unparse_lower() so probe for it in
3194   configure, and if it isn't present provide an inline version in safeuuid.h
3195   (ticket#368).
3197 * Fixed to build with MSVC (ticket#379).
3199 * Add static_cast<char>() to str(bool) overload to suppress bogus MSVC warning
3200   (ticket#377).
3202 debug code:
3204 * common/debuglog.h: Add missing initialisation of uncaught_exception variable
3205   in a couple of places.
3207 Xapian-core 1.1.0 (2009-04-22):
3209 API:
3211 * All deprecated xapian-core features listed for removal in 1.1.0 have been
3212   removed.  See deprecation.html for details, and suggested updates.
3214 * The Unicode character categorisation functions have been updated from
3215   Unicode 5.0 to 5.1.
3217 * Add NON_SPACING_MARK to is_wordchar() for better tokenisation of languages
3218   which use such marks - for example, Arabic.  This is better than the stop-gap
3219   fix in 1.0 of treating NON_SPACING_MARK as a phrase-generator character
3220   when parsing queries, but it does mean that databases built from data
3221   containing such characters will need to be rebuilt.  (ticket#355)
3223 * The details of how to subclass Xapian::Weight to implement your own
3224   weighting scheme have changed incompatibly to allow user weighting schemes
3225   to have access to the same statistics as built-in schemes (ticket#213)
3226   If you have a existing subclass of Xapian::Weight you'll need to update it.
3228 * New Database methods get_doclength_upper_bound(), get_doclength_lower_bound()
3229   and get_wdf_upper_bound(), primarily intended for allowing weighting schemes
3230   to calculate tighter upper bounds on weights (which BM25Weight and TradWeight
3231   now do) which allows matcher weight-based optimisations to be more effective.
3232   Chert actually tracks doclength bounds and a global (rather than per term)
3233   upper bound on wdf; other backends return much less tight bounds, but these
3234   still lead to better upper bounds on weights.
3236 * Enquire::get_eset() now uses an unmodified of probabilistic formula, and
3237   doesn't return terms which would get a negative weight from it (since that
3238   means they are expected to be harmful not helpful).
3240 * Add Database::close() method, which will release system resources (in
3241   particular, close filehandles) held by a database.  This is particularly
3242   useful when wrapping the API for languages with garbage collection.
3244 * Change Database::positionlist_begin() not to throw exceptions if the term or
3245   document doesn't exist.
3247 * Xapian databases now have a UUID, readable with Database::get_uuid().
3249 * A new Database replication API has been added (currently experimental).
3251 * MSet::get_termfreq() will now fall back to looking up the term frequency in
3252   the database rather than raising an exception if a term wasn't present in
3253   the query.
3255 * Calling RSet:add_document() with argument 0 now throws InvalidArgumentError.
3257 * QueryParser sped up (new version of lemon); queryparsertest runs 2.2% faster.
3259 * Add ValueSetMatchDecider, which is a matchdecider which is intended to be
3260   passed a set of values to look for in documents, and selects documents based
3261   on the presence of those values.
3263 * Add new Xapian::PostingSource class to allow passing custom sources of
3264   postings and weights to the matcher.  Built-in PostingSource subclasses:
3265   FixedWeightPostingSource, ValueMapPostingSource, ValuePostingSource, and
3266   ValueWeightPostingSource.  (Currently experimental).
3268 * Database: Add get_value_freq(), get_value_lower_bound() and
3269   get_value_upper_bound() methods to get statistics about the values stored in
3270   a slot.  Add support for the value statistics methods to chert, inmemory,
3271   multi and remote databases.
3273 * Enquire::get_eset() now faster for large ESet size.
3275 * Xapian::Document objects now have a reduced memory footprint.
3277 * Enquire::set_collapse_key() now allows you to specify a maximum number of
3278   matches with each collapse key to keep (which defaults to 1, giving the
3279   previous behaviour).  Enquire can now report bounds and an estimate of what
3280   the total number of matches would have been if collapsing wasn't in use.
3282 * WritableDatabase::commit() is a new, preferred alias for
3283   WritableDatabase::flush().  (ticket#266)
3285 * Add methods for serialising documents and queries to strings, and
3286   unserialising back from strings.  (ticket#206)
3288 testsuite:
3290 * stemtest: No longer checks environment variables OM_STEMTEST_SKIP_RANDOM,
3291   OM_STEMTEST_LANGUAGES, and OM_STEMTEST_SEED.
3293 * perftest: New performance testsuite.  This is intended to contain intended to
3294   contain potentially time-consuming performance tests, which log output to
3295   an XML file for later analysis.  It's not run by "make check" - use "make
3296   check-perf" to run it.
3298 * apitest: Now runs tests over both flint and chert for multi, remotetcp, and
3299   remoteprog.
3301 * Wait for subprocesses to finish at end of tests with remotetcp backend, to
3302   avoid test failures when the same database is used for the next testcase.
3304 matcher:
3306 * Internally, pass around non-normalised document lengths as Xapian::termcount
3307   (unsigned integer) not Xapian::doclength (double).  This gives a 3% speedup
3308   for 10 term OR queries!
3310 chert backend:
3312 * New development backend.  Use Chert::open() to explicitly create a chert
3313   format database, or set XAPIAN_PREFER_CHERT=1 in the environment to
3314   prefer chert when creating a new database without an explicit type.
3316 * Quartz and Flint stored the document length alongside every posting list
3317   entry.  Chert instead stores a chunked list of all the document lengths
3318   which saves a lot of space, and is a big win for large queries or those
3319   which don't need the document lengths.  This structure is used to
3320   implement much faster iteration (six times faster in a test) over all
3321   document ids (which speeds up queries using unary NOT, e.g. `NOT apples'),
3322   and to test for the existence of documents (instead of checking the record
3323   table for an entry).
3325 * Document values are now stored in a chunked stream for each slot for
3326   efficient access to the same slot in lots of documents.  This makes
3327   operations like sort by value much more efficient.
3329 * WritableDatabase::replace_document() now updates the database lazily in
3330   simple cases - for example, if you just change a document's values and
3331   replace it with the same docid, then the terms and document data aren't
3332   needlessly rewritten.  Caveats: currently we only check if you've looked at
3333   the values/terms/data, not if they've actually been modified, and only keep
3334   track of the last document read.
3336 flint backend:
3338 * If we can't obtain a write lock while trying to create a new database
3339   we now report the lock failure with DatabaseLockError, not
3340   DatabaseOpeningError - it's more useful to know that the lock attempt failed
3341   in this situation.
3343 * Improve reporting of failures to obtain lock due to unexpected errors.
3345 * xapian-check: Don't stop checking a table after an error in certain cases -
3346   instead increment the error counter and try to continue checking from the
3347   next item.
3349 remote backend:
3351 * The remote database protocol major version has been increased, allowing
3352   a significant amount of compatibility code to be removed.  This change means
3353   that new clients won't work with old servers, and old clients won't work
3354   with new servers.  If upgrading a live system, you will need to take this
3355   into account.
3357 * The remote servers now always default to opening a Database and the client
3358   has to send a protocol message to explicitly request write access.  This
3359   allows a single server to support multiple readers and one writer
3360   simultaneously.  (ticket#145)
3362 * Database::get_document() no longer does an unnecessary copy of the document's
3363   values.
3365 * Change serialisation of queries to be more compact and easier to parse.
3367 stub databases:
3369 * Stub databases used to assume that any relative paths were relative to the
3370   current working directory.  They now assume that relative paths are
3371   relative to the directory holding the stub database file.
3373 * Stub database lines which begin with a '#' character are now ignored,
3374   allowing comments in stub database files.
3376 * New "stub directory" database type - this is a directory containing a stub
3377   database file named "XAPIANDB".
3379 * Don't just ignore lines with no spaces in a stub database file.
3381 * Bad lines in a stub file were being ignored after we'd seen a good entry.
3383 * Add new Auto::open_stub() overload which opens a stub database file
3384   containing a single entry as a WritableDatabase.
3386 * Add support for "inmemory" to stub database (which is useful now that stub
3387   databases can be opened for writing).
3389 * A stub database file is now allowed to contain no database entries, which
3390   results in an empty Database object (this avoids user code having to special
3391   case to handle "0 or more" databases).
3393 build system:
3395 * To allow installations of Xapian 1.0 and 1.1 to easily coexist, the library
3396   is now libxapian-1.1; xapian.m4 is now xapian-1.1.m4; headers are now
3397   installed in $prefix/include/xapian-1.1.  If you use XO_LIB_XAPIAN or
3398   xapian-config as we recommend, this should all be transparent.  Also
3399   programs and scripts have a default program suffix to -1.1 unless overridden
3400   using the --program-suffix argument to configure (if you really want no
3401   suffix, "./configure --program-suffix=" will achieve this).
3403 * On Linux and k*bsd-gnu, override libtool's link_all_deplibs_CXX to "no".
3405 * On Linux, override libtool's sys_lib_dlsearch_path_spec to a list generated
3406   in a more reliable way which includes all the default directories.
3408 * configure: --enable-debug and --enable-debug-verbose have been deprecated
3409   since 1.0.0, so remove specific errors pointing to the replacements.
3411 documentation:
3413 * Disable "JAVADOC_AUTOBRIEF" in doxygen configuration since we always try to
3414   write a brief description explicitly, and JAVADOC_AUTOBRIEF causes problems
3415   in some cases.
3417 * docs/deprecation.html: Describe what "experimental" features are, and why
3418   replication and posting sources are currently experimental.
3420 * docs/deprecation.html: Deprecate Stem_get_available_languages() from the
3421   python bindings.
3423 examples:
3425 * Use C++ forms of C headers in examples (ticket#330).
3427 packaging:
3429 * xapian-core.spec: We no longer need to run autoreconf to work around
3430   libtool's incomplete sys_lib_dlsearch_path_spec or to pick up distro-specific
3431   patches for link_all_deplibs.
3433 debug code:
3435 * Report get_description() rather than the pointer value for
3436   Xapian::Query::Internal* parameters to internal functions.
3438 * The debug logging framework has been overhauled.  See HACKING for details
3439   of how it now works.
3441 * Faster integer to string functions inside the library (this is a general
3442   improvement, but will particularly speed up debug logging as that converts a
3443   lot of integers to strings).
3445 Xapian-core 1.0.23 (2011-01-14):
3447 API:
3449 * QueryParser: Avoid a double free if Query construction throws an exception
3450   in a particular case.  Fixes ticket#515.
3452 * QueryParser: Handle NEAR/<offset> and ADJ/<offset> where offset isn't an
3453   integer the same way at the end of the query as in the middle.
3455 * Enquire::get_mset(): Avoid pointlessly trying to allocate lots of memory
3456   if the first document requested is larger than the size of the database.
3458 * Enquire::get_mset(): An empty query now returns an MSet with firstitem set
3459   correctly - previously firstitem was always 0 in this case.
3461 matcher:
3463 * The matcher wasn't recalculating the max possible weight after a subquery of
3464   XOR reached its end.  This caused an assertion failure in debug builds, and
3465   is a missed optimisation opportunity.
3467 tools:
3469 * xapian-compact: Fix access to empty priority_queue while merging synonyms.
3470   This could have caused problems, though we've had no reports of any (the
3471   bug was found with _GLIBCXX_DEBUG).
3473 Xapian-core 1.0.22 (2010-10-03):
3475 API:
3477 * Xapian::Document: Initialise docid to 0 when creating a document from
3478   scratch, as documented.
3480 * Xapian::QueryParser: Allow phrase generators between a probabilistic prefix
3481   and the term itself (e.g. path:/usr/local).
3483 matcher:
3485 * Back out the OP_OR efficiency improvement made in 1.0.21 since this change
3486   slows down some other common cases.  We'll address this fully in 1.2.4, but
3487   that fix is more invasive than we are comfortable with for 1.0.x at this
3488   point.
3490 build system:
3492 * xapian-config: Add --static option which makes other options report values
3493   for static linking.
3495 documentation:
3497 * deprecation.html: Add guidelines for supporting other software.
3499 * Document cases where QueryParser's FLAG_WILDCARD and FLAG_PARTIAL aren't
3500   currently supported.
3502 * Fix documentation for Xapian::timeout type - it holds a time interval in
3503   milliseconds not microseconds (the API docs for the methods which use it
3504   explicitly correctly document that the timeouts are in milliseconds).
3506 portability:
3508 * configure: Don't pass -mtune=generic unless GCC >= 4.2 is in use
3509   (ticket#492).
3511 * configure: Add support for --enable-sse=sse and --enable-sse=sse2 to allow
3512   control of which SSE instructions to use.
3514 * configure: Enable use of SSE maths on x86 by default with Sun's compiler.
3516 * configure: Beef up the test for whether -lm is required and add a special
3517   case to force it to be for Sun's C++ compiler - there's some interaction with
3518   libtool and/or shared objects which means that the previous configure test
3519   didn't think -lm is needed here when it is.
3521 * Fix test harness to build under Microsoft Windows (ticket#495).
3523 * Fix to build on OpenBSD 4.5 with GCC 3.3.5.
3525 * Need to avoid excess precision on m68k when targeting models 68010, 68020,
3526   68030 as well as 68000.
3528 packaging:
3530 * xapian-core.spec: Add cmake related files to RPM packaging.
3532 Xapian-core 1.0.21 (2010-06-18):
3534 API:
3536 * Xapian::Stem now recognises "nb" and "nn" as additional codes for the
3537   Norwegian stemmer.
3539 * Xapian::QueryParser now correctly parses a wildcarded term in between two
3540   other terms (ticket#484).
3542 testsuite:
3544 * Improve test coverage of OP_VALUE_RANGE and MSet::get_percent().
3546 matcher:
3548 * OP_OR could skip a matching document if it decayed to OP_AND or OP_AND_MAYBE
3549   during the match in some cases.  Fixes ticket#476.
3551 * OP_XOR with non-leaf subqueries could skip matching documents in some cases,
3552   and OP_XOR of three or more sub-queries could return incorrect weights.
3553   Fixes ticket#475.
3555 * OP_OR is now more efficient if a subquery is potentially expensive (e.g.
3556   ValueRangePostList, OP_NEAR, OP_PHRASE).  A 10-fold speed-up with
3557   ValueRangePostList has been observed.
3559 flint backend:
3561 * When iterating a table, if the table changes underneath we could end up
3562   returning the same entry twice.  (Debian#579951)
3564 * A cancelled transaction (or a failing operation implicitly cancelling
3565   pending changes) now marks the tables as unmodified, which fixes an exception
3566   trying to read block 0 if one of the tables is empty on disk.
3568 quartz backend:
3570 * When iterating a table, if the table changes underneath we could end up
3571   returning the same entry twice.  (Debian#579951)
3573 remote backend:
3575 * When daemonising, read the max fd to close with sysconf() instead of using
3576   a hardcoded value of 256, and work even if stdin and stdout have been closed.
3578 build system:
3580 * Install files to make Xapian easier to use with cmake.
3582 documentation:
3584 * Update the list of languages that the Xapian::Stem constructor recognises.
3586 * Assorted minor improvements to the collated API documentation.
3588 portability:
3590 * On x86 processors, Xapian now defaults to using SSE2 FP instructions.  This
3591   avoids issues with excess precision and it a bit faster too.  If you need
3592   to support processors without SSE2 (this means pre-Pentium4 for Intel) then
3593   configure with --disable-sse.  (ticket#387)
3595 * Fix warning when compiling for mingw with GCC 4.2.1.
3597 * Remove mutable from a couple of reference class members - mutable doesn't
3598   make sense for a reference and some compilers warn about it.
3600 Xapian-core 1.0.20 (2010-04-27):
3602 API:
3604 * MSet: Fix incorrect values reported by get_matches_estimated(),
3605   get_matches_lower_bound(), and get_matches_upper_bound() in certain cases
3606   when sorting and collapsing (ticket#464).
3608 documentation:
3610 * deprecation.html: Note how to disable deprecation warnings. (ticket#393)
3612 examples:
3614 * delve: Add -a option to list all terms in a database.
3616 * delve: -d and -V command line options now report out of range and invalid
3617   numbers.
3619 portability:
3621 * The getopt warning fix for Cygwin in 1.0.19 caused build failures on Mac OS X
3622   (and probably some other platforms with non-GNU getopt implementations), so
3623   replace with a fix which is only enabled for Cygwin. (ticket#469)
3625 Xapian-core 1.0.19 (2010-04-15):
3627 API:
3629 * QueryParser: Fix leak if Xapian::Database throws an exception during parsing
3630   (ticket#462).
3632 testsuite:
3634 * Explicitly flush after indexing for quartz and flint, so we see any
3635   exceptions from the flush (the implicit flush from the destructor swallows
3636   any exceptions).
3638 * apitest: Add databasemodified1 testcase to provide some test coverage for
3639   DatabaseModifiedError.
3641 flint backend:
3643 * When updating a document, rather than decoding the old positions, comparing
3644   with the new, and then encoding the new if different, we now just encode the
3645   new and then compare the encoded forms.  (ticket#428)
3647 * Avoid trying to delete the document positions when we know there aren't any.
3649 * Fix memory leak if Database::allterms_begin() throws an exception
3650   (ticket#462).
3652 * xapian-check: Report document id for document length mismatch.
3654 * Fix potential issues with iterators over a WritableDatabase which is modified
3655   during iteration.  No problems have actually been observed with flint, only
3656   in 1.1.4 with chert in cases which don't occur in flint, but it seems likely
3657   the issue can manifest for flint in other situations.  Fixes ticket#455.
3659 * Initialise zlib z_stream structure members zalloc, zfree, and opaque with
3660   Z_NULL rather than 0 cast to the appropriate type, as that's what the zlib
3661   documentation says to do.  Add missing initialisation of opaque for the
3662   inflate z_stream which the zlib docs say is needed (reading the zlib code,
3663   this isn't true for current versions, so this improves robustness rather
3664   than fixing an observable bug).
3666 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
3667   undefined behaviour (as a block overlaps itself).
3669 quartz backend:
3671 * Fix potential issues with iterators over a WritableDatabase which is modified
3672   during iteration.  No problems have actually been observed with quartz, only
3673   in 1.1.4 with chert in cases which don't occur in quartz, but it seems likely
3674   the issue can manifest for quartz in other situations.  Fixes ticket#455.
3676 * Don't memcpy() a block to itself - it's a waste of effort, and (probably)
3677   undefined behaviour (as a block overlaps itself).
3679 build system:
3681 * Force -fno-strict-aliasing for GCC 4.2 to avoid bad code being generated due
3682   to a bug in that compiler version.  Fixes ticket#449.  This issue hasn't been
3683   observed to affect Xapian 1.0.x, but it seems prudent to backport the fix.
3685 documentation:
3687 * INSTALL: Correct description of --enable-assertions.  It does NOT enable
3688   debugging symbols, and shouldn't control checks on bad data passed to API
3689   calls (if it does anywhere, that's a bug).  Note that Xapian will run more
3690   slowly with assertions on.
3692 * spelling.html:
3694   + Add section on indexing.
3696   + Add a note about removing automatically added spelling dictionary entries.
3698   + Move the "algorithm" section to the end, as it is really just background
3699     information for the curious.
3701 * include/xapian/queryparser.h: Document the possible exception messages from
3702   QueryParser::parse_query().
3704 * include/xapian/termgenerator.h: Note how TermGenerator handles stopwords.
3706 examples:
3708 * delve: Display the lastdocid value when displaying general database
3709   statistics.
3711 * simpleindex: Explicitly call flush() on the database, as that is good
3712   practice (since you see any exceptions).
3714 portability:
3716 * Fix compilation failure in testsuite on OpenBSD, introduced by new regression
3717   test in 1.0.18.  Fixes ticket#458.
3719 * Fix getopt-related warning on Cygwin.
3721 Xapian-core 1.0.18 (2009-02-14):
3723 API:
3725 * Document: Add new add_boolean_term() method, which is an alias for add_term()
3726   with wdfinc=0.
3728 * QueryParser:
3730   + Add support for quoting boolean terms so they can contain arbitrary
3731     characters (partly addresses ticket#128).
3733   + Add ENCLOSING_MARK and COMBINING_SPACING_MARK categories, plus several
3734     zero-width space characters, as phrase generators.  This mirrors a better
3735     fix in 1.1.4, but without losing compatibility with existing databases.
3737   + Fix handling of an explicit AND before a hated term (foo AND -bar).
3738     (ticket#447)
3740 * TermIterator: Only include trailing '+' or '#' on a term if it isn't followed
3741   by a word character (makes more sense and matches QueryParser's behaviour).
3742   (ticket#446)
3744 * Database: Fix many methods to behave better on a database with no
3745   subdatabases, such as is constructed by Database().  Fixes ticket#415.
3747 testsuite:
3749 * Add test coverage for xapian-compact, and improve coverage for
3750   WritableDatabase::replace_document().
3752 * apitest: Rename matchfunctor<n> to matchdecider<n> to match current
3753   terminology.
3755 flint backend:
3757 * When updating documents, don't update posting entries which haven't changed.
3758   Largely fixes ticket #250.
3760 * If the number of entries in the position table happened to be 4294967296 or
3761   an exact multiple, Xapian would ignore positional data for that table when
3762   running queries, and xapian-compact wouldn't copy its contents.
3764 * Iterating all the terms in the database with a prefix is now slightly more
3765   efficient.
3767 * Fix locking code to work if stdin and/or stdout have been closed.
3769 * If a document is replaced with itself unmodified, we no longer increase the
3770   automatic flush counter.
3772 * When iterating a posting list modified since the last flush(), the reported
3773   wdf is now correct (previously it was too high by its old value).
3775 * Replacing a document deleted since the last flush failed to update the
3776   collection frequency and wdf, and caused an assertion failure when assertions
3777   were enabled.
3779 * WritableDatabase::replace_document() didn't always remove old positional
3780   data (the only effect is that the position table was bloated by unwanted
3781   entries).
3783 * xapian-inspect:
3785   + New "until" command which shows entries until a specified key is reached.
3787   + New "open" command which allows easy switching between tables.
3789 * xapian-compact: Fix typos in --help output.
3791 quartz backend:
3793 * Replacing a document deleted since the last flush failed to update the
3794   collection frequency and wdf, and caused an assertion failure when assertions
3795   were enabled.
3797 * WritableDatabase::replace_document() didn't always remove old positional
3798   data (the only effect is that the position table was bloated by unwanted
3799   entries).
3801 remote backend:
3803 * Throw UnimplementedError if a MatchDecider is used with the remote backend.
3804   Previously Xapian returned incorrect results in this case.
3806 build system:
3808 * configure: With --enable-maintainer-mode, enable -Werror for GCC >= 4.1
3809   rather than >= 4.0 as Apple's GCC 4.0 gives bogus uninitialised variable
3810   warnings.
3812 documentation:
3814 * The API documentation now includes Xapian::Error and subclasses, and doesn't
3815   mention Xapian::Query::Internal.
3817 * Make clear in the Xapian::Document API documentation that this class is a
3818   lazy handle and discuss the issues this can cause.
3820 * INSTALL: Improve text about zlib dependency.
3822 * HACKING: Add details of our licensing policy for accepting patches.
3824 examples:
3826 * quest: If no database is specified, still parse the query and report
3827   Query::get_description() to provide an easy way to check how a query parses.
3829 portability:
3831 * Fix GCC 4.2 warning.
3833 xapian-core 1.0.17 (2009-11-18):
3835 API:
3837 * QueryParser:
3839   + Fix handling of a group of two or more terms which are all stopwords which
3840     notably caused issues when default_op was OP_AND, but could probably
3841     manifest in other cases too.  Fixes ticket#406.
3843   + Fix interaction of FLAG_PARTIAL and FLAG_SYNONYM.  (ticket#407)
3845 * Database: A database created via the default constructor no longer causes a
3846   segfault when the methods get_metadata() or metadata_keys_begin() are called.
3848 flint backend:
3850 * Don't try to close the fd one more than the maximum allowable when locking
3851   the database.  Harmless, except it causes a warning when running under
3852   valgrind.  (ticket#408)
3854 remote backend:
3856 * Xapian::Sorter isn't supported with the remote backend so throw
3857   UnimplementedError rather than giving incorrect results.  (ticket#384)
3859 * Fix potential reading off the end of the MSet which is returned internally
3860   by the remote server.
3862 documentation:
3864 * Various documentation comment improvements for the Database class.
3866 examples:
3868 * examples/quest.cc: Tighten up the type of the error we catch to detect an
3869   unknown stemming language.
3871 portability:
3873 * xapian-config: Need to quote ^ for Solaris /bin/sh.
3875 * configure: Actually use any flags we determine are needed to switch the
3876   compiler to proper ANSI C++ mode, when building xapian-core - this stopped
3877   working in 1.0.12, breaking support for HP's aCC, Compaq's cxx, Sun's CC, and
3878   SGI's CC.
3880 Xapian-core 1.0.16 (2009-09-10):
3882 flint backend:
3884 * Fix a typo which stopped this fix in 1.0.12 from working (ticket #398):
3886   If we fail to get the lock after we spawn the child lock process (the common
3887   case is because the database is already open for writing) then we now clean
3888   up the child process properly.
3890 documentation:
3892 * Improve API documentation of QueryParser::set_default_op() and
3893   QueryParser::get_default_op().
3895 portability:
3897 * Fix build failure on Mac OS X 10.6.
3899 Xapian-core 1.0.15 (2009-08-26):
3901 testsuite:
3903 * Fix the test harness not to report heaps of bogus errors when using valgrind
3904   3.5.0.
3906 flint backend:
3908 * Backport the lazy update changes from 1.1.2:
3910   WritableDatabase::replace_document() now updates the database lazily in
3911   simple cases - for example, if you just change a document's values and
3912   replace it with the same docid, then the terms and document data aren't
3913   needlessly rewritten.  Caveats: currently we only check if you've looked at
3914   the values/terms/data, not if they've actually been modified, and only keep
3915   track of the last document read.
3917 * Fix PostingIterator::skip_to() on an unflushed WritableDatabase to skip
3918   documents which were added and deleted since the last flush.  (ticket#392)
3920 documentation:
3922 * Overhaul the doxygen options we use and tweak various documentation comments
3923   to improve the generated API documentation.
3925 * Explicitly document that an empty prefix argument to
3926   QueryParser::add_prefix() means "no prefix".
3928 * Update the documentation comments for Enable::set_sort_by_value(),
3929   set_sort_by_value_then_relevance(), and set_sort_by_relevance_then_value() to
3930   mention sortable_serialise() as a good way to store numeric values for
3931   sorting.
3933 Xapian-core 1.0.14 (2009-07-21):
3935 API:
3937 * When using more than one ValueRangeProcessor, QueryParser didn't reset the
3938   begin and end strings to ignore any changes made by a ValueRangeProcessor
3939   which returned false, so further ValueRangeProcessors would see any changes
3940   it had made.  This is now fixed, and test coverage improved.
3942 testsuite:
3944 * The test harness code which launches xapian-tcpsrv child processes was
3945   failing to close a file descriptor for each one launched due to a bug in
3946   the code which is meant to track them.  This was causing apitest to fail
3947   on OpenBSD (ticket#382).  Also wait between testcases for any spawned
3948   xapian-tcpsrv processes to exit to avoid spurious failures when a database is
3949   reused by the next testcase.
3951 * tests/runtest.in: Use "ulimit -n" where available to limit the number of
3952   available file descriptors to 64 so we catch file descriptor leaks sooner.
3954 * When measuring CPU time used for scalability tests, we no longer try to
3955   include the CPU time used by child processes, as we can only get that for
3956   child processes which have exited and it's hard to ensure that they have
3957   with the current framework.  Although this means we only tests the
3958   client-side scaling for remote tests, the local backend tests cover most of
3959   the work done by the server part of the remote backend.
3961 * apitest: In testcase topercent2, don't expect max_attained or max_possible to
3962   be exact as rounding errors in different ways of calculating can cause small
3963   variations.  On trunk we already have similar code because the new weighting
3964   scheme stuff gives different bounds in the different cases.  This should fix
3965   testsuite failures seen on some of the Debian and Ubuntu buildds.
3967 * The test harness now always reports the full exception message (was
3968   conditional on --verbose), and output for different exception types and
3969   other causes of failure is now more consistent.
3971 * For scalability tests, the test harness now increases the number of
3972   repetitions until the first run takes more than 0.001 seconds, to avoid
3973   trying to base calculations on a length of time we probably can't reliably
3974   measure to start with.
3976 * Add test coverage for Stem::get_description() for each supported language.
3978 * queryparsertest: Reenable tests which require the inmemory backend to be
3979   enabled by fixing typo XAPIAN_HAS_BACKEND_INMEMORY ->
3980   XAPIAN_HAS_INMEMORY_BACKEND.
3982 flint backend:
3984 * Use F_FULLFSYNC where available (Mac OS X currently) to ensure that changes
3985   have been committed to disk.  (ticket#288)
3987 remote backend:
3989 * Fix handling of percentage weights in various cases when we're searching
3990   multiple remote databases or a mix of local and remote databases.
3992 build system:
3994 * configure: -Wshadow produces false positives with GCC 4.0, so only enable it
3995   for >= 4.1 since we enable -Werror for maintainer-mode builds for GCC >= 4.0.
3997 * configure: Check that we can find the valgrind/memcheck.h header as well as
3998   the valgrind binary.
4000 * Change how snowball generates the data used by its among operation - instead
4001   of using pointers to the strings in struct among, store an offset into a
4002   constant pool, as this reduces the number of relocations by about 2300, which
4003   should decrease the time taken by the dynamic linker when loading the
4004   library.  This also reduces the size of the shared library significantly
4005   (on x86-64 Linux, the stripped shared library is 4% smaller).
4007 Xapian-core 1.0.13 (2009-05-23):
4009 API:
4011 * Xapian::Document no longer ever stores empty values explicitly.  This
4012   wasn't intentional behaviour, and how this case was handled wasn't
4013   documented.  The amended behaviour is consistent with how user metadata
4014   is handled.  This change isn't observable using Document::get_value(),
4015   but can be noticed when iterating with Document::values_begin(), using
4016   Document::values_count(), or trying to delete the value with
4017   Document::remove_value().
4019 testsuite:
4021 * Fix testcase scaleweight4 not to fail on x86 when compiled with -O0.  The
4022   problem was in the testcase code, and was caused by excess precision in
4023   intermediate FP values.
4025 * Testcases which check that operations have the expected O(...) behaviour now
4026   check CPU time instead of wallclock time on most platforms, which should
4027   eliminate occasional failures due to load spikes from other processes.
4028   (ticket#308)
4030 * Fix test failures due to SKIP_TEST_FOR_BACKEND("inmemory") not skipping when
4031   it should due to comparing char * strings with == (on trunk the return value
4032   being tested is std::string rather than const char *).
4034 * Improve test coverage in several corner cases.
4036 * Fix testcase consistency2 to actually be run (fortunately it passes).
4038 * In the generated testcases, call get_description() on the default
4039   constructed object of each class to make sure that works (and doesn't try to
4040   dereference NULL, or fail some assertion, etc).  All currently checked
4041   classes are fine - this is to avoid future regressions or such problems with
4042   new classes.
4044 * In the test coverage build, use "--coverage" instead of "-fprofile-arcs
4045   -ftest-coverage".
4047 * The test harness now has the inmemory backend flagged as supporting
4048   user-specified metadata (apart from iteration over metadata keys).
4050 matcher:
4052 * If a query contains a MatchAll subquery, check for it before checking the
4053   other terms so that the loop which checks how many terms match can exit
4054   early if they all match.
4056 * When an OR or ANY_MAYBE decayed to an AND, we were carefully swapping the
4057   children for maximum efficiency, but the condition was reversed so we were
4058   in fact making things worse.  This was noticed because it was resulting in
4059   the same query running faster when more results were asked for!
4061 * Only build the termname to termfreq and weight map for the first subdatabase
4062   instead of rebuilding it for each one.  Also don't copy this map to return
4063   it.  This should speed up searches a little, especially those over multiple
4064   databases.
4066 * If a submatcher fails but ErrorHandler tells us to continue without it, we
4067   just use a NULL pointer to stand in rather than allocating a special dummy
4068   place-holder object.
4070 * Remove AndPostList, in favour of MultiAndPostList.  AndPostList was only used
4071   as a decay product (by AndMaybePostList and OrPostList), and doesn't appear
4072   to be any faster.  Removing it reduces CPU cache pressure, and is less code
4073   to maintain.
4075 * Call check() instead of skip_to() on the optional branch of AND_MAYBE.
4077 flint backend:
4079 * Fix a bug in TermIterator::skip_to() over metadata keys.
4081 remote backend:
4083 * Fix xapian-tcpsrv --interface option to work on MacOS X (ticket#373).
4085 * Fix typo which caused us to return the docid instead of the maximum weight
4086   a document from a remote match could return!  This could have led to wrong
4087   results when searching multiple databases with the remote backend, but
4088   probably usually didn't matter as with BM25 the weights are generally small
4089   (often all < 1) while docids are inevitably >= 1.
4091 inmemory backend:
4093 * The inmemory backend doesn't support iterating over metadata keys.  Trying
4094   to do so used to give an empty iteration, but has now been fixed to throw
4095   UnimplementedError (and this limitation has now been documented).
4097 build system:
4099 * Remove a lot of unused header inclusions and some unused code which should
4100   make the build faster and slightly smaller.
4102 * Fix to compile under --disable-backend-flint, --disable-backend-remote, and
4103   --disable-backend-inmemory.
4105 * Don't remove any built sources in "make clean" even under
4106   --make-maintainer-mode as that breaks switching a tree away from
4107   maintainer-mode with: make distclean;./configure
4109 * configure: Enable more GCC warnings - "-Woverloaded-virtual" for all
4110   versions, "-Wstrict-null-sentinel" for 4.0+, "-Wlogical-op
4111   -Wmissing-declarations" for 4.3+.  Notably "-Wmissing-declarations" caught
4112   that consistency2 wasn't being run.
4114 * Internally, fix the few places where we pass std::string by value to pass
4115   by const reference instead (except where we need a modifiable copy anyway) as
4116   benchmarking shows that const reference is slightly faster and generates
4117   less code with GCC's reference counted std::string implementation - with a
4118   non-reference counted implementation, const reference should be much faster.
4119   (ticket#140)
4121 documentation:
4123 * INSTALL: We no longer regularly test build with GCC 2.95.4 and we're raising
4124   the minimum GCC version required to 3.1 for Xapian 1.1.x.
4126 * Document what passing maxitems=0 to Enquire::get_mset() does.
4128 * docs/queryparser.html: Add examples of using a prefix on a phrase or
4129   subexpression.
4131 * Correct doxygen comments for user metadata functions:
4132   Database::get_metadata() can't throw UnimplementedError but
4133   WritableDatabase::set_metadata() can.
4135 * Document that Database::metadata_keys_begin() returns an end iterator if the
4136   backend doesn't support metadata.
4138 * HACKING: Update the list of Debian/Ubuntu packages needed for a development
4139   environment.
4141 debug code:
4143 * Fix build with --enable-debug.
4145 * Added some more assertions.
4147 Xapian-core 1.0.12 (2009-04-19):
4149 API:
4151 * WritableDatabase::remove_spelling() now works properly.
4153 * The QueryParser now treats NON_SPACING_MARK Unicode characters as phrase
4154   generators, which improves handling of Arabic.  This is a stop-gap solution
4155   for 1.0.x which will work with existing databases without requiring
4156   reindexing - in 1.1.0, NON_SPACING_MARK will be regarded as part of a word.
4157   (ticket#355)
4159 * Fix undefined behaviour in distribution of OP_NEAR and OP_PHRASE over a
4160   non-leaf subquery (indentified by valgrind on testcase nearsubqueries1).
4161   (ticket#349)
4163 * Enhance distribution of OP_NEAR/OP_PHRASE over non-leaf subqueries to work
4164   when there are multiple non-leaf subqueries (ticket#201).
4166 * Enquire::get_mset() no longer needlessly checks if the documents exist.
4168 * PostingIterator::get_description() output improved visually in some cases.
4170 testsuite:
4172 * Add make targets to assist generating a testsuite code coverage report with
4173   lcov.  See HACKING for details.
4175 * Improved test coverage in a number of places and removed some used code as
4176   shown by lcov's coverage report.
4178 flint backend:
4180 * xapian-compact:
4182   + Now handles databases which contains no documents but have user metadata
4183     (ticket#356).
4185   + Fix test for the total document length overflowing.
4187 * Release the database lock if the database is closed due to an unrecoverable
4188   error during modifications. (ticket#354)
4190 * If we fail to get the lock after we spawn the child lock process (the common
4191   case is because the database is already open for writing) then we now clean
4192   up the child process properly.
4194 build system:
4196 * Overriding CXXFLAGS at make-time (e.g. "make CXXFLAGS=-Os") no longer
4197   overrides any flags configure detected to be required to make the compiler
4198   accept ISO C++ (for GCC, no such flags are required, so this doesn't
4199   change anything).
4201 documentation:
4203 * Update documentation and code comments to reflect that 1.1 will be a
4204   development series, and 1.2 the next release series.
4206 * docs/admin_notes.html: Document the child process used for locking which
4207   exec-s "cat" (ticket #258).
4209 * include/xapian/unicode.h: Fix documentation comment typos.
4211 * include/xapian/matchspy.h: Removed currently unused header to stop doxygen
4212   from generating documentation for it.
4214 Xapian-core 1.0.11 (2009-03-15):
4216 API:
4218 * Enquire::get_mset():
4220   + Now throws UnimplementedError if there's a percentage cutoff and sorting is
4221     primarily by value - this has never been correctly supported and it's
4222     better to warn people than give incorrect results.
4224   + No longer needlessly copies the results internally.
4226   + When searching multiple databases, now recalculates the maximum attainable
4227     weight after each database which may allow it to terminate earlier.
4228     (ticket#336).
4230   + Fix inconsistent percentage scores when sorting primarily by value, except
4231     when a MatchDecider is also being used; document this remaining problem
4232     case.  (ticket#216)
4234 * Enquire::set_sort_by_value() (and similar methods): Rename the wrongly named
4235   "ascending" parameter to "reverse", and note that its value should always be
4236   explicitly given since defaulting to "reverse=true" is confusing and the
4237   default will be deprecated in 1.1.0.  (ticket#311)
4239 * Database::allterms_begin(): Fix memory leak when iterating all terms from
4240   more than one database.
4242 * Query::get_terms_begin(): Don't return "" from the TermIterator (happened
4243   when the query contained or was Query::MatchAll).
4245 * Add QueryParser::FLAG_DEFAULT to make it easier to add flags to those set by
4246   default.
4248 testsuite:
4250 * The testsuite now reports problems detected by valgrind with newer valgrind
4251   versions.  Drop support for running the testsuite under valgrind < 3.3.0
4252   (well over a year old) as this greatly simplifies the configure tests.
4254 * Fix usage message for options which take arguments in --help output from test
4255   programs - "-x=foo" doesn't work, the correct syntax is "-x foo".
4257 * If comparing MSet percentages fails, report the differing percentages if in
4258   verbose mode.
4260 * Add test that backends don't truncate total document length to 32 bits.
4262 * Disable lockfileumask1 (regression testcase added in 1.0.10) on Cygwin and on
4263   OS/2.
4265 flint backend:
4267 * The configure test for pread() and pwrite() got accidentally disabled in
4268   0.8.4 and we've always been using llseek() followed by read() or write()
4269   since then.  The configure test is now fixed, and gives a slight speedup
4270   (3% measured for searching).
4272 * The child process used to implement WritableDatabase locking now changes
4273   directory to / so that it doesn't block unmounting of any partitions and
4274   closes any open file descriptors which aren't relating to locking so that
4275   if those files are closed by our parent and deleted the disk space gets
4276   released right away.
4278 * We now reuse the same zlib zstream structures rather than using a fresh
4279   one for each operation.  This doesn't make a measurable difference in
4280   our own tests on Linux but reportedly is measurably faster on some
4281   systems.  (ticket #325)
4283 quartz backend:
4285 * The pread()/pwrite() fix also speeds up quartz.
4287 remote backend:
4289 * Avoid copying Query::Internal objects needlessly when unserialising Query
4290   objects.
4292 inmemory backend:
4294 * Store the (non-normalised) document lengths as Xapian::termcount (unsigned
4295   int) rather than Xapian::doclength (double) which saves 4 bytes per document.
4297 build system:
4299 * configure: The output of g++ --version changed format (again) with GCC 4.3
4300   which meant configure got "g++" for the version.  Instead use the (hopefully)
4301   more robust technique of using g++ -E to pull out __GNUC__ and
4302   __GNUC_MINOR__.
4304 documentation:
4306 * API documentation:
4308   + WritableDatabase::flush() can't throw DatabaseLockError.
4310   + WritableDatabase's constructor can throw at least DatabaseCorruptError or
4311     DatabaseLockError.
4313   + Document how to get all matches from Enquire::get_mset().
4315   + Other minor improvements.
4317 * docs/sorting.html: Clarify meaning.
4319 portability:
4321 * Fix "#line" directives in generated file queryparser/queryparser_internal.cc
4322   to give a relative path - previously they had a full path when generated by a
4323   VPATH build (as release tarballs are), and this confused GCC 2.95 and
4324   depcomp.
4326 * Fix for compiling with Sun's compiler (untested as we no longer have access
4327   to it).
4329 Xapian-core 1.0.10 (2008-12-23):
4331 API:
4333 * Composing an OP_NEAR query with two non-term subqueries now throws
4334   UnimplementedError instead of AssertionError (in a --enable-assertions build)
4335   or leading to unexpected results (otherwise).  This partly addresses bug#201.
4337 * Using a MultiValueSorter with no values set no longer causes a hang or
4338   segmentation fault (but it is still rather pointless!)
4340 matcher:
4342 * If we're using values for sorting and for another purpose, cache the
4343   Document::Internal object created to get the value for sorting, like we do
4344   between other uses.
4346 flint backend:
4348 * If the disk became full while flushing database changes to disk, the
4349   WritableDatabase object would throw a DatabaseError exception but be left in
4350   an inconsistent state such that further use could lead to the database on
4351   disk ending up in a "corrupt" state (theoretically fixable, but no tool
4352   to fix such a database exists).  Now we try to ensure that the object is
4353   left in a consistent state, but if doing so throws a further exception, we
4354   put the WritableDatabase object in a "closed" state such that further
4355   attempts to use it throw an exception.
4357 * Create the lockfile "flintlock" with permissions 0666 so that the umask is
4358   honoured just like we do for the other files (previously we used 0600).
4359   Previously it wasn't possible to lock a database for update if it was
4360   owned by another user, even if you otherwise had sufficient permissions via
4361   "group" or "other".
4363 * Fix garbled exception message when a base file can't be reread.
4365 quartz backend:
4367 * Fix garbled exception message when a base file can't be reread.
4369 remote backend:
4371 * xapian-tcpsrv and xapian-progsrv now accept -w as a short form of --writable,
4372   as was always intended.
4374 build system:
4376 * This release now uses newer versions of the autotools (autoconf 2.62 ->
4377   2.63; automake 1.10.1 -> 1.10.2).
4379 documentation:
4381 * INSTALL: Add new paragraphs about HP's aCC and IRIX (adapted from footnotes
4382   in PLATFORMS).
4384 * PLATFORMS: HP testdrive has been shut down, so all mark all those machines as
4385   "no longer available".  Update atreus' build report to 1.0.10.
4387 * docs/queryparser.html: Add link to valueranges.html.
4389 examples:
4391 * delve: Add missing "and" to --help output.  Report termfreq and collection
4392   freq for each term we're asked about.
4394 portability:
4396 * Fix to build with GCC 4.4 snapshot.
4398 Xapian-core 1.0.9 (2008-10-31):
4400 API:
4402 * Database::get_spelling_suggestion() is now faster (15% speed up for parsing
4403   queries with FLAG_SPELLING_CORRECTION set in a test on real world data).
4405 * Fix OP_ELITE_SET segmentation fault due to excess floating point precision
4406   on x86 Linux (and possibly other platforms).
4408 * Database::allterms_begin() over multiple databases now gives a TermIterator
4409   with operations O(log(n)) rather than potentially O(n) in the number of
4410   databases.
4412 * Add new Database methods metadata_keys_begin() and metadata_keys_end() to
4413   allow the complete list of metadata in a database to be retrieved (this
4414   API addition is needed so that copydatabase can copy database metadata).
4416 testsuite:
4418 * Remove the cached test databases before running the testsuite.
4420 * apitest: Fix cursordelbug1 to work on Microsoft Windows (bug#301).
4422 * apitest,queryparsertest: Skip tests which fail because the timer granularity
4423   is too coarse to measure how long the test took.  In practice, this is only
4424   an issue on Microsoft Windows (bug#300 and bug#308).
4426 matcher:
4428 * Adjust percent cutoff calculations in the matcher in a way which corresponds
4429   to the change to percentage calculations made in 1.0.7 to allow for excess
4430   precision.
4432 * Query::MatchAll no longer gives match results ranked by increasing document
4433   length.
4435 flint backend:
4437 * xapian-compact: Fix crash while compacting spelling table for a single
4438   database when built with MSVC, and probably other platforms, though Linux
4439   got lucky and happened to work (bug#305).
4441 build system:
4443 * configure: Disable -Wconversion for now - it's not useful for older GCC and
4444   is buggy in GCC 4.3.
4446 * configure: Set -Wstrict-overflow to 1 instead of 5, to avoid unreasonable
4447   warnings under GCC 4.3.
4449 documentation:
4451 * Minor improvements to API documentation, including documenting the
4452   XAPIAN_FLUSH_THRESHOLD environmental variable in WriteableDatabase::flush()
4453   (bug#306).
4455 * valueranges.html: Fix typos in example code, and drop superfluous empty
4456   destructor from ValueRangeProcessor subclass.
4458 * HACKING: Several improvements.
4460 examples:
4462 * copydatabase: Also copy user metadata.
4464 Xapian-core 1.0.8 (2008-09-04):
4466 API:
4468 * Fix output of RSet::get_description
4470 testsuite:
4472 * Report subtotals per backend, rather than per testgroup per backend to make
4473   the output easier to read.
4475 flint backend:
4477 * Fix WritableDatabase::add_document() and replace_document() not to be O(n*n)
4478   in the number of values in the new document.
4480 * Fix handling of a table created lazily after the database has had commits,
4481   and which is then cursored while still in sequential mode.
4483 * Fix failure to remove all the Btree entries in some cases when all the
4484   postings for a term are removed.  (bug#287)
4486 * xapian-inspect: Show the help message on start-up.  Correct the documented
4487   alias for next from ' ' to ''.  Avoid reading outside of input string when it
4488   is empty.  (bug#286)
4490 quartz backend:
4492 * Backport fix from flint for WritableDatabase::add_document() and
4493   replace_document() not to be O(n*n) in the number of values in the new
4494   document.
4496 build system:
4498 * configure: Report bug report URL in --help output.
4500 * xapian-config: Report bug report URL in --help output.
4502 * configure: Fix deprecation error for --enable-debug=full to say to instead
4503   use '--enable-assertions --enable-log' not '--enable-debug --enable-log'.
4505 documentation:
4507 * valueranges.html: Expand on some sections.
4509 examples:
4511 * quest: Fix to catch QueryParserError instead of const char * which
4512   QueryParser threw in Xapian < 1.0.0.
4514 * copydatabase: Use C++ forms of C headers.  Only treat '\' as a directory
4515   separator on platforms where it is.  Update counter every 13 counting up to
4516   the end so that the digits all "rotate" and the counter ends up on the exact
4517   total.
4519 portability:
4521 * Eliminate literal top-bit-set characters in testsuite source code.
4523 Xapian-core 1.0.7 (2008-07-15):
4525 API:
4527 * OP_VALUE_RANGE, OP_VALUE_GE, and OP_VALUE_LE:
4529   + If there were gaps in the document id numbering, these operators could
4530     return document ids which weren't present in the database.  This has been
4531     fixed.
4533   + These operators are now more efficient when there are a lot of "missing"
4534     document ids (bug#270).
4536   + Optimise Query(OP_VALUE_GE, <n>, "") to Query::MatchAll.
4538 * Xapian::QueryParser:
4540   + QueryParser now stops parsing immediately when it hits a syntax error.
4541     This doesn't change behaviour, but does mean failing to parse queries is
4542     now more efficient.
4544   + Cases of O(N*N) behaviour have been fixed.
4546 * Xapian::Stem now recognises "nl" as an alias for "dutch" (debian bug 484458).
4548 * Setting sort by value was being ignored by a Xapian::Enquire object which had
4549   previously had a Xapian::Sorter set (bug#256).
4551 testsuite:
4553 * Improved test coverage in a few places.
4555 matcher:
4557 * When using a MatchDecider, we weren't reducing matches_lower_bound unless
4558   all the potential results were retrieved, which led to the lower bound
4559   being too high in some such cases.
4561 * We now track how many documents were tested by a MatchDecider and how many
4562   of those it rejected, and set matches_estimated based on this rate.  Also,
4563   matches_upper_bound is reduced by the number of rejected documents.
4565 * Fixed matches_upper_bound in some cases when collapsing and using a
4566   MatchDecider.
4568 * Fixed matches_lower_bound when collapsing and using a percentage cutoff.
4570 * When using two or more of a MatchDecider, collapsing, or a percentage
4571   cutoff, we now only round the scaled estimate once, and we also round it to
4572   the nearest rather than always rounding down.  Hopefully this should
4573   improve the estimate a little in such cases.
4575 * Fix problem on x86 with the top match getting 99% rather than 100% (caused
4576   by excess precision in an intermediate value).
4578 flint backend:
4580 * If Database::reopen() is called and the database revision on disk hasn't
4581   changed, then do as little work as possible.  Even if it has changed, don't
4582   bother to recheck the version file (bug#261).
4584 * xapian-compact:
4586   + Fix check for user metadata key to not match other key types we may add in
4587     the future.  When compacting, we can't assume how we should handle them.
4589   + If the same user metadata key is present in more than one source database
4590     with different tag values, issue a warning and copy an arbitrary tag value.
4592   + Fix potential SEGV when compacting database(s) with user metadata but no
4593     postings.
4595   + In error message, refer to "iamflint" as the "version file", not the
4596     "meta file".
4598 * xapian-inspect:
4600   + Print top-bit-set characters as escaped hex forms as they often won't be
4601     valid UTF-8 sequences.
4603   + If we're passed a database directory rather than a single table, issue a
4604     special error message since this is an obvious mistake for users to make.
4606 * Fix cursor handling for a modified table which has previously only had
4607   sequential updates which usually manifested as zlib errors (bug#259).
4609 quartz backend:
4611 * Fix cursor handling for a modified table which has previously only had
4612   sequential updates which usually manifested as incorrect data being returned
4613   (bug#259).
4615 * Calling skip_to() as the first operation on an all-documents PostingIterator
4616   now works correctly.
4618 remote backend:
4620 * Improve performance of matches with multiple databases at least one of which
4621   is remote, and when the top hit is from a remote database (bug#279).
4623 * When remote protocol version doesn't match, the error message displayed
4624   now shows the minor version number supplied by the server correctly.
4626 * We now wait for the connection to close after sending MSG_SHUTDOWN for a
4627   WritableDatabase, which ensures that changes have been written to disk
4628   and the lock released before the WritableDatabase destructor returns
4629   (as is the case with a local database).
4631 * We no longer ever send MSG_SHUTDOWN for a read-only Database - just closing
4632   the connection is enough (and is protocol compatible).
4634 inmemory backend:
4636 * Fix bug which resulted in the values not being stored correctly when
4637   replacing an existing document, or if there are gaps in the document id
4638   numbering.
4640 build system:
4642 * This release now uses newer versions of the autotools (autoconf 2.61 ->
4643   2.62; automake 1.10 -> 1.10.1; libtool 1.5.24 -> 1.5.26).  The newer
4644   autoconf reportedly results in a faster configure script, and warns about
4645   use of unrecognised configure options.
4647 * Fix configure to recognise --enable-log=profile and fix build problems when
4648   this is enabled.
4650 * "make up" in the "tests" subdirectory now does "make" in the top-level.
4652 * Fix "make distcheck" by using dist-hook to install generated files from
4653   either srcdir or builddir, with the appropriate dependency to generate them
4654   automatically in maintainer mode builds.
4656 documentation:
4658 * intro_ir.html: Improve wording a bit.
4660 * The documentation now links to trac instead of bugzilla.  For links to the
4661   main website, we now prefer xapian.org to www.xapian.org.
4663 * Doxygen-generated API documentation:
4665   + Improved documentation in several places.
4667   + The helper macro XAPIAN_VISIBILITY_DEFAULT no longer appears in the output.
4669   + Header and directory relationship graphs are no longer generated as they
4670     aren't actually informative here.
4672 * HACKING: Numerous updates and improvements.
4674 examples:
4676 * quest: Output get_description() of the parsed query.
4678 portability:
4680 * Fix build with GCC 2.95.3.
4682 * Fix build with GCC 4.3.
4684 * Newer libtool features improved support for Mac OS X Leopard and added
4685   support for AIX 6.1.
4687 debug code:
4689 * Database::get_spelling_suggestion() now debug logs with category APICALL
4690   rather than SPELLING, for consistency with all other API methods.
4692 * Added APICALL logging to a few Database methods which didn't have it.
4694 * Remove debug log tracing from get_description() methods since logging for
4695   other methods calls get_description() methods on parameters, so logging these
4696   calls just makes for more confusing debug logs.  A get_description() method
4697   should have no side-effects so it's not very interesting even when explicitly
4698   called by the user.
4700 Xapian-core 1.0.6 (2008-03-17):
4702 API:
4704 * Add new query operators OP_VALUE_LE and OP_VALUE_GE which perform "single
4705   ended" range checks, and a corresponding new Query constructor.
4707 * Add Unicode::toupper() to complement Unicode::tolower().
4709 * Xapian::Stem has been further optimised - stemtest now runs ~2.5% faster.
4711 testsuite:
4713 * tests/runtest: Fixed to handle test programs with a ".exe" extension.
4715 * tests/queryparsertest: Add a couple more testcases which already work to
4716   improve test coverage.
4718 * tests/apitest: Add caseconvert1 testcase to test Unicode::tolower() and
4719   Unicode::toupper().
4721 flint backend:
4723 * xapian-check: Fix not to report an error for a database containing no
4724   postings but some user metadata.
4726 * Update the base files atomically to avoid problems with reading processes
4727   finding partially written ones.
4729 * Create lazy tables with the correct revision to avoid producing a database
4730   which we later report as "corrupt" (bug#232).
4732 * xapian-compact: Fix compaction for databases which contain user metadata
4733   keys.
4735 quartz backend:
4737 * Update the base files atomically to avoid problems with reading processes
4738   finding partially written ones.
4740 remote backend:
4742 * The addition of OP_VALUE_LE and OP_VALUE_GE required an update to the Query
4743   serialisation, which required a minor remote protocol version bump.
4745 * Fix to actually set the writing half as the connection as non-blocking when
4746   a timeout is specified.  This would have prevented timeouts from operating
4747   correctly in some situations.
4749 build system:
4751 * configure: GCC warning flag overhaul:  Stop passing "-Wno-multichar" since
4752   any multi-character character literal is bound to be a typo (I believe we
4753   were only passing it after misinterpreting its sense!)  Pass
4754   "-Wformat-security", and "-Wconversion" for all GCC versions.  Add
4755   "-Winit-self" and "-Wstrict-overflow=5" for GCC >= 4.2.  The latter might
4756   prove too aggressive, but seems reasonable so far.  Fix some minor niggles
4757   revealed by "-Wconversion" and "-Wstrict-overflow=5".
4759 * Add XAPIAN_NORETURN() annotations to functions and non-virtual methods which
4760   don't return.
4762 documentation:
4764 * docs/intro_ir.html: Briefly mention how pure boolean retrieval is supported.
4766 * docs/valueranges.html: Fix example of using multiple VRPs to come out as a
4767   "program listing".
4769 * include/xapian/queryparser.h: Fix incorrect example in doccomment.
4771 * docs/quickstart.html: Remove information covered by INSTALL since
4772   there's no good reason to repeat it and two copies just risks one
4773   getting out of date (as has happened here!)
4775 * docs/quickstart.html: Fix very out of date reference to MSet::items
4776   (bug#237).
4778 * PLATFORMS: Remove reports for 0.8.x as they're too old to be interesting.
4779   Separate out 0.9.x reports.  Add Solaris 9 and 10 success reports from James
4780   Aylett.  Update from Debian buildd logs.
4782 portability:
4784 * Now builds on OS/2, thanks to a patch by Yuri Dario.
4786 * Fix testsuite to build on mingw (broken by changes in 1.0.5).
4788 debug code:
4790 * Fix --enable-assertions build, broken by changes in 1.0.5.
4792 Xapian-core 1.0.5 (2007-12-21):
4794 API:
4796 * More sophisticated sorting of results is now possible by defining a
4797   functor subclassing Xapian::Sorter (bug#100).
4799 * Xapian::Enquire now provides a public copy constructor and assignment
4800   operator (bug#219).
4802 * Xapian::Document::values_begin() didn't ensure that values had been read
4803   when working on a Document read from a database.  However, values_end() did
4804   (and so did values_count()) so this wasn't generally a problem in practice.
4806 * Xapian::PostingIterator::skip_to() now works correctly when running over
4807   multiple databases.
4809 * Xapian::Database::postlist_begin() no longer adds a "MultiPostList" wrapper
4810   for the common case when there's only one subdatabase.
4812 * Xapian::TradWeight now avoids division by zero in the (rare) situation of the
4813   average document length being zero (which can only happen if all documents
4814   are empty or only have terms with wdf 0).
4816 * Calling Xapian::WritableDatabase methods when we don't have exactly one
4817   subdatabase now throws InvalidOperationError.
4819 testsuite:
4821 * apitest:
4823   + Testcases now describe the conditions they need to run, and are
4824     automatically collated by a Perl script.  This makes it significantly
4825     easier to add a new testcase.
4827   + The test harness's "BackendManager" has been overhauled to allow
4828     cleaner implementations of testcases which are currently hard to
4829     write cleanly, and to make it easier to add new backend settings.
4831   + Add a "multi" backend setting which runs suitable tests over two
4832     subdatabases combined.  There's a corresponding new make target
4833     "check-multi".
4835   + Add more feature tests of document values.
4837   + sortrel1 now runs for inmemory too.
4839   + Add simple feature test for TradWeight being used to run a query.
4841   + Fix spell3 to work on Microsoft Windows (bug#177).
4843   + API classes are now tested to check they have copy constructors and
4844     assignment operators, and also that most have a default constructor.
4846   + quartztest testcases adddoc2 and adddoc3 have been reworked as apitest
4847     testcases adddoc5 and adddoc6, which run for other backends.
4849   + stubdb1 now explicitly creates the database it needs - generally this
4850     bug didn't manifest because an earlier test has already created it.
4852 * queryparsertest: Add feature tests to check that ':' is being inserted
4853   between prefix and term when it should be.
4855 * Fix extracting of valgrind error messages in the test harness.
4857 * tests/valgrind.supp: Add more variants of the zlib suppressions.
4859 matcher:
4861 * Xapian::Enquire: When the "first" parameter to get_mset() is non-zero, avoid
4862   copying all the wanted items after performing the match.
4864 * Fix bug in handling a pure boolean match over more than one database under
4865   set_docid_order(ASCENDING) - we used to exit early which isn't correct.
4867 * When collapsing on a value, give a better lower bound on the number of
4868   matches by keeping track of the number of empty collapse values seen.
4870 * Xapian::BM25Weight: Fix bug when k2 is non-zero: a non-initialised value
4871   influenced the weight calculations.  By default k2 is zero, so this bug
4872   probably won't have affected most users.
4874 * The mechanism used to collate term statistics across multiple databases has
4875   been greatly simplified (bug#45).
4877 flint backend:
4879 * xapian-check:
4881   + Update to handle flint databases produced by Xapian 1.0.3 and later.
4883   + Fix not to go into an infinite loop if certain checks fail.
4885 quartz backend:
4887 * quartzcompact: Fix equality testing of C strings to use strcmp() rather than
4888   '=='!  In practice, using '==' often gives the desired effect due to pooling
4889   of constant strings, but this may have resulted in a bug on some platforms.
4891 remote backend:
4893 * If we're doing a match with only one database which is remote then just
4894   return the unserialised MSet from the remote match.  This requires an
4895   update to the MSet serialisation, which requires a minor remote protocol
4896   version bump.
4898 build system:
4900 * XO_LIB_XAPIAN now hooks LT_INIT as well as AC_PROG_LIBTOOL and
4901   AM_PROG_LIBTOOL.
4903 * Distribute preautoreconf, dir_contents, docs/dir_contents and
4904   tests/dir_contents.
4906 * Fix preautoreconf to correctly handle all the sources passed to doxygen to
4907   create the collated internal source documentation, and to work in a VPATH
4908   build.
4910 documentation:
4912 * sorting.html: New document on the topic of sorting match results.
4914 * HACKING,admin_notes.html,bm25.html,glossary.html,intro_ir.html,overview.html,
4915   quickstart.html,scalability.html,termgenerator,html,synonyms.html: Assorted
4916   minor improvements.
4918 * valueranges.html: State explicitly that Xapian::sortable_serialise() is used
4919   to encode values at index time, and give an example of how it is called.
4921 * API documentation:
4923  + Clarify get_wdf() versus get_termfreq().
4925  + We now use pngcrush to reduce the size of PNG files in the HTML version.
4927  + The HTML version no longer includes various intermediate files which doxygen
4928    generates.
4930  + Hide the v102 namespace from Doxygen as it isn't user visible.
4932  + Stop describing get_description() as an "Introspection method", as this
4933    doesn't help to explain what it does, and get_description() doesn't really
4934    fall under common formal definitions of "introspection".
4936 * index.html: Add a list of documents on particular topics and include links to
4937   previously unlinked-to documents.  Weed down the top navigation bar which had
4938   grown to unwieldy length.
4940 * PLATFORMS: Update for Debian buildds.
4942 * Improve documentation comment for Document::termlist_count().
4944 * admin_notes.html: Note that this document is up-to-date for 1.0.5.
4946 * INSTALL: zlib 1.2.0 apparently fixes a memory leak in deflateInit2(), which
4947   we use, so that's another reason to prefer 1.2.x.
4949 portability:
4951 * Add explicit includes of C headers needed to build with the latest snapshots
4952   of GCC 4.3.  Fix new warnings.
4954 * xapian-config: On platforms which we know don't need explicit dependencies,
4955   --ltlibs now gives the same output as --libs.
4957 * The minimum supported GCC version is now 2.95.3 (rather than 2.95) as 2.95.3
4958   added support for '#include <sstream>' which means we no longer need to
4959   maintain our own version.
4961 * Fix build with SGI's compiler on IRIX.
4963 * Fix or suppress some MSVC warnings.
4965 debug code:
4967 * Remove incorrect assertion in MultiAndPostList (bug#209).
4969 * Fix build when configured with "--enable-log --disable-assertions".
4971 Xapian-core 1.0.4 (2007-10-30):
4973 API:
4975 * Query:
4977   + Add OP_SCALE_WEIGHT operator (and a corresponding constructor which
4978     takes a single subquery and a parameter of type "double").  This
4979     multiplies the weights from the subquery by the parameter, allowing
4980     adjustment of the importance of parts of the query tree.
4982   + Deprecate the essentially useless constructor Query(Query::op, Query).
4984 * QueryParser:
4986   + A field prefix can now be set to expand to more than one term prefix.
4987     Similarly, multiple term prefixes can now be applied by default.  This is
4988     done by calling QueryParser::add_boolean_prefix() or
4989     QueryParser::add_prefix() more than once with the same field name but a
4990     different term prefix (previously subsequent calls with the same field name
4991     had no effect).
4993   + Trying to set the same field as probabilistic and boolean now throws
4994     InvalidOperationError.
4996   + Fix parsing of `term1 site:example.org term2', broken by changes in 1.0.2.
4998   + Drop special treatment for unmatched ')' at the start of the query, as it
4999     seems rather arbitrary and not particularly useful and was causing us to
5000     parse `(site:example.org) -term' incorrectly.
5002   + The QueryParser now generates pure boolean Query objects for strings such
5003     as `site:example.org' by applying OP_SCALE_WEIGHT with a factor of 0.0.
5005   + Fix handling of `"quoted phrase" +term' and `"quoted phrase" -term'.
5007   + Fix handling of `site:example.org -term'.
5009   + Fix problem with spelling correction of hyphenated terms (or other terms
5010     joined with phrase generators): the position of the start of the term
5011     wasn't being reset for the second term in the generated phrase, resulting
5012     in out of bounds errors when substituting the new value in the corrected
5013     query string.
5015   + The parser stack is now a std::vector<> rather than a fixed size, so it
5016     will typically use less memory, and can't hit the fixed limit.
5018   + Fix handling of STEM_ALL and update the documentation comment for
5019     QueryParser::set_stemming_strategy() to explain how it works clearly.
5021 * PostingIterator: positionlist_begin() and get_wdf() should now always
5022   throw InvalidOperationError where they aren't meaningful (before in some
5023   cases UnimplementedError was thrown).
5025 testsuite:
5027 * Add tests for new features.
5029 * Add another valgrind suppression for a slightly different error from zlib
5030   in Ubuntu gutsy.
5032 * Remove quartztest's test_postlist1 and test_postlist2, replacing the coverage
5033   lost by extending and adding tests which work with other backends as well.
5035 * If a test throws a subclass of std::exception, the test harness now
5036   reports the class name and the extra information returned by std::exception's
5037   what() method.
5039 matcher:
5041 * Several performance improvements have been made, mainly to the handling
5042   of OP_AND and related operations (OP_FILTER, OP_NEAR, and OP_PHRASE).
5043   In combination, these are likely to speed up searching significantly
5044   for most users - in tests on real world data we've seen savings of 15-55%
5045   in search times).  These improvements are:
5047   + OP_AND of 3 or more sub-queries is now processed more efficiently.
5049   + Sub-queries from adjacent OP_AND, OP_FILTER, OP_NEAR, and OP_PHRASE are now
5050     combined into a single multi-way OP_AND operation, and the filters which
5051     implement the near/phrase restrictions are hoisted above this so they need
5052     to check fewer documents (bug#23).
5054   + If an OP_OR or OP_AND_MAYBE decays to OP_AND, we now ensure that the less
5055     frequent sub-query is on the left, which OP_AND is optimised to expect.
5057 * When the Enquire::get_mset() parameter checkatleast is set, and we're sorting
5058   by relevance with forward ordering by docid, and the query is pure boolean,
5059   the matcher was deciding it was done before the checkatleast requirement was
5060   satisfied.  Then the adjustments made to the estimated and max statistics
5061   based on checkatleast meant the results claimed there were exactly msize
5062   results.  This bug has now been fixed.
5064 * Queries involving an OP_VALUE_RANGE filter now run around 3.5 times faster
5065   (bug#164).
5067 * The calculations behind MSet::get_matches_estimated() were always rounding
5068   down fractions, but now round to the nearest integer.  Due to cumulative
5069   rounding, this could mean that the estimate is now a few documents higher in
5070   some cases (and hopefully a better estimate).
5072 * Implement explicit swap() methods for internal classes MSetItem and ESetItem
5073   which should make the final sort of the MSet and ESet a little more
5074   efficient.
5076 flint backend:
5078 * Fixed a bug introduced in 1.0.3 - trying to open a flint database for reading
5079   no longer fails if it isn't writable.
5081 * We no longer use member function pointers in the Btree implementation which
5082   seems to speed up searching a little.
5084 remote backend:
5086 * The remote protocol minor version has been increased (to accommodate
5087   OP_SCALE_WEIGHT).  If you are upgrading a live system which uses the
5088   remote backend, upgrade the servers before the clients.
5090 build system:
5092 * Added macro machinery to allow branch prediction hints to be specified and
5093   used by compilers which support this (current GCC and Intel C++).
5095 * In a developer build, look for rst2html.py if rst2html isn't found as some
5096   Linux distros have it installed under with an extension.
5098 documentation:
5100 * In the API documentation, explicitly note that Database::get_metadata()
5101   returns an empty string when the backend doesn't support user-specified
5102   metadata, and that WritableDatabase::set_metadata() throws UnimplementedError
5103   in this case.  Also describe the current behaviour with multidatabases.
5105 * README: Remove the ancient history lesson - this material is better left to
5106   the history page on the website.
5108 * deprecation.html:
5110   + Deprecate the non-pythonic iterators in favour of the pythonic ones.
5112   + Move "Stem::stem_word(word)" in the bindings to the right section (it was
5113     done in 1.0.0, as already indicated).
5115   + Improve formatting.
5117 * When running rst2html, using "--verbose" was causing "info" messages to be
5118   included in the HTML output, so drop this option and really fix this issue
5119   (which was thought to have been fixed by changes in 1.0.3).
5121 * install.html: Reworked - this document now concentrates on giving
5122   a brief overview of building which should be suitable for most common cases,
5123   and defers to the INSTALL document in each tarball for more details.
5125 * PLATFORMS: Update from tinderbox and buildbot.
5127 * remote.html: xapian-tcpsrv has been able to handle concurrent read
5128   access since 0.3.1 (7 years ago) so update the very out-of-date information
5129   here.  Also, note that some newer features aren't supported by the remote
5130   backend yet.
5132 * HACKING: Note specifically that std::list::size() is O(n) for GCC.
5134 * intro_ir.html: Add link to the forthcoming book "Introduction to
5135   Information Retrieval", which can be read online.
5137 * scalability.html: Update size of gmane.
5139 * quartzdesign.html: Note that Quartz is now deprecated.
5141 debug code:
5143 * The debug assertion code has been rewritten from scratch to be cleaner and
5144   pull in fewer other headers.
5146 Xapian-core 1.0.3 (2007-09-28):
5148 API:
5150 * Add support for user specified metadata (bug#143).  Currently supported by
5151   the flint and inmemory backends.
5153 * Deprecate Enquire::register_match_decider() which has always been a no-op.
5155 * Improve the lower bound on the number of matching documents for an AND query
5156   - if the sum of the lower bounds for the two sides is greater than the
5157   number of documents in the database, then some of them must have both terms.
5159 * Spelling correction: Fix off-by-one error in loop bounds when initialising
5160   (bug#194).
5162 * If the check_at_least parameter to Enquire::get_mset() is used, but there
5163   aren't that many results, then MSet::get_matches_lower_bound() and
5164   MSet::get_matches_upper_bound() weren't always reported as equal - this
5165   bug is now fixed.
5167 * When sorting by value, and using the check_at_least parameter to
5168   Enquire::get_mset(), some potential matches weren't being counted.
5170 * Failing to create a flint or quartz database because we couldn't create the
5171   directory for it now throws DatabaseCreateError not DatabaseOpeningError.
5173 testsuite:
5175 * Fix display of valgrind output when a test fails because valgrind detected
5176   a problem.
5178 * Add another version of valgrind suppression for the zlib end condition check
5179   as this gives a different backtrace for zlib in Ubuntu gutsy.
5181 flint backend:
5183 * The Flint database format has been extended to support user metadata, and
5184   each termlist entry is now a byte shorter (before compression).  As a
5185   result, Xapian 1.0.2 and earlier won't be able to read Xapian 1.0.3
5186   databases.  However, Xapian 1.0.3 can read older databases.  If you open an
5187   older flint database for writing with Xapian 1.0.3, it will be upgraded
5188   such that it cannot then be read by Xapian 1.0.2 and earlier.
5190 * Zlib compression wasn't being used for the spelling or synonym tables (due
5191   to a typo - Z_DEFAULT_COMPRESSION where it should be Z_DEFAULT_STRATEGY).
5193 * xapian-check: Allow "db/record." and "db/record.DB" as arguments.
5195 * Fix "key too long" exception message by substituting FLINT_BTREE_MAX_KEY_LEN
5196   with its numeric value.
5198 * Assorted minor efficiency improvements.
5200 * If we reach the flush threshold during a transaction, we now write out the
5201   postlist changes, but don't actually commit them.
5203 * Check length of new terms is at most 245 bytes for flint in add_document()
5204   and replace_document() so that the API user gets an error there rather
5205   than when flush() is called (explicitly or implicitly).  Fixes bug#44.
5207 * Flint used to read the value of the environmental variable
5208   XAPIAN_FLUSH_THRESHOLD when the first WritableDatabase was opened and would
5209   then cache this value.  However the program using Xapian may have changed
5210   it, so we now reread it each time a WritableDatabase is opened.
5212 * Implement TermIterator::positionlist_count() for the flint backend.
5214 remote backend:
5216 * Fix the result of MSet::get_matches_lower_bound() when using the
5217   check_at_least parameter to get_mset().
5219 inmemory backend:
5221 * Implement TermIterator::positionlist_count() for the inmemory backend.
5223 build system:
5225 * xapian-config: We always need to include dependency_libs in the output of
5226   `xapian-config --libs` if shared libraries are disabled.
5228 * Distribution tarballs are now in the POSIX "ustar" format.  This supports
5229   pathnames longer than 99 characters (which we now have a few instances of
5230   in the doxygen generated documentation) and also results in a distribution
5231   tarball that is about half the size!  This format should be readable by any
5232   tar program in current use - if your tar program doesn't support it, we'd
5233   like to know (but note that the GNU tar tarball is smaller than the size
5234   reduction in the xapian-core tarball...)
5236 * configure no longer generates msvc/version.h - this is now entirely handled
5237   by the MSVC-specific makefiles.
5239 documentation:
5241 * Add a glossary.
5243 * docs/stemming.html: Reorder the initial paragraphs so we actually answer the
5244   question "What is a stemming algorithm?" up front.
5246 * When running rst2html, use "--exit-status=warning" rather than "--strict".
5247   The former actually gives a non-zero exit status for a warning or worse,
5248   while the former doesn't, but does include any "info" messages in the output
5249   HTML.
5251 * docs/deprecation.rst: Add "Database::positionlist_begin() throwing
5252   RangeError and DocNotFoundError".
5254 * valueranges.rst: Correct out-of-date reference to float_to_string.
5256 * HACKING: Document a few more "coding standards".
5258 * PLATFORMS: Updated.
5260 * docs/overview.html: Restore HTML header accidentally deleted in November
5261   2006.
5263 * Fix several typos.
5265 portability:
5267 * Add missing instances of "#include <string.h>" to fix compilation with recent
5268   GCC 4.3 snapshots.
5270 * Fix some warnings for various compilers and platforms.
5272 Xapian-core 1.0.2 (2007-07-05):
5274 API:
5276 * Xapian now offers spelling correction, based on a dynamically maintained
5277   list of spelling "target" words.  This is currently supported by the
5278   flint backend, and works when searching multiple databases.
5280 * Xapian now offers search-time synonym expansion, based on an externally
5281   provided synonym dictionary.  This is currently supported by the flint
5282   backend, and works when searching multiple databases.
5284 * TermGenerator: now offers support for generating spelling correction
5285   data.
5287 * QueryParser:
5289   + New flag FLAG_SPELLING_CORRECTION to enable spelling correction, and a new
5290     method, "get_corrected_query_string()" to get the spelling corrected
5291     query string.
5293   + New flags have been added to allow the new synonym expansion feature to be
5294     enabled and controlled.  Synonym expansion can either be automatic, or only
5295     for terms explicitly indicated in the query string by the new "~" operator.
5297   + The precedence of the boolean operators has been adjusted to match their
5298     usual precedence in mathematics and programming languages.  "NOT" now binds
5299     as tightly as "AND" (previously "AND NOT" would bind like "AND", but just
5300     "NOT" would bind like "OR"!)  Also "XOR" now binds more tightly than "OR",
5301     but less tightly than "AND" (previously it bound just like "OR").
5303   + '+' and '-' have been fixed to work on bracketed subexpressions as
5304     documented.
5306   + If the stemmer is "none", no longer put a Z prefix on terms; this now
5307     matches the output of TermGenerator.
5309 * Add new Xapian::sortable_serialise() and Xapian::sortable_unserialise()
5310   functions which serialise and unserialise numbers (currently only
5311   doubles) to a string representation which sorts in numeric order.  Small
5312   integers have a short representation.
5314 * NumberValueRangeProcessor has been changed to work usefully.  Previously
5315   the numbers had to be the same length; now numbers are serialised to
5316   strings such that a string sort on the string orders the numbers correctly.
5317   Negative and floating point numbers are also supported now.  The old
5318   NumberValueRangeProcessor is still present in the library to preserve
5319   ABI compatibility, but code linking against 1.0.2 or later will pick
5320   up the new implementation, which really lives in a sub-namespace.
5322 * Documents now have a get_docid() method, to get the document ID from the
5323   database they came from.
5325 * Add support for a new type of match decider, called a "matchspy".  Unlike
5326   the old deciders, this will reliably be tested on every candidate
5327   document, so can be used to tally statistics on them.
5329 * Fixed a segfault when getting a description for a MatchNothing query
5330   joined with AND_NOT (bug #176).
5332 * Header files have been tidied up to remove some unnecessary includes.
5333   Applications using "#include <xapian.h>" will not be affected.  We don't
5334   intend to support direct inclusion of individual header files from the xapian
5335   directory, but if you do that, you may have to update you code.
5337 testsuite:
5339 * Feature tests added for all new features.
5341 * Improved test coverage in queryparsertest.  Some tests in queryparsertest
5342   now use flint databases, so the test now ensures that the .flint
5343   subdirectory exists.
5345 * The test harness no longer creates <dbdir>/log for flint (flint doesn't
5346   create a log like quartz does).
5348 * apitest: "-bremote" must now be "-bremoteprog" (to better match
5349   "-bremotetcp"); "-bvoid" must now be "-bnone" (to better describe not
5350   using a database backend).
5352 * To complement "make check-flint", "make check-quartz", and "make
5353   check-remote", you can now run tests for the remotetcp backend with
5354   "make check-remotetcp", for the remoteprog backend with "make
5355   check-remoteprog", for the inmemory backend with "make check-inmemory", and
5356   tests not requiring a backend with "make check-none".
5358 * Several extra tests of the check_at_least parameter supplied to
5359   get_mset() were added.
5361 * Fix memory leak and fd leak in remotetcp handling, so apitest now passes
5362   under valgrind.
5364 * quartztest: no longer test QuartzPostList::get_collection_freq(), which
5365   has been removed.
5367 * Add regression test emptyquery2 for bug #176.
5369 * Add regression test matchall1 for bug with MatchAll queries.
5371 * Enhanced test coverage of match functor, to check that it returns all
5372   matching documents.
5374 matcher:
5376 * Fix bug when check_at_least was supplied - the matches after the
5377   requested MSet size were being returned to the user.  The parameter is
5378   also now handled in a more efficient way - no extra memory is required
5379   (previously, extra memory proportional to the value of check_at_least was
5380   required).
5382 * Fix bug which used incorrect statistics, and caused assertion failures,
5383   when performing a search using a MatchAll query.
5385 * Optimisation for single term queries: we don't need to look at the top
5386   document's termlist to determine that it matches all the query terms.
5388 flint backend:
5390 * The value and position tables are now only created if there is anything to
5391   add to them.  So if you never use document values, there's no value.DB,
5392   value.baseA, or value.baseB.  This means the table doesn't need to be opened
5393   for searching (saving a file handle and a number of syscalls) and when
5394   flushing changes, we don't need to update baseA/baseB just to keep the
5395   revisions in step.  The flint database version has been increased, but the
5396   new code will happily open and read/update flint databases from Xapian 1.0.0
5397   and 1.0.1.  Xapian 1.0.2 flint databases can't be read by Xapian 1.0.1 or
5398   earlier though.
5400 * Two new optional tables are now supported: "spelling", which is used to
5401   store information for spelling correction, and "synonym", which is used
5402   to store synonym information.
5404 * xapian-compact: Now compacts and merges spelling and synonym tables.
5405   Also has a new option "--no-renumber" to preserve document ids from
5406   source databases.
5408 * xapian-check: Now checks the spelling and synonym tables (only the Btree
5409   structure is currently checked, not the information inside).
5411 * Database::term_exists(), Database::get_termfreq(), and
5412   Database::get_collection_freq() are now slightly more efficient for flint
5413   databases.
5415 * New utility 'xapian-inspect' which allowing interactive inspection of key/tag
5416   pairs in a flint Btree.  Useful for development and debugging, and an
5417   approximate equivalent to quartzdump.
5419 * WritableDatabase::delete_document() no longer cancels pending changes if the
5420   document doesn't exist.
5422 * Fix handling of exceptions during commit - previously, this could result
5423   in tables getting out-of-sync, perhaps even resulting in a corrupt database.
5425 * Optimise iteration of all documents in the case where all the document
5426   IDs up to lastdocid are used; in this case, we no longer need to access disk
5427   to get the document IDs.
5429 quartz backend:
5431 * WritableDatabase::delete_document() no longer cancels pending changes if the
5432   document doesn't exist.
5434 * We no longer create a postlist just to find the termfreq or collection
5435   frequency.
5437 remote backend:
5439 * Calling WritableDatabase::delete_document() on a non-existent document now
5440   correctly propagates DocNotFoundError.
5442 * The minor remote protocol version has increased (to fix the previous issue).
5443   You should be able to cleanly upgrade a live system by upgrading servers
5444   first and then clients.
5446 * progclient: Reopen stderr on the child process to /dev/null rather than
5447   closing it.  This fixes apitest with the remoteprog backend to pass when run
5448   under valgrind (it failed in this case in 1.0.0 and 1.0.1).  It probably
5449   has no effect otherwise.
5451 * check_at_least is now passed to the remote server to reduce the work
5452   needed to produce the match, and the serialised size of the returned MSet.
5454 inmemory backend:
5456 * Bug fix: using replace_document() to add a document with a specific
5457   document id above the highest currently used would create empty documents
5458   for all document ids in between.
5460 build system:
5462 * Work around an apparent bug in automake which causes the entries in .libs
5463   subdirectories generated for targets of bin_PROGRAMS not to be removed on
5464   make clean.  This was causing make distcheck to fail.
5466 * Snapshots and releases are now bootstrapped with automake 1.10, and
5467   libtool 1.5.24.
5469 * HTML documentation generated from RST files is now installed.
5471 documentation:
5473 * The API documentation is now generated with Doxygen 1.5.2, which fixes the
5474   missing docs for Xapian::Query.
5476 * Ship and install internals.html.
5478 * Generating the doxygen-collated documentation of the library internals (with
5479   "make doxygen_source_docs") now only tries to generate an HTML version.  The
5480   PDF version kept exceeding TeX limits, and HTML is a more useful format for
5481   this anyway.
5483 * API docs for Xapian::QueryParser now make it clear that the default value for
5484   the stemming strategy is STEM_NONE.
5486 * API docs now describe the NumberValueRangeProcessor more clearly.
5488 * Several typo fixes and assorted wording improvements.
5490 * queryparser.html: Mention "AND NOT" as an alternative way to write "NOT",
5491   and document synonym expansion.
5493 * admin_notes.html: Updated for changes in this release, and corrected a
5494   few minor errors.
5496 * spelling.rst: New file, documenting the spelling correction feature.
5498 * synonyms.rst: New file, documenting the synonyms expansion feature.
5500 * valueranges.rst: The NumberValueRangeProcessor is now documented.
5502 * HACKING: Mention new libtool, and more details about preferring
5503   pre-increment.  Also add a note about 2 space indentation of protection
5504   level declarations in classes.
5506 * INSTALL: note that zlib must be installed before you can build.
5508 examples:
5510 * copydatabase: Now copies synonym and spelling data.  Also, fix a cosmetic
5511   bug with progress output when a specified database directory has a trailing
5512   slash.
5514 portability:
5516 * Fix to build on with OpenBSD's zlib (xapian-core 1.0.0 and 1.0.1 didn't).
5518 * Fixed to build with older zlib such as zlib 1.1.5 which Solaris apparently
5519   uses (xapian-core 1.0.0 and 1.0.1 didn't).  However, we recommend using zlib
5520   1.2.x as decompressing is apparently about 20% faster.
5522 * msvc/version.h.in: Generated version.h for MSVC build no longer has the
5523   remote backend marked as disabled.
5525 * Fix warnings from Intel's C++ compiler.
5527 * Fixes for compilation with gcc-2.95 and GCC 4.3 snapshots.
5529 packaging:
5531 * RPMs:
5533   + Rename xapian.spec to xapian-core.spec to match tarball name.
5535   + Append the user name to BuildRoot.
5537 debug code:
5539 * Better debug logging from the queryparser internals.
5541 Xapian-core 1.0.1 (2007-06-11):
5543 API:
5545 * Xapian::Error:
5547   + Make Error::error_string member std::string rather than char * to avoid
5548     problems with double free() with copied Error objects.  Unfortunately
5549     this mean an incompatible ABI change which we had hoped to avoid until
5550     1.1.0, but in this case there didn't seem to be a sane way to fix the
5551     problem without an ABI change.
5553   + Error::get_description() now converts my_errno to error_string if it hasn't
5554     been already rather than not including any error description in this case.
5556   + Add new method "get_description()" to get a string describing the error
5557     object.  This is used in various examples and scripts, improving their
5558     error reporting.
5560 * Xapian::Database: Add new form of allterms_begin() and allterms_end()
5561   which allow iterating of all terms with a particular prefix.  This
5562   is easier to use than checking the end condition yourself, and is
5563   more efficiently implemented for the remote backend (fixes bug#153).
5565 * Xapian::Enquire: Passing an uninitialised Database object to Enquire will
5566   now cause InvalidArgumentError to be thrown, rather than causing a segfault
5567   when you call Enquire::get_mset().  If you really want an empty database,
5568   you can use Xapian::InMemory::open() to create one.
5570 * Xapian::QueryParser: Multiple boolean prefixed terms with the same term
5571   prefix are now combined with OR before such groups are combined with AND
5572   (bug#157).  Multiple value ranges on the same value are handled similarly.
5574 * Xapian::Query OP_VALUE_RANGE: Avoid calling db->get_lastdocid() repeatedly
5575   as we know the answer won't change - this reduces the run time of a
5576   particular test case by 25%.
5578 testsuite:
5580 * Add test for serialisation of error strings.
5582 * Improved output in various situations:
5584   + Quote strings in TEST_STRINGS_EQUAL().
5586   + queryparsertest: Use TEST_STRINGS_EQUAL when comparing query descriptions
5587     against their expected output, since this makes it much easier to see the
5588     differences.
5590   + Report whole message for exceptions, rather than a truncated version, in
5591     verbose mode.
5593   + Make use of Xapian::Error::get_description(), giving better error
5594     reports.
5596 * queryparsertest: New test of custom ValueRangeProcessor subclass
5597   (qp_value_customrange1).
5599 * apitest: flintdatabaseformaterror1 and flintdatabaseformaterror2 now use a
5600   genuine Xapian 0.9.9 flint database for their tests, and more cases are
5601   tested.  The two tests have also been split into 3 now.
5603 * Fix test harness not to invoke undefined behaviour in cases where a paragraph
5604   of test data contains two or fewer characters.
5606 * Implement a better fix for the MSVC ifstream issue which was fixed in 1.0.0.
5607   This fixes an unintentional side-effect of the previous fix which meant that
5608   apitest's consistency1 wasn't working as intended (it now has a regression
5609   test to make sure it is testing what we intend).
5611 flint backend:
5613 * xapian-compact: Don't uncompress and recompress tags when compacting a
5614   database.  This speeds up xapian-compact rather a lot (by more than 50% in a
5615   quick test).
5617 * If the docid counter wraps, Flint now throws DatabaseError (fixes bug#152).
5619 * Remove the special case error message for pre-0.6 databases since they'll
5620   be quartz format (the check is only in flint because this code was taken from
5621   quartz).
5623 quartz backend:
5625 * If the docid counter wraps, Quartz now throws DatabaseError (fixes bug#152).
5627 remote backend:
5629 * The remote protocol now has a minor version number.  If the major
5630   version number is the same, a client can work with any server with
5631   the same or higher minor version number, which makes upgrading live
5632   systems easier for most remote protocol changes - just upgrade the servers
5633   first.
5635 * When a read-only remote database is closed, the client no longer sends a
5636   (totally bogus) MSG_FLUSH to the server, and the reply is also eliminated.
5637   This reduces the time taken to close a remote database a little (fixes
5638   bug#149).
5640 inmemory backend:
5642 * skip_to() on an allterms TermIterator from an InMemory Database can no longer
5643   move backwards.
5645 * An allterms TermIterator now initialises lazily, which can save some work if
5646   the first operation is a skip_to() (as it often will be).
5648 build system:
5650 * Fix VPATH compilation in maintainer mode with gcc-2.95.
5652 * Fix multiple target rule for generating the queryparser source files in
5653   parallel builds.
5655 * Distribute missing stub Makefiles for "bin", "examples", and
5656   "include/xapian".
5658 documentation:
5660 * Document the design flaw with NumberValueRangeProcessor and why it shouldn't
5661   be used.
5663 * ValueRangeProcessor and subclasses now have API documentation and an overview
5664   document.
5666 * Expand documentation of value range Query constructor.
5668 * Improved API documentation for the TermGenerator class.
5670 * docs/deprecation.rst:
5672   + Fix copy and paste error - set_sort_forward() should be changed to
5673     set_docid_order().
5675   + Improve entry for QueryParserError.
5677 * PLATFORMS: Updated from tinderbox.
5679 examples:
5681 * copydatabase: Rewritten to use the ability to iterate over all the documents
5682   in a database.  Should be much more efficient for databases with sparsely
5683   distributed document IDs.
5685 * simpleindex: Rewritten to use the TermGenerator class, which eliminates a
5686   lot of non-Xapian related code and is more typical of what a user is likely
5687   to want to do.
5689 * simplesearch,simpleexpand: Rewritten to use the QueryParser class, which
5690   is more typical of what a user is likely to want to do.
5692 portability:
5694 * xapian-config: Add special case check for host_os matching linux* or
5695   k*bsd-gnu since vanilla libtool doesn't correctly probe link_all_deplibs=no
5696   for them.
5698 packaging:
5700 * RPMs: Add "# norootforbuild" comment which SuSE's build scripts look for.
5701   Rename "Source0:" to "Source:" as there's only one tarball now.  Add gcc-c++
5702   and zlib-devel to "Build-Requires:".
5704 * The required automake version has been lowered to 1.8.3, so RPMs can now be
5705   built on RHEL 4 and SLES 9.
5707 Xapian-core 1.0.0 (2007-05-17):
5709 API:
5711 * Xapian::Database:
5713   + The Database(const std::string &) constructor has been marked as "explicit".
5714     Hopefully this won't affect real code, but it's possible.  Instead of
5715     passing a std::string where a Xapian::Database is expected, you'll now
5716     have to explicitly write `Xapian::Database(path)' instead of `path'.
5718   + Fixed problem when calling skip_to() on an allterms iterator over multiple
5719     databases which could cause a debug assertion in debug builds, and possible
5720     misbehaviour in normal builds.
5722 * Xapian::Error:
5724   + The constructors of Error subclasses which take a `const std::string &'
5725     parameter are now explicit.  This is very unlikely to affect any real code
5726     but if it does, just write `Xapian::Error(msg)' instead of `msg'.
5728   + Xapian::Error::get_type() now returns const char* rather than std::string.
5729     Generally existing code will just work (only one change was required in
5730     Xapian itself) - the simplest change is to write `std::string(e.get_type())'
5731     instead of `e.get_type()'.
5733   + Previously, the errno value was lost when an error was propagated from
5734     a remote server to the client, because errno values aren't portable
5735     between platforms.  To fix this, Error::get_errno() is now deprecated and
5736     you should use Error::get_error_string() instead, which returns a string
5737     expanded from the errno value (or other system error code).
5739 * Xapian::QueryParser:
5741   + Now assumes input text is encoded as UTF-8.
5743   + We've made several changes to term generation strategy.  Most notably:
5744     Unicode support has been added; '_' now counts as a word character; numbers
5745     and version numbers are now parsed as a single term; single apostrophes are
5746     now included in a term; we now store unstemmed forms of all terms; and we
5747     no longer try to "normalise" accents.
5749   + parse_query() now throws the new Xapian::Error subclass QueryParserError
5750     instead of throwing const char * (bug#101).
5752   + Pure NOT queries are now supported (for example, `NOT apples' will match
5753     all documents not indexed by the stemmed form of `apples').  You need
5754     to enable this feature by passing QueryParser::FLAG_PURE_NOT in flags
5755     to QueryParser::parse_query().
5757   + We now clear the stoplist when we parse a new query.
5759   + Queries such as `+foo* bar', where no terms in the database match the
5760     wildcard `foo*', now match no documents, even if `bar' exists.  Handling
5761     of `-foo*' has also been fixed.
5763   + Now supports wildcarding the last term of a query to provide better support
5764     for incremental searching.  Enabled by QueryParser::FLAG_PARTIAL.
5766   + The default prefix can now be specified to parse_query() to allow parsing
5767     of text entry boxes for particular fields.
5769   + QueryParser::set_stemming_options() has been deprecated since 0.9.0 and
5770     has now been removed.
5772 * Xapian::Stem:
5774   + Now assumes input text is encoded as UTF-8.
5776   + We've updated to the latest version of the Snowball stemmers.  This means
5777     that a small number of words produce different (and generally better)
5778     stems and that some new stemmers are supported: german2 (like german but
5779     normalises umlauts), hungarian, kraaij_pohlmann (a different Dutch
5780     stemmer), romanian, and turkish.
5782 * Xapian::TermGenerator:
5784   + New class which generates terms from a piece of text.
5786 * Xapian::Enquire:
5788   + The Enquire(const Database &) constructor has been marked as "explicit".
5789     This probably won't affect real code - certainly no Xapian API methods
5790     or functions take an Enquire object as a parameter - but calls to user
5791     methods or functions taking an Enquire object could be affected.  In
5792     such cases, you'll now have to explicitly write `Xapian::Enquire(db)'
5793     instead of `db'.
5795   + Enquire::get_eset() now produces better results when used with multiple
5796     databases - without USE_EXACT_TERMFREQ they should be much more similar to
5797     results from an equivalent single database; with USE_EXACT_TERMFREQ they
5798     should be identical.
5800   + Track the minimum weight required to be considered for the MSet separately
5801     from the minimum item which could be considered.  Trying to combine the two
5802     caused several subtle bugs (bug#86).
5804   + Enquire::get_query() is now `const'.  Should have no effect on user code.
5806   + Enquire::get_mset() now handles the common case of an "exact" phrase search
5807     (where the window size is equal to the number of terms) specially.
5809   + Enquire::include_query_terms and Enquire::use_exact_termfreq are now
5810     deprecated in favour of capitalised versions Enquire::INCLUDE_QUERY_TERMS
5811     and Enquire::USE_EXACT_TERMFREQ (for consistency with our other manifest
5812     constants, and general C/C++ conventions).
5814 * Xapian::RSet:
5816   + RSet::contains(MSetIterator) is now `const'.  Should have no effect on user
5817     code.
5819 * Xapian::SimpleStopper::add() now takes `const std::string &' not `const
5820   std::string'.  Should have no effect on user code.
5822 * Xapian::Query:
5824   + We now only perform internal validation on a Query object when it's either
5825     constructed or changed, to avoid O(n^2) behaviour in some cases.
5827   + Xapian::Query::MatchAll (an alias for Query("")) matches all terms in the
5828     document (useful for "pure NOT" queries) and Xapian::Query:MatchNothing
5829     is now a more memorable alias for Query().
5831 * Instead of explicitly checking that a term exists before opening its
5832   postlist, we now do both in one operation, which is more efficient.
5834 * MatchDecider::operator() now returns `bool' not `int'.
5836 * ExpandDecider::operator() now returns `bool' not `int'.
5838 * Xapian::TermIterator::get_termfreq() now throws InvalidOperationError
5839   if called on a TermIterator from a freshly created Document (since
5840   there's no meaningful term frequency as there's no Database for
5841   context).
5843 * <xapian/output.h> is no longer available as an externally visible header.
5844   It's not been included by <xapian.h> since 0.7.0.  Instead of using
5845   `cout << obj;' use `cout << obj.get_description();'.
5847 * New constant Xapian::BAD_VALUENO which is -1 cast to Xapian::valueno.
5849 * New Xapian::ValueRangeProcessor hierarchy: DateValueRangeProcessor,
5850   NumberValueRangeProcessor, and StringValueRangeProcessor.  In
5851   conjunction with the new QueryParser::add_valuerangeprocessor()
5852   method and the new Query::OP_VALUE_RANGE op these allow you to
5853   implement ranges in the query parser, such as `$50..100',
5854   `10..20kg', `01/02/2007..03/04/2007'.
5856 testsuite:
5858 * Many new and improved testcases in various areas.
5860 * If a test throws an unknown exception, say so in the test failure message.
5861   If it throws std::string, report the first 40 characters (or first line if
5862   less than 40 characters) of the string even in non-verbose mode.
5864 * Use of valgrind improved:
5866   + The test harness now only hooks into valgrind if environment variable
5867     XAPIAN_TESTSUITE_VALGRIND is set, which makes it easy to run test programs
5868     under valgrind in the normal way.  The runtest script sets this
5869     automatically.
5871   + runtest now passes "--leak-resolution=high" to valgrind to prevent
5872     unrelated leak reports related to STL classes from being combined.
5874   + configure tests for valgrind improved and streamlined.
5876   + New runsrv script to run xapian-tcpsrv and xapian-progsrv.  We need to
5877     run these under valgrind to avoid issues with excess numerical precision
5878     in valgrind's FP handling, but we can use "--tool=none" which is a lot
5879     faster than running them under valgrind's default memcheck tool.
5881 * The test harness now starts xapian-tcpsrv in a more reliable way - it will
5882   try sequentially higher port numbers, rather than failing because a
5883   xapian-tcpsrv (or something else) is already using the default port.
5884   It also no longer leaks file descriptors (which was causing later tests
5885   to fail on some platforms), and if xapian-tcpsrv fails to start, the error
5886   message is now reported.
5888 * remotetest has been removed and its testcases have either been added to
5889   apitest or just removed if redundant with tests already in apitest.
5891 * termgentest is a new test program which tests the Xapian::TermGenerator
5892   class.
5894 * TEST_EQUAL_DOUBLE() now uses a slightly less stringent threshold -
5895   DBL_EPSILON is too strict for calculations which include multiple
5896   steps.  Also, we now use it instead of doubles_are_equal_enough() and
5897   weights_are_equal_enough() which try to perform the same job.
5899 * New macro TEST_STRINGS_EQUAL() which displays the strings on separate lines
5900   so the differences can be clearly seen.
5902 * Test programs are now linked with '-no-install' which means that libtool
5903   doesn't need to generate shell script wrappers for them on most platforms.
5905 * runtest: Now turns on MALLOC_CHECK_ and MALLOC_PERTURB_ for glibc if
5906   valgrind isn't being used.
5908 * Better support for Microsoft Windows:
5910   + test_emptyterm2 no longer tries to delete a database from disk while a
5911     WritableDatabase object still exists for it, since this isn't supported
5912     under Microsoft Windows.
5914   + Fallback handling when srcdir isn't specified how takes into account .exe
5915     extensions and different path separators.
5917 flint backend:
5919 * Flint is now the default backend.
5921 * xapian-check: New program which performs consistency checks on a flint
5922   database or table.
5924 * xapian-compact: Now prunes unused docids off the start of each source
5925   database's range of docids.
5927 * Positional information is now encoded using a highly optimised fls()
5928   implementation, which is much faster than the FP code 0.9.x used.
5929   Unfortunately the old encoding could occasionally add extra bits
5930   on some architectures, which was harmless except the databases
5931   wouldn't be portable.  Because of this, the flint format has had to
5932   be changed incompatibly.
5934 * The lock file is now called "flintlock" rather than "flicklock" (which
5935   was a typo!)
5937 * Flint now releases its lock correctly if there's an error in
5938   WritableDatabase's constructor.  Previously the lock would remain until
5939   the process exited.
5941 * Flint now throws new Xapian::Error subclass DatabaseVersionError instead of
5942   DatabaseOpeningError when it fails to open a database because it has an
5943   unsupported version.  DatabaseVersionError is a subclass of
5944   DatabaseOpeningError so existing code should continue to work, but it's
5945   now much easier to determine if the problem is that a database needs
5946   rebuilding.
5948 * If you try to open a flint database with an older or newer version than
5949   flint understands, the exception message now gives the version understood,
5950   rather than "I only understand FLINT_VERSION" (literally).
5952 * If we fail to obtain the lock, report why in the exception message.
5954 * Flint now compresses tags in the record and termlist tables using zlib.
5956 * More robust code to handle the flint locking child process, in case of
5957   unexpected errors.
5959 * If a document was replaced more than once between flushes, the document
5960   length wouldn't be updated after the first change.
5962 quartz backend:
5964 * Quartz is still supported, but use in new projects is deprecated (use Flint
5965   instead).  Quartz will be removed eventually.
5967 * quartzcheck: Test if this is a quartz database by looking at "meta" not
5968   "record_DB".  If "record_DB" is >= 2GB and we don't have a LFS aware stat
5969   function then stat can fail even though the file is there.  Also open the
5970   database explicitly as a Quartz database for extra robustness.
5972 * If a document was replaced more than once between flushes, the document
5973   length wouldn't be updated after the first change.
5975 remote backend:
5977 * The remote backend is now supported under Microsoft Windows.
5979 * Open a fresh copy of the database(s) on each connection to a xapian-tcpsrv
5980   rather than relying on being able to share a database across fork() or
5981   between threads (which we don't promise will work).
5983 * xapian-tcpsrv: New "--interface" option allows the hostname or address of the
5984   interface to listen on to be specified (the default is the previous behaviour
5985   of listening on all interfaces).
5987 * If name lookup fails, report the h_errno code from gethostbyname() rather
5988   than whatever value errno happens to currently have!
5990 * Fix bugs in query unserialisation.
5992 * The remote backend now supports all operations (get_lastdocid(), and
5993   postlist_begin() have now been implemented).
5995 * Currently a read-only server can be opened as a WritableDatabase (which is
5996   a minor bug we plan to fix).  In this case, operations which write will fail
5997   and the exception is now InvalidOperationError not NetworkError.
5999 * If a remote server catches NetworkTimeoutError then it will now only
6000   propagate it if we can send it right away (since the connection is
6001   probably unhappy).  After that (and for any other NetworkError) we now
6002   just rethrow it locally to close the connection and let it be logged if
6003   required.
6005 * The timeout parameter to RemoteDatabase wasn't being used, instead the
6006   client would wait indefinitely for the server to respond.
6008 * A timeout of zero to the remote backend now means "never timeout".  This
6009   is now the default idle timeout for WritableDatabase (the connection
6010   timeout default is now 10 seconds, rather than defaulting to the idle
6011   timeout).
6013 * Fix handling of the document length in remote termlists.
6015 * The remote backend now checks when decoding serialised string that the
6016   length isn't more than the amount of data available (bug#117).
6018 * The remote backend now handles the unique term variants of delete_document
6019   and replace_document on the server side.
6021 * The RSet serialisation now encodes deltas between docids (rather than the
6022   docids themselves) which greatly reduces the size of the encoding of a
6023   sparse RSet for a large database.
6025 * We now encode deltas between term positions when sending data after calling
6026   positionlist_begin() on a remote database.
6028 * When using a MatchDecider with remote database(s), don't rerun the
6029   MatchDecider on documents which a remote server has already checked.
6031 * Apply the "decreasing weights with remote database" optimisation which we use
6032   in the sort_by_relevance case in the sort_by_relevance_then_value case too.
6034 * We now throw NetworkError rather than InternalError for invalid data received
6035   over the remote protocol.
6037 * We now close stderr of the spawned backend program when using the "prog" form
6038   of the remote backend.  Previously stderr output would go to the client
6039   application's stderr.
6041 muscat36 backend:
6043 * Support for the old Muscat 3.6 backends has been completely removed.  It's
6044   still possible to convert Muscat 3.6 databases to Xapian databases by
6045   building 0.9.10 and using copydatabase to create a quartz database, which can
6046   then be read by 1.0.0 (and converted to a flint database using copydatabase
6047   again).
6049 build system:
6051 * We've added GCC visibility annotations to the library, which when using GCC
6052   version 4.0 or later reduce the size and load time of the library and
6053   increase the runtime speed a little.  Under x86_64, the stripped library is
6054   6.4% smaller (1.5% smaller with debug information).
6056 * configure: If using GCC, use -Bsymbolic-functions if it is supported
6057   (it requires a very recent version of ld currently).  This option reduces the
6058   size and load time of the shared library by resolving references within the
6059   library when it's created.
6061 * We automatically define _FORTIFY_SOURCE in config.h if GCC is in use
6062   and it's not already set (you can override this as documented in INSTALL).
6063   This adds some checking (mostly at compile time) that important return
6064   values aren't ignored and that array bounds aren't exceeded.
6066 * `./configure --enable-quiet' already allows you to specify at configure time
6067   to pass `--quiet' to libtool.  Now you can override this at make-time by
6068   using `make QUIET=' (to turn off `--quiet') or `make QUIET=y' (to turn on
6069   `--quiet').
6071 * In non-maintainer mode, we don't need the tools required to rebuild some of
6072   the documentation, so speed up configure by not even probing for them in
6073   this common case.
6075 * The makefiles now use non-recursive make in all directories except "docs" and
6076   "tests".  For users, this means that the build is faster and requires less
6077   disk space (bug#97).
6079 * configure: Add proper detection for SGI's C++ (check stderr output of
6080   "CC -v") and automatically pass -ptused in CXXFLAGS for xapian-core and any
6081   applications using xapian-config --cxxflags since it seems to be required to
6082   avoid template linking errors.
6084 * XO_LIB_XAPIAN now checks for the case where XAPIAN_CONFIG wasn't specified
6085   and xapian-config wasn't found, but the library appears to be installed -
6086   this almost certainly means that the user has installed xapian-core from
6087   a package, but hasn't installed the -dev or -devel package, so include
6088   that advice in the error message.
6090 * `./configure --with-stlport-compiler' now requires a compiler name as an
6091   argument.
6093 * configure: Disable probes for f77, gcj, and rc completely by preventing
6094   the probe code from even appearing in configure - this reduces the size of
6095   configure by 209KB (~25%) and should speed it up significantly.
6097 * configure: Suppress more unhelpful warnings and "remarks" for HP's aCC, and
6098   turn on "+wlint", which seems useful.
6100 * A number of cases of unnecessary header inclusions have been addressed,
6101   which should speed up compilation (fewer headers to parse when compiling
6102   many source files).  This also reduces dependencies within the source code,
6103   and thus the number of files which need to be rebuilt when a header is
6104   changed.
6106 * configure: Cache the results of some of our custom tests.
6108 documentation:
6110 * The documentation has all been updated for changes in Xapian 1.0.0.
6112 * Many of the documentation comments in the API headers (which are collated
6113   using doxygen to generated the API reference) have been improved, and some
6114   missing ones added.  Also, internal classes, members, and methods are now all
6115   marked as such so that none should appear in the generated documentation.  In
6116   particular, the class inheritance graphs should be a lot clearer.  A few other
6117   problems have also been addressed.
6119 * docs/internals.html: New separate index page for the "internal"
6120   documentation.
6122 * docs/deprecated.html: New document describing deprecation policy.  This
6123   includes lists of features which have been removed, or which are deprecated
6124   and scheduled for removal, along with suggested replacements.
6126 * docs/admin_notes.html: New document introducing Xapian for sysadmins.
6128 * docs/termgenerator.html: New document describing the new term generation
6129   strategy implemented by the Term::Generator class.
6131 * docs/bm25.html,docs/intro_ir.html: These have been overhauled to make them
6132   fit better with the rest of the documentation, and with Xapian itself.
6134 * docs/overview.html: Fixed links to error classes in generated API
6135   documentation.
6137 * HACKING,INSTALL: Many updates and improvements.
6139 * xapian-config: Improve --version output so that help2man produces a better
6140   man page.
6142 * PLATFORMS: Remove reports for 0.7.* and demote reports for 0.8.* to "older
6143   reports" status.  All SF compilefarm machines are now "no longer available",
6144   so update the symbols and key to reflect this.  Update with recent success
6145   reports from the tinderbox and other sources.
6147 * AUTHORS: Thanks several bug reporters I missed before, as well as recent
6148   contributors.
6150 * docs/code_structure.html now looks nicer and includes links to
6151   svn.xapian.org.
6153 * docs/remote_protocol.html: Fixed several typos and other errors, and document
6154   all the new messages.
6156 * We no longer include docs/apidoc/latex/* in the xapian-core tarballs since
6157   it's just useless bloat.
6159 examples:
6161 * delve:
6163   + Report the exception error string if open a database fails.
6165   + Rename "-k" to "-V" since "keys" were renamed to "values" long ago.  Keep
6166     "-k" as an alias for now, but don't advertise it.  Add handling so "-V3"
6167     shows value #3 for every document in the database.
6169   + No longer stems terms by default.  Add "-s/--stemmer" option to allow a
6170     stemmer to be specified.
6172 * quest: Add "--stemmer" option to allow stemming language to be set, or
6173   stemming to be disabled.
6175 portability:
6177 * Fix compilation with GCC 4.3 snapshot.
6179 * Always use pid_t not int for holding a process id, and use AC_TYPE_PID_T to
6180   `#define pid_t int' if <sys/types.h> doesn't provide pid_t.
6182 * Pass the 4th parameter of setsockopt() as char* which works whether the
6183   function actually takes char* or void* (since C++ allows implicit conversion
6184   from char* to void*).
6186 * Most warnings in the MSVC build have been fixed.
6188 * Refactored most portability workarounds into safeXXXX.h headers.
6190 * Building for mingw in a cygwin environment should work better now.
6192 packaging:
6194 * RPM spec file:
6196   + Updated for the changes in this release.
6198   + ChangeLog.examples is now packaged.
6200 debug code:
6202 * Rename --enable-debug* configure options - conflating the options to "turn on
6203   assertions" and "turn on logging" is confusing. `--enable-debug[=partial]'
6204   becomes `--enable-assertions'; `--enable-debug-verbose' becomes
6205   `--enable-log' and `--enable-debug=full' becomes `--enable-assertions
6206   --enable-log'.  For now the old options give an error telling you the new
6207   equivalent.
6209 * Debug logging from expand is now all of type EXPAND (some was of types
6210   MATCHER and WTCALC before).
6212 * Hook the debug tracing in the lemon generated parser into Xapian's debug
6213   logging framework.
6215 * New assertion types: AssertEqParanoid() and AssertNeParanoid().
6217 * Retry write() if it fails when writing a debug log entry to ensure to avoid
6218   the risk of a partial write.
6220 Xapian-core 0.9.10 (2007-03-04):
6222 API:
6224 * Fix WritableDatabase::replace_document() not to lose positional information
6225   for a document if it is replaced with itself with unmodified postings.
6227 * QueryParser: Add entries to the "unstem" map for prefixed boolean filters
6228   (e.g. type:html).
6230 * Fix inconsistent ordering of documents between pages with
6231   Enquire::set_sort_by_value_then_relevance (fixes bug#110).
6233 testsuite:
6235 * Workaround apparent bug in MSVC's ifstream class.
6237 flint and quartz backends:
6239 * Fix possible double-free after a transaction fails.
6241 * Fix code for recovering from failing to open a table for reading
6242   mid-modification.  If modifications are so frequent that opening for reading
6243   fails 100 times in a row, throw DatabaseModifiedError not
6244   DatabaseOpeningError.
6246 * Don't call std::string::append(ptr, 0) when ptr may be uninitialised
6247   or NULL (rather suspect, and reported to cause SEGV-like behaviour with
6248   MSVC).
6250 * Ensure both_bases is set to false if we don't have both bases when
6251   opening a table using an existing object.
6253 * Use MS Windows API calls to delete files and open files we might want to
6254   delete while they are still open (i.e. the flint and quartz btree base
6255   files).  This fixes a problem when a writer can't discard an old revision at
6256   the exact moment a reader is opening it (bug #108).
6258 remote backend:
6260 * Fix WritableDatabase::has_positions() to refetch the cached value if it
6261   might be out of date.
6263 * Fix incorrect serialisation of a query with non-default termpositions.
6265 inmemory backend:
6267 * If replace_document is used to set the docid of a newly added document which
6268   has previously existed, ensure we mark that document as valid.
6270 documentation:
6272 * Assorted improvements to API documentation.
6274 * docs/Makefile.am: The larger pool_size we set in 0.9.9 for building
6275   sourcedoc.pdf was a bit marginal, so increase it further.
6277 * docs/stemming.html,docs/install.html: Correct 2 references to "CVS" to say
6278   "SVN" instead.
6280 * HACKING: Update the release checklist.
6282 portability:
6284 * Fix flint and quartz to allow 2GB+ B-tree tables when compiling with MSVC.
6286 packaging:
6288 * RPMs: Remove "." from end of "Summary:".  Package the new man page for
6289   xapian-progsrv.
6291 Xapian-core 0.9.9 (2006-11-09):
6293 testsuite:
6295 * Use popen() to run xapian-tcpsrv and wait for "Listening..." before returning
6296   rather than just sleeping for 1 second and hoping that's enough.
6298 * If we can't start xapian-tcpsrv because the port is in use, try higher
6299   numbered ports.
6301 remote backend:
6303 * xapian-tcpsrv: If the port requested is in use, exit with code 69
6304   (EX_UNAVAILABLE) which is useful if you're trying to automate launching of
6305   xapian-tcpsrv instances.
6307 * xapian-tcpsrv: Output "Listening..." once the socket is open and read for
6308   connections (this allows the testsuite to wait until xapian-tcpsrv is ready
6309   before connecting to it).
6311 * xapian-progsrv: Now supports --help, --version, and has a man page.  Fixes
6312   Bug #98.
6314 * Turn on TCP_NODELAY for the TCP variant of the remote backend which
6315   dramatically improves the latency of operations on the database.
6317 build system:
6319 * internaltest: Disable serialiselength1 and serialisedoc1 when the remote
6320   backend is disabled to fix build error in this case.
6322 * Move libbtreecheck.la from testsuite/ to backends/quartz/.
6324 * Move the testsuite harness from testsuite/ to tests/harness/.
6326 documentation:
6328 * Ship our custom INSTALL file rather than the generic one from autoconf which
6329   we've accidentally been shipping instead since 0.9.5.
6331 * docs/Makefile.am: Building sourcedoc.pdf needs a larger pool_size now we're
6332   using pdflatex.
6334 * HACKING: Update debian packaging checklist.
6336 * PLATFORMS: Updated with results from tinderbox.
6338 portability:
6340 * Create "safefcntl.h" as a replacement for <fcntl.h> instead of using
6341   "utils.h" for this purpose, since "utils.h" pulls in many other things we
6342   often don't need.
6344 packaging:
6346 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
6348 Xapian-core 0.9.8 (2006-11-02):
6350 API:
6352 * QueryParser: Don't require a prefixed boolean term to start with an
6353   alphanumeric - allow the same set of characters as we do for the second
6354   and subsequent characters.
6356 flint backend:
6358 * Only force a flush on WritableDatabase::allterms_begin() if there are
6359   actually pending changes.
6361 quartz backend:
6363 * Only force a flush on WritableDatabase::allterms_begin() if there are
6364   actually pending changes.
6366 * quartzcheck: Avoid dying because of an unhandled exception if the Btree
6367   checking code finds an error in the low-level Btree structure.  Add a
6368   catch for any other unknown exceptions.
6370 build system:
6372 * When building with GCC, turn on warning flag -Wshadow even when not in
6373   maintainer mode (provided it is supported by the GCC version being used).
6375 * testsuite/backendmanager.cc: Fix compilation when valgrind is detected by
6376   configure.
6378 * If generating apidoc.pdf fails, display the logfile pdflatex generates since
6379   that is likely to show what failed.
6381 documentation:
6383 * Produce a PDF for apidoc rather than PostScript, since the PDF is smaller,
6384   plus at least as easy to print and easier to view for most users.  Use
6385   pdflatex to generate the PDF directly rather than going via a DVI file which
6386   apparently produces a better result and also avoids problems on some Linux
6387   distros where latex is a symlink to pdfelatex (bug#81, bug#95).
6389 * HACKING: Mention automake 1.10 is out but we've not tested it yet.
6391 * HACKING: Add entries to release checklist: make sure new API methods
6392   are wrapped by the bindings, and that bug submitters are thanked.
6394 * HACKING: Note that on Debian, tetex-extra is needed for
6395   fancyhdr.sty.
6397 * HACKING: Note that dch can be used to update debian/changelog.
6399 * docs/code_structure.html: Document backends/remote.
6401 * PLATFORMS: Update from tinderbox.
6403 portability:
6405 * configure: When checking if we need -lm, don't use a constant argument to
6406   log() as the compiler might simply evaluate the whole expression at compile
6407   time.
6409 * configure: Redhat's GCC 2.96 doesn't support -Wundef even though real GCC
6410   version before and after it do!
6412 * configure: Avoid use of double quotes in double-quoted backticks since
6413   it causes problems on some platforms.
6415 * backends/flint/flint_io.cc: Fix compilation on windows (needs to
6416   #include "safewindows.h" to get definition of SSIZE_T).
6418 * Fix our implementation of om_ostringstream to compile so that the build
6419   works once more on older compilers without <sstream> (regression probably
6420   introduced in 0.9.7).
6422 packaging:
6424 * xapian.spec: Package xapian-progsrv.
6426 Xapian-core 0.9.7 (2006-10-10):
6428 API:
6430 * QueryParser:
6432   + Allow a distance to be optionally specified for NEAR - e.g.
6433     "cats NEAR/3 dogs" (bug#92).
6435   + Implement "ADJ" operator - like "NEAR" except the terms must
6436     appear in matching documents in the same order as in the query.
6438   + Fix bug in how we handle prefixed quoted phrases and prefixed brackets.
6440   + Fix parsing of loved and hated prefixed phrases and bracketted expressions.
6442   + Fix handling of stopwords in boolean expressions.
6444   + Don't ignore a stopword if it's the only query term.
6446 * Document::add_value() failed to replace an existing value with the same
6447   number, contrary to what the documentation says (bug #82).
6449 * Enquire::set_sort_by_value(): Don't fetch the document data when fetching
6450   the value to sort on.  Simple benchmarking showed this to speed up sort by
6451   value by a factor of between 3 and 9!
6453 * Implement transactions for flint and quartz.  Also supported are "unflushed"
6454   transactions, which provided an efficient way to atomically group a number
6455   of database modifications.
6457 * The Xapian::Error and Xapian::ErrorHandler classes have been reimplemented.
6458   The new versions have better, clearer documentation comments and are cleaner
6459   internally.
6461 * Change how doubles are serialised by TradWeight, BM25Weight, and in the
6462   remote backend protocol.  The new encoding allows us to transfer any double
6463   value which can be represented by both machines precisely and compactly.
6465 testsuite:
6467 * Add targets "check-flint", "check-quartz", and "check-remote" in tests and at
6468   the top level which run the subset of tests which test the respective backend.
6470 * apitest: Run tests on flint if flint is enabled, rather than if quartz is
6471   enabled!
6473 * apitest: Speed up deldoc4 when run in verbose mode - some stringstream
6474   implementations are very inefficient when the string grows long.
6476 * Turn on GLIBCXX_FORCE_NEW when running tests under valgrind to stop the GNU
6477   C++ STL from using a pooling allocator.  This helps make velgrind's leak
6478   tracking more reliable.
6480 * Probe for required valgrind logging options at configure time rather than
6481   when running the test program.  This saves about 2 seconds per test program
6482   invocation.
6484 * Fix testsuite harness to show valgrind output when a test fails (when running
6485   under valgrind in verbose mode).  This had stopped working, probably due to
6486   changes in valgrind 3.
6488 * internaltest: Check that the destructor on a temporary object gets called
6489   at the correct time (Sun C++ deliberately gets this wrong by default, and it
6490   would be good to catch any other compilers which do the same).
6492 * apitest: When running tests on the remote backend and running under valgrind,
6493   run xapian-tcpsrv and xapian-progsrv under valgrind too to avoid issues
6494   with the precision of doubles (bug#94).
6496 flint backend:
6498 * Retry on EINTR from fcntl or waitpid when creating or releasing the flint
6499   lock file.
6501 * xapian-compact: Add --blocksize option to allow the blocksize to be set
6502   (default is 8K as before.)
6504 * WritableDatabase::replace_document(did, doc) was double-incrementing the
6505   "changes" counter when document did didn't exist so it would flush twice
6506   as often - fixed.
6508 * WritableDatabase::postlist_begin(): Remove forced flush when iterating the
6509   posting list of a term which has modified postings pending.
6511 quartz backend:
6513 * quartzcompact: Add --blocksize option to allow the blocksize to be set
6514   (default is 8K as before.)
6516 * WritableDatabase::replace_document(did, doc) was double-incrementing the
6517   "changes" counter when document did didn't exist so it would flush twice
6518   as often - fixed.
6520 remote backend:
6522 * Most of the remote backend has been rewritten.  It now supports most
6523   operations which a local database does (including writing!), the protocol
6524   used is more compact, and a number of layers of classes have been eliminated
6525   and the sequences of method calls simplified, so the code should be easier to
6526   understand and maintain despite doing more.  A number of bugs have been fixed
6527   in the process.
6529 * xapian-tcpsrv: Report errno if we catch a Xapian::Error which has it set.
6531 * xapian-tcpsrv: Fix memory leak in query unserialisation.
6533 build system:
6535 * Now using autoconf 2.60 for snapshots and releases.  Also now using a
6536   libtool patch which improves support for Sun C++'s -library=stlport4 option.
6538 * configure: Fix generation of version.h to work with Solaris sed.
6540 * automake adds suitable rules for rebuilding doxygen_api_conf and
6541   doxygen_source_conf, so remove our less accurate versions.  Also fix
6542   dependencies for regenerating the doxygen documentation, and make the
6543   documentation build work with parallel make.
6545 * Make use of the dist_ prefix to avoid having to list files in EXTRA_DIST as
6546   well as in *_DATA and man_MANS.
6548 * Removed a few unused #include-s.
6550 * include/xapian/error.h: Add hook to allow SWIG bindings to be built using
6551   GCC's visibility support.
6553 * configure: Turn on automake's -Wportability to help ensure our Makefile.am's
6554   are written in a portable way.
6556 * configure: Disable probing and short-cut tests for a FORTRAN compiler.  We
6557   don't use one, but current libtool versions always check for it regardless.
6559 * xapian-config: Prune -L/usr/lib from output of `xapian-config --libs'.
6561 documentation:
6563 * docs/scalability.html: quartzcompact and xapian-compact now allow you to set
6564   the blocksize, so there's no need to use copydatabase if you want to migrate
6565   a database to a larger blocksize.  Mention gmane.  Other minor tweaks.
6567 * Eliminate "XAPIAN_DEPRECATED" from generated documentation.
6569 * PLATFORMS: Added success report for Nexenta (alpha 5), MSVC, and sparc linux.
6570   Updated other results from tinderbox.
6572 * Add links to the wiki from README and the documentation index.
6574 * docs/overview.html: Add discussion of uses of terms vs values.
6576 * docs/overview.html: Rewrite the section on Xapian::Document to remove some
6577   very out-of-date information and make it clearer.
6579 * include/xapian/database.h: Note that automatically allocated document IDs
6580   don't reuse IDs from deleted documents.
6582 * include/xapian/enquire.h: Note that "set_sort_by_relevance" is the default
6583   setting.
6585 * docs/queryparser.html,include/xapian/queryparser.h: Add note that
6586   FLAG_WILDCARD requires you to call set_database.
6588 * HACKING: Add some advice regarding debugging using -D_GLIBCXX_DEBUG,
6589   valgrind, and gdb.
6591 * HACKING: Give URL to Alexandre Duret-Lutz's autotools tutorial, which is much
6592   more up-to-date than the "goat book".
6594 * HACKING: Update and expand the information about the debian packaging.
6596 * Add missing dir_contents files.
6598 portability:
6600 * xapian/version.h: Add a check that _GLIBCXX_DEBUG is set compatibly if we're
6601   compiling with GNU C++ 3.4 or newer.
6603 * Add configure check to see if "-lm" is needed to get maths functions since
6604   newer versions of Sun's C++ compiler seem to require this.
6606 * Automatically put Sun's C++ compiler into "ANSI C++ compliant library" mode
6607   (using -library=stlport4).  This allows us to remove most of the special
6608   case bits of code we've accumulated for just this compiler, which improves
6609   maintainability.
6611 * Sun's C++ compiler implements non-standards-conforming lifetimes for
6612   temporary objects by default.  This means database locks don't get released
6613   when they should, so we now always pass "-features=tmplife" for Sun C++
6614   which selects the behaviour specified by the C++ standard.
6616 Xapian-core 0.9.6 (2006-05-15):
6618 API:
6620 * Rename Xapian::xapian_version_string() and companions to
6621   Xapian::version_string(), etc.  Keep the old functions as aliases which are
6622   marked as deprecated.
6624 * QueryParser: Add rules to handle a boolean filter with a "+" in front (such
6625   as +site:xapian.org).
6627 testsuite:
6629 * queryparsertest: Add another prefix testcase to improve coverage.
6631 build system:
6633 * configure: Simpler check for VALGRIND being set to empty value.
6635 * include/Makefile.am: Add xapian/version.h.timestamp as a dependency on
6636   all-local so that xapian/version.h actually gets regenerated when required.
6638 * Eliminate XAPIAN_BUILD_BACKEND_* from config.h and just use
6639   XAPIAN_HAS_*_BACKEND from xapian/version.h instead.
6641 documentation:
6643 * remote_protocol.html: Document keep-alive messages.
6645 * xapian/enquire.h: Remove bogus documentation for a parameter which doesn't
6646   exist.
6648 * PLATFORMS: Added a summary.  Updated and pruned old entries for which we
6649   have a newer close match.
6651 * HACKING: Expand on details of what's required when changing Xapian (discuss
6652   documentation requirements, and more on why feature tests are vital).
6654 * HACKING: Update section on building debian packages.
6656 portability:
6658 * The tarball is generated with a patched version of libtool 1.5.22 which
6659   fixes libtool bugs on HP-UX and some BSD platforms.
6661 * configure: Fix problems with test for snprintf which affected cygwin, and
6662   possibly some other platforms.
6664 * configure: Tweak version.h generation to cope with CXXCPP putting carriage
6665   returns into its output as can happen on cygwin.
6667 * Fix renaming of "iamflint.tmp" for MS Windows where you can't rename an open
6668   file.
6670 * Fixed MSVC7 warnings.
6672 * Added workaround for newlib header bug.
6674 Xapian-core 0.9.5 (2006-04-08):
6676 API:
6678 * QueryParser:
6680   + Fix FLAG_BOOLEAN_ANY_CASE to really allow any case combination - previously
6681     it only allowed all uppercase or all lowercase.
6683   + Fix QueryParser's handling of terms with trailing "#", "+", or "-" when
6684     set_database has been called and the term doesn't exist in the database
6685     with the suffix.
6687 * Add mechanism to allow xapian-bindings to override deprecation warnings so
6688   we can continue to wrap deprecated methods without lots of warnings.
6690 * Move Enquire::get_matching_terms_end() and Document::termlist_end() inline in
6691   header.
6693 * Database::termlist_begin(): Eliminate the MultiTermList wrapper in the common
6694   case where we're only dealing with a single database.
6696 * Fix TermIterator::positionlist_begin() to work on TermIterator from
6697   Database::termlist_begin().  Make TermList::positionlist_begin() pure
6698   virtual and put dummy implementations in BranchTermList and other
6699   subclasses which can't (or don't) implement it.  This makes it hard to
6700   accidentally fail to implement it in a backend's TermList subclass.
6702 * TermIterator::positionlist_begin() with the remote backend now throws
6703   UnimplementedError instead of InvalidOperationError.
6705 * Implement Enquire::set_sort_by_relevance_then_value().
6707 testsuite:
6709 * Added missing feature test for QueryParser::FLAG_BOOLEAN_ANY_CASE.
6711 * remotetest: Check mset size in tcpmatch1.
6713 flint backend:
6715 * xapian-compact: Fixed segfault from passing an unknown option (e.g.
6716   "xapian-compact --foo").
6718 quartz backend:
6720 * quartzdump,quartzcompact: Fixed segfault from passing an unknown option
6721   (e.g.  "quartzdump --foo").
6723 remote backend:
6725 * xapian-tcpsrv: Don't perform a name lookup on the IP address which an
6726   incoming connection is from as that could easily slow down the search
6727   response - instead just print the IP address itself if output is verbose.
6729 * xapian-tcpsrv: Allow up to 5 connections in the listen queue instead of just
6730   one.
6732 build system:
6734 * Removed unused code from the matcher and the remote, quartz, and flint
6735   backends.
6737 documentation:
6739 * All installed binaries now support --help and --version and have a man page
6740   (which is generated using help2man).
6742 * docs/overview.html: Bring up to date.
6744 * docs/remote_protocol.html: Document messages for requesting and sending a
6745   termlist and a document.
6747 * PLATFORMS, AUTHORS: Updated.
6749 * INSTALL: Improve wording.
6751 * HACKING: Note that we now use a lightly patched version of libtool 1.5.22.
6753 * HACKING: aclocal is part of automake, not autoconf.
6755 portability:
6757 * Added some tweaks to help support compilation with MSVC.
6759 packaging:
6761 * RPMs: package the new man pages.
6763 debug code:
6765 * Add missing spaces in some debug output.
6767 Xapian-core 0.9.4 (2006-02-21):
6769 API:
6771 * Flag deprecated methods such that the compiler gives a warning, for compilers
6772   which support such a feature (most notably GCC >= 3.1).
6774 * Correct typo in name of definition of function xapian_revision().
6776 testsuite:
6778 * Updated uses of deprecated methods in the testsuite.
6780 build system:
6782 * xapian-config: Set exec_prefix and prefix at top of script so that
6783   xapian-config works after xapian-core is installed.
6785 documentation:
6787 * Add documentation comment for Enquire::set_sort_by_value_then_relevance().
6789 * README: Add pointer to HACKING.  Change "CVS access" to "SVN access".
6791 * PLATFORMS: Updated from tinderbox.
6793 * COPYING: Update second occurrence of old FSF address.
6795 Xapian-core 0.9.3 (2006-02-16):
6797 API:
6799 * Added 4 functions to report version information for the library version being
6800   used (which may not be the same as that compiled against if shared libraries
6801   are in use):  xapian_version_string(), xapian_major_version(),
6802   xapian_minor_version(), xapian_revision().
6804 * Xapian::QueryParser:
6806   + Fix handling of "+" terms in a query when the default query operator is
6807     AND.  Added regression test for this.
6809   + Added "AND NOT" as a synonym for "NOT".  Added feature tests for this.
6811 * Fix prototype for ESet::operator[] to take parameter of type termcount
6812   instead of doccount (doccount and termcount are both typedefs to the same
6813   type so this really just makes the prototype more consistent).
6815 * Xapian::Stem: Check for malloc and calloc failing to allocate memory and
6816   throw an exception.  Richard has fixed this upstream in snowball, so this is
6817   a temporary fix until we import a new version of snowball.
6819 * Xapian::Database: Trying to open a database for reading which doesn't exist
6820   now fails with DatabaseOpeningError instead of FeatureUnavailableError.
6821   Added regression test for this.
6823 * Add Stopper::get_description() and SimpleStopper::get_description().
6825 testsuite:
6827 * Fixed testsuite harness to work with valgrind on 64 bit platforms.
6829 * Merged the "running tests" section of docs/tests.html into the similar
6830   section in HACKING, and make docs/tests.html refer the reader to HACKING for
6831   more information.
6833 * Tidied and enhanced environmental variables which the test suite harness
6834   recongnises:
6836   + OM_TEST_BACKEND: Removed support since the "-b" switch to apitest allows
6837     you control which backend is used, making OM_TEST_BACKEND pretty much
6838     redundant.
6840   + XAPIAN_SIG_DFL: Renamed to XAPIAN_TESTSUITE_SIG_DFL.
6842   + XAPIAN_TESTSUITE_OUTPUT: New environmental variable to control use of
6843     ANSI colour escape sequences in test output (set to "plain" to disable
6844     them, unset, empty, or "auto" to check if stdout is a tty, or anything
6845     else to force colour).
6847 flint backend:
6849 * xapian-compact: Added "--multipass" option to merge postlists in pairs or
6850   triples until all are merged.  Generally this is faster than an N-way merge,
6851   but it does require more disk space for temporary files so it's not the
6852   default.
6854 quartz backend:
6856 * quartzcheck: If the database is too broken to open, emit a warning message
6857   and bump the error count.
6859 build system:
6861 * Now generate snapshots and releases with automake 1.9.6 (was 1.9.5) and
6862   libtool 1.5.22 (was 1.5.18).
6864 * configure: If not cross-compiling, try to actually run a test program built
6865   with the C++ compiler, not just link one.
6867 * configure: Fix to actually skip the check for valgrind if VALGRIND is set to
6868   an empty value.
6870 * configure: Add sanity check for MS Windows that "find" is Unix-like find, not
6871   MSDOS-like.
6873 * Fix conditional compilation of flint backend - it was being disabled when
6874   quartz was, not when flint was supposed to be.
6876 documentation:
6878 * INSTALL,README: Updated.
6880 * Give pointer to replacements for the deprecated Enquire sorting methods
6881   in the doxygen collated documentation.
6883 * PLATFORMS: Added success reports for ppc64 linux and Fedora Core 4.  Updated
6884   from the tinderbox.
6886 * HACKING: Note platforms valgrind now has solid support for; Improve
6887   phrasing in a few places.
6889 * Upgrade to using doxygen 1.4.6 for generating API documentation.
6891 * Change title of the "full source" documentation to "Internal Source
6892   Documentation" rather than "Full source documentation" to make it
6893   clearer it's only useful if you want to modify Xapian itself.
6895 * Fix documentation comments for the values of QueryParser::feature_flag so
6896   doxygen actually pulls out the documentation for them.  Add documentation for
6897   the parameters of QueryParser::parse_query().
6899 * queryparser.html: Document wildcards.
6901 portability:
6903 * Fix compilation with GCC 4.0.1 and later (need to forward declare class
6904   InMemoryDatabase) (bug #69).
6906 * Fix compilation under cygwin (broken in 0.9.2).
6908 * Don't pass NULL for the second parameter of execl() - the Linux man page
6909   says execl takes "one or more pointers to null-terminated strings".  Also
6910   cast the NULL to (void*) to avoid "missing sentinel" warning from GCC4.
6912 * Use snprintf instead of sprintf where available (we were attempting to
6913   do this in some places before, but the configure test was broken so
6914   sprintf was always being used).
6916 * Enable more warnings under aCC and fix minor issues highlighted.  Suppress
6917   "Entire translation unit was empty" warning which isn't useful to us.
6919 * Write top-bit set characters in the source using \xXX notation to avoid
6920   warnings from Intel's C++ compiler.
6922 * configure: TYPE_SOCKLEN_T fails hard, so only run it if we've successfully
6923   run other socket tests.
6925 * queryparser/accentnormalisingitor.h: #include <limits.h> for CHAR_BIT.
6927 * bin/xapian-compact.cc: Fix printf type mismatch on 64 bit platforms.
6929 * Replace pair<bool, string> with a simple class BoolAndString - the pair
6930   results in a 4328 byte symbol on HP-UX which gets truncated (to 4000 bytes).
6931   Most likely this is harmless, but it causes a warning.
6933 * configure: Disable flint backend by default if building for djgpp or msdos.
6935 * xapian-config: Previously when linking without libtool we've always thrown
6936   in dependency_libs, even though only some platforms need it (because it's
6937   generally pretty harmless).  However some Linux distros have an unhelpful
6938   policy of not packaging .la files, so libxapian.la isn't available to
6939   extract dependency_libs from.  Linux is a platform which doesn't require
6940   dependency_libs to be explicitly linked, so extend xapian-config to not
6941   pull in dependency_libs if libtool's link_all_deplibs_CXX=no.
6943 * xapian-config: If the current platform needs dependency_libs and
6944   libxapian.la's dependency_libs contains another .la file, transform it into a
6945   pair of -L and -l options, and recursively expand its dependency_libs (if
6946   any).
6948 * Don't pass functions with C++ linkage to places wanting pointers to functions
6949   with C linkage.  So far this has worked for us, but it causes warnings with
6950   some compilers, and may not be portable.
6952 * Compaq C++ 7.1 doesn't suffer from the problem which previously prevented
6953   it from building Xapian.  This release includes workarounds for some
6954   oddities with errno.h support in this compiler, but currently the build
6955   fails when trying to link a binary with the library.
6957 packaging:
6959 * RPM: Invoke %setup correctly in xapian.spec.
6961 debug code:
6963 * Add missing '#include <iostream>' when TIMING_PATCH is defined.
6965 Xapian-core 0.9.2 (2005-07-15):
6967 API:
6969 * QueryParser:
6971   + Added optional "flags" argument to parse_query method.
6973   + Add flag FLAG_BOOLEAN_ANY_CASE which tells the QueryParser that boolean
6974     operators such as "AND", "OR", and "NEAR" should be recognised even if
6975     they aren't fully capitalised (so "and", "And", "aNd", etc will work too).
6977   + Add flag FLAG_WILDCARD which tells the QueryParser to allow right
6978     truncation e.g. "xap*".
6980   + Fixed to handle "-site:microsoft.com" where site is a boolean prefix.
6981     Added testcases for this.
6983 testsuite:
6985 * The test harness was incorrectly creating a quartz database when a flint one
6986   was requested, which meant tests weren't being run against flint and so it
6987   had bugs rendering it pretty much unusable.
6989 * Added regression test longpositionlist1 (to check encoding/decoding a long
6990   position list, which flint had problems with).
6992 flint backend:
6994 * Bumped format version number.
6996 * Added new "xapian-compact" program which can compact and merge flint
6997   databases in a similar way to how quartzcompact does for quartz databases.
6999 * Fixed to auto-detect database type when opening an existing Flint database
7000   as a WritableDatabase.
7002 * The code to encode the position list size, first entry, and last entry
7003   didn't match the code to decode them!  Reworked both to match, using a
7004   slightly more compact encoding.
7006 * We were failing to append "DB" to the path when opening a table for reading.
7008 * Rewrite of FlintAllTermsList with several fewer member variables.  The
7009   rewrite fixes a bug too - the old version wasn't ignoring the metainfo
7010   entry which is now in the postlist table.
7012 * It seems we need to explicitly kill the child process used for locking.
7013   Otherwise when we have two databases locked just closing the connection
7014   doesn't cause the child to die.  I don't understand why it's needed, but this
7015   fix is at least clean.
7017 quartz backend:
7019 * quartzcompact: Fix mis-repacking of keys in positionlist table when merging
7020   several databases.
7022 * Disable assertion in allterms iteration which is incorrect in a corner case.
7023   This is only a problem if a termname contains zero bytes and you're using a
7024   debug build.  Add regression test test_specialterms2.
7026 remote backend:
7028 * Implement sorting on a value with the remote backend.
7030 build system:
7032 * Pass automake options to AM_INIT_AUTOMAKE rather than specifying them in
7033   Makefile.am.  This way, the version requirements for autoconf and automake
7034   are stated close together.
7036 * configure: -Wshadow causes false positives with GCC 3.0.4, so only enable it
7037   for 3.1 and up.
7039 * configure: Eliminate use of "ln -s" when generating include/xapian/version.h
7040   since it seems to cause problems on Solaris in some setups and isn't really
7041   necessary.
7043 * Add dependency mechanism so version.h gets regenerated when the template is
7044   changed.
7046 * configure: Check for spaces in build directory, source directory, or install
7047   prefix and die with a helpful message.
7049 * Add dependency to generate queryparser_token.h.
7051 * Eliminated TOP_SRCDIR and TOP_BUILDDIR - it's better to just use top_srcdir
7052   and top_builddir directly.
7054 * configure: Generate the list of source files to feed to doxygen by inspecting
7055   all the Makefile.am files prior to running autoreconf rather than by using
7056   "find" when the user runs ./configure.  This speeds up configure, avoids
7057   generating docs for random .cc and .h files which aren't part of xapian-core,
7058   and avoids problems with picking up FIND.EXE on MS Windows.
7060 documentation:
7062 * Expanded explanation of the "descending docid with boolean weighting" trick
7063   for fast date ordered searching in Enquire::set_docid_order() API docs.
7065 * docs/intro_ir.html: Citeseer has moved, so update link.
7067 * testsuite/testsuite.cc: Update URL for valgrind FAQ in comment.
7069 * COPYING: Update FSF address.
7071 * HACKING: Minor updates to release checklist.
7073 portability:
7075 * Assorted tweaks towards allowing compilation with MSVC.
7077 packaging:
7079 * xapian.spec.in: Package xapian-compact.
7081 Xapian-core 0.9.1 (2005-06-06):
7083 API:
7085 * Fix SEGV on get_terms_begin() on an empty Query object.  This was causing
7086   a SEGV in Omega with an empty query.
7088 * Put Query::get_terms_end() inline in header.
7090 flint backend:
7092 * Added the new "flint" backend, which starts out as a copy of the quartz
7093   backend plus some modifications and replacements.  When creating a database
7094   without a specified backend, quartz is still used unless the environmental
7095   variable XAPIAN_PREFER_FLINT is set to a non-empty value.
7097 * apitest now runs tests on flint as well as the other backends.
7099 * Removed undocumented (and hence the little used) quartz "log" feature.
7101 * Implement new fork+fcntl+exec based locking (for Unix) and CreateFile based
7102   locking (for Windows - currently untested).
7104 * Move the special key/tag pair holding the total document length and doc id
7105   high water mark from the record table to the postlist table.  This means that
7106   when appending documents, the insertion point will now always be at the end
7107   of the record table which is more efficient.  We need to jump around the
7108   postlist table to merge postings in anyway.
7110 * Changed metafile magic to be different from quartz, and make the metafile
7111   version a datestamp which we'll change each time the format changes.
7113 * Check the return value of close() when writing the metafile.
7115 * Flint position list table now stores entries using interpolative coding
7116   (which is significantly more compact).
7118 quartz backend:
7120 * quartzcheck: Fixed corner case where you couldn't check a single Btree table
7121   which was just the DB and baseA/baseB files in a directory (Xapian doesn't
7122   produce anything like this, but btreetest does while unit testing the
7123   Btree code).
7125 build system:
7127 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
7129 * configure: Pass more -W flags to g++ (including -Wundef which caught the
7130   getopt problem fixed in this release).  Fixed new GCC warnings from these new
7131   flags.
7133 * Fixed a lingering DOXYGEN_HAVE_DOT reference.
7135 * Fixed accidentally pruned #define which meant that getopt code was being
7136   included even on systems which use glibc (on such systems, we should use
7137   the glibc copy of the code instead).
7139 * queryparser/queryparser.lemony: Add missing '#include <config.h>'.
7141 documentation:
7143 * Added missing documentation comments for a QueryParser methods added in
7144   0.9.0.
7146 * docs/quartzdesign.html: Removed warning that quartz is still in development.
7148 * PLATFORMS: Updated from tinderbox.
7150 * configure: Describe CC_FOR_BUILD in configure --help output.
7152 * HACKING: Updated release instructions to refer to SVN, and note that release
7153   tarballs are now built specially rather than being copies of snapshots.
7154   Update information about the SVN tag name to use for debian files.
7156 * HACKING: Add "email Fabrice" to the release checklist so that RPM
7157   spec files don't lag behind.
7159 * Fixed a few spelling mistakes.
7161 packaging:
7163 * xapian.spec: Remove bogus %setup line left over from when we packaged
7164   xapian-core and xapian-examples together from separate tarballs.
7166 debug code:
7168 * api/omqueryinternal.cc: Fixed compilation with --enable-debug.
7170 * common/omdebug.h: Replace C style cast with static_cast<> which reveals that
7171   we were discarding const (harmlessly though).
7173 Xapian-core 0.9.0 (2005-05-13):
7175 API:
7177 * Query objects really need to be immutable after construction (otherwise we
7178   need a copy-on-write mechanism).  To achieve this the following API changes
7179   were required:
7181   + Remove Query::set_length() in favour of an optional length
7182     parameter to Enquire::set_query().
7184   + Eliminated Query::set_elite_set_size() in favour of optional parameter
7185     to constructor.
7187   + Eliminated Query::set_window() in favour of an optional parameter to the
7188     constructor.
7190 * Removed OP_WEIGHT_CUTOFF, since it doesn't actually seem to add useful
7191   functionality over using Enquire::set_cutoff().
7193 * MSet::max_size() (which only exists so that MSet is an STL container) now
7194   returns MSet::size() and is inlined from the header.
7196 * Added ESet::max_size() (for STL compatibility).
7198 * Fixed Xapian::RSet to have the same "it's a handle" copy semantics as most of
7199   the other classes.
7201 * Rewritten QueryParser class:
7203   + Uses Lemon instead of Bison to generate the parser, which enables us to
7204     stop using static data, so this class is at last reentrant.
7206   + QueryParser now uses a PIMPL style with reference counted internals like
7207     most of the other Xapian classes.
7209   + Direct access to member variables has gone, which unfortunately forces an
7210     API change (but this fixes bug #39).  Instead of accessing
7211     QueryParser::termlist member variable, iterate over terms using
7212     Query::get_terms_begin() and get_terms_end() on the returned Query object.
7213     Direct access to stoplist is replaced by QueryParser::get_stoplist_begin()
7214     and get_stoplist_end(); and to unstem by get_unstem_begin() and
7215     get_unstem_end().
7217   + The rewrite parses many real world examples better than the old version.
7219   + Now allow searches for C#, etc.  If a database has been set, for this and +
7220     and - suffixes, check if the term actually exists, and if not, ignore the
7221     suffix if the unsuffixed term exists.
7223   + Added QueryParser::get_description() method (not very descriptive yet!)
7225   + Added backward compatibility wrapper for old version of
7226     QueryParser::set_stemming_options().
7228   + xapian.h now automatically includes xapian/queryparser.h.  Directly
7229     including xapian/queryparser.h will continue to work for now, but is
7230     deprecated.
7232   + QueryParser::parse_query() was failing to clear termlist and unstem
7233     - the rewrite fixes this.
7235   + New QueryParser parses "term prefix:(term2 term3)" correctly.
7237 * Added Xapian::SimpleStopper which just stops terms specified by a pair of
7238   iterators.  This should be sufficient for the majority of uses.
7240 * Tidied up the Enquire sorting API and added ability to reverse sort on a
7241   value.  Removed sort_bands support.
7243 * Enquire::get_description() improved.
7245 * Methods which return an end iterator where the internals are just NULL are
7246   now inline in the header for efficiency.  Should we ever need to change an
7247   implementation, we can easily move methods back into the library and bump the
7248   library version suitably.
7250 * Added Stem::operator() as preferred alternative to Stem::stem_word().
7252 * Simplified Stem internal design by restructuring to eliminate a few internal
7253   methods.
7255 * BM25Weight: Avoid fetching document length if we're simply going to multiply
7256   it by zero!
7258 testsuite:
7260 * Fixed TEST_EQUAL_DOUBLE to use DBL_EPSILON correctly.
7262 * Rewrite of index_utils test harness code, removing unused and unusual
7263   features.  Data files for tests are now easier to write.  These changes
7264   also fix the bug that ^x didn't actually decode hex values correctly.
7266 * tests/testdata/etext.txt: Stripped carriage returns.
7268 * apitest: Extended stemlang1 to check that trying to create
7269   a stemmer for a non-existent language throws InvalidArgumentError.
7271 * queryparsertest:
7273   + Moved into tests/ subdirectory.
7275   + Reworked to use the standard testsuite harness.
7277   + Added tests for new features in the rewritten QueryParser.
7279 quartz backend:
7281 * quartzcheck: Now checks the structure of all the tables, not
7282   just the postlist table, and cross-checks doclen values between
7283   termlist and postlist tables.  Recognises "--help" option.  Should
7284   now continue after an error (typically it would crash before), and
7285   counts the number of errors found.  Now exits with non-zero status
7286   if any errors were found.  More readable output.
7288 * quartzcompact: Extended to allow merging several quartz
7289   databases to produce a single compact quartz database.  This
7290   allows for faster building - simple index in chunks, then merge
7291   the chunks.
7293 * quartzcompact: Made full compaction a tiny bit more compact.
7295 * quartzcompact: Added "fuller compaction" mode, which ignores the usual "at
7296   least 4 items per block" rule.  This achieves slightly tighter compaction,
7297   though it's probably not advisable to use this option if you plan to update
7298   the compacted database.
7300 * Improved compaction by a few % in non-full case.  Tighter bound on amount of
7301   memory to reserve to read the tag into.
7303 * Fix skip_to on an allterms TermIterator to set the current term when the
7304   skip_to-ed term is in the database.  Add regression test for this
7305   (allterms5).
7307 * Values are stored in sorted order so we can stop unpacking the list once we
7308   get to one after the one we're looking for (in the case where the one we're
7309   looking for doesn't exist).
7311 build system:
7313 * configure: Check that the C++ compiler can actually link a program.
7314   AC_LANG_CXX doesn't, and if it can't find a C++ compiler it'll just return
7315   "g++" which just leads to a later configure test failing in a confusing way.
7317 * configure: corrected configure output of "none known for yes" or "none known
7318   for no" to "none known for g++-3.2" or similar.
7320 * include/xapian/version.h: Define XAPIAN_HAS_xxx_BACKEND for each backend
7321   which is enabled.  The bindings need this, and user code might find it useful
7322   too.
7324 * include/xapian/database.h: Don't declare the backend factory functions if the
7325   corresponding backend has been disabled.  This means that trying to use a
7326   disabled backend will be caught at compile time rather than link time.
7328 * configure: Enhanced valgrind test to (a) see if --tool=memcheck
7329   is needed and (b) see if valgrind actually works (we don't want to
7330   try to use an x86 valgrind on an x86_64 box).
7332 * configure: Suppress 2 Intel C++ warnings which we can't easily code around,
7333   and enable -Werror automatically with --enable-maintainer-mode.
7335 * Clearer make rules for building Postscript doxygen docs.
7337 * Removed some no longer used code.
7339 * Moved a number of method definitions out of headers because they are virtual,
7340   or too large to be sensible candidates for inlining.
7342 * Eliminated the extra library for the queryparser - it's tiny compared to the
7343   main library and having it around just complicates things.
7345 * configure: We no longer need Bison, but we do need CC_FOR_BUILD to compile
7346   Lemon with.
7348 * Snapshot generator now appends _svn6789 or similar to the version string.
7349   Adjusted configure and XO_LIB_XAPIAN macro to take this into account.
7351 * configure: If any tools needed for documentation are missing
7352   and we're in maintainer mode, die with a suitable error in
7353   configure rather than with strange errors when building the
7354   documentation.
7356 * docs/Makefile.am: Explicitly set the pool_size for latex, because we
7357   now seem to overflow the default setting on some systems.
7359 * docs/Makefile.am: Use $(MAKE) instead of make.
7361 documentation:
7363 * Numerous improvements to documentation comments.  Added documentation
7364   comments for QueryParser class.
7366 * HACKING: Added better description of how reference-counted API
7367   classes are structured.
7369 * HACKING: Note that '#include <limits>' isn't supported by GCC 2.95,
7370   and other assorted minor tweaks.
7372 * HACKING: Note how to disable use of VALGRIND on the make check
7373   command line, or when using runtest directly.
7375 * Updated all documentation mentions of CVS to talk about Subversion
7376   instead.
7378 * PLATFORMS: Updated from tinderbox and other sources.
7380 * PLATFORMS: Added minimal testcase which fails to compile with
7381   Compaq's C++ compiler (cxx).
7383 * INSTALL,README: Updated.
7385 * docs/queryparser.html: Note that + and - work on phrases and
7386   bracketed expressions.
7388 * docs/intro_ir.html: Corrected two errors.
7390 * docs/stemming.html: Stemming appears to be applicable to Japanese
7391   so don't say it isn't!
7393 examples:
7395 * Moved xapian-examples module to examples subdirectory of xapian-core.
7397 * quest: Added stopword handling.
7399 portability:
7401 * configure: autoconf identifies Intel's C++ compiler as GCC, so probe for
7402   which we actually have.
7404 * Xapian will now compile cleanly with Intel C++ 8.1 on ia64 Linux and
7405   on x86 Linux.
7407 * backends/quartz/btree.cc: Fixed GCC compilation warning.
7409 * tests/api_db.cc: Fixed warning from Sun's C++ compiler.
7411 * configure: Automatically enable ANSI C++ mode for SGI's compiler
7412   with '-LANG:std'; check that any automatically determined flags
7413   for ANSI C++ mode actually allow us to compile a trivial program
7414   - if they don't it probably means the compiler isn't the one we
7415   were expecting, but one installed with the same name, so we now
7416   drop the flags in this case.
7418 * The compile on IRIX with SGI compiler is now warning free, apart from two
7419   "unused variable" warnings in Snowball generated code.
7421 * On WIN32, don't define NOMINMAX if it is already defined.
7423 packaging:
7425 * xapian.spec: Don't say "%makeinstall" in a comment since rpm
7426   tries to expand it and explodes.
7428 * xapian.spec: '/usr/share' -> '%{_datadir}'.
7430 * xapian.spec: Put the .so in the -devel package (it's only useful
7431   for linking to - the .so.* files are all that's needed at runtime).
7433 debug code:
7435 * net/socketserver.cc: Fixed typo in debug code.
7437 Xapian-core 0.8.5 (2004-12-23):
7439 quartz backend:
7441 * quartzcompact: When full_compaction is enabled, don't fill the last few bytes
7442   of a block if that would mean we needed an extra item and the overhead for
7443   that item would use up more of the next block than we save.  This reduces the
7444   table size after full compaction by up to 0.2% in my tests!
7446 * quartzcompact: Tables sizes will always be a whole number of Kbytes, since
7447   the blocksize is, so report the size in K.  Also report the change in size as
7448   well as the before and after sizes.
7450 * quartzcompact: Added missing '#include <config.h>' so that largefile support
7451   is enabled when we call stat() and we report compression statistics for
7452   tables > 2G.
7454 * quartzcompact: Added --no-full / -n option to disable full compaction.  This
7455   may be useful if you want to update the database after compacting it (need to
7456   test to see if this option is actually useful).
7458 * Renamed Btree::compress() to Btree::compact() for consistency with
7459   "full_compaction" and "quartzcompact".  Also, "compress" is confusing since
7460   we use that term in the zlib patch.
7462 build system:
7464 * xapian-config: Fixed --libs output to not include libxapian.la.
7466 * Added missing '#include <config.h>' to various .cc files (the omissions were
7467   probably harmless, but config.h should be included as the first thing any
7468   source file does).
7470 documentation:
7472 * Minor updates.
7474 packaging:
7476 * RPM spec file: %makeinstall puts the wrong paths in the .la files so use
7477   "make DESTDIR=... install" instead.
7479 debug code:
7481 * Fixed to build with AssertParanoid enabled.
7483 Xapian-core 0.8.4 (2004-12-08):
7485 API:
7487 * Added constructors to Database and WritableDatabase which fulfil the role
7488   that the Auto::open() factory functions currently do.  Auto::open() is
7489   now deprecated.
7491 * Removed the ability to write a Xapian object to an ostream directly, as
7492   it's little used and potentially dangerous ('cout << mset[i];' will
7493   compile, but you almost certainly meant 'cout << *mset[i];').  You can
7494   get the old effect by writing 'cout << obj->get_description();' instead
7495   of 'cout << obj;'.  Note that including xapian.h no longer pulls in
7496   fstream, which code may have been implicitly relying on - if this is
7497   a problem add '#include <fstream>' after '#include <xapian.h>'.
7499 * QueryParser: Be smarter about when to add a ':' when adding a term prefix.
7501 * BoolWeight::unserialise() now returns BoolWeight*, and similarly for
7502   TradWeight and BM25Weight.  BoolWeight::clone() now returns BoolWeight *.
7504 * If a database contains no positional information, change NEAR and PHRASE
7505   queries into AND queries (as otherwise they'd return no matches at all)
7506   (bug #56).  Added feature test phraseorneartoand1.
7508 * Renamed BM25 parameters to match standard naming in papers and elsewhere
7509   (A->k3, B->k1, C->k2, D->b), eliminated the extra factor of 2 which our C
7510   had, and reordered the parameters to k1, k2, k3.  This is an incompatible API
7511   change for BM25Weight(), so if you are using custom parameters for BM25
7512   you'll need to update your code.
7514 * During query expansion, if we estimate the term frequency, ensure it has a
7515   sane value (>= r and <= N - R + r) rather than bodging around the problem
7516   later on.
7518 * TradWeight, BM25Weight: termfreq is always exact for matching (we only
7519   approximate it for query expansion) so replace code to work around bad
7520   approximations with Assert() to make sure this never happens.
7522 testsuite:
7524 * runtest: Enhanced to allow it to run test programs under valgrind and other
7525   tools (gdb was already supported).
7527 * runtest: now works with valgrind 2.1.2 and later (valgrind's --logfile-fd
7528   option was renamed to --log-fd).
7530 * runtest: Allow VALGRIND environmental variable to override the value we got
7531   from configure.
7533 * Added a dependency so "make check" regenerates runtest if necessary.
7535 * The test programs now point the user to the runtest script if srcdir can't
7536   be guessed.  And they no longer look for the test program in the tests
7537   subdirectory of the current directory.
7539 * btreetest: Fixed memory leaks in test_cursor1 (the testcase itself was
7540   causing the leak, not the library).
7542 * apitest: Fixed mset_range_is_same() and mset_range_is_same_weights() helper
7543   functions which were only comparing the first item in the range.  Thankfully
7544   the tests still all pass so this wasn't hiding any bugs.
7546 * apitest: A modified version of changequery1 fails - the bug is obscure and
7547   subtle, and the fix is tricky so set the modified test to SKIP for now.
7549 * apitest: Added test_weight1 which tests the built-in Xapian::Weight
7550   subclasses and test_userweight1 which tests user defined weighting schemes
7551   (bug#8).
7553 * quartztest: Test with DB_CREATE_OR_OPEN in writelock1.
7555 quartz backend:
7557 * An interrupted update could cause any further updates to fail with "New
7558   revision too low" because the new revision was being calculated incorrectly -
7559   fixed (bug#55).
7561 * Fixed Bcursor::del() which didn't always leave the cursor on the next item
7562   like it should.  This may have been causing problems when trying to remove
7563   the last references to a particular term.
7565 * Fixed ultra-obscure bug in the code which finds a key suitable to
7566   discriminating between two blocks in a B-tree branch (discovered by reading
7567   the code).  Comparing the keys didn't consider the length of the second, so
7568   it is possible the code would miscompare.  But in reality this is extremely
7569   unlikely to happen, and even then would probably just mean that the
7570   discriminating key wouldn't be as short as it could be (wasting a few bytes
7571   but otherwise harmless).
7573 * If we're removing a posting list entirely, often there will only be one
7574   chunk, so avoid creating a Bcursor in this case.
7576 * Simplified Btree::compare_keys() by removing the last case which was dead
7577   code as it was covered by an earlier case.
7579 * Check that any user specified block size is a power of 2.  If the block
7580   size passed is invalid, use the default of 8192 rather than throwing an
7581   exception.
7583 * Started to refactor the Btree manager by introducing Item and Key classes
7584   which take care of handling the on-disk format, and eliminated duplicated
7585   tag reading code in Btree and Bcursor.  These changes will pave the way for
7586   improvements to the on disk format.
7588 * Applied the Quartz "DANGEROUS" patch, but disabled for now.  This way it
7589   won't keep being broken by changes to the code.
7591 * quartzcompact: Added --help and --version; Check that the source path and
7592   desitination path aren't the same; Report each table name when we start
7593   compacting it, and some simple stats on the compaction achieved when we
7594   finish.
7596 muscat36 backend:
7598 * Removed a default parameter value from one variant of
7599   Xapian::Muscat36::open_db() so that there's only one candidate for
7600   open_db(string).
7602 build system:
7604 * xapian-config: If flags are needed to select ANSI mode with the current
7605   compiler, then make xapian-config --cxxflags include them so that Xapian
7606   users don't have to jump through the same hoops we do.
7608 * xapian-config: Added --swigflags option for use with SWIG.
7610 * XO_LIB_XAPIAN now passes ac_top_srcdir to xapian-config which uses it
7611   (if provided) to say "configure.ac" or "configure.in" rather than
7612   "configure.in (or configure.ac)" in the "Add AC_PROG_LIBTOOL"
7613   error message.
7615 * Cleaned up the build system in a few places.
7617 * Removed a few totally unneeded header includes.
7619 * Moved a number of functions and methods out of headers because they're not
7620   good inlining candidates (too big or virtual methods).
7622 * Changed C style casts to C++ style.  The syntax is ugly, but they do make the
7623   intent clearer which is a good thing.  Note this as a coding style guideline
7624   in HACKING.
7626 * configure.ac: Automatically add -Werror to CFLAGS and CXXFLAGS if
7627   maintainer mode is enabled and we're using GCC3 or newer.  Don't do
7628   this for older GCCs as GCC 2.95 issues spurious warnings.
7630 * Reworked how include/xapian/version.h is generated so that it works
7631   better with compilers other than GCC, and with HP-UX sed.
7633 * XAPIAN_VERSION is now a string (e.g. "0.8.4").
7635 * Added new #define XAPIAN_REVISION (which is 4 for version 0.8.4).
7637 documentation:
7639 * docs/bm25.html,docs/intro_ir.html: Reworked to talk about Xapian
7640   rather than Muscat.  Also improved the appearance of the formulae.
7642 * HACKING: Valgrind now supports x86 FreeBSD and PowerPC Linux.
7644 * Documented parameters of Enquire::register_match_decider().
7646 * We now use doxygen 1.3.8 to build documentation for snapshots and releases.
7648 * PLATFORMS: Updated from the tinderbox (which now runs builds on machines
7649   available in HP's testdrive scheme) and other assorted reports.
7651 * PLATFORMS: Removed reports from versions prior to 0.7.0.  So much
7652   has changed that these are of little value.
7654 * docs/scalability.html: Added note warning about benchmarking from cold.
7656 * Assorted other minor documentation improvements.
7658 portability:
7660 * configure.ac: Improved snprintf configure test to actually
7661   check that it works (older implementations may have different
7662   semantics for the return value, and at least one ignores the length
7663   restriction entirely!)
7665 * Reworked the GNU getopt source we use so that the header is clean and
7666   suitable for use from a reasonably ISO-conforming C++ compiler instead of
7667   being full of cruft for working around quirky C compilers which C++ compilers
7668   tend to stumble over.
7670 * Use SOCKLEN_T for the type we need to pass to various socket calls, since
7671   HPUX defines socklen_t yet wants int in those calls.  Reworked the
7672   TYPE_SOCKLEN_T test we use.
7674 * On Windows, we want winsock2.h instead of sys/socket.h.  Mingw doesn't seem
7675   to even have the latter, so I think previously we've been compiling by
7676   picking one up from somewhere random!
7678 * Change the small number of C sources we have to be C++ so we can compile
7679   everything with the C++ compiler.  This way we don't need to worry about
7680   configure choosing a mismatching pair of compilers, or about whether
7681   configure tests with the C compiler don't apply to the C++ compiler, or vice
7682   versa.
7684 * Compiles and passes testsuite with HP's aCC (we have to compile in
7685   ANSI mode, so we automatically add -AA to CXXFLAGS).
7687 * If the link test detects pread and pwrite are present, get configure to try
7688   out prototypes for pread and pwrite.  This is much cleaner than trying to
7689   find the right combination of preprocessor defines to get each platform's
7690   system headers to provide prototypes.
7692 * configure: Disable probing for pread/pwrite on HP-UX as they're present but
7693   don't work when LFS (Large File Support) is enabled, and we definitely want
7694   LFS.
7696 * Fixed some warnings from Sun's C++ compiler.
7698 * Provide our own C_isalpha(), etc replacements for isalpha(), etc
7699   which always work in the C locale and avoid signed char problems.
7701 * For mingw/cygwin, pass -no-undefined when linking libxapianqueryparser.la
7702   so libtool builds a shared library.  Also pass the magic linker flag
7703   -Wl,--enable-runtime-pseudo-reloc if configure has determined it is needed.
7705 * For cygwin, use the underlying MoveFile API call for locking, as link()
7706   doesn't work on FAT partitions.  And don't rely on HAVE_LINK to control
7707   whether we use link() otherwise - if the configure test somehow misfires, a
7708   compilation error is better than using rename() on Unix as that would cause a
7709   second writer to smash the lock of the first.
7711 * Closer to building with Compaq C++ - add "-std strict_ansi" to CXXFLAGS, and
7712   tweaked the code in several places.  It currently dies trying to compile
7713   the PIMPL smart pointer template code which looks hard to fix.
7715 debug code:
7717 * HACKING: Document that %% in XAPIAN_DEBUG_LOG is substituted with
7718   the process-id, and that setting XAPIAN_DEBUG_FLAGS to -1 enables
7719   all debug messages.
7721 * Removed compatibility code for checking environment variables OM_DEBUG_FILE
7722   and OM_DEBUG_TYPES.
7724 Xapian-core 0.8.3 (2004-09-20):
7726 API:
7728 * Fixed bug which caused a segmentation fault or odd "Document not found"
7729   exceptions when new check_at_least parameter to Enquire::get_mset() was used
7730   and there weren't many matches (regression test checkatleast1).
7732 remote backend:
7734 * Renamed omtcpsrv to xapian-tcpsrv and omprogsrv to xapian-progsrv.
7736 packaging:
7738 * RPM packaging now has a separate package for the runtime libraries to
7739   allow 32 and 64 bit versions to be installed concurrently.
7741 * RPM for xapian-core now includes binaries from xapian-examples.
7743 debug code:
7745 * Fixed to compile with debug tracing enabled.
7747 Xapian-core 0.8.2 (2004-09-13):
7749 API:
7751 * Removed the compatibility layer which allowed programs written against the
7752   pre-0.7.0 API to be compiled.
7754 * Added new ESet methods swap(), back() and operator[].
7756 * Xapian::WritableDatabase::replace_document can now be used
7757   to add a document with a specific docid (to allow keeping docids
7758   in sync with numeric UIDs from another system).
7760 * Added Xapian::WritableDatabase::replace_document and
7761   delete_document variants which take a unique id term name rather
7762   than a document id.
7764 * Enquire::get_mset(): If a matchdecider is specified and no matches
7765   are requested, the lower bound on the number of matches must be 0
7766   (since the matchdecider could reject all the matches).
7768 * Renamed Query::is_empty() to Query::empty() for consistency.  Keep
7769   Query::is_empty() for now as a deprecated alias.
7771 * Enquire::set_sorting() now takes an optional third parameter which allows
7772   you to specify a sort by value, then relevance, then docid instead of
7773   by value then docid.
7775 * Enquire::get_mset() now takes an optional "check_at_least" parameter
7776   which allows Omega's MIN_HITS functionality to be implemented in the matcher
7777   (where it can be done a bit more efficiently).
7779 testsuite:
7781 * Reworked quartztest's positionlist1 into a generic api test as apitest's
7782   poslist3.
7784 * apitest: Reenabled allterms2, but with the iterator copying parts removed -
7785   TermIterator is an input_iterator so that part was invalid.
7787 * Overhauled btreetest and quartztest - tests at the Btree level are now all
7788   in btreetest.  Those at the QuartzDatabase level are in quartztest.
7790 * Split api_db.cc into 3 files as it has grown rather large.
7792 * tests/runtest: Added support for easily running gdb on a test program,
7793   automatically sorting out srcdir and libtool.
7795 quartz backend:
7797 * Refactored the quartz backend code to reduce the number of layered classes
7798   and eliminate unnecessary buffering, reducing memory usage so that more
7799   posting list changes can be batched together (see next change) and database
7800   building can be done several times faster.
7802 * Added tunable flush threshold - set XAPIAN_FLUSH_THRESHOLD=50000 to flush
7803   every 50000 documents.  The default is now every 10000 documents (was
7804   every 1000 documents previously).  The optimum value will most likely
7805   depend on your data and hardware.
7807 * WritableDatabase::get_document() no longer forces pending changes to be
7808   flushed.  The document will read things lazily from the database, and that
7809   reading may trigger a forced flush).
7811 * WritableDatabase::get_avlength() no longer forces pending changes to be
7812   flushed.  This means you can now search a modified WritableDatabase without
7813   causing a flush unless the search includes a term whose postlist has pending
7814   modifications.
7816 * Reduced quartz postlist chunk threshold from "2048 or a few bytes more" to
7817   "2000 or a few bytes more" so that full size chunks won't get split by the
7818   Btree.
7820 * Improved the "Db block overwritten" message.  The DatabaseCorruptError
7821   version now suggests multiple writers may be the cause, while the
7822   DatabaseModifiedError version uses less alarming wording and says to call
7823   Database::reopen().
7825 * QuartzWritableDatabase now stores the total document length and the last
7826   docid itself rather than tallying added and removed document length and
7827   writing the last docid back every time a document is added.  This gives
7828   cleaner code and a small performance win.
7830 * Make the first key null for blocks more than 1 away from the leaves.
7831   It saves disk space for a tiny CPU and RAM cost so is bound to be
7832   a win overall.
7834 * matcher/localmatch.cc: Fixed problems handling termweights in queries with
7835   the same term repeated (bug #37) and added regression test (qterminfo2).
7837 * Sped up iteration over all the terms in a database (QuartzCursor now only
7838   reads the tag from the Btree if asked to).
7840 * Cancelling an operation is now implemented more efficiently.
7842 inmemory backend:
7844 * Fixed bugs with deleting a document while a PostingIterator over it is
7845   active.
7847 muscat36 backend:
7849 * Fixed to compile now that internal_end_session() has gone (broken in 0.8.1).
7851 build system:
7853 * Fixed to compile when configured with --disable-inmemory (bug #33).
7855 * XO_LIB_XAPIAN now AC_SUBSTs XAPIAN_VERSION so your application's build
7856   system can easily check for a particular version of Xapian.
7858 * When compiling with GCC, we check that the compiler used to compile the
7859   library and the compiler used to compile the application have compatible
7860   C++ ABI versions.  Unfortunately GCC 3.1 incorrectly reports the same
7861   ABI version as GCC 3.0, so we now special case that test.
7863 * Bumped the versions of the autotools we require for bootstrapping, and
7864   updated the documentation of these in the HACKING document.
7866 * Quote macro names to fix warnings from newer aclocal.
7868 documentation:
7870 * Improved API documentation for Xapian::WritableDatabase::replace_document and
7871   delete_document.
7873 * Added documentation comments for MSet methods size(), empty(), swap(),
7874   begin(), end(), back().
7876 * Removed bogus documentation comments saying that some Enquire methods can
7877   throw DatabaseOpeningError.
7879 * Updated quartz design docs to reflect recent changes.  Also pulled
7880   out the Btree and Bcursor API docs and slotted them in as doxygen
7881   documentation comments - this way they're much more likely to
7882   be kept up-to-date.
7884 * Corrected multiple occurrences of "an Xapian::XXX" to "a Xapian::XXX"
7885   (presumably these all resulted from replacing "Om" with "Xapian::").
7887 * Various minor updates and improvements.
7889 portability:
7891 * Reworked how we cope with fcntl.h #define-ing open on Solaris.  This change
7892   finally allows Sun's C++ compiler to produce a working Xapian build on
7893   sparc Solaris!
7895 * configure.ac: Don't define DATADIR - we no longer use it and clashes
7896   with more recent mingw headers.
7898 * matcher/andpostlist.cc: Initialise lmax and rmax to 0.  This cures
7899   the SIGFPE on apitest's qterminfo2 on alpha linux.
7901 Xapian-core 0.8.1 (2004-06-30):
7903 API:
7905 * New method Xapian::Database::get_lastdocid which returns the highest used
7906   document id for a database (useful for re-synchronizing an indexer which
7907   was interrupted).  Implemented for quartz and inmemory.
7909 * Xapian::MSet::get_matches_*() methods now take collapsing into account, and
7910   the documentation has been clarified to state explicitly that collapsing and
7911   cutoffs are taken into account (bug#31).
7913 * Xapian::MSet: Need to adjust index by firstitem when indexing into items
7914   (bug#28).
7916 * MSetIterator and ESetIterator are now bidirectional iterators (rather than
7917   just input iterators)
7919 * Fixed post-increment forms of PostingIterator, TermIterator,
7920   PositionIterator, and ValueIterator so that *i++ works (as it must for them
7921   to be true input iterators).
7923 * Xapian::QueryParser: If we fail to parse a query, try stripping out
7924   non-alphanumerics (except '.') and reparsing.
7926 * Fixed memory leaked upon Xapian::QueryParser destruction.
7928 * Removed several unused Xapian::Error subclasses (these were used by the
7929   indexer framework which we decided was a failed experiment).
7931 testsuite:
7933 * queryparsertest: Pruned near-duplicate queryparsertest testcases.
7935 * queryparsertest: Added test case for `term NOT "a phrase'.
7937 * remotetest: Use 127.0.0.1 instead of localhost so that tcpmatch1 doesn't fail
7938   just because the network setup is broken.
7940 * apitest: Make emptyquery1 check that Query("") causes an InvalidArgumentError
7941   exception.
7943 quartz backend:
7945 * Fixed bug which meant we sometimes failed to remove a posting when deleting
7946   or replacing a document.
7948 * Fixed PostlistChunkReader to take a copy of the postlist data being read to
7949   avoid problems with reading data from a string that's been deleted.
7951 * Fixed bug in postlist merging which could occasionally extend a postlist
7952   chunk to overlap the docid range of the next chunk.
7954 * Eliminated the split cursor in each Btree object - we only actually need a
7955   single block buffer to handle splitting blocks.  This reduces the memory
7956   overhead of each Bcursor (and hence each QuartzPostList).
7958 * Changed 2 calls to abort() to throw Xapian::DatabaseCorruptError instead,
7960 * If Btree is writable, throw DatabaseCorruptError if we detect overwritten.
7962 * Check the return value of fdatasync()/fsync()/_commit() and raise an error.
7963   If they fail, we really want to know as it could cause data corruption.
7965 * Assorted clean ups, improved comments, debug tracing, assertions.
7967 * When merging in postlist changes, removed an unneeded call to
7968   QuartzBufferedTable::get_or_make_tag() in a case when we're using a cursor
7969   which has already fetched the tag.
7971 * Added SON_OF_QUARTZ define to disable incompatible changes to database
7972   formats by default, and use it to control the docid encoding for keys such
7973   that we're always inserting at the end of the table when added new documents.
7975 * Reopening the readonly version of a writable Btree is now more efficient
7976   (we used to close and reopen all the files and destroy and recreate a lot
7977   of objects and buffers).
7979 * Share file descriptors between the read and write Btree objects so that a
7980   quartz WritableDatabase now uses 5 fds rather than 10.
7982 * Added configure test for glibc, because otherwise we need to include a header
7983   before we can check for glibc in order to define something we should be
7984   defining before we include any headers!  Defining _XOPEN_SOURCE on OpenBSD
7985   seems to do the opposite to Linux and *disable* pread and pwrite!
7987 backends:
7989 * Stripped out the session machinery - all that is actually required is to
7990   ensure that any unflushed changes are flushed when the destructor runs.
7992 * A few other backend interface cleanups.
7994 build system:
7996 * Unified the shlib version numbers (the small benefit of tracking them
7997   individually makes it hard to justify the extra work required, and having one
7998   version simplifies debian packaging too).
8000 * configure.in: Fix typo (STLPORT_CXXLAGS -> STLPORT_CXXFLAGS)
8002 * Removed trivial m4/Makefile.am and autoconf/Makefile.am and do the work
8003   from the top level Makefile.am instead.  It's easier to see the structure
8004   this way, and it also removes a couple of recursive make invocations which
8005   will speed up builds a little.
8007 documentation:
8009 * HACKING: Added a list of subtasks when doing a release.
8010   Currently it's always me that does this, but it may not always be
8011   and anyhow it'll help me to have a list to run through.
8013 * include/xapian/database.h: Remove references to sessions in doxygen
8014   comments.
8016 * docs/quickstart.html: Corrected lingering reference to "om.h" and
8017   note that we need <iostream>.
8019 * docs/quickstartindex.cc.html,docs/quickstartexpand.cc.html,
8020   docs/quickstartsearch.cc.html: Add <iostream>.
8022 * PLATFORMS,AUTHORS: Updated.
8024 * docs/quartzdesign.html: Corrected various pieces of out of date
8025   information, and improved wording in a couple of places.
8027 * docs/scalability.html: Removed the reference to the Quartz update bottleneck
8028   "currently being addressed for Xapian 0.8" as it's now been addressed!  Also
8029   reworded to remove use of first person (it was originally a message sent to
8030   the mailing list).
8032 Xapian-core 0.8.0 (2004-04-19):
8034 * Omega, xapian-examples and xapian-bindings now have their own NEWS files.
8036 API:
8038 * Throw an exception when an empty query is used to build in the binary
8039   operator Query constructor (previously this caused a segfault.  Added
8040   regression test.
8042 * Made the TradWeight constructor explicit.  This is technically an API change
8043   as before you could pass a double where a Xapian::Weight was required - now
8044   you must pass Xapian::TradWeight(2.0) instead of 2.0.  That seems desirable,
8045   and it's unlikely any existing code will be affected.
8047 * Added "explicit" qualifier to constructors for internal use which take a
8048   single parameter.
8050 * Renamed Xapian::Document::add_term_nopos to Xapian::Document::add_term
8051   (with forwarding wrapper method for compatibility with existing code).
8053 * The reference counting mechanism used by most API classes now handles
8054   creating a new object slightly more efficiently.
8056 * Xapian::QueryParser: Don't use a raw term for a term which starts with a
8057   digit.
8059 testsuite:
8061 * apitest, quartztest: Added a couple of tests, and commented out some test
8062   lines which fail in debug builds.
8064 * quartztest: cause a test to fail if there's still a directory after a call
8065   to rmdir(), or if there isn't a directory after calling mkdir().
8067 * apitest: Check returned docids are the expected values in a couple more
8068   cases.  Improved wording of a comment.
8070 quartz backend:
8072 * We now merge a batch of changes into a posting list in a single pass which
8073   relieves an update bottleneck in previous versions.
8075 * When storing the termlist, pack the wdf into the same byte as the reuse
8076   length when possible - doing so typically makes the termlist 14% smaller!
8077   This change is backward compatible (0.7 database will work with 0.8, but
8078   databases built or updated with 0.8 won't work with 0.7).
8080 * quartzcheck: Check the structure within the postlist Btree as well as
8081   the Btree structures themselves.
8083 * Reduced code duplication in the btree manager and btreechecking code.
8085 * quartzdump: Backslash escape space and backslash in output rather than hex
8086   encoding them; renamed start-term and end-term to start-key and end-key;
8087   removed rather pointless "Calling next" message; if there's an error, write
8088   it to stderr not stdout, and exit with return code 1.
8090 * Corrected a number of comments in the source.
8092 * Removed several needless inclusions of quartz_table_entries.h.
8094 * Removed OLD_TERMLIST_FORMAT code - it has been disabled for since 0.6.0.
8096 * Removed all the quartz lexicon code and docs.  It's been disabled for ages,
8097   and we've not missed it.
8099 build system:
8101 * XO_LIB_XAPIAN autoconf macro can now be called without arguments in the
8102   common case where you want the test to fail if Xapian isn't found.
8104 * Fixed the configure test for valgrind - it wasn't working correctly when
8105   valgrind was installed but was too a version to support VALGRIND_COUNT_ERRORS
8106   and VALGRIND_COUNT_LEAKS.
8108 * GCC 2.95 supported -Wno-long-long and is our minimum recommended version, so
8109   unconditionally use -Wno-long-long with GCC, and don't test for it on other
8110   compilers (the old test incorrectly decided to use it with SGI's compiler
8111   resulting in a warning for every file compiled).
8113 documentation:
8115 * Updated the quickstart tutorial and removed the warning that "this
8116   document isn't up to date".
8118 * docs/intro_ir.html: Added a link to "Information Retrieval" by Keith van
8119   Rijsbergen which can be downloaded from his website!
8121 * docs/quartzdesign.html: Some minor improvements.
8123 * docs/matcherdesign.html: Merged in more details from a message sent to the
8124   mailing list.
8126 * docs/queryparser.html: Grammar fixes.
8128 * Doxygen wasn't picking up the documentation for PostingIterator and
8129   PositionListIterator - fixed.  Added doxygen comments for Xapian::Stopper
8130   and Xapian::QueryParser.
8132 * PLATFORMS: Updated with many results from tinderbox and from users.
8134 * AUTHORS: Updated the list of contributors.
8136 * HACKING: XAPIAN_DEBUG_TYPES should be XAPIAN_DEBUG_FLAGS.
8138 * HACKING: Updated to mention that building from CVS requires
8139   `./configure --enable-maintainer-mode' (or use bootstrap).
8141 * HACKING: Added notes about using "using", and pointers to a couple of useful
8142   C++ web resources.
8144 portability:
8146 * Solaris: Code tweaks for compiling with Sun's C++ compiler.
8148 * IRIX: Code tweaks for compiling with SGI's C++ compiler.
8150 * NetBSD mkdir() doesn't cope with a trailing / on the path - fixed our code to
8151   cope with this.
8153 * mingw/cygwin: Only use O_SYNC (on the debug log) if the headers define it.
8155 * backends/quartz/quartz_table_manager.cc: Fix for building on mingw.
8157 * mingw: Added configure test for link() to avoid infinite loop in our C++
8158   wrapper for link.
8160 * mingw and cygwin both need -Wl,--enable-runtime-pseudo-reloc passing when
8161   linking.  Arrange for xapian-config to include this, and check that the ld
8162   installed is a new enough version (or at least that it was at configure
8163   time).  Also pass to programs linked as part of the xapian-core build.
8165 * cygwin: Close a QuartzDatabase or QuartzWritableDatabase before trying to
8166   overwrite it - cygwin doesn't allow use to delete open/locked files...
8168 * backends/quartz/quartz_termlist.cc: Use Xapian::doccount instead of
8169   unsigned int in set_entries().
8171 * Database::Internal::Internal::keep_alive() should be
8172   Database::Internal::keep_alive().
8174 * Make Xapian::Weight::Weight() protected rather than private as we want to be
8175   able to call it from derived classes (GCC 3.4 flags this, other compilers
8176   seem to miss it).
8178 debug code:
8180 * Open debug log with flag O_WRONLY so that we can actually write to it!
8182 * backends/quartz/quartz_values.cc: Fixed problem with dereferencing
8183   a pointer to the end of a string in debug output.
8185 Xapian 0.7.5 (2003-11-26):
8187 API:
8189 * Xapian::QueryParser now supports prefixes on phrases and expressions (e.g.
8190   author:(twain OR poe) subject:"space flight").
8192 * Added missing default constructors for TermIterator, PostingIterator, and
8193   PositionIterator classes.
8195 * Fixed PositionIterator assignment operator.
8197 testsuite:
8199 * queryparsertest: Added testcase for new phrase and expression prefix support.
8201 * apitest: Added regression tests for API fixes.
8203 backends:
8205 * quartzcompact: Fix the name that the meta file gets copied to (was
8206   /path/to/dbdirmeta rather than /path/to/dbdir/meta).
8208 build system:
8210 * Changed to using AM_MAINTAINER_MODE.  If you're doing development work on
8211   Xapian itself, you should configure with "--enable-maintainer-mode" and
8212   ideally use GNU make.
8214 * Fixed configure test for fdatasync to work (I suspect a change in a recent
8215   autoconf broke it as it relied on autoconf internal naming).
8217 * Fully updated to reflect move of libbtreecheck.la from backends/quartz
8218   to testsuite.  btreetest and quartzcheck should build correctly now.
8220 documentation:
8222 * Added first cut of documentation for Xapian::QueryParser query syntax.
8224 * Fixed incorrectly formatted doxygen documentation comments which resulted in
8225   some missing text in the collated API and internal classes documentation.
8227 * Documented --enable-maintainer-mode and problems with BSD make in HACKING.
8229 * Fixed typo in docs/scalability.html.
8231 * PLATFORMS: Updated from the tinderbox.
8233 omega:
8235 * omega: Parsing of the probabilistic query is now delayed until we need some
8236   information from it.  This means that we can now use options set by the
8237   omegascript template to control the behaviour of the query parser.
8238   $set{stemmer,...} now controls the stemming language (e.g. $set{stemmer,fr})
8239   and $setmap{prefix,...} now sets the QueryParser prefix map (e.g.
8240   $setmap{prefix,subject,XT,abstract,XA}).
8242 * omega: Fixed $setmap not to add bogus entries.
8244 * docs/omegascript.txt: Expanded documentation of $set and $setmap to list
8245   values which Omega itself makes use of.
8247 * omega: Cleaned up the start up code quite a bit.
8249 * omega: Removed the unfinished code for caching omegascript command
8250   expansions.  Added code to cache $dbsize.  The only other value correctly
8251   marked for caching is already being cached!
8253 Xapian 0.7.4 (2003-10-02):
8255 API:
8257 * Fixed small memory leak if Xapian::Enquire::set_query() is called more than
8258   once.
8260 * Xapian::ESet now has reference counted internals (library interface version
8261   bumped because of this).
8263 * Removed unused OmDocumentTerm::termfreq member variable.
8265 * OmDocumentTerm ctor now takes wdf, and replaced set_wdf() with inc_wdf() and
8266   dec_wdf().
8268 * Removed unused open_document() method from SubMatch and derived classes.
8270 * Calls made by the matcher to Document::Internal::open_document() now use the
8271   lazy flag provided for precisely this purpose, but apparently never used -
8272   this should give quite a speed boost to any matcher options which use values
8273   (e.g. sort, collapse).
8275 testsuite:
8277 * Finished off support for running tests under valgrind to check for memory
8278   leaks and access to uninitialised variables.
8280 * apitest: Sped up deldoc4.
8282 * btreetest: Removed superfluous `/'s from constructed paths.
8284 * quartztest: adddoc2 now checks that there weren't any extra values created.
8286 backends:
8288 * quartz: don't start the document's TermIterator from scratch on every
8289   iteration in replace_document().  Should be a small performance win.
8291 * quartz: Pass 0 for the lexicon/postlist table when creating a termlist just
8292   to find the doc length.
8294 * quartz: quartz_table_entries.cc: Removed rather unnecessary use of
8295   const_cast.
8297 * quartz: quartz_table.cc: Removed unused variable.
8299 * quartz: Improved encapsulation of class Btree.
8301 build system:
8303 * libbtreecheck.la now has an explicit dependency on libxapian.la.
8305 * We now set the dependencies for libxapian correctly so that linking
8306   applications will pull in other required libraries.
8308 * matcher/Makefile.am: Ship networkmatch.cc even if "make dist" is run from a
8309   tree with the remote backend disabled.
8311 * configure.in: Sorted out tests for gethostbyname and gethostbyaddr using
8312   standard autoconf macros.
8314 * configure.in: If fork is found, but socketpair isn't, automatically disable
8315   the remote backend rather than configure dying with an error.
8317 * autoconf/: Removed various unused autoconf macros.
8319 portability:
8321 * xapian-config.in: Link with libxapianqueryparser before libxapian, since
8322   that's the dependency order.
8324 * Removed or replaced uses of <iostream> and <iosfwd> in the library sources
8325   - we don't need or want the library to pull in cin and friends.
8327 * extra/queryparser.yy: Fixed to build with Sun's C++ compiler.
8329 * Make the dummy source file C++ rather than C so that automake tells libtool
8330   that this is a C++ library - vital for correct linking on some platforms.
8332 * Makefile.am: Pass -no-undefined to libtool so that we can build build a DLL
8333   on MS Windows.
8335 * configure.in: Fixed check for socketpair - we were automatically disabling
8336   the remote backend on platforms where socketpair is in libsocket
8337   (such as Solaris).
8339 * Use O_BINARY for binary I/O if it exists.
8341 * common/utils.h: mkdir() only takes one argument on mingw.
8343 * common/utils.h,testsuite/backendmanager.cc: Touch file using open() rather
8344   than system().
8346 * common/utils.cc: Fixed to compile if snprintf isn't available.
8348 documentation:
8350 * docs/scalability.html: Fixed slip (32GB should be 32TB);  Added note about
8351   Linux 2.4 and ext2 filesize limits.
8353 * PLATFORMS: Updated.
8355 * NEWS: Fixed a few typos.
8357 bindings:
8359 * xapian.i: using namespace std in SWIG parsed segment to sort out typemaps.
8361 packaging:
8363 * Updated RPM packaging.
8365 omega:
8367 * omega: $topdoc now ensures the match has been run; $date no longer ensures
8368   the match has been run.
8370 * omega: Fixed to build with Sun's C++ compiler.
8372 Xapian 0.7.3 (2003-08-08):
8374 API:
8376 * MSetIterator: Fixed MSetIterator::get_document() to work when get_mset() was
8377   called with first != 0 (regression test msetiterator3).
8379 testsuite:
8381 * internaltest: Changed test exception1 to actually test something (hopefully
8382   what was originally intended!)
8384 * Added long option support to the testsuite programs (and quartzdump).
8386 * Testsuite now builds on platforms for which we use our own stringstream
8387   implementation.
8389 * Only use \r in test output if the output is a tty.
8391 * Increased default timeout used by tests running on the remote backend from 10
8392   seconds to 5 minutes to avoid tests failing just because the machine running
8393   them is slow and/or busy.
8395 * Fixed check for broken exception handling - we were getting "Xapian::"
8396   prefixed to one version and not on the other.
8398 * tests/runtest: Set srcdir if it isn't already to make it easy to manually run
8399   test programs from a VPATH build.
8401 * apitest: Check termfreq in allterms4.
8403 backends:
8405 * quartz: Fixed allterms TermIterator to not give duplicate terms when a
8406   posting list is chunked; added regression test (allterms4).
8408 * quartz: Check for EINTR when reading or writing blocks and retry the
8409   operation.  This should mean quartz won't fail falsely if a signal is
8410   received (e.g. if alarm() is used).
8412 build system:
8414 * Renamed libomqueryparser to libxapianqueryparser - for backward compatibility
8415   we still provide a library with the old name for now.
8417 * xapian.m4: Added XO_LIB_XAPIAN to replace OM_PATH_XAPIAN.  XO_LIB_XAPIAN will
8418   automagically enable use of "xapian-config --ltlibs" if A[CM]_PROG_LIBTOOL is
8419   used in configure.in.
8421 * xapian-config: Now supports linking with libtool - using libtool means that
8422   the run-time library path is set and that you can now link with an
8423   uninstalled libxapian.  Also xapian-config will now work once xapian-core's
8424   configure has been run, rather than only after "make all".
8426 * xapian-config: Now automatically tries to link libxapianqueryparser too.
8428 * bootstrap: Removed bootstrap scripts in favour of top-level bootstrap which
8429   creates a top-level configure you can optionally use to configure all checked
8430   out Xapian modules with one command, and which creates a top level Makefile
8431   to build all checked out Xapian modules with one command.
8433 * Added versioning information to libxapian and libxapianqueryparser.
8435 * xapian-example/omega: Use libtool and XO_LIB_XAPIAN so we can link with an
8436   uninstalled Xapian, and so the run time load path gets built into the
8437   binaries (no need to set LD_LIBRARY_PATH just because you install Xapian with
8438   a non-standard prefix).
8440 * configure: Stop the API documentation from being regenerated when
8441   include/xapian/version.h changes (since it's generated by configure).
8443 * Fixed "make dist" in VPATH builds.
8445 portability:
8447 * common/getopt.h: #include <stdlib.h>, <stdio.h>, and <unistd.h> before
8448   defining getopt as a macro - this avoids problems with clobbering prototypes
8449   of getopt() in system headers.
8451 * bin/quartzcompact.cc: Need stdio.h for rename().
8453 * languages/Makefile.am: Fixed compilation for compilers other than GCC.
8455 * Moved rset serialisation into a method of RSet::Internal, so
8456   omrset_to_string() is now just glue code.  This eliminates the need for it to
8457   be a friend of RSet::Internal which Sun's C++ compiler didn't seem to be able
8458   to cope with.
8460 documentation:
8462 * Fix incorrect documentation comment for Enquire::set_set_forward().  (Looked
8463   like a cut&paste error)
8465 * COPYING: Updated FSF address, and reinstated missing section: "How to Apply
8466   These Terms to Your New Programs"
8468 * PLATFORMS: Updated some linux results: RH7.3 on x86, and Debian on alpha and
8469   arm; Updated FreeBSD success report; Updated with results from the tinderbox.
8471 * docs/mkdoc.pl: Don't choke on a comment at the end of the DIST_SUBDIRS line
8472   in a Makefile.am.
8474 * HACKING: Improved note about why libtool 1.5 is needed.
8476 * HACKING: Added note about additional tools needed for building a
8477   distribution.
8479 bindings:
8481 * Fixed VPATH builds.
8483 * python: Fixed to link with libomqueryparser.
8485 * guile,tcl8: Updated typemaps to SWIG 1.3 style.
8487 omega:
8489 * omindex.cc: Added missing `#include <errno.h>'.
8491 * omindex/scriptindex: Fixed signed character issue in accent normalisation.
8493 * omindex: fixed memory and file descriptor leak on indexing a zero-sized file.
8495 * omindex: Fixed sense of test for unreadable files.
8497 * omindex: Improved log messages to distinguish re-indexed/added.
8499 * omindex,omega,scriptindex: Fixed to compile with mingw.
8501 * omindex: Fixed to compile with GNU getopt so we can build on non-glibc
8502   platforms.
8504 examples:
8506 * msearch: Quick fix to get mingw building going.
8508 * getopt: Copied over our fixes for better C++ compatibility.
8510 * simplesearch: Stem search terms.
8512 * simpleindex: Fixed not to run words together between lines.
8514 * simpleindex: Create database if it doesn't exist.
8516 Xapian 0.7.2 (2003-07-11):
8518 testsuite:
8520 * Fixed NULL pointer dereference when a test threw an unexpected exception.
8522 backends:
8524 * Quartz: When asked to create a quartz database, try to create the directory
8525   if it doesn't already exist.  Then we don't have to do it in every single
8526   Xapian program which wants to create a database...
8528 portability:
8530 * common/getopt.h: Fixed to work better with C++ compilers on non-glibc
8531   platforms.
8533 * common/utils.h: missing #include <ctype.h>
8535 * Quartz: Defined _XOPEN_SOURCE=500 for GLIBC so we get pread() and pwrite().
8537 * common/utils.h: Improved mingw implementation of rmdir().
8539 documentation:
8541 * PLATFORMS: Added MacOS X 10.2 success report.
8543 * Improvements to doxygen-generated documentation.
8545 bindings:
8547 * Moved to separate xapian-bindings module.
8549 * Added configure check for SWIG version (require at least 1.3.14).
8551 * bindings/swig/xapian.i: Fixed over-enthusiastic automatic conversion of
8552   termname to std::string.
8554 * PHP4 bindings much closer to working once again; updated guile and tcl8
8555   somewhat.
8557 omega:
8559 * omega: If the same database is listed more than once, only search the first
8560   occurrence.
8562 * omega: use snprintf to help guard against buffer overflows.
8564 Xapian 0.7.1 (2003-07-08):
8566 testsuite:
8568 * Fixed testsuite programs to not try to use "rm -rf" under mingw.
8570 backends:
8572 * Quartz: Use pread() and pwrite() on platforms which support them.  Doing so
8573   avoids one syscall per block read/write.
8575 * Quartz block count is now unsigned, which should nearly double the size of
8576   database for a given block size.  Not tested this yet.
8578 omega:
8580 * omindex: Fixed compilation problem in 0.7.0.
8582 documentation:
8584 * Added new document discussing scalability issues.
8586 * PLATFORMS: Updated.
8588 Xapian 0.7.0 (2003-07-03):
8590 API:
8592 * Moved everything into a Xapian namespace, which the main header now being
8593   xapian.h (rather than om/om.h).
8595 * Three classes have been renamed for better naming consistency:
8596   OmOpeningError is now Xapian::DatabaseOpeningError, OmPostListIterator is
8597   now Xapian::PostingIterator, and OmPositionListIterator is now
8598   Xapian::PositionIterator.
8600 * xapian.h includes <iosfwd> rather than <iostream> - if you were relying on
8601   the implicit inclusion, you'll need to add an explicit "#include <iostream>".
8603 * Replaced om_termname with explicit use of std::string - om_termname was just
8604   a typedef for std::string and the typedef doesn't really buy us anything.
8606 * Older code can be compiled by continuing to use om/om.h which uses #define
8607   and other tricks to map the old names onto the new ones.
8609 * Define XAPIAN_VERSION (e.g. 0.7.0), XAPIAN_MAJOR_VERSION (e.g. 0), and
8610   XAPIAN_MINOR_VERSION (e.g. 7).
8612 * Updated omega and xapian-examples to use Xapian namespace.
8614 queryparser:
8616 * Xapian::QueryParser: Accent normalisation added; Improved error reporting;
8617   Fixed to handle the most common examples found in the wild which used to give
8618   "parse error".
8620 bindings:
8622 * Python bindings brought up to date - use ./configure --enable-bindings to
8623   build them.  Requires Python >= 2.0 - may require Python >= 2.1.
8625 * Enabled optional building of bindings as part of normal build process.  Old
8626   Perl and Java bindings dropped; for Perl, use Search::Xapian from CPAN; Java
8627   JNI bindings will be replaced with a SWIG-based implmentation.
8629 internal implementation changes:
8631 * Removed one wrapper layer from the internal implementation of most API
8632   classes.
8634 * Xapian::Stem now uses reference counted internals.
8636 * Internally a lot of cases of unnecessary header inclusion have been removed
8637   or replaced with forward declarations of classes.  This should speed up
8638   compilation and recompilation of the Xapian library.
8640 * Suppress warnings in Snowball generated C code.
8642 * Reworked query serialisation in the remote backend so that the code is now
8643   all in one place.  The serialisation is now rather more compact and no longer
8644   relies on flex for parsing.
8646 testsuite:
8648 * Moved all the core library tests to tests subdirectory.
8650 * apitest now allows backend to be specified with "-b" rather than having to
8651   mess with environmental variables.
8653 * Testsuite programs can now hook into valgrind for leak checking, undefined
8654   variable checking, etc.
8656 backends:
8658 * Fixed parsing of port number in remote stub databases.
8660 * Quartz: Improved error message when asked to open a pre-0.6 Quartz database.
8662 * Quartz backend: Workaround for shared_level problem turns out to
8663   be arguably the better approach, so made it permanent and tidied up
8664   code.
8666 build system:
8668 * Build system fixed to never leave partial files in place of the expected
8669   output if a build is interrupted.
8671 * quartzcheck, quartzdump, and quartzcompact are now built by "make" rather
8672   than only by "make check".
8674 * xapian-config: Removed --prefix and --exec-prefix - you can't reliably
8675   install Xapian with a different prefix to the one it was configured with,
8676   yet these options give the impression you can.
8678 miscellaneous:
8680 * Fixed sending debug output to a file with XAPIAN_DEBUG_LOG with a value which
8681   didn't contain "%%" (%% expands to the current PID).
8683 * Fixed Xapian::MSetIterator::get_collapse_count() to work as intended.
8685 omega:
8687 * omindex,scriptindex: Normalise accents in probabilistic terms.
8689 * omindex: Read output from pstotext and pdftotext via pipes rather
8690   than temporary files to side-step the whole problem of secure temporary file
8691   creation; Use pdfinfo to get the title and keywords from when indexing a PDF;
8692   Safe filename escaping tweaked to not escape common safe punctuation.
8694 * omindex: Implement an upper limit on the length of URL terms - this is a
8695   slightly conservative 240 characters.  If the URL term would be longer than
8696   this, its last few bytes are replaced by a hash of the tail of the URL.  This
8697   means that (apart from hopefully very rare collisions) urlterms should still
8698   be unique ids for documents.  This is forward and backward compatible for
8699   URLs less than 240 characters.
8701 * omindex: Clean up processing of HTML documents:
8702   - Ignore the contents of <script> and <style> tags in HTML.
8703   - Strip initial whitespace in each tag in an HTML document.
8704   - Try not to split words in half when truncating title and summary.
8706 * query.cc: Set STEM_LANGUAGE near the start of the file so it's easy
8707   for users to change until we get better configurability.
8709 * omega: Replaced half-hearted logging support with flexible OmegaScript-based
8710   approach with new $log command.  Also added $now to allow the current
8711   date/time to be logged.
8713 * templates/xml: added collapse info to xml template.
8715 documentation:
8717 * Assorted minor documentation improvements.
8719 * PLATFORMS: Updated.
8721 rpms:
8723 * Improved RPM packaging of xapian-core and omega.
8725 Xapian 0.6.5 (2003-04-10):
8727 * OmEnquire: optimised the handling when sort_bands == 1 and fixed incorrect
8728   results in this and some other sorting cases; added some sorting testcases.
8730 * OmMSetIterator: added get_collapse_count() which returns a lower bound on
8731   the number of items which were removed by collapsing onto the current item.
8733 * OmStem: added default OmStem constructor and "none" language.  Both of these
8734   give a stemmer object which leaves terms unchanged which should allow for
8735   simpler logic in programs using Xapian.  The default constructor also removes
8736   the need to mess with pointers in some cases.
8738 * Automatically disable the remote backend if we don't have fork() since the
8739   remote backend requires it in several places.
8741 * Fixed to build with debug enabled.
8743 * testsuite: fixed to still build when some backends are disabled.
8745 * extra/parsequerytest.cc: Fixed to build with GCC 2.95.
8747 * Testsuite: Added regression test for Quartz bug which caused problems with
8748   long terms on machines with signed chars.
8750 * testsuite/index_utils.cc: Handling of ^x was just downright wrong due to a
8751   typo.
8753 * Improved portability: Fix for 64 bit machines.  Fixed btreetest to build with
8754   older compilers lacking <sstream>.  Xapian is now much closer to building
8755   with Sun's CFront-based Sun Pro C++ compiler, and with a Linux to mingw
8756   cross-compiler.
8758 * PLATFORMS: Updated with the results of many test builds.
8760 * Improved RPM packaging of xapian-core and omega.
8762 * Documentation: Use http://www.doxygen.org/ as URL for doxygen; Fixed bad link
8763   to our own website in overview.html; code_structure.html now only includes
8764   directories in the build system.
8766 * HACKING: updated.
8768 * Removed bugs/todo.xml, TODO, TODO.release, docs/todo.html, and
8769   docs/todo-release.html from the distribution.  Bugs and todo items will be
8770   tracked in Bugzilla instead.
8772 * Install docs in /usr/share/doc/xapian-core instead of /usr/share/xapian-core.
8774 * omega: If xP and P are both empty, there may be a boolean query, so don't
8775   force first page of hits.
8777 * omega: Fixed off-by-one error in rounding down topdoc - it was possible to
8778   get to an empty page of hits if there were exactly a multiple of HITSPERPAGE
8779   matches and the matcher over-estimated the number of matches and Omega
8780   displayed page links.
8782 * omega: Fixed handling of multiple DB parameters to be as documented.
8784 * omega: Added $collapsed to report get_collapse_count() for the current hit.
8786 * omega: Added $transform{} which does regexp manipulation (currently disabled
8787   until configure tests for regexp library are added)
8789 * omega: Added $uniq{} to eliminate duplicates from a sorted list.
8791 * omega: Don't force page 1 for a query with repeated terms!
8793 * omega: removed duplicates from terms listed in term frequencies.
8795 * omega: Added cgi parameter COLLAPSE to collapse on key values
8797 * omega: Added $value{key[,docid]} support to omegascript
8799 * omega: Renamed DATE1, DATE2, and DAYSMINUS to the more meaningful START, END,
8800   and SPAN (NB SPAN is days before END, or after START, or before today -
8801   whereas SPAN was before *DATE1* or before today).  The old parameters names
8802   are supported (with the original semantics) for now.
8804 * omega: Actually install documentation!
8806 * templates/query: propagate B boolean filters
8808 * templates/godmode: removed link to EuroFerret image
8810 * templates/godmode: added value dumping, for values from 0-255
8812 * omindex: Report correct version number (was hard-wired to 1.0!)
8814 * scriptindex: Allow '_' in fieldnames.  Diagnose bad characters in fieldnames
8815   better.
8817 * dbi2omega: Added DBUSER and DBPASSWD environmental variable support so that
8818   password protected DBs can easily be used
8820 * scriptindex.cc: added missing "#include <stdio.h>" which caused builds
8821   to fail for some platforms.
8823 Xapian 0.6.4 (2002-12-24):
8825 * Quartz backend: Fixed double setting of position list when updating a
8826   document with term position information (overall result was correct, just
8827   inefficient); when deleting a position_list, don't check if it's empty,
8828   just ask the layer below to delete it and let it handle the case when
8829   there's nothing to delete; Fixed unpacking of termlist on platforms where
8830   char is signed.
8832 * OmQueryParser: Added support for searching probabilistic fields (using
8833   <field>:<term>); the unstem multimap now includes "." on the end of a
8834   term if it was there in the query.
8836 * Don't include "om.h" as a dependency for the api docs since it's generated
8837   a configure time and the dependency was forcing users to regenerate the
8838   documentation, which requires doxygen to be installed.
8840 * Bindings: Python bindings updated to work with the updated API (still
8841   disabled by default).
8843 * Muscat 3.6 backend: Fixed to build with the new database factory functions;
8844   fixed compilation warnings; Muscat 3.6 DA and DB databases don't support
8845   positional information.  Instead of throwing an exception when we try to
8846   access it, return an empty position list (like a quartz database with no
8847   position information would).  This allows copydatabase to be used to convert
8848   a Muscat 3.6 database to a quartz one.
8850 * Documentation: quartzdesign and todo list updated.
8852 * quartzcheck: default mode changed to "v" rather than "+", since "+" is too
8853   verbose for a btree of any size; if you pass a quartz database directory,
8854   quartzcheck will now check all the tables which make up a quartz database.
8856 * quartzcompact: new tool which makes a copy of a quartz database with full
8857   compaction turned on - this results in a smaller database which is faster
8858   to search.  The next update will result in a lot of block splitting though
8859   (since all blocks are as full as possible).
8861 * omega: Added $unstem to map a stemmed term to the form(s) used in the query;
8862   $queryterms now only includes the first occurrence of each stemmed form;
8863   $prettyterm makes use of the unstem map; prefer MINHITS to MIN_HITS and
8864   RAWSEARCH to RAW_SEARCH since none of the other CGI parameter names have
8865   _ separating words (continue to support old names for now); fixed default
8866   template to not generate topterms twice, and fixed topterms to not stick
8867   outside the green box; corrected omegascript docs - it's $setrelevant
8868   not $set_relevant.
8870 * scriptindex: index=nopos with new indexnopos action; index and indexnopos now
8871   take an optional prefix argument; index=nopos is handled specially for
8872   backwards compatibility; added new data action to generate terms for date
8873   range searching.
8875 Xapian 0.6.3 (2002-12-14):
8877 * Updated PLATFORMS and todo list.  Noted in HACKING that Bison 1.50 seems to
8878   work with Xapian.
8880 * OmQueryParser now creates an "unstem" multimap to allow probabilistic
8881   query terms to be converted back to the form the user originally typed.
8883 * Updated documentation for remote protocol description and the quickstart
8884   tutorial which were both very out of date.
8886 * No longer use OmSettings to pass matcher parameters.  This completes the
8887   removal of OmSettings.
8889 * Added workaround for problem with cursors sharing levels in the btree.
8890   This should fix sporadic problems with large databases (small databases
8891   have fewer btree levels so aren't affected).
8893 * Stub databases now work again, though with a different format.  The new
8894   format allows multiple databases to be specified in the stub file.
8896 * OmEnquire::get_eset() now takes a flags argument of bit constants |-ed
8897   together instead of 2 bools.
8899 * Applied Martin Porter's better fix for the btree sequential addition bug
8900   which Richard fixed a few months ago.  Richard's fix resulted in a correct
8901   btree, but didn't always utilise space as efficiently as possible.
8903 * Fixed the remote backend to handle weighting schemes after the OmSettings
8904   changes.  You can now even implement your own weighting scheme and use it
8905   with the remote backend provided you register it with SocketServer at
8906   runtime (this feature has been on the todo list for ages).
8908 Xapian 0.6.2 (2002-12-07):
8910 * Set env var XAPIAN_SIG_DFL to stop the testsuite installing its
8911   signal handler (may be useful with some debugging tools).
8913 * backends/quartz/btree.cc: max_item_size wasn't being set due to
8914   some over-zealous code pruning.  It was defaulting to 0, and
8915   was causing the code to write off the end of allocated memory
8916   blocks.
8918 * matcher/localmatch.cc: fixed handling of wtscheme() - we were
8919   trying to use it for the extra weights, and then double
8920   deleting it!
8922 * common/omdebug.cc,common/omdebug.h: Fixed permissions on newly
8923   created log file (was getting 000!); Simplified class internals;
8924   Renamed env vars: OM_DEBUG_FILE is now XAPIAN_DEBUG_LOG,
8925   OM_DEBUG_TYPES is now XAPIAN_DEBUG_FLAGS (old versions still work
8926   for now).
8928 * testsuite/testsuite.cc: Fixed so running "gdb .libs/apitest"
8929   finds srcdir (for an in-tree build at least).
8931 * Fixed to compile with --enable-debug=full.
8933 * docs/remote.html: Updated from OmSettings to factory functions.
8935 * PLATFORMS: ixion is actually Linux 2.2.
8937 * OmWritableDatabase now has a default constructor.
8939 * Weighting scheme now specified by passing OmWeight object to OmEnquire.
8940   This also allows user weighting schemes (just subclass OmWeight and
8941   pass in an instance of this new class).  [This doesn't currently work
8942   with the remote backend.]
8944 * No longer use OmSettings to specify parameters for constructing databases.
8945   Instead there's a factory function for each database type - temporary naming
8946   scheme is OmXxx__open(), mostly because it's easy to grep for later.
8947   Instead of create and overwrite flags, we pass in a value - a new possible
8948   opening mode is "create or open".  [At present stub databases and the
8949   machinery in InMemory to allow the multierrhandler1 test aren't working.
8950   Everything else should be.]
8952 * OmEnquire::get_eset() takes parameters instead of an OmSettings object.
8954 * Fixed reversed sense of use_query_terms (and fixed reversed sense test in
8955   apitest which meant this wasn't spotted).
8957 * Documentation: Link to annotated class lists in doxygen generated
8958   documentation instead of the rather empty index pages; added doxygen
8959   markup so that apidoc now documents header files; updated todo list.
8961 * Documentation: intro doc thing was very out of date in places - fixed.
8963 * Omega: index .php files as HTML, with the PHP code stripped out; omindex
8964   return non-zero return code if an unexpected exception is caught; fixed
8965   HTML parser to not read one character past the end of the document in
8966   some cases; updated in line with OmSettings related changes to the API;
8967   Fixed $dbname to return "default" for the default database instead of "";
8968   templates/query: Removed now unused xDEFAULTOP hidden field, and superfluous
8969   "}"; dbi2omega now more efficient and can be restricted to listed fields.
8971 Xapian 0.6.1 (2002-11-28):
8973 * Fixed to compile with GCC 3.0.
8975 * PLATFORMS: Updated.
8977 Xapian 0.6.0 (2002-11-27):
8979 * Quartz database backend: lexicon disabled (./configure CXXFLAGS=-DUSE_LEXICON
8980   to reenable it), and encoding schemes simplified and made more compact;
8981   extended and added test cases; minimum block size is now 2048 bytes (as
8982   documented before, but now we actually enforce this); btree checking code
8983   split off and only linked in when required; tidied up btreetest's output.
8985 * Replaced our stemmers with those from Snowball.  These give better results,
8986   and are actively maintained by Martin Porter (who wrote the original Xapian
8987   stemmers too).  It also means that Xapian now has stemmers for Finnish,
8988   and Russian, and an implementation of Lovins' English stemmer.
8990 * Assorted improvements to the documentation, especially the documentation
8991   of the internals of the Quartz backend.
8993 * Removed the three uses of RTTI (typeid() and dynamic_cast<>) - one was
8994   totally superfluous, and the other two easily avoided.
8996 * Omega and simpleindex example: limit probabilistic term length to 64
8997   characters to stop the index filling up with junk terms which nobody will
8998   ever search for.
9000 * Omega: Added dbi2omega perl script to dump any database which perl DBI can
9001   access into the dump format expected by scriptindex.
9003 Xapian 0.5.5 (2002-12-04):
9005 * Fixed compilation with --enable-debug.
9007 * Minor documentation updates.
9009 * Omega: Fixed paging on default database; removed xDEFAULTOP from the query
9010   template as it's no longer used; removed bogus unmatched '}' from query
9011   template; added dbi2omega perl script to dump any database which perl DBI
9012   can access into the dump format expected by scriptindex; limit length of
9013   probabilistic terms generated to 64 characters.
9015 Xapian 0.5.4 (2002-10-16):
9017 * Fixed a compilation error with "make check" when using GCC 3.2.
9019 * PLATFORMS: checked 0.5.3 works on OpenBSD and Solaris 7.
9021 Xapian 0.5.3 (2002-10-12):
9023 Notable changes: Improvements to the test suite, and internal code cleanups:
9025 * Internal code cleanups on Quartz Btree implementation.
9027 * Minor documentation updates (TODO and PLATFORMS updated; Martin Porter's
9028   stemming paper removed - see the Snowball site for background stemmer
9029   info).
9031 * Implemented QuartzAllTermsList::get_approx_size().
9033 * Removed a couple of occurrences of "using std::XXX;" from externally
9034   visible headers.
9036 * With GCC, add warning flags "-Wall -W" rather than "-Wall -Wunused" (-Wall
9037   implies -Wunused anyway).  Fixed all the warnings this throws up, except in
9038   languages/ (that code is to be replaced with Snowball soon).
9040 * Test suite: Disable colour test output if stdout isn't a terminal and
9041   reworked check for broken exception handling as the previous  version never
9042   seemed to fire.  Other assorted minor improvements.
9044 * include/om/om.h is now removed on "make distclean" rather than "make clean".
9046 Xapian 0.5.2 (2002-10-06):
9048 Further improvements to documentation and portability:
9050 * docs/: converted all text docs to HTML (except omsettings which will
9051   has odd markup (LaTeX?) and will probably soon be obsolete anyway).
9053 * remote backend: Fixed handling of timeouts which are now in the past - fixes
9054   test failures with redhat/x86.
9056 * quartz backend: now works on 64 bit platforms.
9058 * test suite: try to spot mishandled exceptions and stop them causing bogus
9059   OMEXCEPT failures.
9061 Xapian 0.5.1 (2002-10-02):
9063 This release fixes features improved documentation and some build system
9064 portability fixes.
9066 * PLATFORMS: updated with more test results.
9068 * docs/: tidied up layout of HTML documentation; converted the notes about
9069   BM25 into HTML; updated stemmer docs to reflect intention to use Snowball
9070   instead; included HTML versions of quickstart*.cc.
9072 * automake 1.6.3 and autoconf 2.54 are now required for those working
9073   from CVS to fix a problem with the generated Makefiles and Solaris
9074   make.
9076 * net/Makefile.am: Fixed building of readquery.cc from readquery.ll.
9078 * buildall script is now deprecated - use the new streamlined bootstrap script
9079   in preference.
9081 Xapian 0.5.0 (2002-09-20):
9083 The last release of the software that is now known as Xapian was OmSee 0.4.1 on
9084 November 24th 2000, not far from 2 years ago.
9086 There's been a significant amount of development in this time, so we've
9087 summarised the most notable changes and improvements:
9089   * The project is now called "Xapian". We've renamed the modules in the light
9090     of this change:
9092       + "om" is now "xapian-core"
9093       + "om-examples" is now "xapian-examples", and now contains small,
9094         instructive examples which demonstrate how to use Xapian to implement
9095         particularly features.
9096       + Added "xapian-applications" which contains larger sample applications
9098   * Much improved build system - should now build "out of the box" on many Unix
9099     platforms. Can now VPATH build with vendor tools on most platforms. Builds
9100     as cleanly as we can achieve with GCC 2.95.* (some bogus warnings due to
9101     compiler bugs). Should build without warnings on GCC 3.0, 3.1, and 3.2.
9103   * If using GCC, om/om.h now contains a check that the compiler used to build
9104     Xapian and the compiler used to build the application have compatible C++
9105     ABIs. So you get a clear error message early from the first attempt to
9106     compile a file rather than a confusing error from the linker near the end
9107     of the build.
9109   * RPM packages are now available. We intend to prepare Debian packages in the
9110     near future too.
9112   * xapian-config no longer support "--uninst". It's hard to make this work
9113     reliably and portably, and the effort is better expended elsewhere.
9114     Configure with a prefix and install to a temporary directory instead.
9116   * Xapian can now work with files > 2Gb on OSes which support them.
9118   * Restructured and reworked documentation.
9120   * Removed thread locks. We intend to be "thread-friendly" so different
9121     threads can access different objects without problems. In the rare event
9122     that you want to concurrently call methods on the same object from
9123     different threads you need to create a mutex and lock it. Thus the thread
9124     lock overhead is only incurred when it's necessary.
9126   * Indexgraph removed from core library. It will reappear as an add-on library
9127     at some point.
9129   * Omega's query parser has now been reworked as a separate library.
9131   * Terminology change - "keys" are now known as "values" to avoid confusion,
9132     since they're not like keys in a relational database. The exception is when
9133     a value is used as a key in some operation, e.g. "match_collapse_key".
9135   * Database backends:
9137       + Auto backend: can now be used to create a new database.
9138       + Auto backend: added support for "stub" databases - a text file
9139         specifying the settings for the database to be opened (particularly
9140         useful for allowing easy access to specific remote databases).
9141       + Quartz backend: many fixes and improvements, and the code has been
9142         cleaned up a lot. Implemented deleting of items from postlists.
9143       + Remote backend: implemented term_exists() and get_termfreq();
9144       + Multi-backend: the document length is now fetched from the sub-postlist
9145         rather than the database, which provides a huge speed-up in some cases.
9146       + Sleepycat backend: this experimental backend has been removed.
9147       + Muscat 3.6 backends: now disabled by default.
9149   * Tests:
9151       + Test cases added for most bug fixes and new features.
9152       + stemtest: rewritten in C++ rather than part C++, part perl. Now 15%
9153         faster.
9154       + includetest: removed - it's no longer useful now the code has matured.
9155       + Removed problematic leak checking from testsuite. We plan to use
9156         valgrind instead soon.
9158   * Matcher:
9160       + Fixed several matcher bugs which could cause incorrect results in some
9161         situations.
9162       + Fix bug in expander due to nth_element being called on the wrong
9163         element.
9164       + Added sorting within relevance bands to the matcher.
9165       + Matcher now calculates percentages differently, such that 100%
9166         relevance is actually achievable.
9167       + Matcher now uses a min-heap rather than nth-element to maintain the
9168         proto-mset. This is cleaner and more efficient.
9169       + New operator OP_ELITE_SET replaces match_max_or_terms option.
9170       + Implemented multiple XOR queries.
9171       + Add a new query operator, OP_WEIGHT_CUTOFF, which returns only those
9172         documents from a query which have a weight greater than a specified
9173         cutoff value.
9174       + Removed OmBatchEnquire from system: it may return at a later date, but
9175         for now it is simply out of date and a maintenance liability, and
9176         gives no significant advantage.
9177       + Added experimental match bias functors.
9179   * The API has been cleaned up in various places:
9181       + OmDocumentContents and OmIndexDoc merged to become OmDocument
9182       + OmQuery interface cleaned up
9183       + OmData and OmKey removed - methods which used them now just pass a
9184         string instead
9185       + OmESetItem replaced by OmESetIterator; OmMSetItem by OmMSetIterator;
9186         om_termname_list by OmTermIterator
9187       + OmDocumentTerm and OmDocumentParams removed
9188       + OmMSet::mbound replaced by OmMSet::matches_
9189         {lower_bound,estimated,upper_bound}, giving more information
9190       + Xapian iterators now have default constructors
9191       + Most API classes now have reference counted internals, so assignment
9192         and copying are cheap
9193       + OmStem now has copy constructor and assignment operator
9194       + and more...