summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKeith Bostic <keith@wiredtiger.com>2015-03-20 11:11:31 -0400
committerKeith Bostic <keith@wiredtiger.com>2015-03-20 11:11:31 -0400
commit982b046fda464e00ca4a11e0ec0d904593685015 (patch)
tree3a83bdb700f9a98d29fa871f9a12a5bc3eaad466
parentdbc9f638f24a358173472e2e7f000f624e32f468 (diff)
downloadmongo-982b046fda464e00ca4a11e0ec0d904593685015.tar.gz
Formatting cleanup, make compressor wording consistent for block and
log compression.
-rw-r--r--dist/api_data.py24
-rw-r--r--src/include/wiredtiger.in15
2 files changed, 21 insertions, 18 deletions
diff --git a/dist/api_data.py b/dist/api_data.py
index ec88252bbf7..50739c8967f 100644
--- a/dist/api_data.py
+++ b/dist/api_data.py
@@ -136,11 +136,11 @@ file_config = format_meta + [
requirements from the operating system or storage device''',
min='512B', max='128MB'),
Config('block_compressor', 'none', r'''
- configure a compressor for file blocks. Permitted values are
- \c "none" or custom compression engine name created with
- WT_CONNECTION::add_compressor. If WiredTiger has builtin support
- for \c "snappy", \c "lz4" or \c "zlib" compression, these names are also
- available. See @ref compression for more information''',
+ configure a compressor for file blocks. Permitted values are \c "none"
+ or custom compression engine name created with
+ WT_CONNECTION::add_compressor. If WiredTiger has builtin support for
+ \c "bzip2", \c "snappy", \c "lz4" or \c "zlib" compression, these names
+ are also available. See @ref compression for more information''',
func='__wt_compressor_confchk'),
Config('cache_resident', 'false', r'''
do not ever evict the object's pages; see @ref
@@ -398,9 +398,9 @@ connection_runtime_config = [
eviction configuration options.''',
type='category', subconfig=[
Config('threads_max', '1', r'''
- maximum number of threads WiredTiger will start to help evict
- pages from cache. The number of threads started will vary
- depending on the current eviction load''',
+ maximum number of threads WiredTiger will start to help evict
+ pages from cache. The number of threads started will vary
+ depending on the current eviction load''',
min=1, max=20),
Config('threads_min', '1', r'''
minimum number of threads WiredTiger will start to help evict
@@ -550,9 +550,11 @@ common_wiredtiger_open = [
type='boolean'),
Config('compressor', 'none', r'''
configure a compressor for log records. Permitted values are
- \c "none" or \c "bzip2", \c "snappy", \c "lz4" or custom compression
- engine \c "name" created with WT_CONNECTION::add_compressor.
- See @ref compression for more information'''),
+ \c "none" or custom compression engine name created with
+ WT_CONNECTION::add_compressor. If WiredTiger has builtin support
+ for \c "bzip2", \c "snappy", \c "lz4" or \c "zlib" compression,
+ these names are also available. See @ref compression for more
+ information'''),
Config('enabled', 'false', r'''
enable logging subsystem''',
type='boolean'),
diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in
index 97c9459c424..608fc019131 100644
--- a/src/include/wiredtiger.in
+++ b/src/include/wiredtiger.in
@@ -993,9 +993,9 @@ struct __wt_session {
* @config{block_compressor, configure a compressor for file blocks.
* Permitted values are \c "none" or custom compression engine name
* created with WT_CONNECTION::add_compressor. If WiredTiger has
- * builtin support for \c "snappy"\, \c "lz4" or \c "zlib" compression\,
- * these names are also available. See @ref compression for more
- * information., a string; default \c none.}
+ * builtin support for \c "bzip2"\, \c "snappy"\, \c "lz4" or \c "zlib"
+ * compression\, these names are also available. See @ref compression
+ * for more information., a string; default \c none.}
* @config{cache_resident, do not ever evict the object's pages; see
* @ref tuning_cache_resident for more information., a boolean flag;
* default \c false.}
@@ -1994,10 +1994,11 @@ struct __wt_connection {
* @config{&nbsp;&nbsp;&nbsp;&nbsp;archive, automatically
* archive unneeded log files., a boolean flag; default \c true.}
* @config{&nbsp;&nbsp;&nbsp;&nbsp;compressor, configure a compressor for log
- * records. Permitted values are \c "none" or \c "bzip2"\, \c "snappy"\, \c
- * "lz4" or custom compression engine \c "name" created with
- * WT_CONNECTION::add_compressor. See @ref compression for more information., a
- * string; default \c none.}
+ * records. Permitted values are \c "none" or custom compression engine name
+ * created with WT_CONNECTION::add_compressor. If WiredTiger has builtin
+ * support for \c "bzip2"\, \c "snappy"\, \c "lz4" or \c "zlib" compression\,
+ * these names are also available. See @ref compression for more information.,
+ * a string; default \c none.}
* @config{&nbsp;&nbsp;&nbsp;&nbsp;enabled, enable
* logging subsystem., a boolean flag; default \c false.}
* @config{&nbsp;&nbsp;&nbsp;&nbsp;file_max, the maximum size of log files., an