qcow2: Fix cache-clean-interval documentation

Fixing cache-clean-interval documentation following the recent change to
a default of 600 seconds on supported plarforms (only Linux currently).

Signed-off-by: Leonid Bloch <lbloch@janustech.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
Leonid Bloch 2018-09-29 12:54:54 +03:00 committed by Kevin Wolf
parent cb53460b70
commit e3a7b4556e
3 changed files with 14 additions and 12 deletions

View File

@ -202,18 +202,18 @@ Reducing the memory usage
It is possible to clean unused cache entries in order to reduce the It is possible to clean unused cache entries in order to reduce the
memory usage during periods of low I/O activity. memory usage during periods of low I/O activity.
The parameter "cache-clean-interval" defines an interval (in seconds). The parameter "cache-clean-interval" defines an interval (in seconds),
All cache entries that haven't been accessed during that interval are after which all the cache entries that haven't been accessed during the
removed from memory. interval are removed from memory. Setting this parameter to 0 disables this
feature.
This example removes all unused cache entries every 15 minutes: The following example removes all unused cache entries every 15 minutes:
-drive file=hd.qcow2,cache-clean-interval=900 -drive file=hd.qcow2,cache-clean-interval=900
If unset, the default value for this parameter is 600. Setting it to 0 If unset, the default value for this parameter is 600 on platforms which
disables this feature. support this functionality, and is 0 (disabled) on other platforms.
Note that this functionality currently relies on the MADV_DONTNEED This functionality currently relies on the MADV_DONTNEED argument for
argument for madvise() to actually free the memory. This is a madvise() to actually free the memory. This is a Linux-specific feature,
Linux-specific feature, so cache-clean-interval is not supported in so cache-clean-interval is not supported on other systems.
other systems.

View File

@ -2895,7 +2895,8 @@
# #
# @cache-clean-interval: clean unused entries in the L2 and refcount # @cache-clean-interval: clean unused entries in the L2 and refcount
# caches. The interval is in seconds. The default value # caches. The interval is in seconds. The default value
# is 600, and 0 disables this feature. (since 2.5) # is 600 on supporting platforms, and 0 on other
# platforms. 0 disables this feature. (since 2.5)
# #
# @encrypt: Image decryption options. Mandatory for # @encrypt: Image decryption options. Mandatory for
# encrypted images, except when doing a metadata-only # encrypted images, except when doing a metadata-only

View File

@ -747,7 +747,8 @@ it which is not used for the L2 cache)
@item cache-clean-interval @item cache-clean-interval
Clean unused entries in the L2 and refcount caches. The interval is in seconds. Clean unused entries in the L2 and refcount caches. The interval is in seconds.
The default value is 600. Setting it to 0 disables this feature. The default value is 600 on supporting platforms, and 0 on other platforms.
Setting it to 0 disables this feature.
@item pass-discard-request @item pass-discard-request
Whether discard requests to the qcow2 device should be forwarded to the data Whether discard requests to the qcow2 device should be forwarded to the data