diff options
author | Alex Gorrod <alexg@wiredtiger.com> | 2014-02-27 12:55:14 +1100 |
---|---|---|
committer | Alex Gorrod <alexg@wiredtiger.com> | 2014-02-27 12:55:14 +1100 |
commit | 9184b4247673a11c4ffce6eb49ab37a1a9db83c0 (patch) | |
tree | 64df546ba75833e134fd2fc7cf04a0193bcbb5fa | |
parent | c58c24aae4cf78ea0bbf3851225d6488c1bd7694 (diff) | |
download | mongo-9184b4247673a11c4ffce6eb49ab37a1a9db83c0.tar.gz |
Update documentation for direct_io configuration.
-rw-r--r-- | dist/api_data.py | 7 | ||||
-rw-r--r-- | src/include/wiredtiger.in | 8 |
2 files changed, 12 insertions, 3 deletions
diff --git a/dist/api_data.py b/dist/api_data.py index 2550c405520..412f0603efd 100644 --- a/dist/api_data.py +++ b/dist/api_data.py @@ -613,7 +613,12 @@ methods = { Use \c O_DIRECT to access files. Options are given as a list, such as <code>"direct_io=[data]"</code>. Configuring \c direct_io requires care, see @ref - tuning_system_buffer_cache_direct_io for important warnings''', + tuning_system_buffer_cache_direct_io for important warnings. + Including \c "data" will cause WiredTiger data files to use + \c O_DIRECT, including \c "log" will cause WiredTiger log files + to use \c O_DIRECT, and including \c "checkpoint" will cause + WiredTiger data files opened at a checkpoint (i.e: read only) to + use \c O_DIRECT''', type='list', choices=['checkpoint', 'data', 'log']), Config('extensions', '', r''' list of shared library extensions to load (using dlopen). diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in index ec4825afade..6334bca2061 100644 --- a/src/include/wiredtiger.in +++ b/src/include/wiredtiger.in @@ -1493,8 +1493,12 @@ struct __wt_connection { * @config{direct_io, Use \c O_DIRECT to access files. Options are given as a * list\, such as <code>"direct_io=[data]"</code>. Configuring \c direct_io * requires care\, see @ref tuning_system_buffer_cache_direct_io for important - * warnings., a list\, with values chosen from the following options: \c - * "checkpoint"\, \c "data"\, \c "log"; default empty.} + * warnings. Including \c "data" will cause WiredTiger data files to use \c + * O_DIRECT\, including \c "log" will cause WiredTiger log files to use \c + * O_DIRECT\, and including \c "checkpoint" will cause WiredTiger data files + * opened at a checkpoint (i.e: read only) to use \c O_DIRECT., a list\, with + * values chosen from the following options: \c "checkpoint"\, \c "data"\, \c + * "log"; default empty.} * @config{error_prefix, prefix string for error messages., a string; default * empty.} * @config{eviction_dirty_target, continue evicting until the cache has less |