openstack
/
openstack-doc-tools
Code Issues Proposed changes

Autohelp: update the scripts for the juno/kilo diff 

* include sahara
* remove the keystoneclient workaround
* ignore a problematic neutron import
* handle "None" values

Change-Id: I8f342dcb39f5ddd69b73baec2ecb1f3c6883c01a
This commit is contained in:
Gauvain Pocentek 2015-04-28 22:28:39 +02:00 committed by Andreas Jaeger
parent a9b5e1293b
commit feba2086be
3 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
autogenerate_config_docs/autohelp-wrapper
View File

@ -76,15 +76,6 @@ setup_tools() {
# autohelp.py requires this # autohelp.py requires this
pip install oslo.i18n lxml pip install oslo.i18n lxml
# This is a workaround to avoid pulling in new configuration options brought
# by python-keystoneclient >= 0.8. This version also deprecates some options
# still expected by the projects. The release of version 0.8 happened too
# late in the icehouse release cycle to let the doc team handle the changes
# properly in the documentation.
if echo $BRANCH | grep -q stable/; then
pip install "python-keystoneclient==0.7"
fi
} }
while getopts :b:e:cf opt; do while getopts :b:e:cf opt; do

6
autogenerate_config_docs/autohelp.py
View File

@ -51,7 +51,8 @@ IGNORE = [
'trove.guestagent.datastore.experimental.postgresql.service.root', 'trove.guestagent.datastore.experimental.postgresql.service.root',
'trove.guestagent.datastore.experimental.postgresql.service.users', 'trove.guestagent.datastore.experimental.postgresql.service.users',
'glance.contrib.plugins.image_artifact.setup', 'glance.contrib.plugins.image_artifact.setup',
'glance.contrib.plugins.artifacts_sample.setup' 'glance.contrib.plugins.artifacts_sample.setup',
'neutron.plugins.ml2.drivers.cisco.nexus.type_nexus_vxlan'
] ]
@ -351,9 +352,10 @@ class OptionsCache(object):
deprecated_opts = [{'group': deprecated.group, deprecated_opts = [{'group': deprecated.group,
'name': deprecated.name} 'name': deprecated.name}
for deprecated in option.deprecated_opts] for deprecated in option.deprecated_opts]
help_str = option.help.strip() if option.help else "None"
new_option = { new_option = {
'default': option.default, 'default': option.default,
'help': option.help.strip(), 'help': help_str,
'deprecated_opts': deprecated_opts, 'deprecated_opts': deprecated_opts,
'type': option.__class__.__name__.split('.')[-1] 'type': option.__class__.__name__.split('.')[-1]
} }

3
autogenerate_config_docs/diff_branches.py
View File

@ -27,7 +27,7 @@ from lxml import etree
PROJECTS = ['ceilometer', 'cinder', 'glance', 'heat', 'keystone', 'neutron', PROJECTS = ['ceilometer', 'cinder', 'glance', 'heat', 'keystone', 'neutron',
'nova', 'swift', 'trove'] 'nova', 'sahara', 'swift', 'trove']
MASTER_RELEASE = 'Kilo' MASTER_RELEASE = 'Kilo'
CODENAME_TITLE = {'ceilometer': 'Telemetry', CODENAME_TITLE = {'ceilometer': 'Telemetry',
'cinder': 'OpenStack Block Storage', 'cinder': 'OpenStack Block Storage',
@ -36,6 +36,7 @@ CODENAME_TITLE = {'ceilometer': 'Telemetry',
'keystone': 'OpenStack Identity', 'keystone': 'OpenStack Identity',
'neutron': 'OpenStack Networking', 'neutron': 'OpenStack Networking',
'nova': 'OpenStack Compute', 'nova': 'OpenStack Compute',
'sahara': 'Data Processing service',
'swift': 'OpenStack Object Storage', 'swift': 'OpenStack Object Storage',
'trove': 'Database service'} 'trove': 'Database service'}