Merge pull request #1137 from wiredtiger/changelog-2.3.0

Add draft changelog notes for upcoming 2.3.0 release.

5 files changed, 99 insertions, 1 deletions

diff --git a/NEWS b/NEWS
index 3da048905ac..ebd3c176c87 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,44 @@
+WiredTiger release 2.3.0, 2014-07-29
+------------------------------------
+
+The WiredTiger 2.3.0 release contains significant new features, performance
+enhancements and bug fixes.  Significant changes are described below.
+
+Changes to the WiredTiger API (see upgrading documentation for details):
+
+* Add a LevelDB API implementation for WiredTiger.  This includes support for
+  stock LevelDB as well as Basho, HyperLevelDB and RocksDB versions of the API.
+  To build the LevelDB API include --enable-leveldb in the configure command,
+  to specify compatability with an alternative LevelDB API use
+  --enable-leveldb=[basho,hyper,rocksdb]. [#1028]
+
+* Add ability to build some common extensions into the WiredTiger library.
+  This means that the libraries for those extensions don't need to be
+  dynamically loaded at runtime. Currently supported extensions are Snappy
+  compression and zlib compression. The option can be enabled by passing
+  --with-builtins=[snappy,zlib] to the configure command line.
+
+* Add a new configuration to wiredtiger_open: statistics_log=(on_close=true),
+  that causes a set of statistics to be logged on WT_CONNECTION::close. [#1086]
+
+* Add a new configuration to wiredtiger_open: exclusive, that causes the open
+  to fail if the database already exists.
+
+Other significant changes:
+
+* Performance improvement for high throughput workloads using multiple
+  eviction threads. Performance of some workloads improves by over 15% [#1087]
+
+* Significant performance optimizations for queries, giving up to 20%
+  throughput improvement for in-memory query workloads.
+  https://github.com/wiredtiger/wiredtiger/wiki/Query-throughput
+
+* Fix an off-by-one bug that could lead to ENOMEM during commit with logging.
+  [#1104][#1121]
+
+* Allow bulk loads to multiple files to complete in parallel. [#1114][#1126]
+
+
 WiredTiger release 2.2.1, 2014-06-24
 ------------------------------------
 
diff --git a/src/docs/install.dox b/src/docs/install.dox
index a21ea505f8a..c3daa6d3289 100644
--- a/src/docs/install.dox
+++ b/src/docs/install.dox
@@ -132,7 +132,8 @@ Build the WiredTiger Java API.
 
 @par \c --enable-leveldb[=rocksdb]
 Build the Google, Inc. LevelDB API.  Optionally, if \c rocksdb is
-specified, build the Facebook, Inc. RocksDB API.
+specified, build the Facebook, Inc. RocksDB API.  See @ref leveldb for
+more information.
 
 @par \c --enable-python
 Build the WiredTiger <a href="http://www.python.org">Python</a> API.
diff --git a/src/docs/introduction.dox b/src/docs/introduction.dox
index e719a5b16f4..1773049f718 100644
--- a/src/docs/introduction.dox
+++ b/src/docs/introduction.dox
@@ -37,13 +37,16 @@ For further information about installing and using WiredTiger, see:
 - @subpage programming
 - @ref wt "WiredTiger API reference manual"
 - @subpage command_line
+- @subpage leveldb
 - @subpage admin
 
 For release change logs and upgrading information, see:
+
 - @subpage md_changelog
 - @subpage upgrading
 
 WiredTiger is Open Source; for further information, see:
+
 - @subpage license
 
 WiredTiger releases are tested on Linux, FreeBSD and OS X; for further
diff --git a/src/docs/leveldb.dox b/src/docs/leveldb.dox
new file mode 100644
index 00000000000..f27bbf4b53f
--- /dev/null
+++ b/src/docs/leveldb.dox
@@ -0,0 +1,49 @@
+/*!
+@page leveldb LevelDB compatibility API
+
+WiredTiger includes an implementation of the LevelDB API to ease integration and performance testing with existing applications.
+
+@section leveldb_build Building and using WiredTiger's LevelDB API
+
+Here are the steps to build and run an existing application against WiredTiger's LevelDB API:
+
+<ol>
+<li> choose an installation directory for WiredTiger.  The default is:
+   
+   <code>
+   WT_INSTALL=/usr/local
+   </code>
+   
+   but anywhere is fine.
+   
+<li> build WiredTiger with LevelDB support:
+   
+   <code>
+   ./configure --enable-leveldb --with-builtins=snappy --prefix=$WT_INSTALL
+   make install
+   </code>
+   
+   To include support for Basho's version of LevelDB, change the above to <code>--enable-leveldb=basho</code>.  To include support for HyperLevelDB / HyperDex, change the above to <code>--enable-leveldb=hyper</code>.  To include support for RocksDB, change the above to <code>--enable-leveldb=rocksdb</code>.
+   
+<li> compile and link the application against WiredTiger's LevelDB API:
+   
+   <code>
+   ./configure CPPFLAGS="-I$WT_INSTALL/include/wiredtiger" LDFLAGS="-L$WT_INSTALL/lib/wiredtiger" ... && make
+   </code>
+   
+<li> start the application:
+   
+   <code>
+   LD_LIBRARY_PATH=$WT_INSTALL/lib/wiredtiger \<normal start command\>
+   </code>
+</ol>
+
+@section leveldb_caveats Caveats
+
+The core LevelDB features are well supported, though some configuration options may be ignored.  In the extended versions of the API, some rarely used features have not been implemented, and will cause either build or runtime errors.
+
+The WiredTiger on-disk format is not compatible with LevelDB.  Data will need to be dumped and reloaded by the application.
+
+The WiredTiger LevelDB API is not guaranteed to be binary compatible with LevelDB.  We do not support using \c LD_PRELOAD to switch an existing binary built with stock LevelDB to WiredTiger without compiling against the installed include files.
+
+ */
diff --git a/src/docs/spell.ok b/src/docs/spell.ok
index 3c5c6714e7d..5561c05c686 100644
--- a/src/docs/spell.ok
+++ b/src/docs/spell.ok
@@ -33,8 +33,10 @@ GitHub
 Google
 Google's
 HyperLevelDB
+HyperDex
 IEC
 JavaScript
+LD
 LDFLAGS
 LIBS
 LLVM
@@ -51,6 +53,7 @@ Multithreaded
 NOTFOUND
 NUMA
 NoSQL
+PRELOAD
 README
 RedHat
 RepMgr
@@ -327,6 +330,7 @@ ro
 rocksdb
 rpc
 runnable
+runtime
 rwlock
 sHQ
 sHq