summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs')
-rw-r--r--src/docs/Doxyfile1
-rw-r--r--src/docs/backup.dox5
-rwxr-xr-xsrc/docs/build-javadoc.sh2
-rw-r--r--src/docs/error-handling.dox26
-rw-r--r--src/docs/programming.dox15
-rw-r--r--src/docs/spell.ok1
-rw-r--r--src/docs/style/footer.html4
-rwxr-xr-xsrc/docs/tools/doxfilter.py2
-rwxr-xr-xsrc/docs/tools/fixlinks.py2
-rw-r--r--src/docs/top/main.dox8
-rw-r--r--src/docs/tune-build-options.dox9
-rw-r--r--src/docs/upgrading.dox22
12 files changed, 76 insertions, 21 deletions
diff --git a/src/docs/Doxyfile b/src/docs/Doxyfile
index 3d8c46962f1..e7382e2bc5e 100644
--- a/src/docs/Doxyfile
+++ b/src/docs/Doxyfile
@@ -1582,6 +1582,7 @@ PREDEFINED = DOXYGEN \
__wt_file_system:=WT_FILE_SYSTEM \
__wt_item:=WT_ITEM \
__wt_lsn:=WT_LSN \
+ __wt_modify:=WT_MODIFY \
__wt_session:=WT_SESSION \
__wt_txn_notify:=WT_TXN_NOTIFY \
WT_HANDLE_CLOSED(x):=x \
diff --git a/src/docs/backup.dox b/src/docs/backup.dox
index 45edc85d6a5..91b15da9275 100644
--- a/src/docs/backup.dox
+++ b/src/docs/backup.dox
@@ -59,6 +59,11 @@ During the period the backup cursor is open, database checkpoints can
be created, but no checkpoints can be deleted. This may result in
significant file growth.
+Additionally, if a crash occurs during the period the backup cursor is open and
+logging is disabled, then the system will be restored to the most recent
+checkpoint prior to the opening of the backup cursor, even if later database
+checkpoints were created.
+
The following is a programmatic example of creating a backup:
@snippet ex_all.c backup
diff --git a/src/docs/build-javadoc.sh b/src/docs/build-javadoc.sh
index be886937070..69cb1186467 100755
--- a/src/docs/build-javadoc.sh
+++ b/src/docs/build-javadoc.sh
@@ -8,5 +8,5 @@ CLASSPATH=$THRIFT_HOME/libthrift.jar:$SLF4J_JAR javadoc -public -d $DOCS/java \
-stylesheetfile $DOCS/style/javadoc.css \
-use -link http://java.sun.com/j2se/1.5.0/docs/api/ \
-header '<b>WiredTiger API</b><br><font size="-1"> version '$WT_VERSION'</font>' \
- -windowtitle 'WiredTiger Java API' -bottom '<font size=1>Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved.</font>' \
+ -windowtitle 'WiredTiger Java API' -bottom '<font size=1>Copyright (c) 2008-2017 MongoDB, Inc. All rights reserved.</font>' \
com.wiredtiger com.wiredtiger.util
diff --git a/src/docs/error-handling.dox b/src/docs/error-handling.dox
index 62be498fc15..eb9ca6bb82a 100644
--- a/src/docs/error-handling.dox
+++ b/src/docs/error-handling.dox
@@ -17,13 +17,18 @@ are thrown as \c WiredTigerException, which may be caught by the
application.
The \c WiredTigerRollbackException is a specific type of \c WiredTigerException,
-it is thrown when there is a conflict between concurrent operations.
+thrown when there is a conflict between concurrent operations.
An application that catches this exception should call rollback() on
the relevant transaction, and retry as necessary.
The \c WiredTigerPanicException is a specific type of \c WiredTigerException,
-it is thrown when there is an underlying problem that requires the
-application to exit and restart.
+thrown when there is a fatal error requiring database restart. Applications
+will normally handle \c WiredTigerPanicException as a special case. A
+correctly-written WiredTiger application will likely catch
+\c WiredTigerPanicException and immediately exit or otherwise handle fatal
+errors. Note that no further WiredTiger calls are required after
+\c WiredTigerPanicException is caught (and further calls will themselves
+immediately fail).
The following is a complete list of possible WiredTiger-specific
return values, all constants defined in the com.wiredtiger.db.wiredtiger class:
@@ -47,7 +52,7 @@ This error is returned when an error is not covered by a specific error return.
This error indicates an operation did not find a value to return. This includes cursor search and other operations where no record matched the cursor's search key such as WT_CURSOR::update or WT_CURSOR::remove.
@par <code>WT_PANIC</code>
-This error indicates an underlying problem that requires the application exit and restart. The application can exit immediately when \c WT_PANIC is returned from a WiredTiger interface, no further WiredTiger calls are required.
+This error indicates an underlying problem that requires a database restart. The application may exit immediately, no further WiredTiger calls are required (and further calls will themselves immediately fail).
@par <code>WT_RUN_RECOVERY</code>
This error is generated when wiredtiger_open is configured to return an error if recovery is required to use the database.
@@ -73,7 +78,7 @@ Note that ::wiredtiger_strerror is not thread-safe.
@m_if{c}
@section error_handling_event Error handling using the WT_EVENT_HANDLER
-More complex error handling can be configured by passing an implementation
+Specific error handling can be configured by passing an implementation
of WT_EVENT_HANDLER to ::wiredtiger_open or WT_CONNECTION::open_session.
For example, both informational and error messages might be passed to an
@@ -81,6 +86,17 @@ application-specific logging function that added a timestamp and logged
the message to a file, and error messages might additionally be output to
the \c stderr file stream.
+Additionally, applications will normally handle \c WT_PANIC as a special
+case. WiredTiger will always call the error handler callback with
+\c WT_PANIC in the case of a fatal error requiring database restart,
+however, WiredTiger cannot guarantee applications will see an application
+thread return \c WT_PANIC from a WiredTiger API call. For this reason, a
+correctly-written WiredTiger application will likely specify at least an
+error handler which will immediately exit or otherwise handle fatal errors.
+Note that no further WiredTiger calls are required after an error handler
+is called with \c WT_PANIC (and further calls will themselves immediately
+fail).
+
@snippet ex_event_handler.c Function event_handler
@snippet ex_event_handler.c Configure event_handler
diff --git a/src/docs/programming.dox b/src/docs/programming.dox
index aa76bef4614..205e7544c6c 100644
--- a/src/docs/programming.dox
+++ b/src/docs/programming.dox
@@ -65,19 +65,20 @@ each of which is ordered by one or more columns.
- @subpage_single wtperf
- @subpage_single wtstats
<p>
-- @subpage_single tune_memory_allocator
-- @subpage_single tune_page_size_and_comp
-- @subpage_single tune_cache
+- @subpage_single tune_build_options
- @subpage_single tune_bulk_load
+- @subpage_single tune_cache
+- @subpage_single tune_checksum
+- @subpage_single tune_close
- @subpage_single tune_cursor_persist
-- @subpage_single tune_read_only
- @subpage_single tune_durability
-- @subpage_single tune_checksum
- @subpage_single tune_file_alloc
+- @subpage_single tune_memory_allocator
+- @subpage_single tune_mutex
+- @subpage_single tune_page_size_and_comp
+- @subpage_single tune_read_only
- @subpage_single tune_system_buffer_cache
- @subpage_single tune_transparent_huge_pages
-- @subpage_single tune_close
-- @subpage_single tune_mutex
- @subpage_single tune_zone_reclaim
*/
diff --git a/src/docs/spell.ok b/src/docs/spell.ok
index bc2e16b1122..5d629f4c49f 100644
--- a/src/docs/spell.ok
+++ b/src/docs/spell.ok
@@ -237,6 +237,7 @@ fput
freelist
fsync
ftruncate
+fvisibility
gcc
gdbm
ge
diff --git a/src/docs/style/footer.html b/src/docs/style/footer.html
index e5a7b30eef5..12d25422f89 100644
--- a/src/docs/style/footer.html
+++ b/src/docs/style/footer.html
@@ -3,13 +3,13 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
- <li class="footer">Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li>
+ <li class="footer">Copyright (c) 2008-2017 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
-Copyright (c) 2008-2016 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.
+Copyright (c) 2008-2017 MongoDB, Inc. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
diff --git a/src/docs/tools/doxfilter.py b/src/docs/tools/doxfilter.py
index f1c3308c689..301142269c3 100755
--- a/src/docs/tools/doxfilter.py
+++ b/src/docs/tools/doxfilter.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python
#
-# Public Domain 2014-2016 MongoDB, Inc.
+# Public Domain 2014-2017 MongoDB, Inc.
# Public Domain 2008-2014 WiredTiger, Inc.
#
# This is free and unencumbered software released into the public domain.
diff --git a/src/docs/tools/fixlinks.py b/src/docs/tools/fixlinks.py
index 7163246e3bd..1887665d5be 100755
--- a/src/docs/tools/fixlinks.py
+++ b/src/docs/tools/fixlinks.py
@@ -1,6 +1,6 @@
#!/usr/bin/env python
#
-# Public Domain 2014-2016 MongoDB, Inc.
+# Public Domain 2014-2017 MongoDB, Inc.
# Public Domain 2008-2014 WiredTiger, Inc.
#
# This is free and unencumbered software released into the public domain.
diff --git a/src/docs/top/main.dox b/src/docs/top/main.dox
index 6b28bd0062f..1bfb623c0a0 100644
--- a/src/docs/top/main.dox
+++ b/src/docs/top/main.dox
@@ -6,12 +6,12 @@ WiredTiger is an high performance, scalable, production quality, NoSQL,
@section releases Releases
<table>
-@row{<b>WiredTiger 2.9.2</b> (current),
+@row{<b>WiredTiger 2.9.3</b> (current),
+ <a href="releases/wiredtiger-2.9.3.tar.bz2"><b>[Release package]</b></a>,
+ <a href="2.9.3/index.html"><b>[Documentation]</b></a>}
+@row{<b>WiredTiger 2.9.2</b> (previous),
<a href="releases/wiredtiger-2.9.2.tar.bz2"><b>[Release package]</b></a>,
<a href="2.9.2/index.html"><b>[Documentation]</b></a>}
-@row{<b>WiredTiger 2.8.0</b> (previous),
- <a href="releases/wiredtiger-2.8.0.tar.bz2"><b>[Release package]</b></a>,
- <a href="2.8.0/index.html"><b>[Documentation]</b></a>}
@row{<b>Development branch</b>,
<a href="https://github.com/wiredtiger/wiredtiger"><b>[Source code]</b></a>,
<a href="develop/index.html"><b>[Documentation]</b></a>}
diff --git a/src/docs/tune-build-options.dox b/src/docs/tune-build-options.dox
new file mode 100644
index 00000000000..79cd60b1105
--- /dev/null
+++ b/src/docs/tune-build-options.dox
@@ -0,0 +1,9 @@
+/*! @page tune_build_options gcc/clang build options
+
+WiredTiger can be built using the gcc/clang \c -fvisibility=hidden flag,
+which may significantly reduce the size and load time of the WiredTiger
+library when built as a dynamic shared object, and allow the optimizer
+to produce better code (for example, by eliminating most lookups in the
+procedure linkage table).
+
+ */
diff --git a/src/docs/upgrading.dox b/src/docs/upgrading.dox
index e5fce3d0d5d..8640991e7cd 100644
--- a/src/docs/upgrading.dox
+++ b/src/docs/upgrading.dox
@@ -1,5 +1,18 @@
/*! @page upgrading Upgrading WiredTiger applications
+@section version_293 Upgrading to Version 2.9.3
+<dl>
+
+<dt>Logging subsystem statistics</dt>
+<dd>
+Two logging subsystem statistics have been removed as they were a duplicate of
+other statistics. The \c log_slot_joins and \c log_slot_transitions statistics
+are no longer present. They were duplicates of \c log_writes and
+\c log_slot_closes respectively. Several new logging related statistics have
+been added.
+</dd>
+
+</dl><hr>
@section version_292 Upgrading to Version 2.9.2
<dl>
@@ -16,6 +29,15 @@ have switched that lock from a spin lock to a read-write lock, and consequently
changed the statistics tracking lock related wait time.
</dd>
+<dt>Logging subsystem statistics</dt>
+<dd>
+Two logging subsystem statistics have been removed as they were a duplicate of
+other statistics. The \c log_slot_joins and \c log_slot_transitions statistics
+are no longer present. They were duplicates of \c log_writes and
+\c log_slot_closes respectively. Several new logging related statistics have
+been added.
+</dd>
+
<dt>Forced and named checkpoint error conditions changed</dt>
<dd>
There are new cases where checkpoints created with an explicit name or the