From 34736ecd7dda90014c286533d6f15cc911aeeb40 Mon Sep 17 00:00:00 2001 From: Dolph Mathews Date: Wed, 29 Jun 2016 09:51:20 -0500 Subject: [PATCH] Improve keystone.conf [domain_config] documentation Change-Id: I89a797ce4f85ad0d710d38fb0973d3bf23141807 --- keystone/conf/domain_config.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/keystone/conf/domain_config.py b/keystone/conf/domain_config.py index d81356490f..1fa4b66120 100644 --- a/keystone/conf/domain_config.py +++ b/keystone/conf/domain_config.py @@ -19,24 +19,27 @@ driver = cfg.StrOpt( 'driver', default='sql', help=utils.fmt(""" -Entrypoint for the domain config backend driver in the -keystone.resource.domain_config namespace. +Entry point for the domain-specific configuration driver in the +`keystone.resource.domain_config` namespace. Only a `sql` option is provided by +keystone, so there is no reason to set this unless you are providing a custom +entry point. """)) caching = cfg.BoolOpt( 'caching', default=True, help=utils.fmt(""" -Toggle for domain config caching. This has no effect unless global caching is -enabled. +Toggle for caching of the domain-specific configuration backend. This has no +effect unless global caching is enabled. There is normally no reason to disable +this. """)) cache_time = cfg.IntOpt( 'cache_time', default=300, help=utils.fmt(""" -TTL (in seconds) to cache domain config data. This has no effect unless domain -config caching is enabled. +Time-to-live (TTL, in seconds) to cache domain-specific configuration data. +This has no effect unless `[domain_config] caching` is enabled. """))