diff options
| author | Michael Cahill <michael.cahill@wiredtiger.com> | 2012-11-22 15:52:10 +1100 |
|---|---|---|
| committer | Michael Cahill <michael.cahill@wiredtiger.com> | 2012-11-22 15:52:10 +1100 |
| commit | e99a225b358d6e6a7ebefa5d3a89a6dbde8742c2 (patch) | |
| tree | 360a10e0aa57ee610dac3b326e0916e77f9fae12 | |
| parent | 7c5fec29f30e7e7c6e1f4b3668b5d663fbff4cce (diff) | |
| download | mongo-e99a225b358d6e6a7ebefa5d3a89a6dbde8742c2.tar.gz | |
Update the documentation around statistics keys.
| -rw-r--r-- | dist/stat.py | 2 | ||||
| -rw-r--r-- | src/docs/data_sources.dox | 4 | ||||
| -rw-r--r-- | src/docs/upgrading.dox | 10 | ||||
| -rw-r--r-- | src/include/wiredtiger.in | 2 |
4 files changed, 16 insertions, 2 deletions
diff --git a/dist/stat.py b/dist/stat.py index a70c09e8a63..5d294f51fce 100644 --- a/dist/stat.py +++ b/dist/stat.py @@ -45,7 +45,7 @@ def print_defines(): * @anchor statistics_conn * Statistics are accessed through cursors with \c "statistics:" URIs. * Individual statistics can be queried through the cursor using the following - * keys. + * keys. See @ref data_statistics for more information. * @{ */ ''') diff --git a/src/docs/data_sources.dox b/src/docs/data_sources.dox index 644268f7fb5..1ad5c4fcfa4 100644 --- a/src/docs/data_sources.dox +++ b/src/docs/data_sources.dox @@ -88,4 +88,8 @@ Both examples can use a common display routine that iterates through the statistics until the cursor returns the end of the list. @snippet ex_stat.c statistics display function + +Individual statistics values can be retrieved by searching for the corresponding key, as shown in the following example: + +@snippet ex_stat.c statistics retrieve by key */ diff --git a/src/docs/upgrading.dox b/src/docs/upgrading.dox index ad6578717e5..107826c5907 100644 --- a/src/docs/upgrading.dox +++ b/src/docs/upgrading.dox @@ -1,5 +1,15 @@ /*! @page upgrading Upgrading WiredTiger applications +@section version_138 Upgrading to Version 1.3.8 + +<dl> +<dt>Statistics keys</dt> +<dd> +The @ref statistics_keys "statistics key constants" have been renamed to use +all capitals, and use consistent prefixes to distinguish between connection +statistics and statistics for data sources. +</dd> + @section version_136 Upgrading to Version 1.3.6 <dl> diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in index 0fc9c72ab5c..b8af07f2bee 100644 --- a/src/include/wiredtiger.in +++ b/src/include/wiredtiger.in @@ -1693,7 +1693,7 @@ extern int wiredtiger_extension_init(WT_SESSION *session, * @anchor statistics_conn * Statistics are accessed through cursors with \c "statistics:" URIs. * Individual statistics can be queried through the cursor using the following - * keys. + * keys. See @ref data_statistics for more information. * @{ */ /*! blocks read from a file */ |