diff --git a/oslo_config/generator.py b/oslo_config/generator.py index 164bb29f..475b2442 100644 --- a/oslo_config/generator.py +++ b/oslo_config/generator.py @@ -321,6 +321,14 @@ class _OptFormatter(object): '# effect on stability and/or performance.\n' ) + if opt.sample_default: + lines.append( + '#\n' + '# This option has a sample default set, which means that\n' + '# its actual default value may vary from the one documented\n' + '# below.\n' + ) + if hasattr(opt.type, 'format_defaults'): defaults = opt.type.format_defaults(opt.default, opt.sample_default) diff --git a/oslo_config/sphinxext.py b/oslo_config/sphinxext.py index aaac75d8..9a0da869 100644 --- a/oslo_config/sphinxext.py +++ b/oslo_config/sphinxext.py @@ -142,6 +142,16 @@ def _format_opt(opt, group_name): yield _indent( 'effect on stability and/or performance.', 6) + if opt.sample_default: + yield _indent( + '') + yield _indent( + 'This option has a sample default set, which means that') + yield _indent( + 'its actual default value may vary from the one documented') + yield _indent( + 'above.') + try: help_text = opt.help % {'default': 'the value above'} except (TypeError, KeyError, ValueError): diff --git a/oslo_config/tests/test_generator.py b/oslo_config/tests/test_generator.py index 2daa61c8..766cfa9f 100644 --- a/oslo_config/tests/test_generator.py +++ b/oslo_config/tests/test_generator.py @@ -811,6 +811,10 @@ class GeneratorTestCase(base.BaseTestCase): # # multiple strings (multi valued) +# +# This option has a sample default set, which means that +# its actual default value may vary from the one documented +# below. #multi_opt = 5 #multi_opt = 6 ''')),