From 557d4a22951a9af82a2090ce1490f59b1ebe90ce Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Fri, 18 Mar 2022 22:58:56 +0900 Subject: [PATCH] Fix description of memcache_servers Current description says the option is used by only two backends but in fact this option is used by all backends dependent on memcached. Note that the inet6 prefix is specific to the python-memcached library and should not be used if a backend dependent on different libraries (eg. pymemcache) is used. This change describes that point, too. Change-Id: I3c967841c94b9409096c9b9591f9fb162db7a1ac --- oslo_cache/_opts.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/oslo_cache/_opts.py b/oslo_cache/_opts.py index 2f4d4097..39e76d69 100644 --- a/oslo_cache/_opts.py +++ b/oslo_cache/_opts.py @@ -76,17 +76,18 @@ FILE_OPTIONS = { 'to false.'), cfg.ListOpt('memcache_servers', default=['localhost:11211'], help='Memcache servers in the format of "host:port". ' - '(dogpile.cache.memcached and ' - 'oslo_cache.memcache_pool backends only). ' - 'If a given host refer to an IPv6 or a given domain ' - 'refer to IPv6 then you should prefix the given ' - 'address with the address family (``inet6``) ' + 'This is used by backends dependent on Memcached.' + 'If ``dogpile.cache.memcached`` or ' + '``oslo_cache.memcache_pool`` is used and a given ' + 'host refer to an IPv6 or a given domain refer to ' + 'IPv6 then you should prefix the given address with' + 'the address family (``inet6``) ' '(e.g ``inet6[::1]:11211``, ' '``inet6:[fd12:3456:789a:1::1]:11211``, ' '``inet6:[controller-0.internalapi]:11211``). ' - 'If the address family is not given then default ' - 'address family used will be ``inet`` which ' - 'correspond to IPv4'), + 'If the address family is not given then these ' + 'backends will use the default ``inet`` address ' + 'family which corresponds to IPv4'), cfg.IntOpt('memcache_dead_retry', default=5 * 60, help='Number of seconds memcached server is considered dead'