Make cache config options clearer

Currently the cache config options are unclear.

The ``image_cache_stall_time`` is made to sound like it applies to all
images rather than just incomplete images. This could give users the
wrong impression of this option.

The other commands are updated to make them easier to read and follow
the capitalisation of the usages.

DocImpact
Change-Id: Ia7a81c37e626eddb50c59a5ed854abff52bc89fe
This commit is contained in:
Niall Bunting 2016-01-18 11:58:00 +00:00
parent f4d46d1c34
commit c59b164c41

View File

@ -37,13 +37,14 @@ image_cache_opts = [
help=_('The driver to use for image cache management.')),
cfg.IntOpt('image_cache_max_size', default=10 * units.Gi, # 10 GB
help=_('The upper limit (the maximum size of accumulated '
'cache in bytes) beyond which pruner, if running, '
'starts cleaning the images cache.')),
'cache in bytes) beyond which the cache pruner, if '
'running, starts cleaning the image cache.')),
cfg.IntOpt('image_cache_stall_time', default=86400, # 24 hours
help=_('The amount of time to let an image remain in the '
'cache without being accessed.')),
help=_('The amount of time to let an incomplete image remain '
'in the cache, before the cache cleaner, if running, '
'will remove the incomplete image.')),
cfg.StrOpt('image_cache_dir',
help=_('Base directory that the Image Cache uses.')),
help=_('Base directory that the image cache uses.')),
]
CONF = cfg.CONF