summaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorKeith Bostic <keith.bostic@mongodb.com>2017-05-16 12:02:51 -0400
committerAlex Gorrod <alexander.gorrod@mongodb.com>2017-05-16 12:02:51 -0400
commite3c1f0012e3eac806a7b8e64cb4dee90aeab8eda (patch)
treed5ec62f987747616b6ac2b407ef9acdec0422689 /src/include
parent34b599ea3c994498b53ec1c9deb62914b9798b0b (diff)
downloadmongo-e3c1f0012e3eac806a7b8e64cb4dee90aeab8eda.tar.gz
WT-3314 clarify WT_PANIC error handling (#3418)
A correctly-written WiredTiger application will have an error handler for WT_PANIC, and that isn't explicit in the documentation.
Diffstat (limited to 'src/include')
-rw-r--r--src/include/wiredtiger.in7
1 files changed, 3 insertions, 4 deletions
diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in
index e38c41baccd..848448a453d 100644
--- a/src/include/wiredtiger.in
+++ b/src/include/wiredtiger.in
@@ -3143,10 +3143,9 @@ const char *wiredtiger_version(int *majorp, int *minorp, int *patchp)
#define WT_NOTFOUND (-31803)
/*!
* WiredTiger library panic.
- * 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).
*/
#define WT_PANIC (-31804)
/*! @cond internal */